当前订单状态值
以下是订单可能具有的当前订单状态的列表。
注意 - Zonos可能随时添加更多状态；您的系统应该能够应对额外状态的出现。
生产环境中的状态将保留在生产环境中。Zonos永远不会删除现有状态。
| 状态↕ | 描述↕ | 可设置者↕ |
|---|---|---|
| IGLOBAL_FRAUD_REVIEW | 订单目前正在接受iGlobal的欺诈审查。 | Zonos |
| IGLOBAL_ORDER_IN_PROCESS | 订单有效且已准备好处理。 | Zonos |
| IGLOBAL_ORDER_ON_HOLD | 订单目前处于临时状态保留。 | Zonos |
| IGLOBAL_ORDER_CANCELLED | 订单已在iGlobal系统中取消。 | Zonos |
| VENDOR_PREPARING_ORDER | 卖方已标记订单为准备中。 | 卖方 |
| VENDOR_SHIPMENT_READY | 卖方已标记订单已准备好配送。 | 卖方 |
| VENDOR_LABELS_PRINTED_DATE | 卖方已打印配送标签。 | 卖方 |
| VENDOR_CANCELLATION_REQUEST | 订单已被请求取消。 | 卖方 |
| VENDOR_END_OF_DAY_COMPLETE | 订单已完成且生效。 | 卖方 |
当订单处于以下订单状态之一时，卖方不能更新
vendorOrderStatus：IGLOBAL_LABELS_PROCESSINGIGLOBAL_ORDER_ON_HOLDIGLOBAL_FRAUD_REVIEWIGLOBAL_ORDER_CANCELLEDVENDOR_CANCELLATION_REQUESTVENDOR_END_OF_DAY_COMPLETE
HTTPS请求
POST | https://api.iglobalstores.com/v1/updateVendorOrderStatus
| 字段↕ | 值↕ |
|---|---|
| HTTP方法 | POST |
| 端点URL | https://api.iglobalstores.com/v1/updateVendorOrderStatus |
| 协议 | HTTPS |
| 消息格式 | JSON |
| Accept 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
"orderId": "999-9999",5
"orderStatus": "VENDOR_END_OF_DAY_COMPLETE"6
}请求JSON定义
| 字段↕ | 说明↕ |
|---|---|
orderId 必需 | Zonos订单ID可以与或不与您的商店ID和连字符一起传递（示例：123-45678或45678）。订单完成和支付后，客户将被重定向到您域上托管的订单完成/订单感谢页面。URL将包含一个查询字符串参数orderID，其中将包含此值。integer / string |
orderStatus 必需 | 此字段用于使用订单的新状态更新Zonos系统。以下订单状态可通过此API设置。- VENDOR_PREPARING_ORDER |
VENDOR_SHIPMENT_READYVENDOR_LABELS_PRINTEDVENDOR_END_OF_DAY_COMPLETEVENDOR_CANCELLATION_REQUEST``string| |secret必需 | Zonos提供的API秘密GUID。string| |store必需 | Zonos提供的商店ID。integer|
HTTPS响应
消息格式：JSON
1
{2
"success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"3
}错误HTTP响应
| HTTP响应代码↕ | 响应体示例/描述↕ |
|---|---|
| 406 - 不可接受 | HTML实体。HTTP"Accept"头无效。 |
| 415 - 不支持的媒体类型 | HTML实体。HTTP"Content-Type"头无效。 |
| 200 | "error":"could not parse input" |
| 200 | "error":"Parameter orderId required for updateVendorOrderStatus" |
| 200 | "error":"Parameter orderStatus required for updateVendorOrderStatus." |
| 200 | "error":"orderId: 999-99999 is not a valid orderId" |
| 200 | "error":"Could not retrieve order to updateVendorOrderStatus from orderId: 999-99999" |
| 200 | "error":"OrderId: 999-99999 has already been cancelled and status cannot be updated." |
| 200 | "error":"Cannot update order status to status: VENDOR_CANCELLATION_REQUEST" |
| 200 | "error":"Cannot update order status to invalid status: NEW_ORDER_STATUS" |
| 200 | "error":"OrderId: 999-99999 already has current status: VENDOR_SHIPMENT_READY" |
| 200 | "error":"OrderId: 999-99999 cannot be moved to order status: VENDOR_CANCELLATION_REQUEST while in status: VENDOR_END_OF_DAY_COMPLETE" |
| 200 | "error":"New Status: NEW_ORDER_STATUS is not a valid order status" |
| 200 | "error":"Could not process updateVendorOrderStatus." |
| 200 | "error":"Invalid security credentials" |
响应JSON定义
| 消息↕ | 定义↕ |
|---|---|
success | 此参数将包含更新的摘要。string |
error | 此参数仅在发生错误时显示在响应中，将包含原因的描述。string |
更新订单状态
了解更新订单状态端点的工作原理。updateVendorOrderStatus端点用于更新Zonos系统内订单的订单状态。这将用于以编程方式更新订单的配送状态或请求取消。