DHL eCommerce Europe
v 1.1.31
Division: DHL eCommerce

Best for:

  • DHL Parcel Connect shipping
  • DHL Parcel Return Connect shipping
  • DHL Parcel Connect PLUS shipping
  • Creating cross-border & direct injection shipments within Europe
  • Large business customers of DHL eCommerce in Europe
  • Sending shipments within Europe and from Europe (excl. DE) into Rest of World
Region: Europe
Used for: Shipping
Overview

eConnect

This API Gateway is named eConnect API and is issued by DHL eCommerce . It is the one stop solution for large eCommerce customers in Europe to send shipment data, retrieve labels and access track and trace information. It offers the products DHL Parcel Connect, DHL Parcel Return Connect, DHL Parcel Connect PLUS, DHL Parcel International and DHL Parcel Return International.

Users of the eConnect API can:

Send shipment data Generate label Location Finder Track & Trace
Create shipments automatically without manual effort, directly from their online shop, logistics software etc. Retrieve compliant labels for their shipments in different formats Request information from the "Unified Location Finder" to select from approx. 65 thousand Service Points and lockers for direct addressing of shipments Access track and trace information on account or shipment level

This page provides detailed information about the eConnect API content and its use. Click here to jump directly to the following topics:

Scope

The eConnect API covers the essential DHL cross-border parcel products for shipments within Europe and beyond.

  • DHL Parcel Connect for business customers offers harmonized parcel shipping all across our European network. To target e-commerce volumes its USPs are fast transit times, high quality standard, full end-to-end transparency and a wide range of services for recipients, leveraging the strength of our own network and of selected partners.
    • Weight: Up to 31.5kg
    • Dimension: Maximum 120 x 60 x 60cm
    • Fast transit times: typically ranging between 1-3 days (depending on origin and destination country)
    • For customers in all DHL eCommerce Europe countries
    • Delivery in all DHL eCommerce Europe and partner countries
    • End-to-End transparency through track & trace including pre-delivery notification
    • Saturday and delivery on preferred day possible
    • Direct delivery to Parcelshop or Parcelstation
    • Standard insurance up to €500 included
    • Additional services available (e.g. cash on delivery, pick-up services, bulky goods)
    Parcel Connect Coverage
  • DHL Parcel Return Connect is an international return product for business customers from selected countries with fast transit times, high-density of drop-off points, full end-to-end track & trace transparency, using the strengths of our own network and of selected partners.
    • Weight: Up to 31.5kg
    • Dimension: Maximum 120 x 60 x 60cm
    • For direct returns from all DHL eCommerce Europe countries to DHL eCommerce Europe countries
    • Fast transit times typically ranging between 1-3 days (depending on origin and destination country)
    • Full end-to-end track & trace
    • Return label included with original shipment
    • Free of charge for returning consumer
    • Drop off at DHL & partner Parcelshops  & Parcelstations (as available)
    • Pick-up at private address available
    • Standard insurance up to EUR 500 included
    • Additional services (e.g. bulky goods)
Parcel Return Connect Coverage
  • DHL Parcel Connect PLUS is a service designed especially for companies involved in European cross-border business-to-business e-commerce. Parcel Connect Plus uses a single label, a central system landscape (powered by DHL eCommerce), and a network of certified partners covering Europe, with DHL operating the last mile in over 80% and the rest managed by leading partners in B2B shipping. Parcel Connect Plus is modular and flexible, it can evolve with your business – so it´s always the perfect fit.
    • Delivery to business premises across all European destinations
    • Ships single parcels up to 31.5 kg or pallets combining parcels from 31.5 kg to 1.000 kg, ​with a high maximum shipment weight (up to 2.500 kg) in a multi-piece shipment
    • Maximum size per piece as standards: 120 x 60 x 60 cm (parcels) and 120 x 100 x 200 cm (incl pallet)
    • Maximum size per piece as bulky: 200 x 120 x 80 cm within max girth 360cm (parcels)
    • Cost-saving multi-colli option: up to 999 parcels and up to 5 pallets with one shipment ID
    • Reliable, rapid transit times – including direct injection option across the network
    • End-to-end Track & Trace for each individual piece in a shipment
    • Shipping of dangerous goods in limited quantities
    • Shipping of lithium batteries
    • At least two delivery attempts
    • Proof of delivery via customer signature
    • Delivery during working hours
    • Excellent B2B customer service levels across all markets
    • Return of undeliverables
