{"activeVersionTag":"latest","latestAvailableVersionTag":"latest","collection":{"info":{"_postman_id":"23db1dfa-d0dc-45da-b20a-a4b2fd75c236","name":"DHL eCommerce Americas API","description":"# **🚀 Important Update: Migrating to the New DHL Developer Portal**\n\nThe API documentation for DHL eCommerce Americas is moving to our new, company-wide [DHL Developer Portal](https://developer.dhl.com/api-catalog).\n\nThe DHL Developer Portal is DHL’s single point of contact for APIs from every DHL business division—browse available APIs, sign up for a developer account and manage your Apps in one place.\n\nTo view the documentation for DHL eCommerce Americas APIs, you can do the following on the DHL Developer Portal API Catalog page. Using the filters on the left,\n\n- under Division, select DHL eCommerce\n    \n- under Region, select United States\n    \n\nThe current API documentation site will be retired soon.\n\n**Please bookmark the new Developer Portal today** for the latest documentation for all DHL APIs.\n\nWe appreciate your attention and look forward to seeing you on the new platform!\n\n---\n\n#### This site is a complete reference for DHL eCommerce Americas API (version 4), and also includes a free, ready-to-use Postman collection to get started quickly.\n\nBY ACCESSING AND USING THE DHL ECOMMERCE AMERICAS API (THE “SITE”), YOU INDICATE YOUR ACKNOWLEDGEMENT AND ACCEPTANCE OF THESE [LEGAL TERMS](#bc37696d-db9e-4299-8083-5d88023b8468) OF USE. IF YOU DO NOT AGREE WITH THESE [LEGAL TERMS](#bc37696d-db9e-4299-8083-5d88023b8468), YOU OR THE ENTITY YOU ARE AUTHORIZED TO REPRESENT (HEREINAFTER “YOU”/”YOUR”) SHOULD NOT USE THE SITE. DHL ECOMMERCE AMERICAS MAY CHANGE, SUSPEND OR DISCONTINUE ANY ASPECT OF THE SITE AT ANY TIME, INCLUDING THE AVAILABILITY OF ANY FEATURE, DATABASE OR CONTENT. DHL ECOMMERCE MAY ALSO IMPOSE LIMITS ON CERTAIN FEATURES AND SERVICES AND/OR RESTRICT YOUR ACCESS TO PARTS OR ALL OF THE SITE WITHOUT NOTICE OR LIABILITY OF ANY KIND.\n\nThe **DHL ECOMMERCE AMERICAS API** is your one stop solution to get shipping products, calculating duty and tax, generating shipping labels, manifesting packages, tracking packages and generating return labels.\n\n<img src=\"https://content.pstmn.io/fd9f6ba9-a647-43e9-b205-b2dfa3d0c6cb/aW1hZ2UucG5n\" width=\"772\" height=\"309\">\n\n#### The API can be used for:\n\n- Only DHLeC packages originating within United States and Canada\n    \n- Domestic and international packages\n    \n- All DHL eCommerce Americas shipping products\n    \n\nThis documentation provides detailed information about the API structure and its use. You can also go directly to the following topics:\n\n- [Product Finder API](https://docs.api.dhlecs.com/#280c984f-1548-42b4-8a85-cb4c0b2f4126)\n    \n- [Duty and Tax Calculator (DTC) API](https://docs.api.dhlecs.com/#88a7255d-3139-4f3f-9e82-112037d2621e)\n    \n- [Label API](https://docs.api.dhlecs.com/#be69c425-2003-4632-8da1-0303642087d0)\n    \n- [Manifest API](https://docs.api.dhlecs.com/#1818efe9-256d-4981-bd66-2f5e76f0cb22)\n    \n- [Tracking API](https://docs.api.dhlecs.com/#bc8f6e5c-1bb2-45b9-8731-2a7feb5c71c7)\n    \n- [Webhook API](https://docs.api.dhlecs.com/#5dcbf44d-2ef0-415b-95ff-41be3290ad50)\n    \n- [API References](https://docs.api.dhlecs.com/#322ab786-d4a0-4c55-b3e4-5796922071a1)\n    \n- [API Error Reference](https://docs.api.dhlecs.com/#01a6b108-70a4-4f20-84f5-9e6dcdbc3071)\n    \n\nAlso, information about each error code can be directly referenced by appending the error code to the following URL. For example:\n\n`https://api.dhlecs.com/docs/errors/400.0204003`\n\nThe same error URLs are also returned in the APIs when there is an error response. This allows clients to quickly get detailed information on each type of error.\n\n#### Using the API\n\nThe API has been designed for use by developers. You will need basic knowledge of REST APIs, JSON and HTTPS. Also, your organization must have a customer account with DHL eCommerce Americas.\n\n#### Example Use Cases\n\nSimply Integrate in your existing website / solution\n\nEasy integration into any eCommerce platform such as your Order Management System, Transportation Management System or an eCommerce website.\n\nMerchants can use the API to get access to DHL Ecommerce Americas portfolio solution\n\nThird Party Vendors (3PVs) and shipping aggregators can use the API to provide their customers with access to DHL ECommerce shipping solutions.","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","isPublicCollection":false,"owner":"12197903","team":1047390,"collectionId":"23db1dfa-d0dc-45da-b20a-a4b2fd75c236","publishedId":"T1DsAvtf","public":true,"publicUrl":"https://docs.api.dhlecs.com","privateUrl":"https://go.postman.co/documentation/12197903-23db1dfa-d0dc-45da-b20a-a4b2fd75c236","customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"C60000"},"documentationLayout":"classic-double-column","customisation":null,"version":"8.10.1","publishDate":"2020-08-03T14:55:52.000Z","activeVersionTag":"latest","documentationTheme":"light","metaTags":{},"logos":{}},"statusCode":200},"environments":[],"user":{"authenticated":false,"permissions":{"publish":false}},"run":{"button":{"js":"https://run.pstmn.io/button.js","css":"https://run.pstmn.io/button.css"}},"web":"https://www.getpostman.com/","team":{"logo":"https://res.cloudinary.com/postman/image/upload/t_team_logo_pubdoc/v1/team/f97acb2a259cfa9194b340f2b2565e23bec0c4f552ab463eb8f5b1e5b050b71f","favicon":"https://res.cloudinary.com/postman/image/upload/v1596393521/team/dkx05ayzynaduubph0jv.ico"},"isEnvFetchError":false,"languages":"[{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"HttpClient\"},{\"key\":\"csharp\",\"label\":\"C#\",\"variant\":\"RestSharp\"},{\"key\":\"curl\",\"label\":\"cURL\",\"variant\":\"cURL\"},{\"key\":\"dart\",\"label\":\"Dart\",\"variant\":\"http\"},{\"key\":\"go\",\"label\":\"Go\",\"variant\":\"Native\"},{\"key\":\"http\",\"label\":\"HTTP\",\"variant\":\"HTTP\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"OkHttp\"},{\"key\":\"java\",\"label\":\"Java\",\"variant\":\"Unirest\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"Fetch\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"jQuery\"},{\"key\":\"javascript\",\"label\":\"JavaScript\",\"variant\":\"XHR\"},{\"key\":\"c\",\"label\":\"C\",\"variant\":\"libcurl\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Axios\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Native\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Request\"},{\"key\":\"nodejs\",\"label\":\"NodeJs\",\"variant\":\"Unirest\"},{\"key\":\"objective-c\",\"label\":\"Objective-C\",\"variant\":\"NSURLSession\"},{\"key\":\"ocaml\",\"label\":\"OCaml\",\"variant\":\"Cohttp\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"cURL\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"Guzzle\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"HTTP_Request2\"},{\"key\":\"php\",\"label\":\"PHP\",\"variant\":\"pecl_http\"},{\"key\":\"powershell\",\"label\":\"PowerShell\",\"variant\":\"RestMethod\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"http.client\"},{\"key\":\"python\",\"label\":\"Python\",\"variant\":\"Requests\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"httr\"},{\"key\":\"r\",\"label\":\"R\",\"variant\":\"RCurl\"},{\"key\":\"ruby\",\"label\":\"Ruby\",\"variant\":\"Net::HTTP\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"Httpie\"},{\"key\":\"shell\",\"label\":\"Shell\",\"variant\":\"wget\"},{\"key\":\"swift\",\"label\":\"Swift\",\"variant\":\"URLSession\"}]","languageSettings":[{"key":"csharp","label":"C#","variant":"HttpClient"},{"key":"csharp","label":"C#","variant":"RestSharp"},{"key":"curl","label":"cURL","variant":"cURL"},{"key":"dart","label":"Dart","variant":"http"},{"key":"go","label":"Go","variant":"Native"},{"key":"http","label":"HTTP","variant":"HTTP"},{"key":"java","label":"Java","variant":"OkHttp"},{"key":"java","label":"Java","variant":"Unirest"},{"key":"javascript","label":"JavaScript","variant":"Fetch"},{"key":"javascript","label":"JavaScript","variant":"jQuery"},{"key":"javascript","label":"JavaScript","variant":"XHR"},{"key":"c","label":"C","variant":"libcurl"},{"key":"nodejs","label":"NodeJs","variant":"Axios"},{"key":"nodejs","label":"NodeJs","variant":"Native"},{"key":"nodejs","label":"NodeJs","variant":"Request"},{"key":"nodejs","label":"NodeJs","variant":"Unirest"},{"key":"objective-c","label":"Objective-C","variant":"NSURLSession"},{"key":"ocaml","label":"OCaml","variant":"Cohttp"},{"key":"php","label":"PHP","variant":"cURL"},{"key":"php","label":"PHP","variant":"Guzzle"},{"key":"php","label":"PHP","variant":"HTTP_Request2"},{"key":"php","label":"PHP","variant":"pecl_http"},{"key":"powershell","label":"PowerShell","variant":"RestMethod"},{"key":"python","label":"Python","variant":"http.client"},{"key":"python","label":"Python","variant":"Requests"},{"key":"r","label":"R","variant":"httr"},{"key":"r","label":"R","variant":"RCurl"},{"key":"ruby","label":"Ruby","variant":"Net::HTTP"},{"key":"shell","label":"Shell","variant":"Httpie"},{"key":"shell","label":"Shell","variant":"wget"},{"key":"swift","label":"Swift","variant":"URLSession"}],"languageOptions":[{"label":"C# - HttpClient","value":"csharp - HttpClient - C#"},{"label":"C# - RestSharp","value":"csharp - RestSharp - C#"},{"label":"cURL - cURL","value":"curl - cURL - cURL"},{"label":"Dart - http","value":"dart - http - Dart"},{"label":"Go - Native","value":"go - Native - Go"},{"label":"HTTP - HTTP","value":"http - HTTP - HTTP"},{"label":"Java - OkHttp","value":"java - OkHttp - Java"},{"label":"Java - Unirest","value":"java - Unirest - Java"},{"label":"JavaScript - Fetch","value":"javascript - Fetch - JavaScript"},{"label":"JavaScript - jQuery","value":"javascript - jQuery - JavaScript"},{"label":"JavaScript - XHR","value":"javascript - XHR - JavaScript"},{"label":"C - libcurl","value":"c - libcurl - C"},{"label":"NodeJs - Axios","value":"nodejs - Axios - NodeJs"},{"label":"NodeJs - Native","value":"nodejs - Native - NodeJs"},{"label":"NodeJs - Request","value":"nodejs - Request - NodeJs"},{"label":"NodeJs - Unirest","value":"nodejs - Unirest - NodeJs"},{"label":"Objective-C - NSURLSession","value":"objective-c - NSURLSession - Objective-C"},{"label":"OCaml - Cohttp","value":"ocaml - Cohttp - OCaml"},{"label":"PHP - cURL","value":"php - cURL - PHP"},{"label":"PHP - Guzzle","value":"php - Guzzle - PHP"},{"label":"PHP - HTTP_Request2","value":"php - HTTP_Request2 - PHP"},{"label":"PHP - pecl_http","value":"php - pecl_http - PHP"},{"label":"PowerShell - RestMethod","value":"powershell - RestMethod - PowerShell"},{"label":"Python - http.client","value":"python - http.client - Python"},{"label":"Python - Requests","value":"python - Requests - Python"},{"label":"R - httr","value":"r - httr - R"},{"label":"R - RCurl","value":"r - RCurl - R"},{"label":"Ruby - Net::HTTP","value":"ruby - Net::HTTP - Ruby"},{"label":"Shell - Httpie","value":"shell - Httpie - Shell"},{"label":"Shell - wget","value":"shell - wget - Shell"},{"label":"Swift - URLSession","value":"swift - URLSession - Swift"}],"layoutOptions":[{"value":"classic-single-column","label":"Single Column"},{"value":"classic-double-column","label":"Double Column"}],"versionOptions":[],"environmentOptions":[{"value":"0","label":"No Environment"}],"canonicalUrl":"https://docs.api.dhlecs.com/view/metadata/T1DsAvtf"}