Browse APIs

User Guide (DHL eCommerce Americas)

Best for:

Getting Started 

  • DHL eCommerce Americas API (version 4) is your one stop solution to get shipping products, calculating duty and tax, generating shipping labels, manifesting packages, tracking packages and generating return labels.
  • In the Downloads section, you will find a ready-to-use Postman collection to facilitate your interaction with the API. 
Region: United States
Used for: Information
Division: DHL eCommerce
Duty & Tax (DHL eCommerce Americas)

Best for:

Duty and Tax

  • Calculating the duties, taxes and governmental fees for any cross border shipment, taking into consideration country de minimis values and preferential tariff rates that may apply.
Region: United States
Used for: Additional Services
Division: DHL eCommerce
Label (DHL eCommerce Americas)

Best for:

Shipping Label

  • Creating an US Domestic or an International label.
  • Retrieving an existing label
  • Deleting an existing label (Domestic only)
Region: United States
Used for: Shipping
Division: DHL eCommerce
Location Finder - Unified
Available

Best for:

  • Finding all DHL pick-up and drop-off points to send and receive packages
  • Integrating multiple types of Deutsche Post DHL locations
  • Locations in Germany and many countries worldwide
Used for: Location
Division: DHL eCommerce, Post & Parcel Germany, DHL Group
Manifest (DHL eCommerce Americas)

Best for:

Driver Summary Manifest (DSM)

  • Creating a manifest
  • Downloading a manifest
Region: United States
Used for: Shipping
Division: DHL eCommerce
Product Finder (DHL eCommerce Americas)

Best for:

Shipment Rating

  • Getting shipping products, rates and estimated delivery date (EDD) for a given shipment.
Region: United States
Used for: Information
Division: DHL eCommerce
Return Label (DHL eCommerce Americas)

Best for:

Return Label

  • Creating a US Domestic return label
  • Retrieving an existing return label
Region: United States
Used for: Shipping
Division: DHL eCommerce
Shipment Tracking - Unified
Available

Best for:

  • Providing access to the shipment status at any time
  • Integrating all types of DHL shipments
  • Multiple shipments (e.g. eCommerce, Express, Freight, Letter, Parcel, etc.)
Region: Global
Used for: Tracking
Division: DHL Group, DHL Freight, DHL eCommerce, DHL Supply Chain
Shipment Tracking - Unified - Push
Available

Best for:

  • Providing access to the shipment status at any time
  • Integrating all types of DHL shipments
  • Multiple shipments (e.g. eCommerce, Express, Freight, Letter, Parcel, etc.)

This is the push version of the Shipment Tracking Unified API which proactive sends updates.

Region: Global
Used for: Tracking
Division: DHL Group, DHL Freight
Tracking (DHL eCommerce Americas)

Best for:

Tracking shipments

  • Track single or multiple packages
  • Track packages in a manifest
  • Track using Pickup account and Dates
Region: United States
Used for: Tracking
Division: DHL eCommerce
Tracking Webhooks (DHL eCommerce Americas)

Best for:

Track Events Push

  • Creating a new Webhook subscription 
  • Retrieving an existing Webhook subscription
  • Updating an existing Webhook subscription
  • Deleting an existing Webhook subscription
Region: United States
Used for: Tracking
Division: DHL eCommerce
Additional Services (DHL Freight)

Best for:

To validate which DHL Freight additional services can be combined to each product and how they can be combined with each other.

Precondition:

  • For existing DHL Freight business customers with a valid contract.
  • For domestic and international palletized road freight transport orders (> 35 kg) across Europe.

For this DHL Freight API, we offer a service that will inform you about its important updates; you can subscribe to this service by using the NOTIFICATION button on right hand side of this page.

Region: Europe
Used for: Additional Services
Division: DHL Freight
Blue Dart-Location Finder

Best for:

The Location Finder provides you with information on locations serviced by Blue Dart. It also outlines the services available for each location. This service can be used by the customer to be better advised on the serviceability and reach of Blue Dart locations. This query input is based on pin code.

Get Service for Pin-code :

This method will return information about all types of services provided by Blue Dart for requested pin code.

Get Service for Product:

This method will return service availablity for requested pincode,product / subproduct.

Get Service for Pincode and Product:

This method will return service availablity for requested pincode,product / subproduct.

Region: India
Used for: Information
Division: DHL eCommerce
Blue Dart-Master Download
Available

Best for:

This API exposes methods those will be used for masters download. It will downloads incremental pin code master changes

Download Pincode Master :

Downlaod-Pincode-Master service will help us to downloads incremental pin code master changes

Region: India
Division: DHL eCommerce
Blue Dart-Pickup Cancellation

Best for:

The Cancel Pickup registration API exposes methods which will be used to cancel a Pickup. This Service provide the flexibility to registered customer to cancel its Shipment pickup

Cancel Pickup Registration :

This service will allow customer or user to cancel a pickup for its shipment. Canceling of pickup will be applicable to customer who are registered for the shipment order to Pickup.

The customer will use detail along with additional information related to shipment as token number and pickup registration date for its shipment order.

Region: India
Division: DHL eCommerce
Blue Dart-Product and Sub-Product Pickup Detail

Best for:

The product and Sub-Product Pickup Detail registration API exposes methods which will be used to get detail of a Pickup. This Service provide the flexibility to customer to cancel its get the detail of the pickup

Get All Products and Sub-Products:

This method will return all product & subproduct codes details that will be used to send as input parameters in Pickup Registration method.

This service will allow customer provides all product & subproduct details for its shipment.

Region: India
Division: DHL eCommerce
Blue Dart-Registration for Pickup

Best for:

The registration pickup API provides the flexibility for the Blue Dart customer to register themself for pick up the shipment order.

Register Pickup:

This service will allow customer for Registering their pickup for its shipment. Registration of pickup will be applicable to customer to provide details like Area, Product, Customer Name, Address, Telephone details, etc. The response for the product provides Token Number for the registered shipment and Status of the order.

Region: India
Division: DHL eCommerce
Blue Dart-Tracking Of Shipment

Best for:

The API provide customer with all detail information and status of their shipment.

Shipment Detail:

This operation will return all the information of customer shipment.

Shipment Status:

This operation will provide us all the status information of customer shipment.

Region: India
Division: DHL eCommerce