List Ship-With-Preorder Deferrals
GET/api/v2/inventory-allocations/ship-with-preorder
Lines whose in-stock units are reserved from an incoming purchase order so they ship together with a preorder item on the same order (view=active, the default), or lines whose reservation ended with no free shelf stock to return to and now wait on their PO as a normal backorder (view=attention).
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Every filter is accepted as filter[x] or plain x.
Searches ID (exact), sales order number, SKU and PO number. Restrict with search_columns (comma list of id, sales_order_number, sku, purchase_order_number).
filter_groups (base64-encoded JSON tree with AND/OR groups) applies advanced conditions; each condition's column is <column>.<operator>. Columns: id, quantity (numeric); sales_order_number, sku, purchase_order_number (text); po_available_eta, anchor_eta (date); deferred_at, flagged_at (datetime).
Allowed sorts: id, sales_order_number, sku, quantity, po_available_eta, anchor_eta, deferred_at, flagged_at (prefix with - for descending; default -deferred_at for active, -flagged_at for attention).
Paginated (default 10 per page, maximum 500). The response adds counts (active and needs-attention totals). Dates po_available_eta / anchor_eta are calendar dates; deferred_at / flagged_at are UTC timestamps.
Request
Responses
- 200
- 401
- 403
- 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.
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.