DHL Express - MyDHL API
v 2.9.0
Division: DHL Express

適用於

  • 國際速遞定時服務貨件之報價、運輸、追蹤等
  • 持有 DHL Express 公司帳戶的用戶
  • 全球範圍均適用
Region: Global
Used for: Shipping, Rating, Products, Landed Cost, Tracking
概况

MyDHL API 將 DHL Express 的優勢與您的內部付運過程互相結合。透過整合至您的網站,並與您現有的訂單記錄、倉庫管理及其他業務軟件系統連結,助您執行一個更為精簡且高效的操作,簡單整合!

MyDHL API 是您所有 DHL EXPRESS 服務操作的一站式解決方案。包括:

询价图标 包裹图标 完整落地成本 制作运单图示 取件图标 追踪图标 全球图标 综合解决方案
報價 產品 到岸成本 貨件 收件 追蹤 地址 識別標籤
優化及增長您的業務
  • 將 DHL Express 功能 - 例如出貨程序 - 與您的現有系統無縫整合
  • 無需更換程式或重新輸入資訊即可存取 DHL Express 的派送選項及費用
  • 保留您團隊所熟悉的用戶介面 - 省卻耗時且昂貴的員工培訓
  • 提供 DHL Express 付運服務、到岸成本及自訂派件服務 (On Demand Delivery),能助您的電子商貿網站售出更多產品
專為開發人員而建立
  • 基於行業標準而設的單一 API,易於讓開發人員知悉且了解
  • 專為高速運作的倉庫及對時間敏感的電子商貿結帳而打造
  • 專用 的API 環境讓您測試解決方案
  • 由DHL Express 當地的專業人員提供的開發者支援

涵蓋範圍

使用 MyDHL API 做更多的事
MyDHL API 服務 簡述
報價
「報價」服務操作將根據您的 DHL Express 帳戶返回 DHL Express 產品功能(產品、增值服務以及預估送達時間)及相關收費。
產品
「報價」服務的簡單版,供檢索適合進行單件貨件送貨的 DHL Express 產品。
到岸成本
檢索預估的到岸成本,包括各項關稅及稅費。請注意,這項服務需預先提供您的貨品目錄以及海關數據(例如,協調制度編號- HS Code)。
貨件

「貨件」服務操作讓您建立完整的 DHL Express 貨件,包括貨件標籤、海關文件(可選)與上門收件,以及保險等增值服務。

DHL EXPRESS 建議首先使用「報價」服務,以查閱全部產品及增值服務,之後將所需之 DHL EXPRESS 產品及增值服務轉入「貨件」服務操作。

除建立 DHL Express 貨件外,「貨件」服務亦可為部份已送達之貨件提供電子送貨證明,並為您的貨件上載最新海關發票圖檔。

收件
「收件」服務可建立、更新或取消 DHL Express 上門收件請求
追蹤
「追蹤」服務檢索 DHL Express 貨件的追蹤狀態
地址
驗證 DHL Express 是否在出發地/目的地提供收件/派件服務
識別標籤
為 DHL Express Breakbulk或Loose Break Bulk貨件預先分配識別標籤的服務

使用 API

此 API 專為開發人員而設計。您需掌握 REST APIs、JSON 和 HTTPS 的基本知識。此外,您的機構須在 DHL Express 持有有效公司帳戶。如需了解如何開立帳戶,請前往 DHL Express帳戶申請頁面

使用案例

簡單整合至您的現有網站/解決方案

在您的網站、客戶服務應用程式或訂單處理系統加入 DHL 派送功能,能讓您輕鬆將貨品送出,並讓您的客戶輕鬆收到包裹。DHL Express API 讓您隨時了解 DHL 服務的可用性、運送時間、收費、貨件與預約速遞員上門收件,及追蹤來自世界各國的貨件。

用戶指南

獲取存取權限

如需使用 DHL Express API,您的组织需要在 DHL Express 拥有一个有效的客户账户。

已持有 DHL Express 帳戶號碼:

[1.] 開始您的入門程序 [2.] 獲取 API 權限
  • 使用您的開發者入口帳戶登入

您將獲提供 DHL Express API 權限,並能夠開始開發整合。

如您 不是 DHL Express 客戶,請遵照下列步驟建立一個新的公司帳戶。

[1.] 申請一個公司帳戶。 [2.] 開立帳戶 [3.] 獲取 API 權限
前往 DHL Express公司帳戶申請頁面。填妥表格並按「提交」。 DHL Express 團隊將聯絡您開立帳戶事宜。 一旦您成功開立DHL Express 公司帳戶,只需按 此處 即可獲取權限!

驗證

