订单状态

提供订单状态的批量查询能力，支持按订单号列表或时间范围筛选订单，返回订单的状态信息、金额明细、物流状态等关键数据，适用于订单状态追踪和管理场景。

适用场景

批量查询订单的当前状态（如待支付、已发货等）

按时间范围筛选特定时段内更新的订单

获取订单的支付状态、物流推送状态等明细

分析订单的金额构成（商品总价、运费等）

接口类型

POST

请求频率限制

默认频率：以平台配额为准

请求说明

请求URL

正式环境：https://www.westmonth.com/openapi/v2/order/status
测试环境：https://testing.westmonth.com/openapi/v2/order/status

请求参数

Header参数

参数名	类型	必填	示例值	说明
Authorization	string	是	authorization	身份验证Token
Content-Type	string	是	application/json	建议固定传此值

Body参数

根字段

参数名	类型	必填	默认值	说明
type	integer	是	-	订单类型，固定传4
order_numbers	array	否	-	订单号列表（西月订单号），用于精准查询特定订单
start_time	string	否	-	更新时间开始（格式：yyyy-MM-dd HH:mm:ss），用于筛选时段内的订单
end_time	string	否	-	更新时间结束（格式：yyyy-MM-dd HH:mm:ss），与start_time配合使用
page	integer	否	1	当前页数，默认1
per_page	integer	否	10	每页条数，默认10

响应字段说明

成功响应（HTTP 200）

根字段

字段	类型	说明
code	integer	业务状态码（0表示成功）
msg	string	提示信息（成功时为空）
data	object	业务数据（分页结构）

data对象字段

字段	类型	说明
current_page	integer	当前页码
data	array	订单状态列表（当前页数据）
first_page_url	string	第一页URL
from	integer	起始记录位置
next_page_url	string/null	下一页URL（无下一页时为null）
path	string	接口基础路径
per_page	integer	每页条数
prev_page_url	string/null	上一页URL（无下一页时为null）
to	integer	结束记录位置

data.data数组字段

字段	类型	说明
id	integer	订单ID
type	integer	订单类型（固定为4）
number	string	西月订单号
customer_id	integer	客户ID
status	string	订单状态标识（如：unpaid、shipped）
total	string	总金额（未格式化）
total_original	string	原价总金额（未格式化）
pay_amount	string	实付金额
pay_status	integer	支付状态（0:待支付，1:支付成功，2:支付失败）
pay_time	string	支付时间（格式：yyyy-MM-dd HH:mm:ss）
currency_code	string	货币编码（如：CNY）
currency_value	string	当前汇率
trade_platforms	integer	支付平台（1：微信，2：支付宝，3：额度支付，4：货到付款）
push_status	integer	聚水潭上传状态（0:未上传，1:成功，2:失败）
outbound_status	integer	海外仓出库单推送状态（0:未上传，1:成功，2:失败，3:作废）
delivery_mode	integer	配送模式（0:快递配送，1:第三方物流自提，2:个人自提）
seller_order_no	string	平台订单号
shipment_no	string	物流单号
logistics_company_id	integer	物流公司ID
created_at	string	创建时间
updated_at	string	更新时间
skus	array	商品SKU列表
logistics_company_name	string	物流公司名称
logistics_company_code	string	物流公司编码
status_format	string	订单状态中文描述（如：待支付）
total_format	string	总金额（格式化，含货币符号）
outbound_status_format	string	海外仓出库单状态描述（如：未上传）
push_status_format	string	聚水潭上传状态描述（如：未推送）
trade_platforms_name	string	支付平台名称（如：微信支付）
type_format	string	订单类型描述（如：外部订单）
freight	string	运费（格式化）
delivery_mode_name	string	配送模式名称（如：快递配送）
product_total	string	商品总价（格式化）
freight_num	integer	运费金额（数字，未格式化）

skus数组字段

字段	类型	说明
product_sku	string	SKU编码
depot_id	integer	仓库ID
depost_name	string	仓库名称
delivery_region_id	integer	发货区域ID
region_name	string	发货区域名称
price_format	string	单价（格式化）
total_price_format	string	总价（格式化）
after_sale_status_label	string	售后状态（如：未售后）

调用示例

URL请求

请求示例

{
	"order_numbers": [
		"aOP2505071626702"
	],
	"type": 4,
	"start_time": "",
	"end_time": "",
	"page": 1,
	"per_page": 10
}

成功返回示例

