DELETE
/
api
/
v1
/
core
/
cancel-labels
Cancel-label
curl --request DELETE \
  --url https://api-stage.orchestro.ai/e1/api/v1/core/cancel-labels \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "accounts": [
    {
      "accountNumber": "AC0088",
      "accountType": "SHIPPER"
    }
  ],
  "callerType": "SHIPPER",
  "labels": [
    "PEBMLQJ7"
  ]
}'
[
  {
    "errors": [
      {
        "code": "ERR-3201",
        "message": "Label is already cancelled."
      }
    ],
    "labelId": "PEBMLQJ7",
    "status": "FAILURE"
  }
]

Authorizations

​
Authorization
string
header
required

Body

application/json

The request body for this endpoint accepts a JSON object that includes account information, caller type, and the IDs of the labels that are to be canceled.

​
accounts
object[]

A list of accounts involved in the label cancellation request.

Example:
[
  {
    "accountNumber": "AC0088",
    "accountType": "SHIPPER"
  }
]
​
callerType
string

The type of entity making the cancellation request (e.g., SHIPPER or CARRIER).

Example:

"SHIPPER"

​
labels
string[]

A list of label IDs to be canceled.

The unique identifier of the label to be canceled.

Example:
["PEBMLQJ7"]

Response

200 - application/json

Cancel label successful

​
errors
object[]
Example:
[
  {
    "code": "ERR-3201",
    "message": "Label is already cancelled."
  }
]
​
labelId
string
Example:

"PEBMLQJ7"

​
status
string
Example:

"FAILURE"