高度配送通知 (ASN) 検索取得型 API (Advanced ship notice (ASN) retrieve API)
テスト用エンドポイント:
https://transact.ti.com/v2/store/orders/T10999999/advanced-shipment-notices/test
https://transact.ti.com/v2/store/orders/T10999999/advanced-shipment-notices/499999999/test
正式運用エンドポイント:
https://transact.ti.com/v2/store/orders/{Order Number}/advanced-shipment-notices/
https://transact.ti.com/v2/store/orders/{Order Number}/advanced-shipment-notices/{Waybill Number}
ご注文の梱包が完了し、出荷の準備ができた後、TI は配送追跡情報を生成します。高度配送通知 (ASN) APIを使用すると、追跡番号、配送業者の詳細、商業送り状など、出荷されたご注文に関する詳細情報を検索取得できます。
ASN API の特長:
- リアルタイム更新:プッシュ型 API は、Webhook を貴社システム宛に送信し、ご注文の出荷準備ができたことを通知します。貴社はこれを、自動化フローのトリガーとして使用できます。
- 詳細配送情報:追跡番号、配送業者情報、商業送り状を取得できます。
- 柔軟な取得オプション:注文番号で注文全体の情報を取得したり、送り状番号を使用して特定の配送に関する情報を検索取得したりできます。
ASN API を使用する手順:
- 認証:API を使用して認証を受けるには、貴社の割り当て済みAPI キーとシークレットが必要です。
- 出荷情報の取得:
- 注文全体:リクエストの注文番号を入力します。
- 具体的な配送:以前に受け取った送り状番号、または myTI の注文履歴にある送り状番号を入力します。
- API の応答:ステータス コード (200 OK) と、出荷の詳細を含む JSON 形式の応答を受信します。
- 特定の注文に関する詳細の検索取得:
- 特定の注文に関する詳細情報を取得するには、注文 API に対して注文番号を問い合わせます。
- 例:"https://transact.ti.com/v2/store/orders/T999999999"
API のテスト:
ライブ データで API を使用する前に、テスト環境を利用できます。テスト時:
- 提供されているテスト用エンドポイント URL を使用
- order ID (ご注文 ID) として常に T10999999 を渡し、waybill number (送り状番号) として常に 0499999999 を渡す必要があります。
または
追加のコメント:
- お客様のアクセス トークンが有効である限り、1 つのセッション内で複数の要求を使用することができます。
- この API は、プッシュ型または検索取得型の実装が可能です。詳細については、「プッシュ型通知のセットアップ」をご参照ください。
検索取得に対応する要求の例:
curl --request GET \
--url 'https://transact.ti.com/v2/store/orders/{orderNumber}/advanced-shipment-notices/{wayBillNumber}'
--header 'Authorization: Bearer {access_token}' \