Shipments

Get shipment details

Read a shipment, including label_errors and an inline Base64 label when available. Use label_format=pdf (default) or label_format=zpl.

get/api/external/v1/shipments/{shipment_id}

Request

  • Base URL: http://localhost
  • URL: http://localhost/api/external/v1/shipments/{shipment_id}
  • Auth: HTTP bearer

Response

Example response

{
  "data": {
    "id": "shp_x7Kq9",
    "external_reference": "ERP-SHIPMENT-100045",
    "order_reference": "ERP-ORDER-5001",
    "shipment_status": "created",
    "label_status": "created",
    "label_errors": [],
    "shipping_method": {
      "id": "sm_a1b2c3",
      "name": "PostNord Service Point",
      "delivery_type": "pickup_point"
    },
    "carrier": {
      "id": "postnord",
      "name": "PostNord"
    },
    "service_point": {
      "id": "sp_xyz789",
      "name": "PostNord Ombud City"
    },
    "sender": {
      "name": "Merchant Warehouse",
      "address1": "Warehouse Road 10",
      "address2": null,
      "postal_code": "41502",
      "city": "Göteborg",
      "country": "SE",
      "phone": null,
      "email": "warehouse@example.com"
    },
    "recipient": {
      "name": "Anna Andersson",
      "address1": "Drottninggatan 1",
      "address2": null,
      "postal_code": "11151",
      "city": "Stockholm",
      "country": "SE",
      "phone": "+46701234567",
      "email": "anna@example.com"
    },
    "parcels": [
      {
        "weight_grams": 1200,
        "length_cm": 30,
        "width_cm": 20,
        "height_cm": 10
      }
    ],
    "tracking": {
      "number": "PN123456789SE",
      "url": "https://tracking.example/PN123456789SE",
      "status": "in_transit",
      "last_event_at": "2026-05-27T12:00:00Z"
    },
    "metadata": {
      "source": "erp"
    },
    "links": {
      "self": "/api/external/v1/shipments/shp_x7Kq9",
      "label": "/api/external/v1/shipments/shp_x7Kq9/label",
      "tracking": "/api/external/v1/shipments/shp_x7Kq9/tracking"
    },
    "created_at": "2026-05-27T10:00:00Z",
    "updated_at": "2026-05-27T12:00:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.