Create Merged Shipment
POST/api/v2/merged-shipments
Merges two or more sales orders into a single physical shipment (merge group). Each underlying sales order remains intact; one fulfillment per SO is created and linked to the new merge group. The lowest-ID order is the primary.
Authentication: Requires Bearer token.
Request Body:
- sales_order_ids (required, integer[]): Two or more sales order IDs to merge
- notes (optional, string, max 2000): Free-form notes attached to the merge group
- acknowledge_warnings (optional, boolean): If true, allows merging despite warnings (e.g. ship-by date variance). Blockers always prevent merging.
Request
Responses
- 201
- 401
- 403
- 422
- 429
Created
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden — the token lacks a required scope, the endpoint is not available to API tokens, or the user behind the token lacks the permission. A human must adjust the token scopes or user permissions; do not retry.
Unprocessable Entity
Rate limited — platform limit is 1,000 requests/min; individual tokens may carry lower limits. Honor the Retry-After header before retrying. See the Rate Limits guide.