Retrieve a single shipment

Shipments Detail view

Pull the authoritative record for any shipment ID. Responses include labels, package metadata, routing events, and calculated ETA so you can troubleshoot customer issues in one call.

Verb

GET · read only

Security

Bearer token · shipment.read scope

Ideal use

Customer support consoles · incident workflows

Endpoint overview

GET Path param

URL: `{{ url }}/api/v2/shipments/{{ shipment_id }}/`

• Returns `200` when the shipment belongs to the authenticated account.
• Responds with `404` if the ID is unknown or outside your tenant.
• Use this endpoint to refresh cached data after webhook notifications.

Request contract

Element	Required	Description
Authorization header	Yes	Bearer {{ token }} issued via AAJ Auth.
shipment_id	Yes	Path parameter such as E9C5308D. Case-insensitive.

Sample request

GET /api/v2/shipments/E9C5308D/ HTTP/1.1
Host: {{ url }}
Authorization: Bearer {{ token }}
Accept: application/json

Success response

{
  "message": "success!",
  "status_code": 200,
  "payload": {
    "id": "04843296-38fc-4913-9bfa",
    "meta": {
      "package_type": "regular",
      "booking": 838,
      "origin": ["Nigeria", "ogun"],
      "destination": ["Nigeria", "lagos"],
      "receiver_name": "TAIWO HASSANAT SHOGEYINBO",
      "tpl_service": "AAJ",
      "delivery_mode": "DOOR_STEP"
    },
    "delivery_mode": "DOOR_STEP",
    "order_type": "LC",
    "shipment_type": "AAJ LOCAL",
    "package_index": 0,
    "tracking_id": "04843296",
    "invoice": "",
    "packages": {
      "tpl": "AAJ",
      "type": "regular",
      "draft": false,
      "items": [
        {
          "name": "WOVEN WOMEN DRESS MFG BY SLASH COURTURE, 8 FEBURG ROAD, AGEGE, LAGOS STATE",
          "price": 13000,
          "quantity": 1,
          "unitMeasurement": "PCS"
        }
      ],
      "packages": [
        {
          "actualWeight": 10,
          "unitMeasurement": "KGS",
          "packageDimension": {
            "price": 4000,
            "width": 30,
            "height": 22,
            "length": 38,
            "weight": 6
          }
        }
      ],
      "itemsValue": 13000
    },
    "shipment_tracking_number": "",
    "tracking_url": "https://express.org/#track",
    "label_documents": [
      "JVBERi0xLjUKJb/3ov4KMSAwIG9iago8PCAvVHlwZSAvT2JqU3RtIC9MZW5ndGggMTA2MyAv"
    ],
    "current_tracking_updates": "",
    "void_state": false,
    "events": [],
    "status": 0,
    "in_manifest": false,
    "otp_sent": null,
    "created_at": "2024-11-04T09:58:06.615269+01:00",
    "updated_at": "2024-11-04T09:58:25.704518+01:00",
    "manifest_id": "",
    "received_by": null,
    "eta": {
      "number_of_days": 2,
      "date_of_arrival": "2024-11-06T08:58:06.615269+0000"
    },
    "acknowledgement_copy": null,
    "acknowledgement_otp": null,
    "mps": false,
    "source": {
      "id": "",
      "name": "",
      "branch": "",
      "customer_id": "",
      "account_number": ""
    },
    "reweigh_data": null,
    "booking": 838,
    "master_shipment": null
  }
}

Error response

{
  "message": "shipment not found",
  "status_code": 404,
  "payload": null
}

Field reference

Field	Description
id	Unique shipment identifier.
meta	Canonical booking context (routing, receiver, delivery mode).
packages	Array of physical packages plus declared items and weights.
tracking_url	Deep link for customer-facing tracking.
label_documents	Base64-encoded label PDFs ready for download.
events	Most recent milestone events tied to the shipment.
status	Integer status flag; map via shipment status reference.
eta	Calculated promise window with arrival date.
acknowledgement_*	Proof-of-delivery artifacts when the shipment completes.
source	Account metadata for auditing (branch, account number).

Support workflow: Pair this endpoint with track-shipment to show both the static shipment payload and the live movement history in a single console.