Overview
ShipBob’s Inventory History API can be used to fetch various inventory movements that occur within the ShipBob Network. An example of this is Warehouse Receiving Order (WRO) stow events as inventory is stowed at a fulfillment center. When stowing occurs, ShipBob’s On Hand quantity increases for that inventory item, and is considered ready to use for fulfillment. This API can be used to capture inventory events such as stow events, spot checks, restock events, and more.Request
Method: POST Authorization: Bearer token, PAT generated from the ShipBob merchant dashboard. Sandbox- Base url:
https://inventorymanagementapi-stage.shipbob.dev
- Endpoint:
/inventory/history:query
- Base url:
https://gateway.shipbob.com
- Endpoint:
/inventory/history:query
Response
Response schema“ReceivingStow”
will return a type field of “WroAndBox”
, and the value field will contain a combination of the WRO id and the box id. These two values will always be separated by a space.
As another exmaple, using the Event Category of “OrderPicked”
will return a type field of “OrderId”
and a value field that will contain the ShipBob order id, in case it needs to be fetched in any subsequent steps within the integration workflow.
Supported Event Categories
The following event categories can be sent via the POST request:EventCategory | Description |
---|---|
OrderPicked | This will return any picking event that occurs during the outbound fulfillment process. |
InventoryAdjusted | Events that occur due to an inventory adjustment, including found inventory during spot-checks and setting on-hand quantities. |
InventoryFacilityUpdated | Events that occur when updating the facility of inventory locations. |
AttributeUpdated | Events that occur when updating inventory attributes. |
InventoryReceived | Events related to receiving new inventory, including returns. |
InventoryRestocked | Events related to restocking previously picked inventory. |
ReceivingStow | This will return stow events that occur from WROs which updates On Hand quantities. |
KittingStow | Events related to stowing inventory during the kitting process, including legacy kitting operations. |
Pagination
The response includes the fieldinventory_audit_event_id
which can be used as a cursor.
Usage: Begin with an empty cursor. To fetch additional records, use the last inventory_audit_event_id
as a query parameter in subsequent requests.
Example:
POST https://inventorymanagementapi-stage.shipbob.dev/inventory/history:query?cursor=23456
This will return any records after (not including) the cursor value.