This documentation provides an overview and API request examples for getting product inventory history events from ShipBob.

Base Setup

Use the appropriate base URL depending on the environment.

Get Inventory History

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

[
  {
    "inventory_id": 12345,
    "event_category": "SpotChecking",
    "event_date": "2025-03-02T19:52:15.6700004+00:00",
    "fulfillment_center_id": 169,
    "inventory_quantity_changed": -17,
    "lot_number": null,
    "expiration_date": null
  },
  {
    "inventory_id": 45678,
    "event_category": "SpotChecking",
    "event_date": "2025-03-02T18:20:21.124613+00:00",
    "fulfillment_center_id": 169,
    "inventory_quantity_changed": 5,
    "lot_number": null,
    "expiration_date": null
  }
]

Query Parameters

ParameterTypeDescription
EventCategorystringThe category of an inventory event (see below).
LimitintegerNumber of records to return. Default: 50.
PageintegerPage number for paginated results.
StartDatedatetimeStart time (ISO 8601 format) for querying inventory history.
EndDatedatetimeEnd time (ISO 8601 format) for querying inventory history.

Note: Use ISO 8601 format for date parameters. Example: 2025-03-01T00:00:00Z.

Event Category Options

Event CategoryDescription
SpotCheckingManual stock verification adjustments.
CreateInventoryInitial product creation in inventory.
RestockAfterReturnReturns added back to inventory.
ReceivingNew stock received at fulfillment center.
OrderPickingItems picked for order fulfillment.
RestockAfterPickingAdjustments after picking orders.
SkuChangeUpdates to SKU numbers affecting inventory.

Additional Notes

  • 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.