エンドポイント
オーダー完了詳細のリクエスト
POST | https://api.iglobalstores.com/2.0/order-completed - 完了した注文に関連する情報の新しいリクエストを作成します。
HTTPSリクエスト
| フィールド | ノート |
|---|---|
| HTTPメソッド | POST |
| エンドポイントURL | https://api.iglobalstores.com/2.0/order-completed |
| プロトコル | HTTPS |
| メッセージフォーマット | JSON |
| Accept HTTPヘッダー | Accept: application/json |
| セキュリティトークンHTTPヘッダー | serviceToken: your-test-token-valueHTTPSリクエストにserviceTokenという名前のヘッダーを追加し、テストセキュリティAPIトークンの値を設定します。（このトークンについてはアカウントマネージャーにお問い合わせください。） |
| Content-Type HTTPヘッダー | Content-Type: application/jsonサービスにJSONデータを投稿するため、HTTPSリクエストにContent-Typeという名前のヘッダーを追加し、値をapplication/jsonに設定します |
リクエストボディ内のJSONキー/値ペア
メッセージフォーマット: 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
{
"billingAddress": {
"address1": "123 S West Elm St",
"address2": null,
"address3": null,
"city": "Calgary",
"countryCode": "CA",
"postalCode": "T2P 5G8",
"state": "Alberta",
"stateCode": null
},
"billingCompany": null,
"billingEmail": "jdoe@jdoe.com",
"billingName": "John E. Doe",
"billingPhone": "+1 555-555-5555",
"orderGrandTotal": 1225.89,
"orderNumber": "854725421",
"paymentTypeCode": "PAYPAL",
"prepaidDutyTax": true,
"shippingQuoteId": "bcdbdbcd-0145-4d3b-a54e-0de3cdce5a0a",
"shipToCompany": null,
"shipToEmail": "jdoe@jdoe.com",
"shipToName": "John Doe",
"shipToPhone": "+1 555-555-5555"
}
リクエスト JSON 定義
| フィールド | ノート |
|---|---|
billingAddress 必須 | これは注文の請求先住所です。これは、address1、address2、address3、city、state、stateCode、postalCode、および countryCode の以下の住所フィールドを含むマップです。これらのフィールドは、国に基づいて必須または任意です。ローカリゼーションエンドポイントは、各国に対してどの特定の住所フィールドが必須または任意であるかを返します。注意: stateCode は常に必須ではなく、ローカリゼーションエンドポイントで宣言されていません。利用可能な場合は stateCode を渡すことができます。 |
billingCompany 任意 | これは注文の請求先会社名です。 |
billingEmail 必須 | これは注文の請求先メールアドレスです。 |
billingName 必須 | これは注文の完全な請求先名です。 |
billingPhone 必須 | これは注文の請求先電話番号です。 |
items[index].orderGrandTotal 必須 | これは、買い物客が注文のために支払った合計金額（米ドル）です。カンマなし、ドル記号 “$” なし、2 桁の小数点で提供してください。例: 2102.99 |
items[index].orderNumber 必須 | これは新しく完了した注文の注文番号です。例: 854725421 |
paymentTypeCode 必須 | これは、買い物客が注文の支払いに使用した支払い方法です。例: PayPal または Visa または MC または AMEX または DISC |
prepaidDutyTax 必須 | 買い物客は輸入関税と税金を prepay することを選択しましたか、それとも強制的に prepay されましたか？その場合は true に設定し、そうでない場合は false に設定します。例: true または false |
shippingQuoteId 必須 | これは、買い物客が選択した配送見積もりの ID です。カートの詳細は、配送見積もりが取得されたときと同じである必要があります。カートの詳細が変更された場合は、買い物客の注文を完了する前に新しい配送見積もりを呼び出す必要があります。 |
shipToCompany 任意 | これは、発送された注文を受け取る個人の会社名です。 |
shipToEmail 必須 | これは、発送された注文を受け取る個人のメールアドレスです。 |
shipToName 必須 | これは、発送された注文を受け取る個人の完全な名前です。 |
shipToPhone 必須 | これは、発送された注文を受け取る個人の電話番号です。 |
HTTPS レスポンス
メッセージ形式: JSON
カナダとオーストラリアのみの例レスポンス
注意: 実際のレスポンスには、すべてのサポートされている国が含まれます。
例のレスポンス
1
2
3
4
5
6
7
{
"igOrderId": "e55a4efc-e615-49af-b3a4-afcda87e9e5e",
"deniedParty": {
"flagged": true,
"source": "source reference for review"
}
}
Response JSON 定義
| フィールド | ノート |
|---|---|
deniedParty | これは拒否された当事者スクリーニング結果のマップです。nullに設定されている場合、拒否された当事者スクリーニングは実行されていません。この問題に遭遇した場合は、あなたのZonos担当者に連絡してください。 |
deniedParty.flagged | この注文がZonosの拒否された当事者統合リストのレコードに一致したかどうかを示します。trueの場合、この注文を処理する前に確認してください。疑わしい場合は、trueにフラグ付けされた注文を処理しないでください。例の値: true または false |
deniedParty.source | フラグ付けされたフィールドがtrueに設定されている場合、このフィールドには、注文が拒否された当事者に一致した理由を確認するのに役立つソース参照が保持されます。 |
igOrderId | 新しく完了した注文のZonos識別子。例の値: e55a4efc-e615-49af-b3a4-afcda87e9e5e |
オーダー完了APIレガシー
レガシーオーダー完了APIの動作について学びましょう。オーダー完了エンドポイントは、ショッパーの注文の最終詳細を受け入れ、拒否された当事者のために注文の詳細をスクリーニングし、結果を返すとともにZonos特有の注文IDを返します。