Skip to main content

Bulk Submit Fulfillment Orders

POST 
/api/fulfillment-orders/bulk-submit

Bulk submitted many FulfillmentOrders at once. Accepts ids[] (required without apply_to_all; each must exist in fulfillment_orders) OR apply_to_all=true.

Required scope: orders:write

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

With apply_to_all=true the entire filtered set is resolved server-side from the table's current filter[...] / filter_groups query-string params (there is no body filters param). FOs not in a submittedable state are skipped (reported in skipped[], not failed). Returns the acted ids, the skipped ids+reasons, and a summary message.

Authenticate with a Personal Access Token.

Set override_partial_dispatch to true to submit orders that are only partially fulfillable even when partial dispatch is disabled. Otherwise such orders are returned in skipped with a code of partial_dispatch_disabled.

Click & Collect (pickup) orders are all-or-nothing. A pickup fulfillment order whose pickup items are not all allocated is never marked ready for collection by this endpoint, whatever the partial-dispatch setting — the customer collects once. It is returned in skipped with code partial_dispatch_disabled and stays held until every pickup item is allocated. Send override_partial_dispatch: true to stage the in-stock items anyway.

Required permission: fulfillment_orders.submit (Fulfillment Orders → Submit & sync) and fulfillment_orders.index (Fulfillment Orders → View). A token also needs its orders scope; the owner needs these role permissions.

Request​

Responses​

OK

Response Headers
    Content-Type