Skip to main content

Create Fulfillment Order Merge Group

POST 
/api/fulfillment-orders/merge-group

Merge two or more pre-dispatch fulfillment orders from DIFFERENT sales orders into one merged shipment group. The group dispatches to the shipping provider as a single order keyed on the primary member; at ship time each member's sales order records its own fulfillment carrying the shared tracking. If one of the given fulfillment orders already belongs to a group, the others are added to that group.

Required scope: orders:write

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

Eligibility is enforced server-side: every member must be pre-dispatch (status=open, request_status unsubmitted/rejected), at the same warehouse, for the same shipping provider and shipping address. Amazon FBA fulfillment orders can never be merged.

Body fields:

  • fulfillment_order_ids (required, array of integers, min 2) — the fulfillment orders to merge.
  • primary_fulfillment_order_id (optional, integer, nullable) — which member's reference the provider order is keyed on; defaults to the first id.

Returns 201 with the group and its member summaries. 409 when a member is no longer mutable (already dispatched); 422 for ineligible combinations.

Authentication: Requires Bearer token.

Request​

Responses​

Created

Response Headers
    Content-Type