Parcel Connect Plus Coverage

 

  • DHL Parcel International provides shipping of parcels to over 220 countries. Business customers benefit from simplified postal customs clearance, reliable transit times with end-to-end tracking to key destinations using our global postal network and our international shipping expertise.
    • Weight: Up to 20kg (DHL eCommerce limit)
    • Dimension: [Europe: maximum 120 x 60 x 60cm, maximum girth 300cm] [Americas, Aspac: Maximum length 42 inch, maximum length & girth 79 inch] (depending on origin and destination country)
    • Available to 220 destinations worldwide
    • Range-definite transit times [typically between 5-10 days]
    • End-to-end tracking
    • Delivery through local postal providers
    • Simplified postal customs clearance
    • Standard insurance up to €500 included
  • DHL Parcel Return International provides return shipping of parcels [from 26 European countries to EU countries and Switzerland using the network of our postal partners.]
    • Weight: Up to 20kg (DHL eCommerce limit)
    • Dimension: Maximum 120 x 60 x 60cm (depending on origin and destination country)
    • [For returns within Europe via Germany]
    • End-to-end tracking
    • Online label creation for returns
    • Drop-off at postal outlets
    • Liability based on legal regulations

Feel free to check out our website for more detailed product information. For further information on the functionalities, please visit Use Cases.

In case you are a customer based in Germany, please check out our German portfolio at the DHL Developer Portal.

Example Use Cases

Example 1: user sends shipment data to DHL and receives a label in return

The eConnect API allows the user to send shipment data for Parcel Connect, Parcel Connect Return, Parcel Connect PLUS, Parcel International and Parcel Return International shipments to DHL. The data needs to be send in JSON format, following the "cPAN" request scheme according to the API documentation. If requested the API will return the respective label in the desired format (e.g. PDF) and resolution.

Example 2: user searches for shipment status via track & trace

The eConnect API offers a full track and trace functionality for the shipments of each user. It is possible to request the status information on singular shipment or account level.

Example 3: request ServicePoint location and directly address a shipment to a ServicePoint

The customer can address DHL Parcel Connect shipments to a DHL network location address, e.g. a ServicePoint or Locker, instead of a doorstep address. If the location data is not known, the user can search for available locations using the DHL Unified Location Finder API. Retrieved location information needs to be integrated into the respective shipment data of the eConnect API.

Please visit our Use Case section for a full list of possible use cases.

User Guide

Get Access

For onboarding, you need to follow this process guided by our country based DHL eCommerce teams:

  1. To request access for our Production and Sandbox environments you have to sign up. To sign up, please get in touch with your local sales representative.
  2. Implement your API solution in our Sandbox environment (see use cases) and seek approval from our DHL experts (for data and label).
  3. Retrieve access to Production environment and start shipping.

To contact your DHL eCommerce team, please use this contact form.

Authentication

To get access to the API (Sandbox and Production environment), you will receive a Client ID and a password. Please use the contact form (including your company name, industry and contact details (incl. phone number and email address)) to apply for these.

The API provides OAuth 2.0 Access Token with various authorization scopes.

The "Get Access Token" API call provides an OAuth 2.0 Bearer token with authorization scope, assigned to your client id. It grants you an access to the CCC APIs.

The API operation is secured by HTTP Basic authentication, therefore you have to provide 'client_id' and 'client_secret' as an username and password, when calling the API. Credentials will be provided to you via secured channel.

Environments

The addressable API base URL/URI environments are:

Environment Description
https://api-sandbox.dhl.com Sandbox environment
https://api.dhl.com Production environment

The Sandbox environment can be used for testing freely. Only the production environment will trigger underlying processes, e.g. billing, operational procedures.

Information for Integrators

The DHL eConnect API differentiates between customers and integrators. If you are an integrator, you may retrieve permission to operate the API on behalf of an assigned customer. For administrative reasons, shipments are always assigned to a dedicated customer. API users with status "integrator" cannot generate shipments themselves, unless they additionally have a customer account.

The customer/integrator configuration is performed by DHL, please contact via the contact form.

Rate Limits

Rate limits protect the DHL infrastructure from suspicious requests that exceed defined thresholds.

Should you exceed your rate limit you will receive a HTTP status code within the API response that will indicate this.

In addition to the rate limit a so called "spike arrest" protects our API Platform from potential outages caused by a very large volume of requests sent in a short time span (minutes or seconds). This will be indicated by a different HTTP status code.

Functionalities

This API offers various functionalities that all support you in managing your DHL eCommerce Solutions cross-border parcel shipments. This page gives an overview and introduction to the available functionalities. A detailed developer's documentation is available in the "Reference Docs" section (see here).

Please note that all integrated API features need to be covered by the customer's DHL contract. The technical API integration of a feature alone is no sufficient precondition for feature usage on the production environment.

