List Inventory Comparison
GET/api/shopify/:integrationInstance/inventory
Get paginated inventory comparison data showing SKU.io quantities vs Shopify quantities per product/location.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Authentication: Requires Bearer token.
Search (filter[search]) matches the ShipBob product SKU and name, the mapped SKU.io product's SKU and name, and the inventory / fulfillment center ids. Narrow it with search_columns (sku, name, shipbob_inventory_id, shipbob_fulfillment_center_id) and make it exact with search_strict_columns.
Each row includes fulfillment_center_name, shipbob_product {id, name, sku} and product_link (the mapped SKU.io product) — both resolved within this instance.
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.