SEND Packages API

[
  {
    "parcel_quote_id": "string",
    "status": "pending",
    "source": "string",
    "direction": "string",
    "reference": "string",
    "rates": [
      {
        "id": "string",
        "carrier": "string",
        "service": "string",
        "rate": "string",
        "currency": "string",
        "estimated_delivery_days": 1,
        "estimated_delivery_date": "2023-01-15"
      }
    ],
    "sender": {
      "name": "John Sender",
      "email": "sender@example.com",
      "phone": "+1234567890",
      "address": {
        "street": "123 Main St",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country": "US"
      }
    },
    "recipient": {
      "name": "John Sender",
      "email": "sender@example.com",
      "phone": "+1234567890",
      "address": {
        "street": "123 Main St",
        "city": "New York",
        "state": "NY",
        "postal_code": "10001",
        "country": "US"
      }
    },
    "package": {
      "weight": 5,
      "length": 10,
      "width": 8,
      "height": 6,
      "item_description": "Electronics"
    },
    "cargo_volume": "1 x 40'",
    "origin_details": {},
    "dest_details": {},
    "parcel_details": {},
    "tracking_code": "string",
    "label_url": "string",
    "selected_rate": {},
    "tracker_id": "string",
    "purchased_at": "2024-01-15T09:30:00Z",
    "booked_at": "2024-01-15T09:30:00Z",
    "estimated_price": 6246625,
    "created_at": "2024-01-15T09:30:00Z"
  }
]

Authentication

X-Api-Keystring

API Key authentication via header

Query parameters

statusenumOptionalDefaults to pending

Allowed values:

pageintegerOptional

Response

parcel_quote_idstringOptional

statusenumOptional

sourcestringOptional

directionstringOptional

referencestringOptional

rateslist of objectsOptional

senderobjectOptional

recipientobjectOptional

packageobjectOptional

Air weight/dimensions, or ocean packages[] nested under package in responses.

cargo_volumestringOptional

Human-readable cargo summary, e.g. 2 x 40' (ocean) or 5 kg (air).

origin_detailsobjectOptional

dest_detailsobjectOptional

parcel_detailsobjectOptional

tracking_codestring or nullOptional

label_urlstring or nullOptional

selected_rateobject or nullOptional

tracker_idstring or nullOptional

purchased_atdatetime or nullOptional

Legacy booking timestamp when status is booked. Same moment as booked_at. Not payment confirmation for ocean/import intake quotes.

booked_atdatetime or nullOptional

When the quote became booked. Null while pending.

estimated_pricedouble or nullOptional

NGN total from selected_rate.rate. For ocean/import intake, provisional until warehouse receive; customer payment is invoiced separately.

created_atdatetimeOptional

Errors

401

Unauthorized Error

$	curl -G https://api.trysend.com/v1/parcel_quotes \
>	-H "X-Api-Key: <apiKey>" \
>	-d page=1 \
>	-d status=pending