端点
POST | https://api.iglobalstores.com/v1/orderNumbers
HTTPS 请求
| 字段↕ | 说明↕ |
|---|---|
| HTTP 方法 | POST |
| 端点 | https://api.iglobalstores.com/v1/orderNumbers |
| 协议 | HTTPS |
| 消息格式 | JSON |
| 接受 HTTP 头 | Accept: application/json |
| Content-Type HTTP 头 | Content-Type: application/json |
请求正文中的 JSON 键/值
消息格式：JSON
1
{2
"store": "999",3
"secret": "f5bde245-f55e-414d-b722-80b25161c12c",4
"sinceOrderId": "999-99999"5
}请求 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
"totalCount": 6,3
"orderCount": 5,4
"testOrderCount": 1,5
"orders": [6
{7
"testOrder": false,8
"id": "999-99991",9
"timestamp": "2015-01-01 00:33:14.0"10
},11
{12
"testOrder": true,13
"id": "999-99992",14
"timestamp": "2015-01-01 05:12:46.0"15
},16
{17
"testOrder": false,18
"id": "999-99993",19
"timestamp": "2015-01-01 14:50:54.0"20
},21
{22
"testOrder": false,23
"id": "999-99994",24
"timestamp": "2015-01-02 20:14:01.0"25
},26
{27
"testOrder": false,28
"id": "999-99995",29
"timestamp": "2015-01-02 20:57:47.0"30
},31
{32
"testOrder": false,33
"id": "999-99996",34
"timestamp": "2015-01-02 22:11:40.0"35
}36
]37
}错误 HTTP 响应
| 错误↕ | 含义↕ |
|---|---|
| 406 - Not Acceptable | HTML 实体。HTTP"Accept"头无效。 |
| 415 - Unsupported media type | HTML 实体。HTTP"Content-Type"头无效。 |
| 200 | "error":"could not parse input" |
| 200 | "error":"orderId: 999-99999 is not a valid orderId" |
| 200 | "error":"Parameter orderId or referenceId is required." |
| 200 | "error":"Cannot specify both Parameters orderId and referenceId." |
| 200 | "error":"Could not process order details." |
| 200 | "error":"Invalid security credentials" |
响应 JSON 定义
| 字段↕ | 说明↕ |
|---|---|
error | 当发生错误时，此参数才会出现在响应中，并将包含错误原因的描述。string |
orderCount | 检索到的实时订单的总数。integer |
order.testOrderCount | 检索到的测试订单的总数。integer |
orders | 订单映射列表。string |
orders[index].id | 完整的 Zonos 订单 ID，包括商店 ID 和破折号。string |
orders[index].merchantOrderId | 通过 updateMerchantOrderId API 服务端点与订单相关联的 MerchantOrderId。string |
orders[index].orderStatus | 订单的当前状态，可能的值。string |
orders[index].orderStatusDate | 代表上次更新状态时间的 epoch。integer |
orders[index].orderStatusDateString | 代表上次更新状态时间的时间戳（UTC/GMT）。timestamp |
orders[index].testOrder | 指示订单是"测试订单"还是"实时订单"。boolean |
orders[index].timestamp | 代表订单下达时间的时间戳（UTC/GMT）。timestamp |
totalCount | 检索到的实时订单和测试订单的总数。integer |
订单号
了解订单号端点的工作原理。orderNumbers端点用于安全地检索通过 Zonos Checkout 完成的订单号列表。它通常用于订单协调，以确保所有订单都已导入到特定日期或 orderID，以及日期范围内的订单。