Once you have an access token, use the Label API to generate a US Domestic or an International label.

Scope

The following operations are allowed in the Label API:

Each Label API request is used to create a single shipping label.

Each label requires a unique identifier called the packageId. For every successful label that is created, the response will contain the DHL unique package identifier, called the dhlPackageId.

After generating a label, a package will have the following identifiers used so it can be tracked:

• packageId: Customer-provided package ID, also known as the CCN (customer confirmation number) or the GM number.
• dhlPackageId: DHL-generated package ID.
• trackingId: Last-mile carrier package ID. For international shipments, this ID is only available after the package has been shipped. For domestic shipments, this ID contains the full USPS IMpb number and is always available.

Workflow

Customers can use this API to:

Create a shipping label for a single package (single physical mail item) using a unique reference of

• POST the label request and generate a Domestic Label.
• POST the label request and generate an International Label.

You can generate the labels in PNG ,PDF or ZPL formats. API returns the label contents directly in the response in the requested format.

• ZPL labelData is provided with an encodeType of PLAIN.
• PNG labelData is provided with an encodeType of BASE64.
• PDF labelData is provided with an encodeType of BASE64.

Sample Domestic Label

Sample International Label

Please see Label Samples under the Reference section for hazmat label samples and requirements.

The Label API is used by clients throughout the day as orders are fulfilled. At the end of the day, the Manifest API is used to manifest and print a DSM (Driver Summary Manifest).

{
   "pickup": "5234567",
   "distributionCenter": "USRDU1",
   "orderedProductId": "GND",
   "consigneeAddress": {
       "name": "John Doe",
       "companyName": "Doe Inc.",
       "address1": "5923 Peachtree Industrial Blvd",
       "address2": "Suite 100",
       "city": "Norcross",
       "state": "GA",
       "country": "US",
       "postalCode": "30024",
       "email": "2@y.com",
       "phone": "44423440348"
   },
   "returnAddress": {
       "name": "Dave Bloggs",
       "companyName": "Joe Inc.",
       "address1": "4552 OLD DIXIE HWY",
       "address2": "Near Pixar road",
       "city": "Baltimore",
       "state": "MD",
       "country": "US",
       "postalCode": "30024",
       "email": "2@y.com",
       "phone": "44423440348"
   },
   "packageDetail": {
       "packageId": "V4-TEST-1586965592482",
       "packageDescription": "test package desc",
       "weight": {
           "value": 10,
           "unitOfMeasure": "OZ"
       },
       "service": "DELCON",
       "serviceEndorsement": "1",
       "billingReference1": "test bill ref 1",
       "billingReference2": "test bill ref 2",
       "shippingCost": {
           "currency": "USD",
           "freight": 4,
           "declaredValue": 50,
           "insuredValue": 50,
           "dutiesPaid": false
       }
   }
}