API ReferenceInventory

Query Inventory History Events

View as Markdown

Fetches inventory movement events that change on-hand quantities within the ShipBob network. Returns events such as receiving/stow, order picks, adjustments, restocks, and attribute updates. Filter by inventory IDs, event category, date range, and facility. Supports cursor-based pagination for large result sets.

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

Query parameters

cursorstringOptionalformat: "int32"

Request

This endpoint expects an object.
facility_idintegerRequired

Required. The ShipBob fulfillment center ID where the inventory events occurred. To find available facility IDs, use the Get Fulfillment Centers endpoint.

cursorinteger or nullOptional

Optional. Pagination cursor using the inventory_audit_event_id from the previous response. Returns events after this ID.

end_datedatetime or nullOptional
Recommended. End date for filtering events. If omitted, defaults to current date.
event_categorystring or nullOptional

Recommended. Filter by event type: OrderPicked, InventoryAdjusted, InventoryFacilityUpdated, AttributeUpdated, InventoryReceived, InventoryRestocked, ReceivingStow, or KittingStow.

inventory_idslist of integers or nullOptional
Recommended. Filter by specific inventory IDs. Returns events for these inventories only.
start_datedatetime or nullOptional
Recommended. Start date for filtering events. If omitted, defaults to 90 days ago. Maximum range is 90 days.

Response

OK
datalist of objects or null
Array of inventory history events matching the query criteria.
firststring or null
URL to retrieve the first page of results.
laststring or null
URL to retrieve the last page of results.
nextstring or null
URL to retrieve the next page of results. Null if no more results available.
prevstring or null
URL to retrieve the previous page of results. Null if on the first page.