DHdhl
Orders

Get Shipments for an Order

Searches shipments attached to an given order. Answers with a not found status (404) if order does not exist or if there are no shipmments attached to this order.

get/dpi/shipping/v1/orders/{orderId}/shipments

Request

  • Base URL
    https://api-sandbox.dhl.com
  • Auth
    none declared. Required headers: Authorization

Path parameters

orderIdstring required

The id of the order that the user wants to retrieve all shipments for.

Headers

Authorizationstring required

Bearer Auth access_token together with the "Bearer" prefix is required. Example of the header value:"Bearer 0UuA....."

Response

Shipments data.

awbstring

Transport document issued by a carrier or a forwarder towards the business customer.

Example response

[
  {
    "awb": "AWB123456789",
    "order": {
      "customerEkp": "9012345678",
      "orderId": 1234,
      "orderStatus": "FINALIZE",
      "paperwork": {
        "contactName": "Max Mustermann",
        "awbCopyCount": 3,
        "jobReference": "Job ref",
        "pickupType": "CUSTOMER_DROP_OFF",
        "telephoneNumber": "+4935120681234"
      },
      "items": [
        {
          "product": "GMP",
          "serviceLevel": "PRIORITY",
          "recipient": "Doris Bronson",
          "addressLine1": "Mustergasse 12",
          "city": "Dresden",
          "destinationCountry": "DE",
          "barcode": "BC123456789",
          "custRef": "REF-2361890-AB",
          "recipientPhone": "+4935120681234",
          "recipientFax": "+4935120681234",
          "recipientEmail": "alfred.j.quack@somewhere.eu",
          "addressLine2": "Hinterhaus",
          "addressLine3": "1. Etage",
          "state": "Sachsen",
          "postalCode": "01432",
          "shipmentAmount": 100,
          "shipmentCurrency": "EUR",
          "shipmentGrossWeight": 1500,
          "returnItemWanted": false,
          "shipmentNaturetype": "SALE_GOODS",
          "contents": [
            {
              "contentPieceHsCode": 1234567890,
              "contentPieceDescription": "Trousers",
              "contentPieceValue": "120.50",
              "contentPieceNetweight": 1200,
              "contentPieceOrigin": "DE",
              "contentPieceAmount": 2
            }
          ]
        }
      ],
      "shipments": [
        {}
      ]
    },
    "items": {
      "product": "GMP",
      "serviceLevel": "PRIORITY",
      "recipient": "Doris Bronson",
      "addressLine1": "Mustergasse 12",
      "city": "Dresden",
      "destinationCountry": "DE",
      "barcode": "BC123456789",
      "custRef": "REF-2361890-AB",
      "recipientPhone": "+4935120681234",
      "recipientFax": "+4935120681234",
      "recipientEmail": "alfred.j.quack@somewhere.eu",
      "addressLine2": "Hinterhaus",
      "addressLine3": "1. Etage",
      "state": "Sachsen",
      "postalCode": "01432",
      "shipmentAmount": 100,
      "shipmentCurrency": "EUR",
      "shipmentGrossWeight": 1500,
      "returnItemWanted": false,
      "shipmentNaturetype": "SALE_GOODS",
      "contents": [
        {
          "contentPieceHsCode": 1234567890,
          "contentPieceDescription": "Trousers",
          "contentPieceValue": "120.50",
          "contentPieceNetweight": 1200,
          "contentPieceOrigin": "DE",
          "contentPieceAmount": 2
        }
      ]
    }
  }
]

Changes

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