Get Active Merge Group for Sales Order
GET/api/v2/sales-orders/:salesOrder/active-merge-group
Returns the open merged shipment (not yet shipped, cancelled, or unmerged) that the sales order currently belongs to, with primary sales order, warehouse, creator, shipping method, and per-order fulfillments (including lines) eager-loaded. Returns null data when the order is not part of an active merge group.
orders:readGrant this scope to your token under Settings → Developer → Personal Access Tokens.
Authentication: Requires Bearer token.
Path Parameters:
- salesOrder (integer): ID of the sales order
Request
Responses
- 200
- 401
- 403
- 404
- 429
OK
Response Headers
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.
Not Found
Response Headers
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.