订单列表

提供订单列表的多条件筛选查询能力，支持通过订单状态、支付状态、下单时间等条件筛选订单，并以分页形式返回符合条件的订单列表及详情，适用于批量管理和查询订单的场景。

适用场景

按订单状态（如待支付、已支付）筛选订单

按支付状态（如支付成功、支付失败）查询订单

按时间范围筛选特定时段内创建的订单

批量获取订单的基本信息和商品明细

接口类型

POST

请求频率限制

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

请求说明

请求URL

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

请求参数

Header参数

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

Body参数

根字段

参数名	类型	必填	默认值	说明
status	string	否	-	订单状态枚举值，如： - unpaid：未支付 - paid：已支付 - cancelled：已取消 - shipped：已发货
pay_status	integer	否	-	支付状态： - 0：待支付 - 1：支付成功 - 2：支付失败
created_at	array	否	-	下单时间范围，格式：[开始时间, 结束时间]，时间格式为yyyy-MM-dd HH:mm:ss
page	integer	否	1	当前页码，默认1
size	integer	否	20	每页条数，默认20

响应字段说明

成功响应（HTTP 200）

根字段

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

data对象字段

字段	类型	说明
data	array	订单列表（当前页数据）
total	integer	符合条件的订单总条数
page	integer	当前页码
size	integer	每页条数
numPage	integer	总页数

data.data数组字段

字段	类型	说明
order_id	integer	订单ID
number	string	西月订单号
status	string	订单状态枚举值
status_format	string	订单状态中文描述（如：待支付）
products	array	订单商品列表
quantity	integer	订单商品总数量
total	string	订单总金额（未格式化）
total_format	string	订单总金额（带货币符号，如：￥50.00）
total_original	string	订单原价（未格式化）
total_original_format	string	订单原价（带货币符号）
currency_code	string	货币编码（如：CNY）
pay_status	integer	支付状态（0:待支付，1:支付成功，2:支付失败）
created_at	string	下单时间（格式：yyyy-MM-dd HH:mm:ss）
updated_at	string	更新时间（格式：yyyy-MM-dd HH:mm:ss）
delivery_region_name	string	发货区域名称
delivery_mode_name	string	配送模式（如：快递配送）
name_supplier	string	收件人姓名
contact_number	string	收件人电话
seller_order_no	string	商家订单号
detpName	string	商品仓库名称
has_after_sale	integer	是否有售后（0:无，1:有）

products数组字段

字段	类型	说明
product_sku	string	商品SKU编码
name	string	商品名称
image	string	商品图片URL
quantity	integer	商品数量
price	string	商品单价（未格式化）
price_format	string	商品单价（带货币符号）
subtotal	integer	商品小计金额（未格式化）
subtotal_format	string	商品小计金额（带货币符号）
delivery_region_name	string	商品发货区域名称
after_sale_status_label	string	商品售后状态（如：未售后）

调用示例

URL请求

请求示例

{
    "status": "unpaid",
    "pay_status": 0,
    "created_at": [
        "2025-01-17 14:06:25",
        "2035-01-17 23:59:59"
    ],
    "page": 1,
    "size": 1
}

成功返回示例

{
    "code": 0,
    "msg": "",
    "data": {
        "data": [
            {
                "order_id": 1841982,
                "number": "aOP2505071626702",
                "status": "unpaid",
                "order_product": [
                    {
                        "id": 1963212,
                        "product_id": 100,
                        "image": "https://westmonth/SKUDatum/old/cbsft114yy02-一盒12pcs/mainpicture/cbsft114yy02-一盒12pcs-001.jpg",
                        "name": "South Moon 艾蒿臂贴 手臂和腿部天然草药艾灸贴",
                        "quantity": 1,
                        "price": "5.00",
                        "price_format": "￥5.00",
                        "subtotal": 5,
                        "subtotal_format": "￥5.00",
                        "product_sku": "cbsft114yy02-一盒12pcs",
                        "delivery_region_id": 5,
                        "delivery_region_name": "中国",
                        "after_sale_id": 0,
                        "after_sale_status": "default_status",
                        "after_sale_status_label": "未售后"
                    }
                ],
                "order_product_first_id": 1963212,
                "quantity": 1,
                "total": "50.00",
                "total_original": "45.00",
                "total_format": "￥50.00",
                "total_original_format": "￥45.00",
                "currency_code": "CNY",
                "currency_value": "1",
                "pay_status": 0,
                "created_at": "2025-05-07 16:13:53",
                "updated_at": "2025-05-07 18:21:31",
                "delivery_region_id": 5,
                "delivery_region_name": "中国",
                "trade_platforms": 0,
                "products": [
                    {
                        "id": 1963212,
                        "product_id": 100,
                        "image": "https://westmonth/SKUDatum/old/cbsft114yy02-一盒12pcs/mainpicture/cbsft114yy02-一盒12pcs-001.jpg",
                        "name": "South Moon 艾蒿臂贴 手臂和腿部天然草药艾灸贴",
                        "quantity": 1,
                        "price": "5.00",
                        "price_format": "￥5.00",
                        "subtotal": 5,
                        "subtotal_format": "￥5.00",
                        "product_sku": "cbsft114yy02-一盒12pcs",
                        "delivery_region_id": 5,
                        "delivery_region_name": "中国",
                        "after_sale_id": 0,
                        "after_sale_status": "default_status",
                        "after_sale_status_label": "未售后"
                    }
                ],
                "delivery_mode_name": "快递配送",
                "name_supplier": "Stacie R. Sheppard",
                "contact_number": "18965213578",
                "seller_order_no": "576722608781890541",
                "entrepot": [],
                "platform_name": null,
                "detpName": "中国仓",
                "status_format": "待支付",
                "after_status": 0,
                "pay_trade_no": "",
                "shop_relation": null,
                "ring_stock_id": 0,
                "ring_stock_type": "",
                "ring_stock_type_name": "",
                "shop_name": "xxxxxx",
                "reorder": 0,
                "is_receipt": 0,
                "is_upload_receipt": 0,
                "shipments": "",
                "express_company": "",
                "express_number": "",
                "has_after_sale": 0
            }
        ],
        "total": 3,
        "page": 1,
        "size": 1,
        "numPage": 3
    }
}

