端点
订单号
检索订单号列表。
订单详情
检索订单的详细信息。
检索订单 API 端点使用
有两种常见方式使用这些端点。
- (第 1 部分 + 第 2 部分) – 在您的域上使用自定义订单确认/成功页面来触发您的系统调用
orderDetail
端点并导入已完成的订单。此外,定期调用orderNumbers
端点以对账 Zonos 系统中未导入到您系统的任何订单。 - (仅第 2 部分) – 使用 Zonos 基本订单确认/成功页面或您域上的静态页面向客户指示订单已完成。安排您的系统定期调用
orderNumbers
端点,以确定何时有新订单准备导入到您的系统中。当找到未完成的订单时,调用orderDetail
端点以获取这些订单的数据。
第 1 部分:您域上的成功页面
每当买家在 Zonos Checkout 中完成订单时,他们会立即被重定向到订单成功页面 URL。已完成的订单 ID 将作为查询字符串附加到重定向 URL。订单成功页面的 URL 应提供给 Zonos。该 URL 也可以在创建 Zonos 系统中的临时购物车时作为参数传递给 createTempCart
端点。
示例: http://www.examplestore.com/internationalThankYou?orderId=999-99999
当客户被重定向到此页面时,您的系统需要从 URL 中解析 orderId
的值。然后,您将使用 orderId
调用 orderDetail
端点以检索订单数据。
第 2 部分:使用计划任务
除了在触发成功页面时调用订单详情外,我们建议您设置一个计划调用以获取所有订单及其详细信息作为补救措施。这样,您可以检索 Zonos 系统中尚未导入到您系统的任何已完成订单。
此过程应为计划任务/脚本,例如 Cron 任务,每小时/班次/天等运行一次(根据您的业务流程需要的频率安排)。该脚本应调用自上次调用订单以来发生的所有订单及其详细信息。orderNumbers
端点允许您检索 sinceOrderId
或 sinceDate
的订单,如此处 API 测试 GUI 所示。通过此计划调用检索的所有订单应与每次触发成功页面时插入到您系统中的订单进行对账。任何尚未在您系统中的订单应插入到您的系统中,并视为合法订单。
初始订单状态
IGLOBAL_ORDER_IN_PROCESS
或 IGLOBAL_FRAUD_REVIEW
在调用 orderDetail
端点时,我们建议您的系统首先检查订单数据的 orderStatus
属性。
不需要欺诈审查的订单将初始化为 orderStatus
: IGLOBAL_ORDER_IN_PROCESS
。处于此状态的订单准备好进行处理和发货。
需要欺诈审查的订单将初始化为 orderStatus
: IGLOBAL_FRAUD_REVIEW
。处于此状态的订单当前正在筛查和审查以防止欺诈。我们建议您将此订单放置在您的系统中的审查或保留状态,并继续调用 orderDetail
端点,直到订单通过 Zonos 的欺诈审查流程。
一旦 Zonos 的欺诈筛查流程完成,订单将转移到以下状态之一:
-
订单通过欺诈筛查
- 订单将转移到
orderStatus
:IGLOBAL_ORDER_IN_PROCESS
并可以继续发货。
- 订单将转移到
-
订单未通过欺诈筛查
- 订单将转移到
orderStatus
:IGLOBAL_ORDER_CANCELLED
并应在您的系统中取消。
- 订单将转移到
API 测试 GUI
请 联系支持 获取您的帐户凭据。
检索订单
检索订单号列表或有关订单的详细信息。
此“检索订单”API 端点用于检索 Zonos 系统内已完成订单的数据。响应将包含一个 JSON 对象,表示订单的所有可用信息,包括账单和运输地址、运输方式、订单总额和状态。