API ReferenceOrders

Batch Cancel Shipments

View as Markdown

Cancels multiple shipments in a single request. Shipments can only be cancelled if they are in a cancellable state (i.e. not picked, packed, or shipped yet).

Authentication

AuthorizationBearer

Authentication using Personal Access Token (PAT) token or OAuth2

Headers

shipbob_channel_idstringRequiredformat: "int32"

Retrieve your channel ID from the GET /channel endpoint. Use the channel ID that has write scopes.

Request

The shipment IDs to cancel
shipment_idslist of integers or nullOptional
Shipment IDs to cancel

Response

Success
resultslist of objects or null
The results of all cancellation actions

Errors