DOCS

API 経由での接続

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

安全に DHL キャリアアカウントを接続して、交渉済みの出荷料金にアクセスし、Zonos を通じて直接ラベルを作成します。

はじめに 

DHLキャリアアカウントの接続プロセスは、認証情報を検証し、料金の取得と出荷ラベルの生成にアカウントが適切に構成されていることを確認します。DHLアカウントを接続すると、Zonos は接続が正しく機能していることを検証するためのテストレート呼び出しを実行し、認証情報を保存します。

DHL Express に登録するか、Zonos ダッシュボードから設定するには、この ガイド の手順に従ってください。

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

DHLキャリアアカウントの接続:

  • DHL に対して正しい認証情報タイプが提供されていることを検証します
  • 資格情報が有効であることを確認するために、DHL API へライブのレート呼び出しを行います
  • 将来の出荷レート計算とラベル作成のために、Zonos に接続済みアカウントを保存します
  • 接続済みアカウントの詳細を返します。DHL アカウント情報と rate のタイプを含みます

接続後、あなたの DHL キャリアアカウントは、交渉済み料金に基づくリアルタイムの出荷料金を取得し(該当する場合)、DHL の出荷ラベルを作成するために使用できます。

DHL アカウントを接続する 

DHL キャリアアカウントを資格情報とともに接続するには、carrierAccountConnect ミューテーションを使用します。

Mutation

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

ミューテーション

GraphQL

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

変数

このミューテーションには DHLのキャリアコード、rate のタイプ、そして DHLアカウントの認証情報が必要です。

変数

json

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

DHLは以下の認証情報タイプが必要です:

  • API_KEY - DHLのAPIキー
  • API_PASSWORD - DHLのAPIパスワード
  • ACCOUNT_NUMBER - DHLのアカウント番号

これらの認証情報は、DHLアカウントポータルで見つけることができます、またはDHLのアカウント担当者にご連絡ください。

応答の例

接続に成功

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

応答

json

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

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

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

エラー

json

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

エラー: 無効な認証情報

資格情報の形式が有効であっても、DHL で正常に認証されない場合:

エラー

json

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

接続後の動作

  • アカウントは組織内に保存され、認証情報に紐づけられます
  • 契約済みの料金を使用してDHLの配送料金を取得できます(該当する場合)
  • DHLの配送ラベルを Zonos API で作成できます
  • このキャリアアカウントは、再接続せずに複数の出荷で使用できます

次のステップ 

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

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