Shipment Data

  • It is mandatory for the sender to send shipment data for each individual piece/parcel. Please see below explanations for details on the requested shipment parameter, in addition please check our use cases and the "reference docs" section on this website.
  • Along with the recipient and sender address data, several additional shipment details need to be defined for each shipment:
    • Product type: DHL Parcel Connect, DHL Parcel Return Connect, DHL Parcel Connect PLUS, DHL Parcel International or DHL Parcel Return International
    • Sender address data: Use these fields to define the shipper address on the label. The field "customerIdentfication" must contain the senders DHL customer number (e.g. EKP, local ID). Please note: For Connect return shipments the "customerIdentification" needs to be included as an attribute for the sender as well, not for the receiver.
    • Recipient address data: Use these fields to insert the consignee address and/or the selected servicepoint information
    • Product features: Depending on the selected product type, various product features are to be selected in the shipment data:
      • Mandatory features
        • Delivery type: The delivery type needs to be chosen i.e. default for doorstep, parcelshop, parcelstation or postOffice.
        • Gross weight: It is mandatory to provide the gross weight in kg.
      • Optional features
        • Size: It is optional, but recommended, to delivery size information for shipments in meter.
        • Cash on delivery (COD): When choosing "Cash-on-delivery", a shipment is handed over to the recipient against payment. Financial details are required in this case.
        • Bulky: Shipments outside the standard dimensions or with any property that prevents automated sorting need to be marked as bulky by the customer. For details see product information (above).
        • Additional insurance: Depending on your contract with DHL, the customer can order additional insurances
        • Customer Barcode: Add additional information to your parcel via an individual barcode
        • Labelless Returns: Provide your customer a labelless drop off solution via QR-Code (or other code) returns (Depending on drop off country)
        • Return consolidation: Improve your return flow via consolidation in our DHL Return Hubs

Label

  • The API can generate high-resolution labels based each individual shipment data and provide the label files within the API response.
  • Labels are available for all covered products, i.e. DHL Parcel Connect, DHL Parcel Return Connect, DHL Parcel Connect PLUS, DHL Parcel International and DHL Parcel Return International
  • All labels generated by the eConnect API come with an unique shipment identifier barcode (ASC MH10 format) which is assigned by the service. All these shipment identifiers have the same number-prefix JJD1499902... and a total length of 21 characters. They are unique for at least 13 months, before they are used again for another shipment.
  • In certain cases it is possible to offer customer-individual shipment identifiers, please contact your DHL responsible if required.
  • Currently the following products, formats, sizes and resolutions are available:
    • 5 products: "DHL Parcel Connect", "DHL Parcel Return Connect", "DHL Parcel Connect PLUS", "DHL Parcel International" or "DHL Parcel Return International"
    • 2 sizes: 15x10cm or 21x10cm
    • 2 resolutions: 200 dpi or 300 dpi
    • 3 formats: PDF, PNG or ZPL
  • In case of generating DHL Parcel Return labels, it is recommended to additionally generate return instructions. Return instructions contain information in all local languages and shall help return senders (i.e. consumer) to correctly handle the return shipment. To receive our return instructions, please request them via our DHL contact.
  • When creating shipments into customs areas please refer to below chapter "Customs Data".
  • Please see below an example DHL Parcel Connect label for shipment delivered to a door-step address as well as the respective return label.
