Get Sales Order Backorder Coverage
GET/api/sales-orders/:salesOrder/backorders
Gets backorder coverage data for a sales order — whether any of its lines are backordered, and the expected-arrival window of the incoming purchase orders that cover those backorders.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Response fields:
- earliest_covered_ship_by_date (date|null): The earliest resolved arrival date (ETA) among the purchase order lines allocated to the order's backordered lines. Null when no backordered line is covered by a purchase order.
- latest_covered_ship_by_date (date|null): The latest such ETA — the date by which all covered backordered lines are expected to be shippable.
- has_backorder_lines (boolean): True when the order has at least one backordered line.
Path parameters:
- salesOrder (required): Sales order ID.
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 — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.