Get Product Fulfillment Debt Summary
GET/api/v2/products/:product/fulfillment-debt-summary
Get the channel fulfillment-debt summary for a product — units the sales channel shipped that have never been deducted from inventory (no inventory movements exist for them), with a per-warehouse breakdown.
products:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
total_units is the gross owed quantity; outstanding_units nets out active allocations (planned / awaiting receipt / allocated) that will settle automatically when stock arrives. first_date / last_date bound the affected order dates.
Pass warehouse_id to scope the summary (and the breakdown) to a single warehouse.
Authentication: Requires Bearer token.
Request
Responses
- 200
- 401
- 403
- 404
- 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.
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.