您的 DHL EXPRESS 顧問將為您提供 DHL EXPRESS API (MyDHL API) 訪問憑證,並協助您解決可能遇到的技術問題。

請確保在請求中的認證標頭已預先設置,且遵循BasicAuth標準。

環境

可使用API的基本URL/URI環境是:

環境 簡述
https://dpdhl.sharepoint.com/sites/SmartCenter/SitePages/What-is-M365-Apps.aspx 測試您的解決方案的專用測試環境
https://express.api.dhl.com/mydhlapi 使用 DHL Express 建立真實交易的生產環境

配額限定

  • DHL EXPRESS 測試環境將為您的訪問憑證提供每日 500 次的服務調用限額。這個應該用於測試您使用 DHL EXPRESS 的整合開發。
  • DHL EXPRESS 測試環境有正式的服務水平協議,以保證其支援隨時可用。

其他資訊

DHL Express API 的輸入數據需經過多個步驟的驗證。第一步是根據請求訊息格式(即模式驗證)定義的數據基數和數據內容限制進行一般模式驗證。在第二步,傳輸的數據應用了多個業務規則。這些驗證的結果會位於服務操作的結果訊息中。服務操作總是會返回一項結果訊息。所有錯誤或驗證錯誤都會存儲在這一結果訊息中。
 

法律條款
使用及存取 DHL Express 的特定條款 —— MyDHL API(「MyDHL API」)
  1. 當使用或存取 MyDHL API 及其相關服務(「API 服務」;為避免疑義,這些法律條款提及的 MyDHL API 認定為包含 API 服務在內的 MyDHL API,但上下文另有說明者除外)時,您將進入一項法律協議,且您同意全部這些條款且不作修改。在同意這些條款的同時,您已同意遵循 DHL 的General Developer Portal Terms of Use,該條款是與您使用 MyDHL API 有關、具有約束力的額外協議,該兩組條款在本文件中統一解釋為(「法律條款」)。
  2. 要登記使用 MyDHL API,您及/或您獲授權代表的法人團體(下稱「您」/「您的」)需在 DHL Express 業務單位持有有效公司帳戶。一旦您的憑證獲得 DHL 成功驗證,我們即為您提供 API 產品金鑰以及存取詳細內容。
  3. 如您聘請外部開發人員或其他 IT 服務供應商開發您的應用程式,或讓任何其他第三方(「第三方」)代表您存取及/或使用 MyDHL API,您須對該等第三方在存取及/或使用 MyDHL API 的任何行為或疏忽承擔全部責任。
  4. 本法律條款適用於您對 MyDHL API 的使用及/或存取,除本條款另有規定者外,並不構成對適用之運輸條款及細則、運輸服務協議,或任何其他與 DHL Express 或其附屬公司所簽署向您提供產品或服務之協議(各自稱為「協議」)之替代或修改。無論前述條文有何規定,您明確承認並同意,就您對 MyDHL API 的使用及存取而言,法律條款應優先與協議的條款及細則,但是,在協議有專門針對您使用及存取 MyDHL API 的內容的情況下,則以協議為優先。
  5. 由您另行接受的其他條款,有可能適用與部份 API 服務。請注意,由 DHL Express 提供的運輸服務,嚴格遵守 DHL Express Terms and Conditions of Carriage
  6. 您特此授予 DHL Express 使用全部數據、文件、標誌或其他您傳輸至 MyDHL API 或在其中傳輸之資訊(「資訊」)的權利,以供用於 API 服務規定的用途。此項包含將該項資訊用於處理及運輸貨物的用途。您應確保您透過 MyDHL API 向 DHL Express 傳輸的所有資訊皆為完整、正確及準確。倘因使用錯誤或不正確,或資訊不完整而造成的任何損害或後果,您將承擔所有責任。倘因使用或倚賴本項資訊而有可能造成的任何索償、損失、損害或後果,您將承擔所有責任,並對 DHL Express 作出全面賠償。
  7. 您有責任依照全部適用之法律,特別是競爭法、數據保護法以及海關法,透過 MyDHL API 開展一切活動。您應負責提出正確的法律依據用於處理個人數據,讓 DHL Express 與收件人和收貨人溝通。特別是,在需要獲得同意的國際,對於任何第三方所持有、由您向 DHL Express 提供的個人數據,您應獲得接收方的同意,方可接收 DHL Express 的電子郵件、SMS 短訊,或任何其他形式的電子數據、文件或資訊,以及通常狀況下的同意內容。因應 DHL Express 的要求,您應向 DHL Express 提供該等同意的證明。
  8. DHL Express 將依據適用之數據保護法律以及 Deutsche Post DHL Data Privacy Policy而處理個人數據。請參閱 DHL Express 私隱聲明了解詳情。 您須依據適用之數據保護法,處理您向我們送出或取得之全部個人數據。
  9. 您接受 DHL Express 在處理透過 MyDHL API 發出的貨件訂單時收取費用,同時,假如您未有在預期取件時間內為貨件訂單發出貨品, DHL Express 可要求您作出賠償。
  10. API 服務是按「現狀」的基礎提供。在法律容許的最大範圍內,DHL Express 免除所有明示、默示、法定或其他形式的保證,包括但不限於隱含的可銷售性保證、無侵犯第三方權利及特定目的的適切性。DHL Express 及其附屬公司或代理人對 API 服務的準確性、完整性、安全性或時效性均未作出任何陳述或保證。透過 MyDHL API 所獲取的任何資訊,並不構成 DHL Express 在本法律條款下未明確註明內容的任何保證。
  11. 您僅限將 MyDHL API 用於合法之合約用途,且須與您的 DHL Express 貨件相關。
  12. API 服務

