エンドポイント
HTTPS リクエスト
POST | https://api.iglobalstores.com/v2/setShipmentTracking
| フィールド | ノート |
|---|---|
| HTTP メソッド | POST |
| エンドポイント URL | https://api.iglobalstores.com/v2/setShipmentTracking |
| プロトコル | HTTPS |
| メッセージフォーマット | JSON |
| Accept HTTP ヘッダー | Accept: application/json |
| Content-Type HTTP ヘッダー | Content-Type: application/json |
リクエストボディ内の JSON キー/値のペア
メッセージフォーマット: JSON
例
1
2
3
4
5
6
7
8
9
10
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"orderId": "999-99999",
"trackingList": [
{
"number": "1Z204E380338943508"
}
]
}
| フィールド | ノート |
|---|---|
orderId 必須 | Zonos の注文IDは、ストアIDとハイフンを含めるか含めないかで渡すことができます（例：123-45678または45678）。注文の完了と支払い後、顧客はあなたのドメインにホストされた注文完了/感謝ページにリダイレクトされます。URLには、orderIdというクエリ文字列パラメータが含まれ、この値が含まれます。integer / string |
secret 必須 | Zonos によって提供されたAPIシークレットGUID。string |
store 必須 | Zonos によって提供されたストアID。integer |
trackingList 必須 | これはオブジェクトのリストです。各オブジェクトは、少なくとも「number」という名前のキーを持ち、そのキーの値は追跡番号の1つであるキー/値ペアを持つ必要があります。各追跡番号のために、キー/値ペアを持つ別のオブジェクトが必要です。 |
HTTPSレスポンス
メッセージ形式: JSON
成功レスポンスの例
1
2
3
{
"success": "Updated Order: 99999 with new tracking info."
}
例外エラー応答
1
2
3
{
"error": "A specific message describing the error."
}
追跡情報を更新する
追跡情報を更新するエンドポイントの動作方法を学びます。setShipmentTrackingエンドポイントは、追跡番号を使用して Zonos システム内の注文を更新するために使用されます。