List Inventory Comparison
GET/api/big-commerce/:integrationInstance/inventory
Get a paginated side-by-side comparison of SKU.io quantities vs BigCommerce quantities, one row per product listing per BigCommerce inventory location. Each row includes the variance and a status of synced, variance, or needs_recalc.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Allowed sorts: id, sku_quantity, sales_channel_quantity, created_at, updated_at (default -id).
Route name: big-commerce.inventory.index
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.