端点
请求订单完成详情
POST | https://api.iglobalstores.com/2.0/order-completed - 创建一个新的请求以获取与已完成订单相关的信息。
HTTPS 请求
| 字段 | 备注 |
|---|---|
| HTTP 方法 | POST |
| 端点 URL | https://api.iglobalstores.com/2.0/order-completed |
| 协议 | HTTPS |
| 消息格式 | JSON |
| 接受 HTTP 头 | Accept: application/json |
| 安全令牌 HTTP 头 | serviceToken: your-test-token-value在您的 HTTPS 请求中添加一个名为 serviceToken 的头，值为您的测试安全 API 令牌。（请联系您的客户经理以获取此令牌。） |
| 内容类型 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 必填 | 这是购物者为其订单支付的总金额，单位为美元（USD）。请提供不带逗号、不带美元符号“$”且保留两位小数。例如值：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"
}
}
响应 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。