下列必要前提和限制適用於 API 服務、數據或透過 MyDHL API 所提供資訊的使用及存取。

下列詳情並非透過 MyDHL API 提供之現有 API 服務之詳盡列表,DHL Express 僅僅是希望您了解部份可供您使用的部份 API 服務的具體內容。

  • 「建立一項貨件」
    • 當使用 API 服務「建立貨件」時,此項除了其他事項外,還包括建立及列印貨件標籤、預約收取貨件以及存取其他增值服務的可能性。請注意,在 MyDHL API 內預訂的貨件 並不構成貨運合約。貨運合約僅在貨件轉交 DHL Express 或由其收件並予以接受時簽署。
  • 「產品及報價」
    • API 服務「產品」為您提供 DHL Express 對某一貨件產品的能力,而 API 服務「報價」則提供價格及預估送達日期/時間的指示。
    • API 服務「到岸成本」計算其預估到岸成本,其中包含關稅、運費以及您可能向 DHL Express 繳交的其他費用。對於作為 DHL EXPRESS - MyDHL API 一部分的「到岸成本」服務,適用以下附加條款及細則。
    • 所要求以及所收到的數據,例如產品名稱、產品性能、費率、交貨時間/預估送達日期,在此處稱為「產品及/或報價數據」。
    • 關於費率、運輸時間及/或送達日期的資訊,僅為指示性內容,且不予保證。DHL Express 對該項指示性報價與實際費率或運輸時間之間的差異不予承擔任何責任或義務。最終費率及/或運輸時間可因貨件特點、所要求服務以及實際交予 DHL Express 的包裹而異。報價之價格不含關稅、稅費、海關費用或全部附加費用。
    • 未經 DHL Express 事先以書面形式作出同意,您 不得 向任何第三方披露產品及/或報價數據,特別是其他貨運及/物流服務供應商。
    • 您不得將產品及/或報價數據以任何形式存儲及/或修改;在未經我們事先以書面形式作出同意的狀況下,因競爭目的而從產品及/或報價數據之中分析及/或得出數據/資訊,則屬嚴禁之列。
  • 「到岸成本服務」(「LC」)獲「成本服務」(「LC」)
    • LC 是一項為您提供到岸成本預估的服務。到岸成本乃指將產品從另一地點運輸至您的所在地的相關總成本,包括預估運輸費用及關稅。LC 以您所提供之資訊為基礎。您確認,透過 LC 提供的數據具有時效性,且有可能頻繁變化。您有責任向 DHL Express 提交所需之貨件數據,即運費和保險費等運輸價值,以供計算預估到岸成本。
    • LC 並不是您的保險需要的替代品,也不是由您的保險供應商所執行相應風險評估的替代品。LC 僅向業務客戶單獨提供。您不得將 LC 用於任何違反一般開發者入口網站之使用條款以及該等法律條文或任何適用法律之用途。您不得大量複製 DHL Express 提供的產品或服務,包括但不限於 LC 所列的特性、功能或客戶。在任何狀況下,您不得透過應用程式或其他方式重新包裝或轉售 LC 服務或其任何部份,或透過 LC 提供的數據,且您同意不會使用透過 LC 提供的數據/內容建立數據庫。
    • 您須對全部貨件的運送文件所填入資訊的準確性完全負責,且須遵守全部適用於您的貨件的出口、入口以及其他要求。
2.13.3
01.Jun.2025
  • Shipment
    • Support for new registration number type of 'FTN' (Foreign Tax Identification Number) for Mexico country usage  
       
  • Invoice
    • Support for new registration number type of 'FTN' (Foreign Tax Identification Number) for Mexico country usage  
       
