Skip to main content

Search Backorders

POST 
/api/v2/inventory-allocations/backorders

Returns the same paginated list of backorders as the GET version of this endpoint, but accepts filters as a JSON request body instead of the query string. Use this POST variant when the filter set is too large or too complex to fit in a URL.

Required scope: orders:write

Grant this scope to your token under Settings → Developer → Personal Access Tokens.

A status scope selects which backorders are returned: active (default; outstanding backorders awaiting stock or receipt), released (backorders that have since been allocated or fulfilled), released_fulfilled, released_submitted, released_unfulfilled, or all.

Provide advanced filters under filter_groups, a tree of conditions combined with a conjunction of and or or. Each condition names a column, an operator, and a value. A free-text search term matches against allocation id, SKU, product name, supplier, sales order number, and purchase order number.

Text columns (sku, product_name, supplier_name) accept: is, is_not, contains, does_not_contain, starts_with, ends_with, is_empty, is_not_empty, is_one_of, is_not_one_of. Numeric and date columns (id, quantity, priority, backordered_quantity, released_quantity, created_at, updated_at, backorder_date, order_date) accept: is, is_not, greater_than, greater_than_or_equal, less_than, less_than_or_equal, between, is_empty, is_not_empty. Boolean filters covered_by_po and has_other_wh_stock accept is with true/false; eta_state accepts is with has_eta, late_eta, or missing_eta; supplier_id accepts a numeric id or none.

Sortable columns (via sort, prefix with - for descending): id, priority, quantity, created_at, updated_at, backorder_date, backordered_quantity, released_quantity, sku, product_name, supplier, order_date, sales_order_number, eta. Results default to priority.

Request​

Responses​

OK

Response Headers
    Content-Type