DHdhl
Orders

Create Order

Creates a new order based on the given JSON data

post/dpi/shipping/v1/orders

Request

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

Headers

Authorizationstring required

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

ThirdPartyVendor-IDstring

The ID of the 3PV/Third Party Vendor who creates this order. If no 3PV software is used please leave out of request

Request body

customerEkpstring required

Deutsche Post Customer Account number (EKP) of the customer who wants to create an order.

orderStatus'OPEN' | 'FINALIZE' required

The status of the order. It indicates if an order shall be held open to add more items at a later point in time. "OPEN" means items can be added later, "FINALIZE" means that the order shall be processed immediately.

Example request

{
  "customerEkp": "9012345678",
  "orderStatus": "FINALIZE",
  "paperwork": {
    "contactName": "John Doe",
    "awbCopyCount": 3,
    "jobReference": "Job ref",
    "pickupType": "CUSTOMER_DROP_OFF",
    "telephoneNumber": "+4935120681234"
  },
  "items": [
    {
      "product": "GMP",
      "serviceLevel": "PRIORITY",
      "recipient": "John Doe",
      "addressLine1": "Any Street",
      "addressLine2": "Flat 2",
      "addressLine3": "1st floor",
      "postalCode": "01432",
      "city": "Any City",
      "state": "Any State",
      "destinationCountry": "DE",
      "custRef": "REF-2361890-AB",
      "recipientPhone": "+44123456789",
      "recipientFax": "+44123456789",
      "recipientEmail": "john.doe@example.eu",
      "senderTaxId": "IOSS number",
      "importerTaxId": "IOSS number",
      "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
        }
      ]
    }
  ]
}

Response

Data of created order.

unknown required

Example response

{
  "customerEkp": "9012345678",
  "orderId": 1234,
  "orderStatus": "FINALIZE",
  "shipments": {
    "awb": 9980000123456,
    "items": {
      "id": 123456,
      "barcode": "RX12345678DE",
      "product": "GMP",
      "serviceLevel": "PRIORITY",
      "custRef": "REF-2361890-AB",
      "recipient": "Alfred J. Quack",
      "recipientPhone": "+4935120681234",
      "addressLine1": "Mustergasse 12",
      "addressLine2": "Hinterhaus",
      "addressLine3": "1. Etage",
      "city": "Dresden",
      "state": "Sachsen",
      "postalCode": "01432",
      "destinationCountry": "DE",
      "shipmentGrossWeight": 1500,
      "senderTaxID": "IOSS number",
      "importerTaxId": "IOSS number",
      "returnItemWanted": false,
      "contents": []
    }
  }
}

Changes

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