Delete shipment

DELETE 
/shipments/:shipment_id

Delete a shipment with the specified ID and stop tracking it.

Only the shipment ID can be provided. Deleting a shipment by tracking code is not supported.

Request

Path Parameters

shipment_id stringrequired

ID of the shipment.

Responses

200

Shipment deleted and tracking stopped.

401

The API token in the request is missing or is invalid. See the Error responses page for more details.

application/json

Schema

Schema

error

object

status integerrequired

HTTP status code of the error.

message stringrequired

Human-readable message describing the error.

code string

Optional machine-readable code providing details about some 4xx errors.

Example (from schema)

{
  "error": {
    "status": 0,
    "message": "string",
    "code": "string"
  }
}

402

No active plan for the account or plan doesn't allow API/endpoint usage. See the Error responses page for more details.

application/json

Schema

Schema

error

object

status integerrequired

HTTP status code of the error.

message stringrequired

Human-readable message describing the error.

code string

Optional machine-readable code providing details about some 4xx errors.

Example (from schema)

{
  "error": {
    "status": 0,
    "message": "string",
    "code": "string"
  }
}

404

The requested resource does not exist. See the Error responses page for more details.

application/json

Schema

Schema

error

object

status integerrequired

HTTP status code of the error.

message stringrequired

Human-readable message describing the error.

code string

Optional machine-readable code providing details about some 4xx errors.

Example (from schema)

{
  "error": {
    "status": 0,
    "message": "string",
    "code": "string"
  }
}

429

The API rate limit has been exceeded. See the Error responses page for more details.

application/json

Schema

Schema

error

object

status integerrequired

HTTP status code of the error.

message stringrequired

Human-readable message describing the error.

code string

Optional machine-readable code providing details about some 4xx errors.

Example (from schema)

{
  "error": {
    "status": 0,
    "message": "string",
    "code": "string"
  }
}

Loading...