Skip to main content

Execute Post-Submission Merge

POST 
/api/fulfillment-orders/merge-provider/execute

Runs a post-submission cross-order merge for already-dispatched fulfillment orders. The plan is re-validated first; if it can still run, a background job cancels the absorbed orders at the shipping provider, adds their items to the master order, and then records the merge in SKU (each sales order keeps its own tracking). Returns a job handle to track progress.

Required scope: orders:write

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

Body

  • fulfillment_order_ids (int[], required, min 2) — the orders to merge.
  • primary_fulfillment_order_id (int, required) — the order that survives as the master (it receives the others' items).
  • acknowledge_label_voids (bool, optional) — set true to confirm any labels that must be voided first.

Responses

  • 202 Accepted — data.tracked_job_log_id to poll/subscribe on.
  • 422 — the merge can't run; blockers lists why.

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

Request​

Responses​

Accepted

Response Headers
    Content-Type