DHL Api V2.1

Services

Standard

The most basic service. Normal ground shipping without any modifier to speed up the shipping time.

Returns

A shipment that the customer sends back to the store / sender

Europaket

The service DHL Europaket is a great solution for business-to-business parcel shipments, because shipments within the 32 supported countries will generally be delivered within 48 hours.

Requirements:

  • minimum dimensions (l/w/h): 15 x 11 x 3.5 cm
  • maximum dimensions (l/w/h): 120 x 60 x 60 cm
  • maximum weight: 31.5 kg

Package types

Bulk

Shipments that don't fall into the normal dimensions can be send by specifying them as bulk items when sending via dhl.

Requirements:

  • package.type has to be bulk
  • you'll have to use your own contract with the carrier

Parcel

The most basic package type for shipping parcels there is.

Additional services

Advance notice

DHL currently only supports advance notice via email.

Requirements:

  • service has to be standard

Cash on delivery

Requirements:

  • You'll have to use your own DHL contract

GoGreen

Using the additional service DHL GoGreen you benefit from climate-neutral dispatch within Germany and internationally.

Requirements:

  • You'll have to use your own DHL contract

Ident Check

If you want the carrier to only deliver the shipment to a specific person you can use the DHL ident check. DHL will ask the recepient to show them a valid ID. Thus you will be able to minimize fraud, only deliver to persons of a certain age (e.g. when sending alcoholic beverages, adult content or pharmaceuticals that need a prescription).

Requirements:

  • You'll have to use your own DHL contract
  • Your DHL contract must be setup for DHL "Ship" (DHL "Versenden")
  • The recipient has to be located in Germany
  • Only available for label size A5

Delivery Time (Preferred Time)

Premium International

Using the additional service DHL premium international you can reduce international shipping transit times.

Requirements:

  • You'll have to use your own DHL contract
  • Your DHL contract must be setup for DHL "Ship" (DHL "Versenden")

Visual age check

When sending goods that are only legally available for people of a specific age, you can request the carrier to check the receiver's age visually. Just add the additional service visual_age_check and either 16 or 18 as its minimum_age value.

Requirements:

  • You need to use your own DHL Ship contract
  • The recipient has to be located in Germany

Other attributes

Additional insurance

DHL is offering you the option of an additional insurance which you can book instead of their normal liability.

Customs declaration

If you want to send a shipment to a country where a customs declaration is necessary you can specify this the following way. Detailed information about the parameters can be found in our documentation of creating a shipment.

Requirements:

  • customs_declaration.currency has to be EUR

Parcel pickup station (Packstation)

When sending to a DHL Packstation the following parameters have to be defined:

  • care_of = customer id number (postnummer)
  • street has to be PACKSTATION
  • street_no = number of packstation

Post office delivery (Postfiliale)

When sending to a DHL post office the following parameters have to be defined:

  • care_of = customer id number (postnummer)
  • street has to be POSTFILIALE
  • street_no = number of the Postfiliale outlet

Label formats

PDF

  • DIN A5: pdf_a5
  • DIN A6: pdf_a6

Field lengths

  • company: 2 - 50 characters
  • last_name: 1 - 35 characters (firstname + last_name <= 35 characters)
  • care_of: 0 - 35 characters
  • street: 1 - 35 characters
  • street_no: 1 - 10 characters
  • zip_code: 1 - 10 characters
  • city: 1 - 35 characters
  • state: 0 - 30 characters
  • phone: 0 - 20 characters
  • notification_email: 0 - 70 characters
  • customs_declaration
    • contents_explanation: 0 - 256 characters
    • invoice_number: 0 - 35 characters
    • drop_off_location: 0 - 35 characters
    • items
      • description: 0 - 256 characters
      • hs_tariff_number: 1 - 10 characters

DHL Api V3.1

Services

Standard

The most basic service. Normal ground shipping without any modifier to speed up the shipping time.

Requirements:

  • Domestic shipments within Germany:
    • Minimum dimensions (l/w/h): 15 x 11 x 1 cm
    • Maximum dimensions (l/w/h): 120 x 60 x 60 cm
    • Maximum weight: 31.5 kg
  • International shipments:
    • Minimum dimensions (l/w/h): 15 x 11 x 1 cm
    • Maximum dimensions (l/w/h): 120 x 60 x 60 cm
    • Maximum weight: depends on local carrier

Returns

A shipment that the customer sends back to the store / sender

Europaket

The service DHL Europaket is a great solution for business-to-business parcel shipments, because shipments within the 32 supported countries will generally be delivered within 48 hours.

Requirements:

  • minimum dimensions (l/w/h): 15 x 11 x 3.5 cm
  • maximum dimensions (l/w/h): 120 x 60 x 60 cm
  • maximum weight: 31.5 kg

Prio

To receive priority handling by DHL you can book the service DHL Prio and your parcel will be delivered on the next business day.

Requirements:

  • service has to be dhl_prio
  • The sender has to be located in Germany
  • The recipient has to be located in Germany
  • You'll have to use your own contract with the carrier

Warenpost (domestic)

"Whether you need to ship glasses, shirts or flip-flops, many products are ultimately too small to send in a parcel or small package. For frequent shippers, Warenpost is the perfect, convenient solution - especially if your goods have to reach customers quickly, reliably and affordably too."

Requirements:

  • carrier has to be dhl
  • package.type has to be parcel
  • service has to be dhl_warenpost
  • The sender and recipient have to be located in Germany
  • For shipments up to 1,000g
  • Minimum dimensions (l/w/h): 10 x 7 x 0.1cm
  • Maximum dimensions (l/w/h): 35.3 x 25 x 5cm
  • Minimum volume: 200 items per year
  • you'll have to use your own contract with the carrier

