When you configure an export, import, or other type of flow step using the prebuilt DHL connector, you can select any of the API operations listed below, organized by API type.
Note
If your API endpoint isn’t listed here, switch the flow step to HTTP mode and configure the endpoint provided in the DHL API documentation. You can also create a composite endpoint for this application in HTTP mode.
DHL eCommerce Europe
| Resource | API endpoint | Export |
Import |
|---|---|---|---|
| Courier pickup in Italy and France (Beta version) | Send courier pickup request |
|
X |
| Label reprint | Get the label reprinted based on the piece ID and customer ID | X |
|
| Multiple track and trace | Get multiple track and trace of customer with date interval | X |
|
| Send cCustoms | Send cCustoms data |
|
X |
| Send cEvent | Send cEvent data |
|
X |
| Send Connect Plus (Beta version) | Send shipment data for Connect Plus product and receive labels |
|
X |
| Send CPAN | Send shipment data and receive labels |
|
X |
| Send return international with cCustoms (Beta version) | Send return international with cCustoms data |
|
X |
| Track and trace | Get track and trace details of shipment | X |
|
| Track and trace paging | Get track and trace details of shipments with paging | X |
|
DHL Express Global
| Resource | API endpoint | Export |
Import |
|---|---|---|---|
| Address | Validate DHL Express pickup/delivery capabilities at origin/destination | X |
|
| Identifier | Service to allocate identifiers upfront for DHL Express breakbulk or loose breakbulk shipments | X |
|
| Invoice | Upload commercial invoice data |
|
X |
| Pickup | Cancel a DHL Express pickup booking request |
|
X |
| Update pickup information for an existing DHL Express pickup booking request |
|
X |
|
| Create a DHL Express pickup booking request |
|
X |
|
| Product | Retrieve available DHL Express products for a one-piece shipment | X |
|
| Rating | Retrieve rates for a one-piece shipment | X |
|
| Reference data | Provide reference data currently used for MyDHL API services usage | X |
|
| ServicePoint | Returns a list of service points based on the given postal location address, service point ID, or geocode details for DHL Express service points to pick up and drop off shipments | X |
|
| Shipment | Electronic proof of delivery | X |
|
| Upload paperless trade shipment (plt) images of previously created shipment. |
|
X |
|
| Create shipment |
|
X |
|
| Upload commercial invoice data for your DHL Express shipment |
|
X |
|
| Get image | X |
|
|
| Tracking | Track a single DHL Express shipment | X |
|
| Track a single or multiple DHL Express shipments | X |
|
DHL Parcel
| Resource | API endpoint | Export |
Import |
|---|---|---|---|
| Aggregations | Create an aggregation shipment; only applicable for the Connect Light product |
|
X |
| Capabilities | Retrieve the capabilities | X |
|
| Custom forms | Get customs by shipment ID | X |
|
| Get customs by shipment ID and form type | X |
|
|
| Get customs by label ID | X |
|
|
| Customs declaration | Download customs attachment | X |
|
| Download customs attachment PDF | X |
|
|
| Upload customs attachment |
|
X |
|
| Create customs declaration |
|
X |
|
| Get customs declaration | X |
|
|
| Download all customs documents | X |
|
|
| Create customs document |
|
X |
|
| Destination countries | Retrieve the destination countries | X |
|
| Retrieve the destination countries with properties | X |
|
|
| Drafts | List all drafts for a specific user | X |
|
| Save a draft to the draft service |
|
X |
|
| Remove drafts from the draft service |
|
X |
|
| Save drafts to the draft service |
|
X |
|
| Promote multiple drafts to shipments |
|
X |
|
| Get a draft from the draft service | X |
|
|
| Remove a draft from the draft service |
|
X |
|
| Entry summary declaration | Create entry summary declaration |
|
X |
| Intervention | Request an agreed place intervention by parcel ID or not home code |
|
X |
| Request a date/time intervention by parcel ID or not home code |
|
X |
|
| Request a neighbour intervention by parcel ID or not home code |
|
X |
|
| Request a service point intervention by parcel ID or not home code |
|
X |
|
| Intervention options | Retrieve the intervention options by parcel ID or not home code | X |
|
| Retrieve nearby neighbour addresses | X |
|
|
| Retrieve all available service points by parcel ID | X |
|
|
| Retrieve all available delivery timeframes by parcel ID | X |
|
|
| Intervention options v2 | Retrieve intervention options by tracking code | X |
|
| Labels | Get label data | X |
|
| Get label data PDF | X |
|
|
| Reprint label by tracker code | X |
|
|
| Find labels and filter by tracker code, order reference, or shipment ID | X |
|
|
| Get multiple labels | X |
|
|
| Parcel types | Retrieve the parcel types v2a for business users | X |
|
| ParcelShop locator | Search by a specific servicepoint ID | X |
|
| Search by a full query | X |
|
|
| Pickup availability | Retrieves a pickup availability list for the given postal code and country code | X |
|
| Pickup requests | Find a pickup request by ID | X |
|
| Retrieve pickup requests for a user | X |
|
|
| Create a pickup request |
|
X |
|
| Products | Retrieve a product | X |
|
| Retrieve the products | X |
|
|
| Shipment options | Retrieve the shipment options | X |
|
| Shipments | Create labels for all pieces in the shipment |
|
X |
| Retrieve a shipment by shipment ID | X |
|
|
| Time windows | Retrieve time windows | X |
|
| Track trace | Track and trace | X |
|
| Track trace pusher: Configurations | List all configurations for the given organisation | X |
|
| Add a configuration for the given organisation |
|
X |
|
| Update a configuration for the given organisation |
|
X |
|
| Remove a configuration for the given organisation |
|
X |
|
| Track trace pusher: Subscriptions | Add a subscription |
|
X |
| List latest subscriptions for the given push configuration | X |
|
|
| Transit times | Find the transit time for a country to a certain destination | X |
|
| Translations | Key translations | X |
|