AWBs

Create a Single AWB

Creates a new single awb based on the given data. This request will be decommissioned. Please use /dpi/v1/bulk/{customerEkp}/mixedorders instead.

post/dpi/shipping/v1/awbs

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....."

Request body

awbCopyCountinteger required

Copies of AWB labels. One AWB per final receptacle required. Number between 1 and 99.

contactNamestring required

Contact name for paperwork.

customerEkpstring required

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

itemFormat'P' | 'G' | 'E' | 'MIXED' required

The item format for this awb.

jobReferencestring

Job reference for the whole shipment.

product'GMM' | 'GMR' | 'GMP' | 'GPT' required

The product that is used for the shipment of this item. Available products are: GMP [Packet Priority/Prio (goods)], GPT [Packet Tracked/Tracked], GMM [Business Mail Priority/Prio (documents)], GMR [Business Mail Registered/Plus (documents)]

serviceLevel'PRIORITY' | 'REGISTERED' required

The service level that is used for the shipment of this item. There are restrictions for use of service level: Registered is only available with product GMR and SalesChannel DPI

telephoneNumberstring

Telephone number for paperwork. Mandatory for sales channel EXPRESS.

totalWeightnumber double

Total weight of the awb (in kg).

Example request

{
  "customerEkp": "9012345678",
  "contactName": "Max Mustermann",
  "awbCopyCount": 3,
  "product": "GMP",
  "serviceLevel": "PRIORITY",
  "itemFormat": "P",
  "jobReference": "Job ref",
  "totalWeight": 5,
  "telephoneNumber": "+4935120681234"
}

Response

Bytestream (File) containing the awb label.