API ReferenceOrdersAdditional

Bulk Release Shipments From Hold

View as Markdown
Releases multiple shipments from hold in a single request. Only the merchant-initiated holds — Manual and Auto Processing Pause — are removed; operational holds (e.g. invalid address, short at pack) are never removed by this action. **Per-shipment results:** each shipment returns its own result in `results`. A shipment moves back to processing only when no hold reasons of any kind remain after the merchant-initiated holds are removed. If the shipment stays held for operational reasons, the release still succeeds and `is_still_on_hold_due_to_other_reasons` is `true`. Releasing a shipment with nothing to release is an idempotent success. HTTP 400 is only returned when the request itself is malformed (empty `shipment_ids` or over the batch cap).

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token

OR
AuthorizationBearer
OAuth2 authentication using JWT tokens

Request

This endpoint expects an object.
shipment_idslist of longsRequired
Shipments to release from hold. Must contain at least one id.

Response

OK
summaryobject
Summary of the bulk operation results
resultslist of any or nullOptional

Per-shipment release results

Errors

400
Bad Request Error