2.13.1
06.Apr.2025
  • Shipment
    • Considering of special services of 'TF' (Verified Delivery) which is part of customer agreement on DHL Express shipper account level when rendering the Transport Label
2.13.0
23.Mar.2025
  • Shipment
    • Option to return rates for product B (BBX) onboarded customers
       
  • Rates
    • Option to return rates for product B (BBX) onboarded customers
       
  • Get Image
    • Supports document image retrieval of customs document type of 'TAS' (transport-accompanying-document) and 'GES' (generic-entry-summary)
2.12.1
19.Jan.2025
  • Shipment
    • introducing new 'DDS' (Due Diligence Statement Reference Number) type code under Export Declaration/ Line Item references
    • Support for new registration number type of 'EIC' (eInvoice Carrier) for Taiwan country usage  
       
  • Invoice
    • introducing new 'DDS' (Due Diligence Statement Reference Number) type code under Export Declaration/ Line Item references
    • Support for new registration number type of 'EIC' (eInvoice Carrier) for Taiwan country usage  
2.12.0
22.Oct.2024
  • Shipment
    • Account validation enhancement on allowed product and network type combination
    • New release version number 'x-version' to return new 'pickupCutoffSameDayOutboundProcessing' field to replace legacy field 'GMTCutoffTime' in shipment response
       
  • Reference Data
    • New language codes details for document rendering Commercial Invoice, Shipment Receipt, Email Notification and Tracking localization
    • Updated new supported values for 'unitOfMeasurement' category
  • Rates
    • New release version number 'x-version' to return new 'pickupCutoffSameDayOutboundProcessing' field to replace legacy field 'GMTCutoffTime' in rates response


 

2.11.4
29.Sep.2024
  • Shipment
    • Support for new Registration number type of 'IMS'  
      Note: 'IMS' code will be available in Production by the end of March 2025.
2.11.2
28.Jul.2024
  • Shipment
    • Invoice date field description updates
    • Reference Data updates on registration number information for Malaysia (MY) e-Invoice regulatory changes 
       
  • Tracking
    • Tracking response with event remarks fields at shipment and pieces level
2.11.1
26.May.2024
  • Shipment
    • Support for manufacturerDetails customer role
    • exportDeclaration's and lineItems's customsDocuments typeCode updates with new 'PCH' value
    • 'PPY' - Proof Of Payment typeCode is replaced with 'PCH' - Proof Of Purchase.
  • Invoice
    • Support for manufacturerDetails customer role
    • exportDeclaration's and lineItems's customsDocuments typeCode updates with new 'PCH' value
    • 'PPY' - Proof Of Payment typeCode is replaced with 'PCH' - Proof Of Purchase.
2.11.0
31.Mar.2024
  • Shipment
    • Handling of export line item’s taxes paid indicator applicable to the provided destination country dynamically
    • Support for Broker customer role
    • New 'linkLabelsByPieces' option under getAdditionalInformation's typeCode that return additional response fields in shipment response for linkage of individual piece’s reference number and its transport label or waybill document image type.
  • Invoice
    • Support for Broker customer role
  • Tracking
    • Tracking response with masking protected data and authorization process implementation
    • New request parameter to return GMT offset per event/ checkpoint
2.10.1
10.Mar.2024

Tracking

  • Support for trackingView of 'all-check-with-remarks' and new parameter for requesting array of controlled access data codes in tracking response.
2.10.0
22.Oct.2023
  • Shipment
    • Support for multilingual Global Shipment Receipt
2.9.0
27.Aug.2023
  • Shipment
    • bypassPLTError query parameter made publicly available without any restriction to all the DHL Express MyDHL API customers
    • Updated invoice display logic to individually and consistently show Freight and Insurance charges, preventing them from being categorized under "Other Charges" for enhanced clarity.
    • Considering of special services (CIN2, GoGreen/ GoGreen+) which is part of Customer agreement on DHL Express account level when rendering the Transport label
    • Enhanced data validation:  positive values are enforced for parameters such as totalNetWeight, totalGrossWeight, price, netValue weight, grossValue weight, additionalCharges's value, importCustomsDutyValue, and importTaxesValue.
  • Invoice
    • Updated invoice display logic to individually and consistently show Freight and Insurance charges, preventing them from being categorized under "Other Charges" for enhanced clarity.
  • Get Image
    • Support document image retrieval of customs document with both the Export and Import document function type
  • Reference Data – new API
    • Introduced new resource allowing to retrieve various DHL Express related reference data
2.8.2
27.Jul.2023
  • Service Point
    • Returns 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
