Unmerge Merged Shipment
POST/api/v2/merged-shipments/:mergedShipment/unmerge
Reverses a merge group, restoring each sales order to its pre-merge state. Only allowed before a label is purchased / the shipment is shipped.
orders:writeGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Path Parameters:
- mergedShipment (integer): ID of the merge group
Request Body:
- reason (optional, string, max 1000): Audit-trail reason for the unmerge
Required permission: fulfillment_orders.update (Fulfillment Orders → Edit) and fulfillment_orders.index (Fulfillment Orders → View). A token also needs its orders scope; the owner needs these role permissions.
Request
Responses
- 200
- 401
- 403
- 404
- 422
- 429
OK
Unauthenticated — the bearer token is missing, revoked, expired, or malformed. Never retry automatically; fix the credential. See the Errors guide.
Forbidden
Response Headers
Not found — no record with the given identifier (or the route does not exist). Verify the ID before retrying.
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.