SEND Packages API

[
  {
    "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",
    "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"
  }
]

Packages for the authenticated business, newest first. Filtered by API key mode (test/live).

Authentication

X-Api-Keystring

API Key authentication via header

Query parameters

statusenumOptional

Allowed values:

keystringOptional

Search by customer name or parcel number

pageintegerOptional

Response

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

storage_feeobjectOptional

noticeslist of objectsOptional

origin_countrystringOptional

destination_countrystringOptional

created_atdatetimeOptional

Errors

401

Unauthorized Error

$	curl https://api.trysend.com/v1/packages \
>	-H "X-Api-Key: <apiKey>"