DHL Express - MyDHL API
v 2.9.0
Division: DHL Express

主なサービス:

  • DHL Expressで発送する荷物の見積もり、出荷書類作成、追跡
  • DHL Expressのアカウント番号をお持ちのお客様
  • 対象:グローバル
Region: Global
Used for: Shipping, Rating, Products, Landed Cost, Tracking
概要

MyDHL APIは、DHL Expressとお客様の社内出荷プロセスを結びつけるものです。お客様のウェブサイトと統合し、受注管理、倉庫管理、その他の業務用ソフトウェアシステムと連携することで、より合理的で効率的なオペレーションを支援します。さあ、MyDHL APIを始めましょう!

MyDHL APIは、DHL Expressのすべてのサービスに対応するワンストップソリューションです。利用可能なAPIは以下です: 

評価アイコン 小包アイコン 完全陸揚費 出荷アイコン 集荷アイコン 追跡アイコン グローブアイコン 統合ソリューション
見積もり 配達サービス 陸揚げ費用の見積もり 出荷書類作成 集荷依頼 追跡 配達可能エリアの確認 番号の事前発行
ビジネスの成長と最適化
  • DHL Expressの機能(フルフィルメントなど)をお客様の既存システムにシームレスに統合することができます
  • プログラムの切り替えや情報を再入力せずに、発送可否や見積もりを確認できます
  • 新しい使い方を覚えることなく、使い慣れたユーザーインターフェイスをそのまま利用できます
  • お客様のEコマースサイトのチェックアウト時に、配達サービス、陸揚げ費用の見積もり、オンデマンドデリバリーを提供することで、より多く販売することができます
開発者向けに作成
  • 業界標準に基づいたAPIです
  • 時間的制約のある倉庫やeコマースビジネスを考慮して構築されています
  • お客様のソリューションをテストするための環境を提供します
  • DHL ExpressのAPIエキスパートがサポートします

対象範囲

MyDHL APIでさらに便利に
サービス 詳細
見積もり
【RATING】Rating APIでは、DHL Expressの利用可能な配達サービス(オプショナルサービス、配達予定を含む)とお客様のDHL Expressアカウント番号に基いた見積もりを返します。(複数個口にも対応)
配達サービス
【PRODUCT】Product APIでは、DHL Expressで利用可能な配達サービス(オプショナルサービス、配達予定を含む)を返します。(1個口のみ対応)
陸揚げ費用の見積もり
【LANDED COST】Landed Cost APIは、輸入関税・消費税等を含む陸揚げ費用の見積もりを返します。本サービスをご利用の際は、HSコードを含む品目情報をリクエストに含む必要があります。
出荷書類作成

【SHIPMENT】Shipment APIでは、運送状、インボイス、集荷予約、運送保険などのオプショナルサービスを含むDHL Expressの発送に必要な出荷書類を作成できます。

まずRate APIをご利用いただき、利用可能な配達サービスとオプショナルサービスをご確認いただいた上で、ご希望のサービスを含めてCreate Shipment APIをリクエストすることをおすすめします。

出荷書類の作成だけでなく、追加の通関書類のアップロードや、配達済み貨物の電子配達証明を発行することも可能です。

集荷依頼
【PICKUP】Pickup APIは、DHL Expressの集荷を依頼、変更、またはキャンセルできます。
追跡
【TRACKING】Tracking APIは、DHL Expressで出荷した荷物の輸送状況を返します。
配達可能エリアの確認
【ADDRESS】Address APIは、DHL Expressの集配可能エリアを返します。
番号の事前発行
【IDENTIFIER】Identifier APIは、DHL Expressが提供するブレークバルクエクスプレスなどの出荷時に必要な運送状番号やPID番号を事前に発行します。

MyDHL API利用条件

APIは、開発者が使用することを前提に設計されています。REST API、JSON、HTTPSに関する基本的な知識が必要です。また、有効なDHL Expressのアカウント番号をお持ちであることが条件となります。アカウント番号を取得する場合は、DHL Expressのアカウント番号登録ページをご覧ください。

