端点
POST | https://api.iglobalstores.com/v1/orderNumbers
HTTPS 请求
| 字段 | 备注 |
|---|---|
| HTTP 方法 | POST |
| 端点 | https://api.iglobalstores.com/v1/orderNumbers |
| 协议 | HTTPS |
| 消息格式 | JSON |
| 接受 HTTP 头 | Accept: application/json |
| 内容类型 HTTP 头 | Content-Type: application/json |
请求体中的 JSON 键/值
消息格式: JSON
示例请求: sinceOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceOrderId": "999-99999"
}
示例请求：sinceDate
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101"
}
示例请求：sinceDate, throughDate
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"throughDate": "20150601"
}
示例请求：missingMerchantOrderId
1
2
3
4
5
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"missingMerchantOrderId": true
}
示例请求：状态
1
2
3
4
5
6
{
"store": "999",
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",
"sinceDate": "20150101",
"statuses": true
}
请求 JSON 定义
| 字段 | 备注 |
|---|---|
missingMerchantOrderId 可选，如果传递另一个参数选项 | 此参数用于查询过去两周内缺少 merchantOrderId 的一组订单。当通过 updateMerchantOrderID API 端点提交 merchantOrderId 时，订单将不再出现在此查询中。boolean: true/false |
secret 必需 | 由 Zonos 提供的 API 密钥 GUID。string |
sinceDate 可选，如果传递 sinceOrderId 参数。 | 此参数用于查询特定日期之后的一组订单。sinceDate 和 sinceOrderId 不能同时发送。string - 日期 UTC/GMT；格式：yyyymmdd |
sinceOrderId 可选，如果传递 sinceDate / throughDate 参数 | Zonos 订单 ID，可以带或不带您的商店 ID 和连字符（示例：123-45678 或 45678）。注意：此参数将用于查询特定 Zonos 订单之后的一组订单。sinceDate 和 sinceOrderId 不能同时发送。integer / string |
statuses 可选 | 此参数用于在响应中包含当前订单状态和 merchantOrderId。如果在请求中存在此参数，无论其值如何，都将包含状态。boolean: true |
store 必需 | 由 Zonos 提供的商店 ID。integer |
throughDate 可选 | 此参数用于查询特定日期范围内的一组订单。必须与 sinceDate 参数一起传递。string - 日期 UTC/GMT；格式：yyyymmdd |
HTTPS 响应
消息格式：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
34
35
36
37
{
"totalCount": 6,
"orderCount": 5,
"testOrderCount": 1,
"orders": [
{
"testOrder": false,
"id": "999-99991",
"timestamp": "2015-01-01 00:33:14.0"
},
{
"testOrder": true,
"id": "999-99992",
"timestamp": "2015-01-01 05:12:46.0"
},
{
"testOrder": false,
"id": "999-99993",
"timestamp": "2015-01-01 14:50:54.0"
},
{
"testOrder": false,
"id": "999-99994",
"timestamp": "2015-01-02 20:14:01.0"
},
{
"testOrder": false,
"id": "999-99995",
"timestamp": "2015-01-02 20:57:47.0"
},
{
"testOrder": false,
"id": "999-99996",
"timestamp": "2015-01-02 22:11:40.0"
}
]
}
带有 'statuses' 参数的示例成功响应
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
{
"totalCount": 2,
"orderCount": 1,
"testOrderCount": 1,
"orders": [
{
"testOrder": false,
"id": "999-99991",
"timestamp": "2015-01-01 00:33:14.0",
"merchantOrderId": null,
"orderStatus": "IGLOBAL_FRAUD_REVIEW",
"orderStatusDate": 1420097594000,
"orderStatusDateString": "2015-01-01 14:16:17.0"
},
{
"testOrder": true,
"id": "999-99992",
"timestamp": "2015-01-01 05:12:46.0",
"merchantOrderId": "abc123",
"orderStatus": "IGLOBAL_ORDER_IN_PROCESS",
"orderStatusDate": 1420097594000,
"orderStatusDateString": "2015-01-01 14:16:17.0"
}
]
}
示例错误响应
1
2
3
{
"error": "Couldn't find order for sinceOrderId: 999999"
}
HTTP错误响应
| 错误 | 含义 |
|---|---|
| 406 - 不可接受 | HTML实体。HTTP “Accept”头无效。 |
| 415 - 不支持的媒体类型 | HTML实体。HTTP “Content-Type”头无效。 |
| 200 | “error”:”无法解析输入” |
| 200 | “error”:”orderId: 999-99999 不是有效的 orderId” |
| 200 | “error”:”参数 orderId 或 referenceId 是必需的。” |
| 200 | “error”:”不能同时指定参数 orderId 和 referenceId。” |
| 200 | “error”:”无法处理订单详情。” |
| 200 | “error”:”无效的安全凭证” |
响应 JSON 定义
| 字段 | 备注 |
|---|---|
error | 该参数仅在发生错误时出现在响应中，并将包含原因的描述。string |
orderCount | 检索到的有效订单的总数。integer |
order.testOrderCount | 检索到的测试订单的总数。integer |
orders | 订单映射的列表。string |
orders[index].id | 包含商店 ID 和破折号的完整 Zonos 订单 ID。string |
orders[index].merchantOrderId | 通过 updateMerchantOrderId API 服务端点与订单关联的 MerchantOrderId。string |
orders[index].orderStatus | 当前订单状态的可能值。string |
orders[index].orderStatusDate | 表示状态最后更新时的纪元。integer |
orders[index].orderStatusDateString | 表示状态最后更新时的 UTC/GMT 时间戳。timestamp |
orders[index].testOrder | 指示订单是“测试订单”还是“有效订单”。boolean |
orders[index].timestamp | 表示订单在 UTC/GMT 中下单时的时间戳。timestamp |
totalCount | 检索到的有效和测试订单的总数。integer |
订单号
了解订单号端点的工作原理。orderNumbers端点用于安全地检索通过Zonos Checkout 完成的订单号列表。它通常用于订单对账，以确保所有订单在特定日期或订单ID时已被导入，以及在日期范围内的订单。