订单详情

提供订单的详细信息查询能力，支持通过西月订单号或平台订单号获取订单的基本信息、商品列表、物流信息等全面数据，适用于订单管理、详情展示及状态跟踪等场景。

适用场景

订单管理页面展示订单的完整信息（如商品明细、收货地址、支付状态）

客服查询订单详情以解答用户疑问

订单状态跟踪，确认订单是否支付、发货

数据分析时提取订单的各项属性（如商品种类、运费、支付方式等）

接口类型

GET

请求频率限制

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

请求说明

请求URL

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

请求参数

Header参数

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

Query参数

参数名	类型	必填	说明
order_no	string	否	西之月订单号（与seller_order_no二选一，不可同时存在）
seller_order_no	string	否	商家订单号（与order_no二选一，不可同时存在）

⚠️ 注意：order_no和seller_order_no必须填写其中一个，且不能同时填写。

响应字段说明

成功响应（HTTP 200）

根字段

字段	类型	说明
code	integer	业务状态码（0表示成功）
msg	string	提示信息（成功时为空）
data	array	订单详情列表（通常包含一个订单对象）

data数组字段

字段	类型	说明
order_id	integer	订单ID（系统内部标识）
order_number	string	西之月订单号（与请求参数order_no一致）
place_order_time	string	下单时间（格式：YYYY-MM-DD HH:MM:SS）
status	string	订单状态枚举值（如：unpaid=未支付，paid=已支付，shipped=已发货）
order_status	string	订单状态中文描述（如：待支付、已支付、已发货）
customer_name	string	收件人姓名
phone	string	收件人电话
address	string	收件人完整地址（包含国家、省/州、城市、详细地址）
mode_payment	string	支付方式
pay_time	string	支付时间
postcode	string	邮编
order_products	array	订单包含的商品列表
amount_payable	string	应付总金额（含商品金额和运费，带货币符号）
trade_platforms	string	支付平台，1：微信，2：支付宝，3：额度支付，4：货到付款
sub_total	string	商品总金额（带货币符号）
freight	string	运费（带货币符号）
comment	string	评论
delivery_mode_name	string	配送方式（快递配送、第三方物流自提、个人自提）
name_supplier	string	提货人姓名
contact_number	string	联系电话
seller_order_no	string	商家订单号（与请求参数seller_order_no一致）
platform_name	string	平台名称
logistics_company_name	string	物流公司中文名称（第三方物流自提返回）
logistics_company_name_en	string	物流公司英文名称（第三方物流自提返回）
logistics_company_code	string	物流公司编码（第三方物流自提返回）
shipment_no	string	第三方物流单号
shipments	array	物流信息列表（已发货订单包含此项）

order_products数组字段

字段	类型	说明
product_sku	string	商品SKU编码
name	string	商品名称
image	string	商品图片URL
quantity	integer	购买数量
price	string	商品单价
subtotal	string	商品小计金额（单价×数量，带货币符号）
warehouses	object	发货仓库信息（包含地址、联系人等）
region	object	发货区域信息（包含区域名称、编码等）

shipments数组字段

字段	类型	说明
express_company	string	快递公司名称
express_number	string	运单号（可用于物流跟踪）
status	integer	物流状态（0=运输中，1=已完成）
created_at	string	物流信息创建时间

调用示例

URL请求

请求示例

成功返回示例