失败返回示例

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

错误处理

公共错误码

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

常见问题

Q1：如何查询最近7天内支付成功的订单？

A：传入参数：

{
  "status": "paid",
  "pay_status": 1,
  "created_at": ["2025-07-02 00:00:00", "2025-07-09 23:59:59"],
  "page": 1,
  "size": 20
}

Q2：如何判断订单是否有售后？

A：通过has_after_sale字段判断，1表示有售后，0表示无售后；也可查看products数组中的after_sale_status_label字段，了解具体商品的售后状态。

版本历史

版本	日期	修改说明
v1.0	2025-02-01	初始版本，支持订单列表查询

application/json

Bodyapplication/json

示例

{
    "code": 0,
    "msg": "",
    "data": {
        "data": [
            {
                "order_id": 1841982,
                "number": "aOP2505071626702",
                "status": "unpaid",
                "order_product": [
                    {
                        "id": 1963212,
                        "product_id": 100,
                        "image": "https://westmonth/SKUDatum/old/cbsft114yy02-一盒12pcs/mainpicture/cbsft114yy02-一盒12pcs-001.jpg",
                        "name": "South Moon 艾蒿臂贴 手臂和腿部天然草药艾灸贴",
                        "quantity": 1,
                        "price": "5.00",
                        "price_format": "￥5.00",
                        "subtotal": 5,
                        "subtotal_format": "￥5.00",
                        "product_sku": "cbsft114yy02-一盒12pcs",
                        "delivery_region_id": 5,
                        "delivery_region_name": "中国",
                        "after_sale_id": 0,
                        "after_sale_status": "default_status",
                        "after_sale_status_label": "未售后"
                    }
                ],
                "order_product_first_id": 1963212,
                "quantity": 1,
                "total": "50.00",
                "total_original": "45.00",
                "total_format": "￥50.00",
                "total_original_format": "￥45.00",
                "currency_code": "CNY",
                "currency_value": "1",
                "pay_status": 0,
                "created_at": "2025-05-07 16:13:53",
                "updated_at": "2025-05-07 18:21:31",
                "delivery_region_id": 5,
                "delivery_region_name": "中国",
                "trade_platforms": 0,
                "products": [
                    {
                        "id": 1963212,
                        "product_id": 100,
                        "image": "https://westmonth/SKUDatum/old/cbsft114yy02-一盒12pcs/mainpicture/cbsft114yy02-一盒12pcs-001.jpg",
                        "name": "South Moon 艾蒿臂贴 手臂和腿部天然草药艾灸贴",
                        "quantity": 1,
                        "price": "5.00",
                        "price_format": "￥5.00",
                        "subtotal": 5,
                        "subtotal_format": "￥5.00",
                        "product_sku": "cbsft114yy02-一盒12pcs",
                        "delivery_region_id": 5,
                        "delivery_region_name": "中国",
                        "after_sale_id": 0,
                        "after_sale_status": "default_status",
                        "after_sale_status_label": "未售后"
                    }
                ],
                "delivery_mode_name": "快递配送",
                "name_supplier": "Stacie R. Sheppard",
                "contact_number": "18965213578",
                "seller_order_no": "576722608781890541",
                "entrepot": [],
                "platform_name": null,
                "detpName": "中国仓",
                "status_format": "待支付",
                "after_status": 0,
                "pay_trade_no": "",
                "shop_relation": null,
                "ring_stock_id": 0,
                "ring_stock_type": "",
                "ring_stock_type_name": "",
                "shop_name": "xxxxxx",
                "reorder": 0,
                "is_receipt": 0,
                "is_upload_receipt": 0,
                "shipments": "",
                "express_company": "",
                "express_number": "",
                "has_after_sale": 0
            }
        ],
        "total": 3,
        "page": 1,
        "size": 1,
        "numPage": 3
    }
}

订单列表

订单列表

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Body参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

常见问题

Q1：如何查询最近7天内支付成功的订单？

Q2：如何判断订单是否有售后？

版本历史

请求参数

请求示例代码

返回响应

订单列表

订单列表#

适用场景#

接口类型#

请求频率限制#

请求说明#

请求参数#

Header参数#

Body参数#

响应字段说明#

调用示例#

URL请求#

请求示例#

成功返回示例#

失败返回示例#

错误处理#

常见问题#

Q1：如何查询最近7天内支付成功的订单？#

Q2：如何判断订单是否有售后？#

版本历史#

请求参数

请求示例代码

返回响应

订单列表

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Body参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

常见问题

Q1：如何查询最近7天内支付成功的订单？

Q2：如何判断订单是否有售后？

版本历史