使用事例

既存のウェブサイトやソリューションに簡単に組み込むことができます。

Shipment APIをお客様のウェブサイト、顧客サービスアプリケーションまたは注文処理システムに組み込むことで、出荷や受領確認を簡単に行うことができるようになります。MyDHL APIを使用すると、世界各国のDHLサービス対応状況、所要日数、見積もり、集荷予約状況、追跡などの最新の情報を常に入手することができます。

利用開始方法

アクセスを取得

MyDHL APIを使用するには、有効なDHL Expressのアカウント番号が必要です。

DHL Expressのアカウント番号をすでに持っている場合:

[1.] 利用開始手続き [2.] IDクレデンシャルの取得
  • Get Accessをクリックし、IDクレデンシャルを申請します。

MyDHL APIのアクセスが提供され、開発を開始できます。

DHL Expressのアカウント番号を持っていない場合:

[1.] アカウント番号の申請 [2.] アカウント番号の開設 [3.] 利用開始手続き
DHL Expressのアカウント開設フォームに進んでください。必要事項を入力したら、[確定]をクリックします。 担当部署より、アカウント番号についてご連絡いたします。 アカウント番号が発行されたら、API Developer Portalに登録し、Get AccessからIDクレデンシャルを申請します。

認証方法

MyDHL APIのIDクレデンシャルが発行されたら、不明点はMyDHL APIサポートにお問い合わせください。

認証方法は、Basic認証を設定してください。

環境

MyDHL APIのエンドポイントは以下の通りです。

URL/URI 詳細
https://express.api.dhl.com/mydhlapi/test テスト環境(実運用ではご利用いただくことはできません)
https://express.api.dhl.com/mydhlapi 本番環境(ご利用前に申請が必要です)

クォータ制限

  • MyDHL APIのテスト環境では、1日に実行可能なAPIの呼び出し回数を500回までとしています。テスト環境は、開発時の動作確認の場としてご利用ください。
  • MyDHL APIのテスト環境には、正式なSLAが設定されています。

追加情報

MyDHL APIにリクエストしたデータの検証には、いくつかの処理があります。まず、スキーマバリデーションを行い、リクエストメッセージの構造を検証します。次に、そのリクエストに対しビジネスルールが適用されます。これらの検証結果はすべて保存されており、レスポンスデータとして返されます。検証エラーなどが生じた場合には、レスポンスデータの内容でエラーの原因を特定することができます。

