SEND Packages API

{
  "id": "string",
  "tracking_code": "string",
  "status": "booked",
  "lane": {
    "code": "string",
    "origin": "string",
    "destination": "string"
  },
  "commodity": {
    "code": "string",
    "label": "string"
  },
  "sender": {
    "name": "string",
    "phone": "string",
    "address": {
      "street": "123 Main St",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "US"
    }
  },
  "recipient": {
    "name": "string",
    "phone": "string",
    "address": {
      "street": "123 Main St",
      "city": "New York",
      "state": "NY",
      "postal_code": "10001",
      "country": "US"
    }
  },
  "hold_instruction": "hold",
  "hold_updated": "2024-01-15T09:30:00Z",
  "created_at": "2024-01-15T09:30:00Z"
}

One package with lane, commodity, parties, and hold state. Side effects: none (read-only). Auth: X-Api-Key.

Authentication

X-Api-Keystring

API Key authentication via header

Path parameters

idstringRequired

Parcel token

Response

idstring

tracking_codestring

statusenum

Allowed values:

laneobject

commodityobject

senderobject

recipientobject

hold_instructionenum

Allowed values:

hold_updateddatetime

When the hold state last changed.

created_atdatetime

Errors

401

Unauthorized Error

404

Not Found Error