Package types

Bulk

Shipments that don't fall into the normal dimensions can be send by specifying them as bulk items when sending via dhl.

Requirements:

  • package.type has to be bulk
  • you'll have to use your own contract with the carrier

Parcel

The most basic package type for shipping parcels there is.

Additional services

Advance notice

DHL currently only supports advance notice via email.

Requirements:

  • service has to be standard

Cash on delivery

Requirements:

  • You'll have to use your own DHL contract
  • label.format can be pdf_a5 or zpl2_103x199mm_203dpi

Endorsement

Prior to sending your parcel you can specify what should happen to the shipment in case it cannot be delivered in the destination country. By choosing the handling option `abandon`, your parcel will not be returned to you, but rather auctioned off or destroyed by the recipient countrys' postal company. You will not be charged with a return fee for this option.

Requirements:

  • You'll have to use your own DHL contract
  • Available for international shipments from Germany
  • The additional service attribute properties.handling has to be abandon
  • label.format can be pdf_a5, pdf_a6 or zpl2_103x199mm_203dpi

GoGreen

Using the additional service DHL GoGreen you benefit from climate-neutral dispatch within Germany and internationally.

Requirements:

  • You'll have to use your own DHL contract

Ident Check

If you want the carrier to only deliver the shipment to a specific person you can use the DHL ident check. DHL will ask the recepient to show them a valid ID. Thus you will be able to minimize fraud, only deliver to persons of a certain age (e.g. when sending alcoholic beverages, adult content or pharmaceuticals that need a prescription).

Requirements:

  • You'll have to use your own DHL contract
  • Your DHL contract must be setup for DHL "Ship" (DHL "Versenden")
  • The recipient has to be located in Germany
  • label.format can be pdf_a5 or zpl2_103x199mm_203dpi

Named Person Only

To ensure that a package is only delivered to the recipient you can book the DHL additional service named person only.

"The named person only service ensures in an uncomplicated and cost-effective way that your parcels are only delivered to the recipient in person or to an authorized person."

Requirements:

  • service has to be standard or dhl_prio
  • label.format can be pdf_a5 or zpl2_103x199mm_203dpi
  • The sender has to be located in Germany
  • The recipient has to be located in Germany
  • You'll have to use your own contract with the carrier

Parcel outlet routing

With the DHL additional service retail outlet routing you can tell the carrier to reroute a parcel to the nearest outlet when the recipient can't be reached. Otherwise the parcel will be returned immediately.

Requirements:

  • service has to be standard or dhl_warenpost
  • label.format can be pdf_a5, pdf_a7, pdf_100x70mm, zpl2_100x70mm_203dpi or zpl2_103x199mm_203dpi
  • Let the carrier inform the recipient about the redirection by providing their email address
  • Either the sender or the recipient has to be located in Germany
  • You'll have to use your own contract with the carrier

Preferred Day

Using the DHL additional service preferred day you can request a delivery to be made on an specific date in time.

Requirements:

  • service has to be standard
  • label.format can be pdf_a5 or zpl2_103x199mm_203dpi
  • The sender has to be located in Germany
  • The recipient has to be located in Germany
  • You'll have to use your own contract with the carrier

Premium International

Using the additional service DHL premium international you can reduce international shipping transit times.

Requirements:

  • You'll have to use your own DHL contract
  • Your DHL contract must be setup for DHL "Ship" (DHL "Versenden")

Visual age check

When sending goods that are only legally available for people of a specific age, you can request the carrier to check the receiver's age visually. Just add the additional service visual_age_check and either 16 or 18 as its minimum_age value.

Requirements:

  • You need to use your own DHL Ship contract
  • The recipient has to be located in Germany
  • label.format can be pdf_a5 or zpl2_103x199mm_203dpi

Other attributes

Additional insurance

DHL is offering you the option of an additional insurance which you can book instead of their normal liability.

Customs declaration

If you want to send a shipment to a country where a customs declaration is necessary you can specify this the following way. Detailed information about the parameters can be found in our documentation of creating a shipment.

Requirements:

  • customs_declaration.currency has to be EUR

Parcel pickup station (Packstation)

When sending to a DHL Packstation the following parameters have to be defined:

  • care_of = customer id number (postnummer)
  • street has to be PACKSTATION
  • street_no = number of packstation

Post office delivery (Postfiliale)

When sending to a DHL post office the following parameters have to be defined:

  • care_of = customer id number (postnummer)
  • street has to be POSTFILIALE
  • street_no = number of the Postfiliale outlet

Label formats

PDF

  • DIN A5: pdf_a5
  • DIN A6: pdf_a6
  • DIN A7: pdf_a7
  • 100x70mm: pdf_100x70mm

ZPL

  • ZPL2 100x70mm 203dpi: zpl2_100x70mm_203dpi
  • ZPL2 103x199mm 203dpi: zpl2_103x199mm_203dpi

Field lengths

  • company: 2 - 50 characters
  • last_name: 1 - 35 characters (firstname + last_name <= 35 characters)
  • care_of: 0 - 35 characters
  • street: 1 - 35 characters
  • street_no: 1 - 10 characters
  • zip_code: 1 - 10 characters
  • city: 1 - 35 characters
  • state: 0 - 30 characters
  • phone: 0 - 20 characters
  • notification_email: 0 - 70 characters
  • customs_declaration
    • contents_explanation: 0 - 256 characters
    • invoice_number: 0 - 35 characters
    • drop_off_location: 0 - 35 characters
    • items
      • description: 0 - 256 characters
      • hs_tariff_number: 1 - 10 characters