法的条件・利用規約
DHL Express - MyDHL API(以下、「MyDHL API」という)の使用およびアクセスに関する特定条件。
  1. MyDHL APIおよびその関連サービスを使用またはアクセスする場合(以下「APIサービス」といい、誤解を避けるために、この法的条件におけるMyDHL APIへの言及は、文脈によって示唆されていない限り、APIサービスを含むMyDHL APIへの言及とみなされます)、お客様は法的契約を締結し、修正なしにこれらの条件のすべてに同意するものとします。本規約に同意することにより、お客様はDHLの一般開発者ポータル(API Developer Portal)利用規約の遵守に同意していることになり、これはお客様のMyDHL APIの使用に関するさらなる拘束力のある合意を意味しています。この2つの規約は集合的に解釈され、本書では(「法的条件」)として扱います。
  2. MyDHL APIの利用登録を行うには、お客様および/またはお客様が代表を務める法人(以下、「お客様」/「お客様の」という)は、DHL Expressの法人で有効な顧客アカウントを所有している必要があります。APIプロダクトキー(IDクレデンシャル)とアクセス詳細は、DHLによるお客様の資格証明書の検証が完了した時点で提供されます。
  3. お客様が、お客様のアプリケーションを開発するために、外部の開発者、その他のITサービスプロバイダー、またはその他の第三者(以下、「第三者」)に、お客様に代わってMyDHL APIへのアクセスおよび/または使用を依頼した場合、お客様は、MyDHL APIへのアクセスや使用に関連する当該第三者のいかなる行為または不作為に対しても、全責任を負うことに同意します。
  4. 本法的条件は、お客様のMyDHL APIの使用および/またはアクセスを規定し、本書に別段の定めがない限り、お客様に提供されるサービスまたは製品について規定する、該当する運送約款、輸送サービス契約、またはDHL Expressもしくはその関連会社とのその他の契約(別途、それぞれ「契約」)に代わるものではなく、また変更されないものです。上記にかかわらず、お客様は、お客様によるMyDHL APIの使用およびアクセスに関してのみ、契約がお客様によるMyDHL APIの使用またはアクセスを特に扱っていない限り、法的条件が契約の諸条件に優先することを明確に認め、同意するものとします。
  5. 特定のAPIサービスには、お客様が別途承諾する追加条件が適用される場合があります。DHL Expressが提供する輸送サービスには、常にDHL Expressの運送約款が適用されますので、ご注意ください。
  6. お客様は、DHL Expressに対し、お客様がMyDHL APIに送信した、またはMyDHL API内で送信したすべてのデータ、文書、ロゴ、その他の情報(以下「情報」という)を、APIサービスで定められた目的のために使用する権利を許諾するものとします。これには、出荷の処理および輸送を目的とした情報の利用が含まれます。お客様は、MyDHL APIを通じてDHL Expressに送信するすべての情報が完全で、正しく、かつ正確であることを確認するものとします。虚偽情報・不正確な情報・不完全な情報の利用に起因する損害または結果に対して、お客様は単独で責任を負うものとします。お客様は、本情報の使用または依存から生じるいかなるクレーム、損失、損害または結果に対しても単独で責任を負い、DHL Expressを全面的に免責するものとします。
  7. お客様は、すべての適用法、特に競争法、データ保護法、関税法に従って、MyDHL APIを介して行われるすべての活動に対して責任を負うものとします。DHL Expressが貨物の受取人および荷受人と連絡を取るために、個人情報を処理するための正しい法的根拠を提供する責任を負うものとします。特に、同意が必要とされる国において、お客様は、第三者が所有し、お客様がDHL Expressに提供した個人データについて、DHL ExpressからのEメールまたはSMS、その他の電子形式のデータ、文書または情報、一般的には第三者からの受信者の同意を得るものとします。DHL Expressの要求があった場合、お客様は当該同意の証拠をDHL Expressに提供するものとします。
  8. DHL Expressは、適用されるデータ保護法およびDeutsche Post DHLデータプライバシーポリシーに従って個人データを取り扱います。詳細については、DHL Expressのプライバシーに関するお知らせをご覧ください。お客様は、適用されるデータ保護法に従って、お客様が当社に送信し、または当社から取得したすべての個人データを処理する必要があります。
  9. お客様は、MyDHL APIを通じて行われた出荷注文の処理にDHL Expressが費用を負担すること、およびその後、お客様が出荷注文に対して集荷予定時刻に貨物を提出しなかった場合、DHL Expressがお客様に補償を要求する可能性があることを承諾します。
  10. 本APIサービスは、「現状のまま」提供されます。DHL Expressは、法律で認められている最大限の範囲において、製品性、第三者の権利の非侵害、特定目的への適合性の黙示的保証を含むがこれに限定されず、明示、黙示、法定、その他すべての保証を排除するものとします。DHL Express、その関連会社または代理店は、APIサービスの正確性、完全性、安全性または適時性について、いかなる表明または保証も行わないものとします。MyDHL APIを通じて取得したいかなる情報も、DHL Expressが法的条件に明示的に記載していない、いかなる保証も生じないものとします。
  11.  お客様は、MyDHL APIを正当な契約上の目的のためにのみ、かつお客様のDHL Expressの出荷に関連してのみ使用するものとします。
  12. APIサービス

MyDHL APIを通じて提供されるAPIサービス、データまたは情報の使用およびアクセスには、以下の前提条件および制限事項が適用されます。