Label Example ConnectLabel Example Return Connect

    Labelless Returns

    • The API can generate high-resolution (QR-)codes based each individual shipment data and provide the label files within the API response.
    • (QR-)codes are available for DHL Parcel Return Connect
    • All (QR-)codes generated by the eConnect API come with an unique shipment identifier barcode (ASC MH10 format) which is assigned by the service. All these shipment identifiers have the same number-prefix JJD1499902... and a total length of 21 characters. They are unique for at least 13 months, before they are used again for another shipment.
    • In certain cases it is possible to offer customer-individual shipment identifiers, please contact your DHL responsible if required.
    • Currently the following products, formats, sizes and resolutions are available:
      • 1 product: "DHL Parcel Return Connect"
      • 2 resolutions: 200 dpi or 300 dpi
      • 2 formats: PNG or GIF
    • In case of generating DHL Parcel Return (QR-)codes, it is recommended to additionally generate return instructions. Return instructions contain information in all local languages and shall help return senders (i.e. consumer) to correctly handle the return shipment. To receive our return instructions, please request them via our DHL contact.
    • Please see below an example for DHL Parcel ReturnConnect labelless return (QR-)code.

                              

    Addressing to ServicePoints

    • With DHL Parcel Connect it is possible, to directly address shipments to ServicePoints or Lockers in the destination country, instead of a doorstep address.
      • The service is available for destinations: AT, BE, BG,CY, CZ, DE, DK, EE, ES, FI, FR, GB, GR, HR, HU, IT, LT, LV, LU, NL, NO, PL, PT, RO, SE, SI, SK, UK
      • The service is not available for destinations: IE
    • The DHL Unified Location Finder API provides up-to-date address data of all available DHL and Partner locations, which can be used for direct addressing of shipments.
    • It contains location information of ServicePoints, Postoffices and Lockers, including additional information such as opening hours, holiday closing times and services offered.
    • The DHL Location Finder API offers to retrieve locations in an area near a specific address (within a radius of 25km).
    • Please find more information on how to access and integrate the DHL Location Finder API here.
    • After retrieving location address data via the DHL Unified Location Finder API, the address data needs to be entered into the shipment data for the particular shipment on the eConnect API.
    • Apply the below mapping table to correctly map the location data fields from the DHL Location Finder API to the shipment data fields of the DHL eConnect API - needed for DHL Parcel Connect shipments directly addressed to a ServicePoint, PostOffice or Locker.
    Mapping

    Overview of field mappings

    Content DHL Location Finder API DHL eConnect API Example / Comment
    Type of Location locations/ location/ type CPAN/ addresses/ recipient/ type see table below
    Name of Recipient n.a. CPAN/ addresses/ recipient/ name e.g. Hans Schmitz
    Postnummer (only for DE Packstation) n.a. CPAN/ addresses/ recipient/ customerIdentification e.g. 1234567 (only needed for DE Packstation)
    Name of ServicePoint (not needed for Lockers) locations/ name CPAN/ addresses/ recipient/ additional name e.g. B+B Tabakwaren
    Keyword of ServicePoint/ Locker locations/ location/ keyword CPAN/ addresses/ recipient/ street1 e.g. Postfiliale
    ID of ServicePoint/ Locker locations/ location/ keywordId CPAN/ addresses/ recipient/ street1Nr e.g. 443
    Street name of the Servicepoint locations/ place/ address/ streetAddress CPAN/ addresses/ recipient/ street2 e.g. Monckebergstr. 7
    ZIP Code of the Servicepoint locations/ place/ address/ postalCode CPAN/ addresses/ recipient/ postcode e.g. 20095
    City of the ServicePoint locations/ place/ address/ addressLocality CPAN/ addresses/ recipient/ city e.g. Hamburg
    Country of the ServicePoint locations/ place/ address/ countryCode CPAN/ addresses/ recipient/ country e.g. DE

    Additional information & tipps for using both API's

    • When requesting locations from the DHL Unified Location Finder API, please make sure to only select locations offering the following "service types" in the Location Finder API:
      • "parcel:pick-up" - these locations are available for any direct addressing of parcels
      • "parcel: pick-up-unregistered" - these locations are available for any direct addressing of parcels
      • "parcel: pick-up-registered" - these locations are available for direct addressing of parcels only, if a destination specific recipient-registration number is transmitted in the shipment data (e.g. for German Parcelstations a "Postnumber" is mandatory)
    • When requesting locations from the DHL Location Finder API, please make sure to map the "type" of the selected location from the Location Finder API correctly to the DHL eConnect Solutions API:
    DHL Location Finder API <type> DHL eConnect API <type>
    servicepoint parcelshop
    locker parcelstation
    postoffice postOffice

    Track & Trace

    • The DHL Unified Shipment Tracking API provides you with the current status of all our parcels created via the eConnect API.
    • Next to the API channel, customers shipments can be monitored as well via public websites, e.g.: www.dhl.com/tracking
    • Senders can communicate track & trace information to their recipients via one link for all European destinations. The link gives direct access to tracking information: http://www.dhl.com/tracking?tracking-ID=#### and can be personalized with an individual shipping ID.

    Customs data

    • The customs functionality of the eConnect API is applicable for the products "DHL Parcel International" and "DHL Parcel Connect". However, the product "DHL Parcel Connect" only supports shipments from or to the United Kingdom via this eConnect API.
    • For parcels into customs destinations, it is mandatory send customs data per each shipment (i.e. cCustoms request) in addition to the shipment data (i.e. cPAN request).
    • The cCustoms call requires information about the content of the parcel (including its value and purpose). It will forward the electronic information to the customs entities (directly or through the customs broker).
    • For customs destinations which require CN23 document, the eConnect API returns this document accordingly to the user on request.The CN23 document is returned together with the shipment label (see explanations on "Label" above). It is issued in PDF format for printout and attachment to the parcel.
    • Overview of use cases:
      • If you create a shipment to a non-customs destination, you don't need to send a "cCustoms" request. If you still send customs data, these will be ignored by the eConnect API.
      • If you create a shipment to a customs destination or region, the "cCustoms" request containing the customs data is mandatory. If you don't send it, your shipments will be rejected and you will not receive a shipment label.
      • If either one of CPAN and/or cCustoms is inconsistent, your shipments will be rejected too.
    Use Cases

    Use Case Overview

    Below you can find an overview of the different use cases, that are available via the eConnect API. In the next section you can find a short description for each use case. For request/response examples please see Reference Docs section.

    Business Process   eConnect API functionalities/requests        
    No. Use Case Access Shipment data (cPAN) Location finder T&T Customs data (cCustoms)
    1 Create DHL Parcel Connect shipment delivered to a doorstep address yes yes no optional no
    2 Create DHL Parcel Connect shipment delivered to a Service Point (Option to include location finder) yes yes optional optional no
    3 Create DHL Parcel Connect shipment delivered to a locker/Parcelstation in Germany yes yes optional optional no
    4 Create DHL Parcel Return Connect shipment yes yes no optional no
    5 Create DHL Parcel Return Connect shipment with labelless solution yes yes no optional no
    6 Create DHL Parcel Connect shipment including customs yes yes no optional yes

    Use Case 1: DHL Parcel Connect shipment delivered to doorstep address

    Business Process

    This request enables users to inject their shipment data for doorstep deliveries for DHL Parcel Connect shipments. If requested, the API will return the respective label in the desired format and resolution.

    Key success factors:

    • The recipient address must be the correct door address of the recipient
    • It is recommended to include e-mail and/or phone number in the recipient data to enable recipient services (e.g. re-routing to ServicePoints)

    Request/Response Examples

    For examples and Try-Out functionality see Reference Docs section under "sendCPAN".

    Use Case Label

    Depending on how the request was specified, the response may optionally contain a shipping label in the specified format. The response will also contain a status code as well as a status message both indicating whether the request could be processed successfully or not.

    Use Case 2: DHL Parcel Connect shipment delivered to Service Point (Option to include location finder)

    Business Process

    This request enables users to inject their shipment data for ServicePoint deliveries for DHL Parcel Connect shipments. The sender needs to know the desired ServicePoint address. If requested, the API will return the respective label in the desired format and resolution.

    Key success factors:

    • It is mandatory for ServicePoint shipments to include the following parameters in the address: name of recipient, name of service point, keyword, servicepointID, street, housenumber, ZIP code, city, country
    • When sending the shipment data to the eConnect API, the location information needs to be integrated into the respective shipment data (cPAN), by using the mapping table shown here.
    • Only for directly addressed shipments to German ServicePoints (aka „Postfiliale" - See Use Case 4) the attributes which contain the street and house number of the shops are optional.
    • It is recommended to include phone numbers for SMS notification to create higher pick up rates
    • Shipments to Denmark, Great Britain, Italy, Norway, Sweden: Please note that shipment data (cPAN) needs to provide the addressees home address in an additional recipient section. 
    • Shipments to Luxembourg: Please note that there is an exception for shipments to LU as address data needs to be entered differently. In case you want to send shipments to lockers in LU, please reach out to us for further instructions

    Optional: In case the desired location data of the ServicePoint is not known already, you have the option to search for a location address by accessing the DHL Location Finder API. Ideally the eCommerce/webshop user interface lets the recipient choose the preferred ServicePoint during check-out.

    Request/Response Examples

    For examples and Try-Out functionality see Reference Docs section under "sendCPAN".

    Use Case Label

    Depending on how the request was specified, the response may optionally contain a shipping label in the specified format. The response will also contain a status code as well as a status message both indicating whether the request could be processed successfully or not.

    Use Case 3: DHL Parcel Connect shipment delivered to locker/Parcelstation in Germany

    Business Process

    This request enables the user to inject their shipment data for shipments delivered to lockers/Parcelstations in Germany. To make use of DHL lockers in Germany, customers need to provide an identification number for each recipient (i.e. "PostNummer"), as German recipients need to be registered to receive locker shipments. The PostNummer needs to be inserted into the "customerIdentification" field of the recipient data in the shipment data request. If requested, the API will return the respective label in the desired format and resolution.

    Key success factors:

    • The attributes which contain the street and house number of the shops are optional.
    • It is recommended to include phone numbers for SMS notification to create higher pick up rates at the locker.
    • Shipments to Denmark, Great Britain, Italy, Norway, Sweden: Please note that shipment data (cPAN) needs to provide the addressees home address in an additional recipient section. 
    • Shipments to Luxembourg: Please note that there is an exception for shipments going to LU as address data needs to be entered differently. In case you want to send shipments to lockers in LU, please reach out to us for further instructions.

    Request/Response Examples

    For examples and Try-Out functionality see Reference Docs section under "sendCPAN".

    Use Case Label

    Depending on how the request was specified, the response may optionally contain a shipping label in the specified format. The response will also contain a status code as well as a status message both indicating whether the request could be processed successfully or not.

    Use Case 4: DHL Parcel Return Connect shipment

    Business Process

    This request enables the user to send shipment data for a DHL Parcel Return Connect Shipment. If requested, the API will return the respective label in the desired format and resolution.

    Key success factors:

    • The Return product needs to be dropped-off by the customer in a local ServicePoint or PostOffice in the country of residency.
    • DHL Return Connect offers a public website to search for drop-off locations all across Europe: https://finder.dhlparcel.com/
    • Make sure to inform your recipients (i.e. consumers) about where they can search for possible drop off points for returns in their region, e.g. by distributing this link (https://finder.dhlparcel.com/)
    • It is recommended to additionally generate return instructions. Return instructions contain handling information to help return senders (i.e. consumers) to correctly handle the return shipment. The instructions are issued by DHL in all local European languages and can be requested via our contact form (add link).

    Request/Response Examples

    For examples and Try-Out functionality see Reference Docs section under "sendCPAN".

    Use Case Label

    Depending on how the request was specified, the response may optionally contain a shipping label in the specified format. The response will also contain a status code as well as a status message both indicating whether the request could be processed successfully or not.

    Use Case 5: DHL Parcel Return Connect shipment with labelless solution

    Business Process

    This request enables the user to send shipment data for a DHL Parcel Return Connect Shipment. To make use of the labelless solution parameters of the call must be changed. If requested, the API will return the respective (QR-)code in the desired format and resolution. With this (QR-)code the recipients (i.e. consumers) can return the parcel without any label at ServicePoints

    Key success factors:

    • The Return product needs to be dropped-off by the customer in a local ServicePoint or PostOffice in the country of residency.
    • DHL Return Connect offers a public website to search for drop-off locations all across Europe: https://finder.dhlparcel.com/
    • Make sure to inform your recipients (i.e. consumers) about where they can search for possible drop off points for returns in their region, e.g. by distributing this link (https://finder.dhlparcel.com/)
    • It is recommended to additionally generate return instructions. Return instructions contain handling information to help return senders (i.e. consumers) to correctly handle the return shipment. The instructions are issued by DHL in all local European languages and can be requested via our contact form (add link).
    • The recipients (i.e. consumers) needs to provide the (QR-)code at the ServicePoint or PostOffice.

    Request/Response Examples

    For examples and Try-Out functionality see Reference Docs section under "sendCPAN".

    Use Case Label

    Depending on how the request was specified, the response contains a (QR-)code in the specified format. The response will also contain a status code as well as a status message both indicating whether the request could be processed successfully or not.

    Use Case 6: DHL Parcel Connect shipment including customs

    Business Process

    This request enables the user to send shipment and custom data for DHL Parcel Connect shipment. For this case, it is mandatory to send a "cCustoms" request after sending the cPAN. The cCustoms call requires information about the content of the parcel (including its value and purpose) and if successful it will forward the electronic information to the customs entities. 

    Key success factors:

    • Make sure that both cPAN and cCustoms are correct, meaning that all mandatory fields are filled out, data specific to the customs clearance solution is populated and data is consistent (e.g. shipment weights of cPAN and cCustoms match; same currency is used for monetary values throughout the entire cCustoms request). Otherwise, the system will reject the shipment.
    • The cPAN needs to be send before cCustoms request, with “parcelIdentifier” being the mandatory data element which allocates each cCustoms request to the respective cPAN.
    • For every cPAN, only one cCustoms call can be sent. If cCustoms data needs to be amended, a new cPAN with a new cCustoms request is required.

    Use Case Label

    Depending on how the request was specified, the response may optionally contain a shipping label in the specified format. The response will also contain a status code as well as a status message both indicating whether the request could be processed successfully or not.

    Request/Response Examples

    For examples and Try-Out functionality see Reference Docs section under "send-cPAN" and "send-cCustoms".

    Support & FAQ

    Support

    To get access to the eConnect API and solve any business-related matters, please access our business customer service available here

    In case of technical questions related to the eConnect API and it's associated services please contact our technical support.

     

    FAQ

    Should we conduct all testing against the sandbox API or are we also able to test towards the production API?

    First we kindly ask you to do all testing against the Sandbox, until you have finalized your flow with working requests/replies. Then we will do an approval of label & request data. After that you will receive PROD credentials for real-life shipment tests (e.g. with a couple of customer shipments).

    Note: usually a limited amount of test shipments against the production environment remain without consequence, if there are no scan events performed by DHL and no additional services are requested (e.g. pickup-requests).

    Do you have any Postman collections of the different requests that you could share with us?

    Unfortunately we do not share those at the moment, they are only used internally by our developer team.

    Which information is mandatory to enter to be able to book a shipment?

    Please see our request spec for details on each field.

    Do you have package volume and weight validations on your side through the API, or do we need to have all the validations on our side?

    We have a validation service for several aspects of the shipment, but that is currently inactive for self-labeling customers. Only active for API-label customers.

    Which package types should be available?

    The allowed packaging types per product and shipment can be obtained from the product information (see overview section) and need to be obeyed. On the API-call there is no package-type field, so from IT-integration perspective the type of packaging does not have relevance.

    How do we request the label through the API, do you have any examples?

    This is part of the GET request, it is defined here.

    Is it possible to send in a parcel ID/parcelIdentifier while also requesting a label, so that the label would contain the customers own parcel ID?

    This is not supported at the moment. Either you use our API-generated label, which will come with a dedicated number range starting with "JVGL..." or you create the label yourself, applying a different number range.

    Do you have any restrictions on which kinds of parcel ID's you are accepting?

    The following options exist for identifiers:

    • ASC MH10 in symbology Code 128 barcode, max. 35digits (alphanumeric characters)
    • GS1 (former EAN), starting with an FNC1 character in symbology Code GS1 128, 20digits (numerical)

    It is permitted that the routing barcode is shown in one license plate barcode format (i.e. ASC MH10) while the identifier is shown in another license plate barcode format (i.e. GS1)

     

    FAQ on Service Points

    When we request available service points from the API, does the receiving address need to look exactly like in your specification?

    The minimum requirement is to provide a correct zip code and city.

    How should the service point be sent in the EDI to you?

    It is essential to map the retrieved service point addressing information to the correct API fields. Please see our example CPAN for this use case here.

    Is it possible to search by ServicepointID via the API?

    This search option is not available at the moment.

     

    Integrators

    Are the API credentials unique to the integrator or to the customer?

    Generally the credentials are customer-unique. Only in case the service is cloud-based (and not installed on customers premises), we can issue a central pair of credentials to you, so that it is integrator-unique.

    Legal Terms

    Specifics for the use of DHL eCommerce Solutions Europe API

    To register for the use of and/or access to DHL eCommerce Solutions' Europe API and the underlying API Services (create shipment, generate label, track & trace, parcel shop finder) - hereinafter referred to as DHL eCommerce Solutions Europe API - you and/or the entity you are authorized to represent (hereinafter "You"/"Your") need to have an account with and/or have entered into a Customer Services Agreement with one of DHL eCommerce Solutions' legal entities. If You engage an external developer or other IT services provider to represent You and to develop Your Application according to the General Developer Portal Terms of Use and these special API terms & conditions (also referred to as "Legal Terms"), You are liable for the acts or omissions of such third party in connection with the access to and/or usage of the DHL eCommerce Solutions Europe API.

    These Legal Terms and the General Developer Portal Terms of Use govern your usage of and/or access to the DHL eCommerce Solutions Europe API including the API Services and, unless otherwise stated herein, do not replace and/or modify any other DHL eCommerce Solutions terms and conditions of Carriage, Customer Services Agreements and/or any other agreements, contracts or SOWs with DHL eCommerce Solutions or any of its affiliates, which govern services or products provided to you (separately, each an "Agreement"). Notwithstanding the foregoing, you expressly acknowledge and agree that solely with respect to your use of and access to the DHL eCommerce Solutions Europe API these Legal Terms and the General Developer Portal Terms of Use shall have preference over the terms and conditions in an Agreement, unless any terms and conditions in an Agreement specifically address the use of/access to the DHL eCommerce Solutions Europe API by You, in which case the specific terms and conditions of the Agreement shall prevail with respect to Your use of/access to the DHL eCommerce Solutions Europe API.

    You shall use the services and/or data that You receive via the DHL eCommerce Solutions Europe API only for the legitimate contractual purposes and only in connection with DHL eCommerce Solutions' carriage services.

    The following prerequisites and/or restrictions apply for the usage of data or information received via the DHL eCommerce Solutions Europe API:

    Label

    The API Service "label" provides You with the possibility to create and download labels for singular shipments. Please note that the creating and/or downloading of a label does not constitute the contract of carriage. Such contract will be concluded once the labeled package is handed over or picked up and accordingly accepted by DHL eCommerce Solutions

    Track & Trace

    Data requested and received via this API, such as transport status, estimated delivery date, is hereinafter referred to as "Tracking Data".

    Tracking Data is Confidential Information in the meaning of section "Communication" of the General Developer Portal Terms of Use. Other than set forth below You must not reveal and/or provide third parties with the Tracking Data and/or analyze, modify such data in any form and/or derive data/information especially for competitive purposes from it without DHL eCommerce Solutions' prior written consent.

    Tracking Data is provided to You and/or the entity you are authorized to represent (hereinafter "You"/"Your") under the prerequisite, that You retrieved the according tracking number in compliance with the applicable law, especially in the field of data protection and competition law and that You use the Tracking Data solely for Your own or Your customers' legitimate tracking purposes.

    You shall not combine Tracking Data with advertisement or present it in a way that it could be regarded as advertisement.

    Unless otherwise agreed, You shall delete the Tracking Data 90 days after the delivery (of the shipment) to the recipient is completed. DHL eCommerce Solutions shall not be required to provide Tracking Data to You that is older than 90 days from the delivery date.

    The use and submission of Tracking Data - including submission to any of Your subcontractors - shall always be in compliance with applicable laws and regulations, including - without limitation - data protection laws and competition/antitrust law.

    If You are neither the shipper/sender nor the recipient of packages the Tracking Data refers to,

    • You shall ensure, that you are duly authorized to act on behalf of the sender and/or the recipient;
    • You shall make the sender and/or the recipient aware of the restrictions set out in this User Guide just as the General Developer Portal Terms of Use;
    • You shall make the sender aware of the necessity to inform the recipient transparently about the processing of his/her personal data according to applicable data protection laws;
    • You shall inform the sender and/or recipient transparently that the use of Your Application may result in the disclosure of data being subject to postal secrecy and data protection laws to third parties (including You).
    June 2024
    28.Jun.2024
    • Return Connect labels generated via the eConnect API, now carry additional graphical and written information about the local network service provider, to further improve the drop-off experience.
    May 2024
    17.May.2024
    • API shipping labels are now available in native zpl format if requested by the user via GET parameter.
    • As an alternative option to printed labels, the product "Return Connect" now offers QR code return labels out of Poland, Bulgaria, Sweden and Spain
    December 2023
    11.Dec.2023
    • The send CPAN function was enhanced to support Return consolidation in DHL facilities based on customer configuration.
    • Adjustment of password credential reset process to a fully automized solution. API users will get new credentials automatically every year.
    October 2023
    17.Oct.2023
    • A new endpoint is available to book courier pickups for business customer addresses in Italy and France (beta version).
    August 2023
    17.Aug.2023
    • A new endpoint is available to Reprint shipment labels, that have been produced in the past, e.g. if labels are lost or damaged.
    • The API Status has been integrated into the status.dhl.com platform, enabling API users to subscribe to alerts in case of availability issues with the eConnect API.
    • A new option is offered, to automatically send emails to shipment recipients, whenever a shipment is created via the eConnect API.
    April 2023
    03.May.2023
    • First mile handling options for outbound shipments out of Italy and France
    • Labelless Return Connect option for Polish senders of returns
    • Provision of improved error messages on eConnect API to smoothen onboarding and error handling
    • Increased robustness in handling of timestamp formats in API requests
    October 2022
    10.Oct.2022
    • Contents of the developer Portal have been improved.
    • The eConnect API features the new DHL Parcel Connect PLUS product.
    • The eConnect API features the postal return product "DHL Parcel Return International" for EU origins plus UK in selected customer scenarios.
    • For trusted API partners, the eConnect API now offers a feature to send parcel-related events to DHL. Contact your DHL representative for details.
    • For shipment labels, created via the eConnect API, it is now possible for customers to provide customer-individual Identcode Ranges ("customRange"). Enabling API-generated labels with customer barcodes for shipment identification.
    January 2022
    31.Jan.2022
    • The eConnect developer portal now offers "Try Out" functionality in the "Reference Docs" section. All available endpoints can be tested by developers with dummy data to provide easy access and accelerate API onboardings.
    December 2021
    21.Dec.2021
    • The cPAN request parameters related to the "direct injection" functionality are now deprecated. It is no longer necessary to transmit any "direct injection" parameters in cPAN requests. The configuration of direct injection setups for individual customers is done via the eConnect backend.
    October 2021
    29.Oct.2021
    • New Label selection available: eConnect API users can choose between 3 formats (pdf, zpl, png), 2 resolutions (200, 300 dpi) and 2 label sizes (10x15cm, 10x21cm) for eConnect labels.
    • Simplification of shipment data (cPAN) to improve user experience for eConnect API developers; reduction of complexity
    June 2021
    10.Jun.2021
    • eConnect Portal now features Track & Trace UI for customers using the eConnect API
    • New Code examples for most common programming languages added, see "Reference Docs" / "Send CPAN"
    November 2020
    04.Nov.2020
    • Improved documentation, including
      • Overview of the different products and countries covered by the API
      • Comprehensive description on how to use the API and its functionalities
      • Description of various use cases (incl. example cPAN and example label)
    • For DHL Parcel International, the cPAN fields Street2 and StreetNr2 will now be displayed on the label.
    October 2020
    09.Oct.2020
    • Initial release