SEND Packages API

{
  "id": "string",
  "status": "pending",
  "lane": {
    "code": "string",
    "origin": "string",
    "destination": "string"
  },
  "commodity": {
    "code": "string",
    "label": "string"
  },
  "transport_mode": "air",
  "total": 1.1,
  "estimated_delivery_date": "2023-01-15",
  "created_at": "2024-01-15T09:30:00Z",
  "rate": {
    "id": "string",
    "name": "string",
    "unit": "string",
    "rate": "string",
    "quantity": "string",
    "amount": "string",
    "currency": "string"
  },
  "charges": [
    {
      "id": "string",
      "name": "string",
      "unit": "string",
      "rate": "string",
      "quantity": "string",
      "amount": "string",
      "currency": "string"
    }
  ]
}

Returns the quote from Get Rate. A booked quote also includes sender, recipient, and booked_at.

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

idstringRequired

Parcel quote token

Response

idstring

Stable public quote identifier. Use as quote_id when creating a booking.

statusenum

Always pending on create.

laneobject

Origin/destination pair from lane_code.

commodityobject

Commodity from commodity_code. Does not change pricing.

transport_modeenum

Unified-flow mode.

totaldouble

NGN grand total (freight rate plus charges).

estimated_delivery_datedate

Estimated delivery date.

created_atdatetime

Quote creation timestamp.

rateobject

Freight rate for this quote. Use id as rate_id when creating a booking.

chargeslist of objects

Additional fees included in total. A charge id is not a bookable rate id.

Errors

401

Unauthorized Error

404

Not Found Error