Skip to main content

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.

Required scope: inventory:read

Grant 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.

Why a line is here:

  • unrecorded_reason: unmapped_product (the channel SKU matches no product), identity_tracked (serial/lot stock), pool_unavailable (stock held by another commitment), or failed (the sync could not complete — see unrecorded_detail).
  • unrecorded_reason_label / unrecorded_remedy: display text for the above. An unmapped SKU needs no action and may stay in this state indefinitely.
  • unrecorded_quantity: units the channel shipped that could not be recorded.
  • is_settleable: false when the line names no product or warehouse. Those lines are real debt and are listed here, but a catch-up stock take cannot include them — there is nothing to adjust.

Request​

Responses​

OK

Response Headers
    Content-Type