Get 3PL Inventory Comparison Summary
GET/api/3pl-inventory/integration-instances/:integrationInstance/summary
Get the comparison summary for one 3PL integration: the selected (or latest completed) snapshot, summary counts, per-warehouse totals and checks, a 30-day trend of settled agreement, and the comparison settings.
inventory:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token (inventory:read scope).
Agreement % = lines exact or within tolerance ÷ compared lines. difference is always 3PL − SKU.io. basis says which SKU.io quantity the 3PL figure is compared with: on_hand (physical units, excluding stock in transit) or sellable_on_hand (on-hand minus held and non-sellable units).
When warehouse_id is given, the counts are recomputed for that warehouse only.
Warehouse checks: three_pl_zero (the 3PL reports no stock while SKU.io holds some), negative_sku_count, shipped_from_empty_count (products SKU.io shipped from the warehouse in the 24 hours before the snapshot that the 3PL reports at zero).
is_stale is true when the latest capture failed or the latest snapshot is older than twice the snapshot cadence.
Returns 404 when the integration does not support the comparison, or snapshot_id belongs to another integration.
currency_code is the tenant base currency every cost and value in the comparison is denominated in.
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
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.