Skip to main content

Bulk Cancel Fulfillment Orders

POST 
/api/fulfillment-orders/bulk-cancel

Bulk cancelled many FulfillmentOrders at once. Accepts ids[] (required without apply_to_all; each must exist in fulfillment_orders) OR apply_to_all=true, optional reason (string, max 1000) recorded on each cancelled FO.

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

Required permission: fulfillment_orders.cancel (Fulfillment Orders → Cancel) 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