Get Inventory Summary
GET/api/big-commerce/:integrationInstance/inventory/summary
Get aggregate inventory sync statistics for the integration instance: total SKU/location rows, how many are in sync, how many have a variance, how many need recalculation, and the timestamps of the last fetch from BigCommerce and last sync to BigCommerce.
Any valid API token can call this endpoint — no specific scope required. Manage tokens.
Route name: big-commerce.inventory.summary
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.