List 3PL Inventory Comparison Overview
GET/api/3pl-inventory/overview
List every 3PL integration that supports the inventory comparison, with its latest snapshot, agreement %, 30-day settled trend, lines off by more than the tolerance, units apart, and the number of warehouses with a failing check.
inventory:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (inventory:read scope).
Not paginated.
meta.currency_code is the tenant base currency the units-apart values are denominated in.
Request
Responses
- 200
- 401
- 403
- 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.
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.