{
  "code": 0,
  "msg": "",
  "data": [
    {
      "order_id": 1841982,
      "order_number": "aOP2505071626702",
      "place_order_time": "2025-05-07 16:13:53",
      "status": "unpaid",
      "order_status": "待支付",
      "customer_name": "Stacie R. Sheppard",
      "phone": "xxxx",
      "entrepot": [],
      "address": "United States ALABAMA Sylacauga , Alabama, Talladega, Sylacauga, / 301 S Broadway Ave",
      "mode_payment": "",
      "pay_time": "",
      "postcode": "35150",
      "order_products": [
        {
          "id": 1963212,
          "order_id": 1841982,
          "product_id": 100,
          "order_number": "aOP2505071626702",
          "order_shipment_id": 0,
          "shipped_at": null,
          "product_sku_delivery_region_id": 35791,
          "delivery_region_id": 5,
          "depot_id": 5,
          "product_sku": "cbsft114yy02-一盒12pcs",
          "name": "South Moon 艾蒿臂贴 手臂和腿部天然草药艾灸贴",
          "image": "https://westmonth/SKUDatum/old/cbsft114yy02-一盒12pcs/mainpicture/cbsft114yy02-一盒12pcs-001.jpg",
          "quantity": 1,
          "price": "5.00",
          "original_price": "5.00",
          "subtotal": "￥5.00",
          "original_subtotal": "5.00",
          "is_add": 0,
          "is_barter": 0,
          "is_split": 0,
          "is_merge": 0,
          "after_sale_id": 0,
          "after_sale_status": "default_status",
          "created_at": "2025-05-07 16:13:53",
          "updated_at": "2025-05-07 16:13:53",
          "deleted_at": null,
          "price_format": "￥5.00",
          "total_price_format": "￥0.00",
          "subtotal_format": "￥0.00",
          "after_sale_status_label": "未售后",
          "warehouses": {
            "id": 167,
            "depot_id": 5,
            "address": "广东省汕头市龙湖区练江中路工业大厦H7幢201号房之一",
            "contact_name": "西之月",
            "contact_phone": "13076369857",
            "postcode": "515000",
            "created_at": "2024-11-29T02:31:55.000000Z",
            "updated_at": "2024-11-29T02:31:55.000000Z"
          },
          "region": {
            "id": 5,
            "name": "中国",
            "code": "CN",
            "shop_id": 15632946,
            "wms_co_id": 0,
            "country_id": 44,
            "logo": "https://westmonth-test.oss-cn-shenzhen.aliyuncs.com/test/20250415150112204143.jpg",
            "sort": 99,
            "created_at": "2024-02-01 06:15:38",
            "updated_at": "2025-04-18 12:14:14",
            "deleted_at": null,
            "service_type": "1,2"
          }
        }
      ],
      "amount_payable": "￥45.00",
      "trade_platforms": 0,
      "sub_total": "￥5.00",
      "freight": "￥40.00",
      "comment": "买家备注",
      "delivery_mode_name": "快递配送",
      "name_supplier": "Stacie R. Sheppard",
      "contact_number": "18965213578",
      "seller_order_no": "576722608781890541",
      "platform_name": "",
      "logistics_company_name": "",
      "logistics_company_name_en": "",
      "logistics_company_code": "",
      "shipment_no": "",
      "shipments": [
        {
          "id": 1,
          "order_id": 1,
          "order_number": "OP25050911111",
          "express_code": "OTHER.CBERP",
          "express_company": "DHL Paket",
          "express_number": "CA5245xxxxx",
          "created_at": "2025-05-09 17:00:40",
          "updated_at": "2025-05-09 17:00:40",
          "status": 0
        }
      ]
    }
  ]
}

失败返回示例

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

错误处理

公共错误码

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

注意事项

订单号（order_no）和平台订单号（seller_order_no）具有唯一对应关系，通过任一编号均可查询到相同的订单详情

未发货的订单，shipments字段可能为空；已发货的订单会包含物流信息

不同配送方式返回的字段可能存在差异（如第三方物流自提会返回logistics_company_name等字段）

常见问题

Q1：如何通过商家订单号查询订单详情？

A：调用接口时，在query参数中传入seller_order_no=商家订单号（如seller_order_no=576722608781890541），无需传入order_no。

版本历史

版本	日期	修改说明
v1.0	2024-12-01	初始版本，支持订单详情查询

application/json

Bodyapplication/json

示例

