List Inventory Locations
GET/api/big-commerce/:integrationInstance/inventory/locations
Get the BigCommerce inventory locations known for the integration instance, with each location's ID, name, and active state. Location IDs can be used with the inventory comparison filter.
This endpoint currently requires session authentication; Personal Access Token scope support is in progress.
Route name: big-commerce.inventory.locations
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.