This documentation provides an overview and API request examples for getting product inventory history events from ShipBob.
Use the appropriate base URL depending on the environment.
Base URL:
https://api.shipbob.com/2.0/
Base URL:
https://api.shipbob.com/2.0/
Base URL:
https://sandbox-api.shipbob.com/2.0/
Use this endpoint to retrieve a list of inventory history events filtered by date range and event category.
Endpoint: GET /inventory/history:query
Sample Request: https://api.shipbob.com/2.0/inventory/history:query?EventCategory=SpotChecking&EndDate=2025-03-03&StartDate=2025-03-01
Sample Response
Parameter | Type | Description |
---|---|---|
EventCategory | string | The category of an inventory event (see below). |
Limit | integer | Number of records to return. Default: 50 . |
Page | integer | Page number for paginated results. |
StartDate | datetime | Start time (ISO 8601 format) for querying inventory history. |
EndDate | datetime | End time (ISO 8601 format) for querying inventory history. |
Note: Use ISO 8601 format for date parameters. Example: 2025-03-01T00:00:00Z
.
Event Category | Description |
---|---|
SpotChecking | Manual stock verification adjustments. |
CreateInventory | Initial product creation in inventory. |
RestockAfterReturn | Returns added back to inventory. |
Receiving | New stock received at fulfillment center. |
OrderPicking | Items picked for order fulfillment. |
RestockAfterPicking | Adjustments after picking orders. |
SkuChange | Updates to SKU numbers affecting inventory. |
The API response is paginated; use Limit
and Page
for large data retrieval.
Ensure proper authentication using a Bearer Token.
The event_date
field follows UTC timezone.