{
    "code": 0,
    "msg": "",
    "data": [
        {
            "order_id": 1841982,
            "order_number": "aOP2505071626702",
            "place_order_time": "2025-05-07 16:13:53",
            "status": "unpaid",
            "order_status": "待支付",
            "customer_name": "Stacie R. Sheppard",
            "phone": "18965213578",
            "entrepot": [],
            "address": "United States ALABAMA Sylacauga , Alabama, Talladega, Sylacauga, / 301 S Broadway Ave",
            "mode_payment": "",
            "pay_time": "",
            "postcode": "35150",
            "order_products": [
                {
                    "id": 1963212,
                    "order_id": 1841982,
                    "product_id": 100,
                    "order_number": "aOP2505071626702",
                    "order_shipment_id": 0,
                    "shipped_at": null,
                    "product_sku_delivery_region_id": 35791,
                    "delivery_region_id": 5,
                    "depot_id": 5,
                    "product_sku": "cbsft114yy02-一盒12pcs",
                    "name": "South Moon 艾蒿臂贴 手臂和腿部天然草药艾灸贴",
                    "image": "https://westmonth/SKUDatum/old/cbsft114yy02-一盒12pcs/mainpicture/cbsft114yy02-一盒12pcs-001.jpg",
                    "quantity": 1,
                    "price": "5.00",
                    "original_price": "5.00",
                    "subtotal": "￥5.00",
                    "original_subtotal": "5.00",
                    "is_add": 0,
                    "is_barter": 0,
                    "is_split": 0,
                    "is_merge": 0,
                    "after_sale_id": 0,
                    "after_sale_status": "default_status",
                    "created_at": "2025-05-07 16:13:53",
                    "updated_at": "2025-05-07 16:13:53",
                    "deleted_at": null,
                    "price_format": "￥5.00",
                    "total_price_format": "￥0.00",
                    "subtotal_format": "￥0.00",
                    "after_sale_status_label": "未售后",
                    "warehouses": {
                        "id": 167,
                        "depot_id": 5,
                        "address": "广东省汕头市龙湖区练江中路工业大厦H7幢201号房之一",
                        "contact_name": "西之月",
                        "contact_phone": "13076369857",
                        "postcode": "515000",
                        "created_at": "2024-11-29T02:31:55.000000Z",
                        "updated_at": "2024-11-29T02:31:55.000000Z"
                    },
                    "region": {
                        "id": 5,
                        "name": "中国",
                        "code": "CN",
                        "shop_id": 15632946,
                        "wms_co_id": 0,
                        "country_id": 44,
                        "logo": "https://westmonth-test.oss-cn-shenzhen.aliyuncs.com/test/20250415150112204143.jpg",
                        "sort": 99,
                        "created_at": "2024-02-01 06:15:38",
                        "updated_at": "2025-04-18 12:14:14",
                        "deleted_at": null,
                        "service_type": "1,2"
                    }
                }
            ],
            "amount_payable": "￥45.00",
            "trade_platforms": 0,
            "sub_total": "￥5.00",
            "freight": "￥40.00",
            "comment": "买家备注",
            "delivery_mode_name": "快递配送",
            "name_supplier": "Stacie R. Sheppard",
            "contact_number": "18965213578",
            "seller_order_no": "576722608781890541",
            "platform_name": "",
            "logistics_company_name": "",
            "logistics_company_name_en": "",
            "logistics_company_code": "",
            "shipment_no": "",
            "shipments": [
                {
                    "id": 1,
                    "order_id": 1,
                    "order_number": "OP25050911111",
                    "express_code": "OTHER.CBERP",
                    "express_company": "DHL Paket",
                    "express_number": "CA5245xxxxx",
                    "created_at": "2025-05-09 17:00:40",
                    "updated_at": "2025-05-09 17:00:40",
                    "status": 0
                }
            ]
        }
    ]
}

订单详情

订单详情

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Query参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

注意事项

常见问题

Q1：如何通过商家订单号查询订单详情？

版本历史

请求参数

请求示例代码

返回响应

订单详情

订单详情#

适用场景#

接口类型#

请求频率限制#

请求说明#

请求参数#

Header参数#

Query参数#

响应字段说明#

调用示例#

URL请求#

请求示例#

成功返回示例#

失败返回示例#

错误处理#

注意事项#

常见问题#

Q1：如何通过商家订单号查询订单详情？#

版本历史#

请求参数

请求示例代码

返回响应

订单详情

适用场景

接口类型

请求频率限制

请求说明

请求参数

Header参数

Query参数

响应字段说明

调用示例

URL请求

请求示例

成功返回示例

失败返回示例

错误处理

注意事项

常见问题

Q1：如何通过商家订单号查询订单详情？

版本历史