Get shipment details

Retrieve full details for a specific shipment, including origin, destination, items, tracking, documents, and cost breakdown.

GET /shipments/{shipmentId}

Get shipment details

cURL

curl --request GET \
  --url https://api.shippeek.dev/shipments/{shipmentId} \
  --header 'Authorization: Bearer <token>'

200

{
  "id": "<string>",
  "createdDate": "2023-11-07T05:31:56Z",
  "status": "<string>",
  "origin": {
    "company": "<string>",
    "address": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  },
  "destination": {
    "company": "<string>",
    "address": "<string>",
    "address2": "<string>",
    "city": "<string>",
    "state": "<string>",
    "postalCode": "<string>",
    "country": "<string>"
  },
  "items": [
    {
      "weight": 123,
      "freightClass": 50,
      "length": 123,
      "width": 123,
      "height": 123,
      "quantity": 1,
      "description": "<string>",
      "package": "<string>",
      "hazardous": false,
      "nmfc": "<string>"
    }
  ],
  "tracking": {
    "status": "<string>",
    "trackingNumber": "<string>",
    "pickupDate": "2023-11-07T05:31:56Z",
    "deliveryDate": "2023-11-07T05:31:56Z"
  },
  "documents": [
    {
      "type": "bol",
      "url": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Your ShipPeek API token in the format client_id.client_secret.

Path Parameters

shipmentId · string · required

Shipment ID

Response

200

application/json

Shipment details returned

id · string

createdDate · string<date-time>

status · string

origin · object

Show child attributes

destination · object

Show child attributes

items · object[]

Show child attributes

tracking · object

Show child attributes

documents · object[]

Show child attributes