All changes made to an existing version of an API will be backwards-compatible. We consider the following changes to be backwards-compatible:

• Adding optional properties to a request body and/or query params
• Returning additional properties in existing API responses
• Changing the order of properties in existing API responses
• Adding new HTTP methods to existing APIs
• Adding new API resources

In general, API clients should rely on technical identifiers such as product codes, error codes, event IDs in the integration design.

Fields such as product names, product descriptions, error descriptions, event descriptions are subject to change and should not be relied upon for technical integration purposes.

Changelog

Keep track of changes and upgrades to the DHL eCommerce Americas API.

This log lists all changes to the API, in chronological order.

January 19, 2024

• Added Delivery Area Surcharge into list of rate components in Product Finder section

July 23, 2024

• List of rate components has been added into Product Finder section

June 19, 2024

• Added Label Samples folder within the References section
  • Shows Hazmat Labels and Requirements for Domestic and International
  • Direct link is provided within Label section
• Removed deprecated Transportation API section from documentation
• Updated Domestic Label image in Label section that now includes:
  • Addition of 2D barcodes
  • Custom Label Text fields placement change

May 28, 2024

• Returning shipDate in Product Finder Response
• Deprecated rateDate in Product Finder Request
• Now offering Domestic Auto-Manifest for clients
  • More information can now be found in the Manifest section under the Domestic Auto-Manifest header

May 13, 2024

• Removed USISP1 - Edgewood, NY and USMEM1 - Memphis, TN from the list of valid Distribution Centers.

April 1, 2024

• Returning effectiveFrom date in Product Finder API response.

March 25, 2024

• Added Hong Kong into the International Regulations table for Required Consignee Phone Number under PLT.
• Added Malaysia into the International Regulations table for the Recommended Shipper taxID/taxID type under Non-PLT.

March 18, 2024

• Support for PDF label format.
• Included "gmtOffset" variable in the tracking API response for domestic track events.
• Support for Tracking ID based webhook subscriptions.
• Added clarification to distributionCenter field in the Glossary section pertaining its purpose in the ProductFinder API.

January 25, 2024

• Updated the Domestic Product Names in Reference page.
• Added note to developers/customers to refer to the Product ID and not the Product Name in order to uniquely identify and select products.
  • Added in the Product Finder response Description field and under Domestic Products table in Reference page.

October 27, 2023

• Added MAX domestic product to Content Categories page for Category Codes 01 and 04.

October 18, 2023

• Documented changes related to Billable weight calculation used in Product Finder and Label API:
  • Added packageType property in the optional dimension object used in ProductFinder and Label API
  • Added Package Types in the References section that explains allowed values and descriptions for the packageType property
  • Added Weights in the Glossary section to explain the concept of Billable weight, Actual Weight and Dimensional weight
• Added Void Label endpoint details under the Label API.