如何使用WooCommerce API获取订单列表

在WooCommerce开发过程中，获取订单列表是管理订单数据、对接ERP系统、自动化发货和财务统计的重要基础操作。WooCommerce提供了完善的REST API，开发者可以通过API轻松获取订单信息，实现各类业务需求。本文会介绍如何使用WooCommerce API获取订单列表，包括API权限设置、调用示例和常见问题排查。

一、开启WooCommerce API功能

在调用WooCommerce API前，需要先确保API功能已开启并获取认证密钥。

登录WordPress后台
进入 WooCommerce → 设置 → 高级 → REST API

点击添加密钥
填写描述，选择用户（通常为管理员账户），权限选择读取/写入或仅读取

点击生成API密钥

系统会生成 Consumer Key 与 Consumer Secret，请妥善保存。

二、API认证方式

WooCommerce REST API基于 Basic Authentication，要通过用户名密码组合调用。用户名为 Consumer Key，密码为 Consumer Secret。

如果使用HTTPS，可以直接通过Basic Auth调用；如果是HTTP，需要安装Basic Auth插件支持。

三、获取订单列表的API端点

WooCommerce REST API获取订单列表的端点为：

GET /wp-json/wc/v3/orders

完整请求URL示例：

https://yourdomain.com/wp-json/wc/v3/orders

其中：

yourdomain.com 替换为你的站点域名
/wc/v3/ 表示WooCommerce API的版本路径

四、使用Postman测试API

以下为使用Postman调用WooCommerce订单列表API的步骤：

打开 Postman，点击 New → HTTP

输入请求名称，保存到 Collection

请求类型选择 GET
输入 URL： https://yourdomain.com/wp-json/wc/v3/orders

点击 Authorization 标签
Type 选择 Basic Auth
Username 填写 Consumer Key
Password 填写 Consumer Secret

点击 Send

如果认证成功，返回结果会是包含订单信息的JSON数组。

五、API参数与分页

WooCommerce API默认每页返回10条订单记录，可以使用下面的参数进行控制：

per_page：每页返回数量（最大100）
page：页码
status：按订单状态过滤，例如pending、processing、completed
orderby：排序字段，如date
order：排序方式，asc 或 desc

示例请求

获取状态为已完成的前20条订单列表：

GET https://yourdomain.com/wp-json/wc/v3/orders?status=completed&per_page=20

六、常见错误排查

1. 返回401 Unauthorized

确认API密钥正确
用户拥有管理员权限
使用HTTPS或安装Basic Auth插件

2. 返回空数组

检查店铺是否存在符合查询条件的订单
确保per_page和page参数设置正确

3. 返回 403 Forbidden

检查API用户权限是否包含读取权限
确认服务器没有拦截API请求（如CDN或防火墙限制）

结论

WooCommerce REST API为开发者提供了强大灵活的接口，通过上述方法可以轻松获取订单列表，进一步对接外部系统，构建自动化电商解决方案。熟悉API调用参数与分页规则，会帮助你在项目开发中实现更高效的数据交互与业务集成。

了解宝藏号的更多信息

订阅后即可通过电子邮件收到最新文章。

文章版权归作者所有，未经允许请勿转载。