POST
/
shipment
/
cancelbulk
curl --request POST \
  --url https://api.shipbob.com/1.0/shipment/cancelbulk \
  --header 'Authorization: <api-key>' \
  --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

Provide your personal access token in the format 'Bearer {your_personal_access_token}'

Headers

​
shipbob_channel_id
string
required

Channel ID for Operation

Body

application/json
The shipment IDs to cancel

Model for cancel multiple shipments at once

​
shipment_ids
integer[] | null

Shipment IDs to cancel

Response

200
application/json
Success
​
results
object[] | null

The results of all cancellation actions

Was this page helpful?