DOCS

检索订单

检索订单

检索订单号列表或订单的详细信息。

此"检索订单"API 端点用于检索 Zonos 系统中已完成订单的数据。响应将包含一个 JSON 对象,表示订单的所有可用信息,包括账单和配送地址、配送方法、订单总计和状态。

端点 

订单号

检索订单号列表。

订单详情

检索订单的详细信息。

检索订单 API 端点用法

使用这些端点有两种常见方式。

  1. (第 1 部分 + 第 2 部分)– 在您的域上使用自定义订单确认/成功页面,触发您的系统调用 orderDetail 端点并导入已完成的订单。此外,定期调用 orderNumbers 端点,以调和 Zonos 系统中未导入到您系统的任何订单。
  2. (仅第 2 部分)– 使用 Zonos 基本订单确认/成功页面或您域上的静态页面向客户指示订单完成。安排您的系统定期调用 orderNumbers 端点,以确定何时有新订单准备好导入您的系统。找到待处理订单时,调用 orderDetail 端点以获取这些订单的数据。

第 1 部分:您域上的成功页面

每次买家在 Zonos Checkout 中完成订单时,他们都会立即被重定向到订单成功页面 URL。已完成的订单 ID 将作为查询字符串附加到重定向 URL。订单成功页面的 URL 应提供给 Zonos。创建 Zonos 系统中的临时购物车时,URL 也可以作为参数传递给 createTempCart 端点。

示例:http://www.examplestore.com/internationalThankYou?orderId=999-99999

当客户被重定向到此页面时,您的系统需要从 URL 解析 orderId 的值。然后,您将使用 orderId 调用 orderDetail 端点来检索订单数据。

第 2 部分:使用计划作业

除了在触发成功页面时调用订单详情外,我们建议您设置一个计划调用,以获取所有订单及其详情作为万能方案。这样,您可以检索 Zonos 系统中尚未导入到您系统的任何已完成订单。

此过程应该是一个计划作业/脚本,例如 Cron 作业,每小时/班次/天等运行一次(根据您的业务流程需要的频率安排)。该脚本应调用自上次调用订单以来发生的所有订单及其详情。orderNumbers 端点允许您检索 sinceOrderIdsinceDate 订单,如此处位置的 API 测试 GUI 所演示的那样。通过此计划调用检索的所有订单应与每次触发成功页面时插入到您系统中的订单进行协调。任何不在您系统中的订单都应插入您的系统并视为合法订单。

初始订单状态

IGLOBAL_ORDER_IN_PROCESSIGLOBAL_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

联系支持以获取您的账户凭据。

预约演示

这个页面有帮助吗?


在此页面: