Skip to main content
POST
/
2025-07
/
shipment:batchCancel
Cancel multiple Shipments by Shipment Id
curl --request POST \
  --url https://api.shipbob.com/2025-07/shipment:batchCancel \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'shipbob_channel_id: <shipbob_channel_id>' \
  --data '
{
  "shipment_ids": [
    0
  ]
}
'
{
  "results": [
    {
      "action": "Cancel",
      "is_success": true,
      "reason": "string",
      "shipment_id": 0
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Authentication using Personal Access Token (PAT) token

Headers

​
shipbob_channel_id
string<int32>
required

Channel ID for Operation

Body

application/json

The shipment IDs to cancel

Model for cancel multiple shipments at once

​
shipment_ids
integer<int32>[] | null

Shipment IDs to cancel

Response

Success

​
results
object[] | null

The results of all cancellation actions

Last modified on August 7, 2025