Check Merge Eligibility
POST/api/v2/merged-shipments/eligibility
Evaluates whether a set of sales orders can be merged into a single physical shipment. Returns blockers (hard failures) and warnings (acknowledgeable issues). Does not perform the merge.
Authentication: Requires Bearer token.
Request Body:
- sales_order_ids (required, integer[]): Two or more sales order IDs to evaluate
- proposed_warehouse_id (optional, integer): Override the inferred fulfilling warehouse
Request
Responses
- 200
- 401
- 403
- 422
- 429
OK
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.