以下の詳細は、MyDHL APIで利用できるAPIサービスのすべてを網羅したものではなく、DHL Expressは、お客様が利用できる特定のAPIサービスの特定の要素について知っていただきたいと考えています。

  • 「出荷書類作成」
    • APIサービス「Create Shipment(出荷書類作成)」を使用する場合、特に、運送状の作成と印刷、集荷の予約、その他の付加価値サービスへのアクセスが可能になります。MyDHL API内での集荷の予約は、運送契約を構成するものではありませんのでご注意ください。運送契約は、DHL Expressが貨物を引き渡し、または引き取り、引き受けた時点で成立するものとします。
  • 「配達サービスと見積もり」
    • APIサービス「Product(配達サービス)」は、DHL Expressの製品性能をお客様に提供し、APIサービス「Rating(見積もり)」は、運送料金の見積もりや配達予定日を表示します。
    • APIサービスの「Landed Cost(陸揚げ費用の見積もり)」は、関税、運賃、その他お客様がDHL Expressに提供することができる費用を含む陸揚げ費用の概算を算出します。DHL EXPRESS - MyDHL APIの一部である「Landed Cost(陸揚げ費用の見積もり)」サービスについては、以下に定める追加条件が適用されます。
    • 製品名、製品性能、見積もり、リードタイム、配達予定日など、要求されたデータおよび受け取ったデータを、以下「配達サービス/見積もりデータ」と呼びます。
    • 見積もり料金、輸送時間、配達予定日に関する情報は、あくまでも目安であり、保証するものではありません。DHL Expressは、この提示された目安となる見積もりと実際の料金または輸送時間との差異について、いかなる責任も負わないものとします。最終的な料金や輸送日数は、貨物の特性、ご依頼のサービス、実際にDHL Expressに委託された荷物によって異なる場合があります。見積もり料金には、関税、諸税、通関手数料、その他すべての追加料金が含まれていない場合があります。
    • お客様は、DHL Expressの書面による事前の同意なく、本配達サービスおよび/または見積もりデータを第三者、特に他の輸送および/またはロジスティクスサービスプロバイダーに開示および/または提供しないものとします。
    • また、当社の書面による事前の同意なしに、配達サービスデータおよび見積もりデータを分析したり、競争目的のデータ・情報を導出することは特に禁止されています。
  • 「陸揚げ費用の見積もり」(Landed Cost「LC」)
    • LCは、陸揚費の見積もりを提供するサービスです。陸揚費とは、製品を他の地域からお客様の地域へ配送するために必要な費用の総額で、運送料金や関税の見積もりなどが含まれます。LCは、お客様からいただいた情報に基づいています。お客様は、LCを介して提供されるデータが一刻を争うものであり、頻繁に変更される可能性があることを了承するものとします。お客様は、DHL Expressの陸揚費の計算に必要なデータ(運賃や保険料などの輸送価値)の提供に関するすべての責任を負います。
    • LCは、いかなる保険および保険会社によるそれぞれのリスク評価の必要性に代わるものではありません。LCは企業顧客にのみ提供しています。お客様は、一般的な開発者ポータル(API Developer Portal)利用規約、これらの法的条件、または適用される法律に違反する目的でLCを使用してはなりません。お客様は、DHL Expressが提供する製品またはサービス(LCの特徴、機能またはクライアントを含むがこれに限定されない)を実質的に複製してはならないものとします。お客様は、いかなる場合においても、アプリケーションまたはその他の方法で、LCのサービスまたはその一部、あるいはLCを通じて提供されるデータを再梱包または再販してはならず、LCを通じて提供されるデータ/コンテンツを使用してデータベースを作成しないことに同意するものとします。
    • あらゆる出荷について、お客様は、出荷書類に記入する情報の正確性、およびお客様の出荷に適用されるすべての輸出、輸入、およびその他の要件に準拠することについてすべての責任を負うものとします。
2.10.0
22.Oct.2023
  • Shipment
    • Support for multilingual Global Shipment Receipt
  • Upload Image
    • Ability to upload document images for PLT shipments anytime during the shipment lifecycle prior completion (delivery) checkpoint 
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