Get Locations-Off Impact
GET/api/v2/warehouse-locations/locations-off-impact
Stock held in named locations (every bin except the warehouse's Unassigned/default location), per warehouse. Read this before switching warehouse locations off: while they are off, every sale, receipt and adjustment is booked to the default location and these bin balances stop changing.
warehouses:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Only warehouses that hold stock in a named location are returned.
Query parameters:
- warehouse_id (optional, integer): one warehouse. Omit for every warehouse that uses locations.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 422
- 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.
Unprocessable Entity
Response Headers
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.