{
    "code": 0,
    "msg": "",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 1841982,
                "type": 4,
                "number": "aOP2505071626702",
                "customer_id": 880,
                "status": "unpaid",
                "total": "45.00",
                "total_original": "45.00",
                "pay_amount": "0.00",
                "pay_status": 0,
                "pay_time": "2025-05-07 16:13:57",
                "currency_code": "CNY",
                "currency_value": "1",
                "trade_platforms": 0,
                "o_id": 0,
                "push_status": 0,
                "outbound_status": 0,
                "shipping_method_code": "",
                "shipping_method_name": "",
                "delivery_mode": 0,
                "seller_order_no": "576722608781890541",
                "shipment_no": "",
                "logistics_company_id": 0,
                "created_at": "2025-05-07 16:13:53",
                "updated_at": "2025-05-07 16:13:53",
                "latest_log_outbound": null,
                "latest_log_pool": null,
                "error_msg": "",
                "skus": [
                    {
                        "product_sku": "cbsft114yy02-一盒12pcs",
                        "depot_id": 5,
                        "depost_name": "中国仓",
                        "delivery_region_id": 5,
                        "region_name": "中国",
                        "price_format": "￥0.00",
                        "total_price_format": "￥0.00",
                        "subtotal_format": "￥0.00",
                        "after_sale_status_label": "未售后"
                    }
                ],
                "logistics_company_name": "",
                "logistics_company_code": "",
                "status_format": "待支付",
                "total_format": "￥45.00",
                "total_original_format": "￥45.00",
                "outbound_status_format": "未上传",
                "push_status_format": "未推送",
                "pay_time_format": "",
                "trade_platforms_name": "",
                "type_format": "外部订单",
                "freight": "￥40.00",
                "delivery_mode_name": "快递配送",
                "product_total": "￥5.00",
                "subarea_name": "",
                "platform_name": "",
                "freight_num": 40
            }
        ],
        "first_page_url": "http://westmoon.io/openapi/v2/order/status?page=1",
        "from": 1,
        "next_page_url": null,
        "path": "http://westmoon.io/openapi/v2/order/status",
        "per_page": 10,
        "prev_page_url": null,
        "to": 1
    }
}

失败返回示例

{
    "code": 3,
    "msg": "授权无效 authorization timestamp error",
    "data": []
}

错误处理

公共错误码

HTTP status code	错误码	错误信息	描述

常见问题

Q1：如何查询最近3天内更新的订单？

A：传入start_time（3天前的时间）和end_time（当前时间），如：{"type":4, "start_time":"2025-07-06 00:00:00", "end_time":"2025-07-09 23:59:59"}。

Q2：push_status和outbound_status分别表示什么？

A：push_status是订单向聚水潭ERP系统的上传状态；outbound_status是向海外仓推送出库单的状态，两者用于追踪订单的系统同步情况。

Q3：如何区分不同的配送模式？

A：通过delivery_mode（数字）或delivery_mode_name（中文名称）字段判断，0对应快递配送，1对应第三方物流自提，2对应个人自提。

版本历史

版本	日期	修改说明
v1.0	2025-01-05	初始版本，支持订单状态查询

application/json

Bodyapplication/json

示例

{
    "code": 0,
    "msg": "",
    "data": {
        "current_page": 1,
        "data": [
            {
                "id": 1841982,
                "type": 4,
                "number": "aOP2505071626702",
                "customer_id": 880,
                "status": "unpaid",
                "total": "45.00",
                "total_original": "45.00",
                "pay_amount": "0.00",
                "pay_status": 0,
                "pay_time": "2025-05-07 16:13:57",
                "currency_code": "CNY",
                "currency_value": "1",
                "trade_platforms": 0,
                "o_id": 0,
                "push_status": 0,
                "outbound_status": 0,
                "shipping_method_code": "",
                "shipping_method_name": "",
                "delivery_mode": 0,
                "seller_order_no": "576722608781890541",
                "shipment_no": "",
                "logistics_company_id": 0,
                "created_at": "2025-05-07 16:13:53",
                "updated_at": "2025-05-07 16:13:53",
                "latest_log_outbound": null,
                "latest_log_pool": null,
                "error_msg": "",
                "skus": [
                    {
                        "product_sku": "cbsft114yy02-一盒12pcs",
                        "depot_id": 5,
                        "depost_name": "中国仓",
                        "delivery_region_id": 5,
                        "region_name": "中国",
                        "price_format": "￥0.00",
                        "total_price_format": "￥0.00",
                        "subtotal_format": "￥0.00",
                        "after_sale_status_label": "未售后"
                    }
                ],
                "logistics_company_name": "",
                "logistics_company_code": "",
                "status_format": "待支付",
                "total_format": "￥45.00",
                "total_original_format": "￥45.00",
                "outbound_status_format": "未上传",
                "push_status_format": "未推送",
                "pay_time_format": "",
                "trade_platforms_name": "",
                "type_format": "外部订单",
                "freight": "￥40.00",
                "delivery_mode_name": "快递配送",
                "product_total": "￥5.00",
                "subarea_name": "",
                "platform_name": "",
                "freight_num": 40
            }
        ],
        "first_page_url": "http://westmoon.io/openapi/v2/order/status?page=1",
        "from": 1,
        "next_page_url": null,
        "path": "http://westmoon.io/openapi/v2/order/status",
        "per_page": 10,
        "prev_page_url": null,
        "to": 1
    }
}

订单状态

订单状态

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Body参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

常见问题

Q1：如何查询最近3天内更新的订单？

Q2：push_status和outbound_status分别表示什么？

Q3：如何区分不同的配送模式？

版本历史

请求参数

请求示例代码

返回响应

订单状态

订单状态#

适用场景#

接口类型#

请求频率限制#

请求说明#

请求参数#

Header参数#

Body参数#

响应字段说明#

调用示例#

URL请求#

请求示例#

成功返回示例#

失败返回示例#

错误处理#

常见问题#

Q1：如何查询最近3天内更新的订单？#

Q2：push_status和outbound_status分别表示什么？#

Q3：如何区分不同的配送模式？#

版本历史#

请求参数

请求示例代码

返回响应

订单状态

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Body参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

常见问题

Q1：如何查询最近3天内更新的订单？

Q2：push_status和outbound_status分别表示什么？

Q3：如何区分不同的配送模式？

版本历史