In the coming weeks, FastBound will add support for an optional new SKU property on its Acquisition Items and Items. This will be a string property with a maximum length of 50 characters. Users of the FastBound user interface will be able to set this property when importing, acquiring, or editing items.
If you don’t need to use the SKU field, you don’t need to change anything. If you want to use the new SKU field, your integration may need to be updated to be made aware of this new field.
API users
After we release this update, in order to ensure that your integration doesn’t overwrite SKU values with null, you’ll need to update your code to first read the new SKU field, and then pass it back in the appropriate Edit endpoint. This is because Edit API calls are not a PATCH operation; they update the object with all fields specified in the endpoint signature.
Acquisition Items
If you use the API to create acquisitions and add/edit acquisition items, you’ll need to update your code to account for the new SKU field.
Adding items to an acquisition
You can add items to an existing acquisition with the following endpoints:
-
Single item: https://cloud.fastbound.com/swagger/index.html#/AcquisitionsV1/post__accountNum__api_Acquisitions__id__Items
-
Multiple items: https://cloud.fastbound.com/swagger/index.html#/AcquisitionsV1/post__accountNum__api_Acquisitions__id__Items_Multiple
If you plan to use the new SKU field, you can prepare your software by starting to send your SKUs as the property “sku” on the acquisition items in the above requests.
For example:
Note that until we release the update that supports SKUs, any SKUs you send will be silently ignored.
Reading full item details of an item on an acquisition
After you have added items to an acquisition, you can read an item’s full details to get the SKU using the following endpoints:
-
Get by Acquisition Id and Acquisition Item Id: https://cloud.fastbound.com/swagger/index.html#/AcquisitionsV1/get__accountNum__api_Acquisitions__id__Items__acquisitionItemId_
-
Get by Acquisition External Id and Acquisition Item External Id: https://cloud.fastbound.com/swagger/index.html#/AcquisitionsV1/get__accountNum__api_Acquisitions__acquisitionExternalId__Items__acquisitionItemExternalId_
After we have released support for the new SKU field, the responses of these endpoints will return the acquisition item’s SKU as a property in the response.
For example:
Note that until we release the update that supports SKUs, this property will not be present in the response.
Editing items on an acquisition
You can edit items that are already on an acquisition with the following endpoint:
-
Edit by Acquisition Id and Acquisition Item Id: https://cloud.fastbound.com/swagger/index.html#/AcquisitionsV1/put__accountNum__api_Acquisitions__id__Items__acquisitionItemId_
If you plan to use the new SKU field, you can prepare your software by starting to send your SKUs as the property “sku” on the acquisition item in the above request.
For example:
Note that until we release the update that supports SKUs, any SKUs you send will be silently ignored.
Also, because the edit operation is not a PATCH, please ensure you get the acquisition item’s properties from the API, make any changes, and then submit all of the properties listed so that you don’t inadvertently overwrite valid properties with null values.
Creating and Committing an acquisition in a single call
FastBound has an endpoint that allows you to create and commit an acquisition and its items in a single call. If you plan to use the new SKU field, you can prepare your software by starting to send your SKUs as the property “sku” on the acquisition items in the request.
For example:
Note that until we release the update that supports SKUs, any SKUs you send will be silently ignored.
Items
If you use the API to read or edit items, you’ll need to update your code to account for the new SKU field.
Reading Items
After we have released support for the new SKU field, the responses of these endpoints will contain an item’s SKU:
-
Get All / Search (will also allow the caller to search by SKU): https://cloud.fastbound.com/swagger/index.html#/ItemsV1/get__accountNum__api_Items
-
Get by Id: https://cloud.fastbound.com/swagger/index.html#/ItemsV1/get__accountNum__api_Items__id_
-
Get by External Id: https://cloud.fastbound.com/swagger/index.html#/ItemsV1/get__accountNum__api_Items_GetByExternalId__externalId_
Example of SKU in the response:
Note that until we release the update that supports SKUs, this property will not be present in the response.
Editing an item
You can edit an item with the following endpoint:
If you plan to use the new SKU field, you can prepare your software by starting to send your SKUs as the property “sku” on the item in the above request.
For example:
Note that until we release the update that supports SKUs, any SKUs you send will be silently ignored.
Also, because the edit operation is not a PATCH, please ensure you get the item’s properties from the API, make any changes, and then submit all properties specified on the endpoint so that you don’t inadvertently overwrite valid properties with null values.
Webhooks users
After we release the update that supports SKUs, relevant webhook request bodies will contain the item’s SKU for each item. Events that will contain SKU on items in the request body:
-
acquisition.committed
-
disposition.committed
-
disposition.deleted
-
disposition.items.added
-
disposition.items.edited
-
disposition.items.removed
-
inventory.location.moved
-
inventory.location.verified
-
inventory.notfound
-
item.deleted
-
item.edited
-
item.imported
-
item.undeleted
-
item.undisposed