Cancel a package that has not been converted to a shipment

curl -X POST https://api.trysend.com/v1/packages/PKG123456789/cancel \
     -H "X-Api-Key: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "comment": "Customer no longer needs this shipment"
}'

{
  "parcel_id": "string",
  "parcel_number": "string",
  "customer_identifier": "string",
  "status": "booked",
  "trade_direction": "import",
  "quantity": 1,
  "declared_weight": 1.1,
  "actual_weight": 1.1,
  "length": 1.1,
  "width": 1.1,
  "height": 1.1,
  "volume": 1.1,
  "mode": "test",
  "hold_instruction": "hold",
  "hold_released_at": "2024-01-15T09:30:00Z",
  "warehouse_arrived_at": "2024-01-15T09:30:00Z",
  "cancelled_at": "2024-01-15T09:30:00Z",
  "storage_fee": {
    "free_days": 1,
    "start_date": "2023-01-15",
    "last_free_day": "2023-01-15",
    "chargeable_storage_days": 1,
    "daily_rate": 1.1,
    "currency": "string",
    "storage_area_sqm": 1.1,
    "amount_due": 1.1
  },
  "notices": [
    {
      "token": "string",
      "uuid": "string",
      "level": "info",
      "body": "string",
      "active": true,
      "created_at": "2024-01-15T09:30:00Z",
      "deactivated_at": "2024-01-15T09:30:00Z"
    }
  ],
  "origin_country": "string",
  "destination_country": "string",
  "created_at": "2024-01-15T09:30:00Z"
}

Cancel a package that has not been converted to a shipment (i.e. it has no shipment_id).

Cancelling is a soft action: the package stays retrievable with status set to cancelled (see cancelled_at). Once attached to a shipment, a package can no longer be cancelled.

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

idstringRequired

Parcel token

Request

This endpoint expects an object.

commentstringOptional

Optional free-text reason for the cancellation.

Response

OK — package cancelled

parcel_idstringOptional

parcel_numberstringOptional

customer_identifierstringOptional

statusenumOptional

trade_directionenumOptional

quantityintegerOptional

declared_weightdoubleOptional

actual_weightdoubleOptional

lengthdoubleOptional

widthdoubleOptional

heightdoubleOptional

volumedoubleOptional

modeenumOptional

hold_instructionenumOptional

hold_released_atdatetime or nullOptional

warehouse_arrived_atdatetime or nullOptional

cancelled_atdatetime or nullOptional

Set when the parcel is cancelled. A parcel cannot be cancelled once it has been converted to a shipment.

storage_feeobjectOptional

noticeslist of objectsOptional

origin_countrystringOptional

destination_countrystringOptional

created_atdatetimeOptional

Errors

401

Unauthorized Error

404

Not Found Error

422

Unprocessable Entity Error