2.8.0
07.May.2023
  • Shipment
    • Support for Customer own calculated totals and sub-totals amounts on the Commercial invoice ('preCalculatedTotalGoodsValue','preCalculatedTotalInvoiceValue','preCalculatedLineItemTotalValue' and 'totalWithImportDutiesAndTaxes'). If all of these provided in the request then DHL Express will not auto-calculate the values but will use what is provided by the customer in the request
    • Currency Code made optional for non-declarable shipments 
    • Incoterm made optional for all non-declarable shipments
    • Introduced Shipment data validation flow to support data validation without label creation
    • Automated Digital Imaging (ADI) enablement

 

  • Invoice
    • Support for Customer own calculated totals and sub-totals amounts on the Commercial invoice ('preCalculatedTotalGoodsValue','preCalculatedTotalInvoiceValue','preCalculatedLineItemTotalValue' and 'totalWithImportDutiesAndTaxes'). If all of these provided in the request then DHL Express will not auto-calculate the values but will use what is provided by the customer in the request
2.7.2
05.Mar.2023
  • Shipment
    • Support for multiple UN code values for Excepted Quantities(HH)  under valueAddedServices/dangerousGoods
    • Support for multiple MRN (Movement Reference number) values under content/exportDeclaration/invoice/customerReferences
  • Invoice
    • Support for Commercial Invoice’s indicative duty and tax amount rendering for customs purpose using   COMMERCIAL_INVOICE_P_10 and COMMERCIAL_INVOICE_L_10 templates
    • Support for multiple MRN (Movement Reference number) values under content/exportDeclaration/invoice/customerReferences
2.7.0
16.Oct.2022
  • Shipment
    • Support Singapore OVR GSTN registration number and GST taxes
    • Support for Dangerous Goods customized statement on Shipment level
    • Validation of any Country code provided in the request message
  • Invoice
    • Validation of any Country code provided in the request message
  • Rates
    • Option to decide whether Quoted or Committed Estimated Delivery Date to be returned
  • Address
    • Support for County name (Suburb)
2.6.0
11.Sep.2022
  • Shipment
    • Mandatory "exportDeclaration" section for declarable (non-documents) shipments
    • Support for Ultimate Consignee customer role
    • Introduced option that allows exact-match validation of postal address provided under Shipper and Receiver customer details
    • Support for Commercial Invoice’s indicative duty and tax amount rendering for customs purpose using COMMERCIAL_INVOICE_P_10 and COMMERCIAL_INVOICE_L_10 templates
  • Invoice
    • Support for Ultimate Consignee customer role
  • Rates
    • Introduced option to return dependent / mutual exclusive services list  
    • Introduced option that allows exact-match validation of postal address provided under Shipper and Receiver customer details
2.5.0
09.Jul.2022
  • Shipment
    • Support for Global Returns Invoice templateName 'RET_COM_INVOICE_A4_01'
2.4.0
20.Feb.2022
  • Shipment
    • Support for non-DHL barcode Licence plate identification number types
    • Added Export Line Item Reference Type of ECCN - No License Required indicator (NLR)
    • Ability to return provinceName in rendered Transport Label and Waybill document
    • List of supported incoterms updated
  • Invoice
    • Added Export Line Item Reference Type of ECCN - No License Required indicator (NLR)
  • Get Image – new API
    • Retrieve shipment related document images (Commercial Invoice, Waybill Document, Customs document)
2.3.1
14.Dec.2021
  • Shipment 
    • Removed <function> field in Shipment request
2.3.0
25.Oct.2021
  • Shipment
    • PDF Labels rendered can be requested to fit to A4 page size
2.2.0
06.Sep.2021
  • Landed Cost 
    • Return landed cost with partial or no commodity code
    • Improved error messages
    • Ability to return tariff formula
2.1.0
11.Jul.2021
  • Shipment

    • Support for upload Invoice data for existing shipment
    • Support for additional customs related e-commerce rules
  • Invoice – new API

    • Support for upload Invoice data before shipment is created
2.0.0
12.Mar.2021
  • Shipment
    • Support for the new European Union VAT and customs e-commerce rules for the import of low value consignments as of July 1st 2021
    • Support for Loose BBX shipments
    • Support for Label-Less return shipments
    • Support for Cash-On-Delivery shipments
    • Support for upload of additional document images for Advanced Shipments
1.1.0
20.Jul.2020

Added new endpoints to the API:

  • Tracking
  • Pickup
  • Identifier
  • Address
1.0.0
27.Mar.2020
  • Initial Release of Rates, Shipments & Fully Landed Cost - ready for Pilot