DOCS

Update order status

/

更新订单状态

了解更新订单状态的端点如何工作。

updateVendorOrderStatus端点用于更新Zonos系统中订单的状态。这将用于以编程方式更新订单的运输状态或请求取消。

当前订单状态值 

以下是订单可能具有的当前状态列表。

注意 - 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
端点URLhttps://api.iglobalstores.com/v1/updateVendorOrderStatus
协议HTTPS
消息格式JSON
接受HTTP头Accept: application/json
Content-Type HTTP头Content-Type: application/json

请求体中的JSON键/值对

消息格式:JSON

示例

1
2
3
4
5
6
{
  "store": "999",
  "secret": "f5bde245-f55e-414d-b722-80b25161c12c",
  "orderId": "999-9999",
  "orderStatus": "VENDOR_END_OF_DAY_COMPLETE"
}

请求 JSON 定义

字段备注
orderId 必填Zonos 订单 ID 可以带或不带您的商店 ID 和连字符(示例:123-45678 或 45678)。订单完成和付款后,客户将被重定向到托管在您域上的订单完成/感谢页面。URL 将包含一个查询字符串参数 orderID,该参数将包含此值。integer / string
orderStatus 必填此字段用于更新 Zonos 系统中的订单新状态。以下订单状态可以通过此 API 设置。- VENDOR_PREPARING_ORDER
  • VENDOR_SHIPMENT_READY
  • VENDOR_LABELS_PRINTED
  • VENDOR_END_OF_DAY_COMPLETE
  • VENDOR_CANCELLATION_REQUEST string | | secret 必填 | 由 Zonos 提供的 API 秘密 GUID。string | | store 必填 | 由 Zonos 提供的商店 ID。integer |

HTTPS 响应

消息格式:JSON

示例成功响应

1
2
3
{
  "success": "Updated Order: 99999 to new order status: VENDOR_PREPARING_ORDER"
}

示例错误响应

1
2
3
{
  "error": "OrderId: 99999 cannot be moved to order status: VENDOR_PREPARING_ORDER while in status: IGLOBAL_FRAUD_REVIEW"
}

HTTP错误响应

HTTP响应代码响应体示例/描述
406 - 不可接受HTML实体。HTTP “Accept”头无效。
415 - 不支持的媒体类型HTML实体。HTTP “Content-Type”头无效。
200“error”:“无法解析输入”
200“error”:“更新VendorOrderStatus所需的参数orderId”
200“error”:“更新VendorOrderStatus所需的参数orderStatus。”
200“error”:“orderId: 999-99999 不是有效的orderId”
200“error”:“无法从orderId: 999-99999检索订单以更新VendorOrderStatus”
200“error”:“OrderId: 999-99999 已被取消,状态无法更新。”
200“error”:“无法将订单状态更新为状态: VENDOR_CANCELLATION_REQUEST”
200“error”:“无法将订单状态更新为无效状态: NEW_ORDER_STATUS”
200“error”:“OrderId: 999-99999 当前状态为: VENDOR_SHIPMENT_READY”
200“error”:“OrderId: 999-99999 在状态: VENDOR_END_OF_DAY_COMPLETE 时无法移动到订单状态: VENDOR_CANCELLATION_REQUEST”
200“error”:“新状态: NEW_ORDER_STATUS 不是有效的订单状态”
200“error”:“无法处理更新VendorOrderStatus。”
200“error”:“无效的安全凭证”

响应JSON定义

消息定义
success此参数将包含更新的摘要。string
error此参数仅在发生错误时出现在响应中,并将包含原因的描述。string

这个页面有帮助吗?


有问题吗?

联系我们。
在本页上: