Get Fulfillment Debt Report
GET/api/inventory/fulfillment-debt-report
Returns a paginated list of fulfillment debt lines — sales order lines the sales channel has already fulfilled that could not be recorded against stock. Includes both outstanding lines (units still owed with nothing reserved) and covered lines (debt fully netted by planned / awaiting-receipt / allocated inventory, which settles automatically when that stock lands). Lines are returned newest first. Authentication: Requires Bearer token.
inventory:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Filters:
- filter[coverage]: 'outstanding' (net debt remains) or 'covered' (debt fully reserved against incoming inventory). Omit for both.
- filter[order_number], filter[order_status], filter[fulfillment_status], filter[warehouse_name]: text filters.
- filter[order_date.from] / filter[order_date.to]: date range.
- filter[line_quantity], filter[processable_quantity], filter[fulfilled_quantity], filter[reserved_quantity], filter[debt_quantity]: numeric filters.
- filter[search]: searches SKU, product name, and order number.
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.