DOCS

API で接続

DHL キャリアアカウントに接続する

DHL 運送業者アカウントを安全に接続して、交渉された配送料にアクセスし、Zonos を通じて直接ラベルを作成します。

始めましょう 

DHL 運送業者アカウントの接続プロセスでは、資格情報が検証され、料金を取得して配送ラベルを生成するようにアカウントが適切に設定されていることを確認します。 DHL アカウントに接続すると、Zonos は資格情報を保存する前に、テスト評価呼び出しを実行して、接続が正しく機能していることを確認します。

DHL Express への登録、または Zonos Dashboard からのセットアップについては、このガイドの手順に従ってください。

DHL キャリアアカウントの接続の仕組み 

DHL キャリアアカウントを接続する:

  • DHL に正しい認証情報の種類を指定したことを検証します。
  • DHL API にライブ評価呼び出しを実行して、資格情報が有効であることを確認します
  • 将来の出荷評価とラベル作成のために、接続されたアカウントを Zonos に保存します
  • DHL アカウント情報や料金タイプなど、接続されているアカウントの詳細を返します。

接続すると、DHL 配送業者アカウントを使用して、交渉された料金 (該当する場合) に基づいてリアルタイムの配送料金を取得し、DHL 配送ラベルを作成できます。

DHL アカウントを接続してください 

carrierAccountConnect ミューテーションを使用して、認証情報で DHL キャリアアカウントを接続します。

ミューテーション

このミューテーションを使用して、DHL キャリア アカウントに接続し、資格情報を検証します。

1mutation CarrierAccountConnect($input: CarrierAccountConnectInput!) {
2 carrierAccountConnect(input: $input) {
3 errors
4 carrierAccount {
5 credentialProvider
6 id
7 integrationType
8 organization
9 rateType
10 carrier {
11 id
12 code
13 name
14 }
15 credentials {
16 type
17 value
18 }
19 }
20 }
21}

変数

このミューテーションには、DHL キャリアコード、料金タイプ、および DHL アカウントの認証情報が必要です。

1{
2 "input": {
3 "carrierCode": "DHL",
4 "rateType": "NEGOTIATED",
5 "credentials": [
6 {
7 "type": "API_KEY",
8 "value": "actual_api_key_value"
9 },
10 {
11 "type": "API_PASSWORD",
12 "value": "actual_api_password_value"
13 },
14 {
15 "type": "ACCOUNT_NUMBER",
16 "value": "actual_account_number_value"
17 }
18 ]
19 }
20}

DHL には次の認証情報の種類が必要です:

  • API_KEY- あなたの DHL API キー
  • API_PASSWORD- あなたの DHL API のパスワード
  • ACCOUNT_NUMBER- あなたの DHL 口座番号

これらの資格情報は、DHL アカウント ポータルで確認するか、DHL アカウント担当者に連絡することで見つけることができます。

応答例

接続成功

認証情報が有効で、DHL がレートを正常に返す場合:

1{
2 "data": {
3 "carrierAccountConnect": {
4 "errors": [],
5 "carrierAccount": {
6 "credentialProvider": "ORGANIZATION",
7 "id": "carrier_account_123",
8 "integrationType": "REST",
9 "organization": "organization_id",
10 "rateType": "NEGOTIATED",
11 "carrier": {
12 "id": "carrier_123",
13 "code": "dhl",
14 "name": "DHL"
15 },
16 "credentials": [
17 {
18 "type": "API_KEY",
19 "value": "actual_api_key_value"
20 },
21 {
22 "type": "API_PASSWORD",
23 "value": "actual_api_password_value"
24 },
25 {
26 "type": "ACCOUNT_NUMBER",
27 "value": "actual_account_number_value"
28 }
29 ]
30 }
31 }
32 }
33}

エラー: サポートされていない認証情報の種類です

DHL がサポートしていない認証情報の種類を指定した場合:

1{
2 "data": {
3 "carrierAccountConnect": {
4 "errors": [
5 "Credential type SITE_ID is not supported by carrier DHL"
6 ],
7 "carrierAccount": null
8 }
9 }
10}

エラー: 無効な認証情報

資格情報が有効なタイプであるにもかかわらず、DHL で正常に認証されない場合:

1{
2 "data": {
3 "carrierAccountConnect": {
4 "errors": [
5 "Failed to get rating from DHL API"
6 ],
7 "carrierAccount": null
8 }
9 }
10}

接続後の動作

DHL キャリアアカウントが正常に接続されたら:

  • アカウントは組織に保存され、資格情報にリンクされます
  • 交渉した料金を使用して DHL の配送料金を取得できます (該当する場合)
  • Zonos API を通じて DHL 配送ラベルを作成できます。
  • 運送業者アカウントは、再接続せずに複数の発送で使用できます

次のステップ 

DHL キャリアアカウントを接続した後:

GraphQL API ReferenceTypes, inputs, and operations used in this guide

このページは役に立ちましたか?