跳转至

商城订单列表(分页)

功能说明

  • 查询商城订单列表

接口地址

HTTP请求方式

  • Method: POST
  • Content-Type: application/x-www-form-urlencoded

参数说明

  • 公有参数

    发送请求是必须传入公共参数,详见公共参数

  • 私有参数

参数名称 是否必须 参数类型 长度限制 描述
enterprise_ids string 企业编码,多个以英文“,”分隔,不能超过1000个
user_ids string 员工唯一标识,多个以英文“,”分隔,不能超过1000个
spu_code string spu编码
spu_name string spu名称
delivery_name string 收货联系人
delivery_phone string 收货手机号
outer_order_code string 外部订单号
shop_order_codes string 订单号,多个以英文“,”分隔,不能超过1000个
seller_order_codes string 商家订单号,多个以英文“,”分隔,不能超过1000个
time_order_start string 订单开始时间,格式yyyy-MM-dd
time_order_end string 订单结束时间,格式yyyy-MM-dd
page_index int 开始页数,默认1
page_size int 显示行数,默认20,最大支持100条

请求示例(HTTP)

POST /tenant/commerce/order/list?access_token=0d3ed01d6dc76f22394adb01bbb2cfe8&appid=25001707&enterprise_ids=27341,1&seller_order_codes=S202211022455543096701458,1&timestamp=1667809443&version=1.0.0&sign=e03e28ac2de10d62009397804ae9bfa648c014c2 HTTP/1.1
Host: https://openapi.guanaitong.tech

返回参数说明

参数名称 描述
code 返回码。详见错误代码
msg 如果错误,返回错误信息。
data 如果没有错误,返回商城订单列表
data.enterprise_id Integer类型,企业编码
data.shop_order_code String类型,订单编号
data.out_trade_no String类型,外部业务单号
data.buyer_name String类型,买家姓名
data.order_price BigDecimal类型,订单总价
data.logistics_amount BigDecimal类型,运费
data.refund_amount BigDecimal类型,退款总额
data.trade_status Integer类型,买家订单交易状态
1 等待买家付款
2 买家已付款
3 交易关闭
data.cancel_order_reason_desc String类型,订单关闭原因
data.create_time String类型,订单创建时间,格式yyyy-MM-dd HH:mm:ss
data.pay_time String类型,订单支付时间,格式yyyy-MM-dd HH:mm:ss
data.refund_first_time String类型,订单首次退款时间,格式yyyy-MM-dd HH:mm:ss
data.refund_last_time String类型,订单最后退款时间,格式yyyy-MM-dd HH:mm:ss
data.order_list 订单明细,List集合
data.product_list 订单商品列表,List集合

订单明细(order_list)

参数名称 描述
seller_order_code String类型,商家订单号
delivery_name String类型,收货人姓名
delivery_phone String类型,收货人手机号
address String类型,收货地址
order_price BigDecimal类型,订单价格
order_status Integer类型,订单状态1.等待买家付款
2.已付款,待备货
3.已付款,待备货,部分退款中
4.已备货待发货
5.已备货待发货部分退款中
6.已备货待发货退款中
7.已发货待买家确认收货
8.已发货待买家确认收货部分退款中
9.已发货待买家确认收货退款中
10.交易成功
11买家取消交易关闭
12客服取消交易关闭
13超时取消交易关闭
14退款成功交易关闭
trade_status Integer类型,买家订单交易状态
1 等待买家付款
2 买家已付款
3 商家已备货
4 商家已发货
5 买家已收货(交易成功)
6 订单取消(交易关闭)
time_created String类型,订单成交时间,格式yyyy-MM-dd HH:mm:ss
time_delivery String类型,发货时间,格式yyyy-MM-dd HH:mm:ss
time_closed String类型,订单关闭时间,格式yyyy-MM-dd HH:mm:ss
logistics_amount BigDecimal类型,运费

订单商品列表(product_list)

参数名称 描述
spu_code String类型,商品code
spu_name String类型,商品名称
product_title String类型,商品标题
sku_code String类型,sku_code
sku_name String类型,sku_name
sku_pic_url String类型,单规格商品的图片,默认取商品的第一张头图
sku_category String类型,规格信息(商品销售属性)
deal_price BigDecimal类型,成交价
purchase_num Integer类型,购买数量

正确返回示例

{
    "code": 0,
    "msg": "OK",
    "data": {
        "data_list": [
            {
                "create_time": "2022-11-02 11:51:50",
                "cancel_order_reason_desc": "",
                "buyer_name": "偶偶",
                "order_price": 1.2,
                "enterprise_id": 27341,
                "pay_time": "2022-11-02 11:51:57",
                "out_trade_no": "202211022455543063146924",
                "trade_status": 2,
                "logistics_amount": 0.0,
                "shop_order_code": "202211022455543063146924",
                "product_list": [
                    {
                        "purchase_num": 1,
                        "sku_pic_url": "https://img1.guanaitong.com/grus-gfs/test/gmall-seller-mgr/by-days/2022-05-11/709dad23a623a8bd0ae0211763f45794.jpg",
                        "spu_name": "测试商品自营商品0511",
                        "spu_code": "PC22051100000002",
                        "deal_price": 1.2,
                        "sku_name": "颜色:黑色 大小:100ml",
                        "sku_category": "颜色:黑色 大小:100ml ",
                        "sku_code": "KC22051100000004",
                        "product_title": "测试商品自营商品0511"
                    }
                ],
                "order_list": [
                    {
                        "order_status": 4,
                        "address": "北京北京市东城区东华门街道方法灌灌灌灌",
                        "delivery_name": "适当的",
                        "trade_status": 3,
                        "logistics_amount": 0.0,
                        "seller_order_code": "S202211022455543096701458",
                        "time_created": "2022-11-02 11:51:50",
                        "time_delivery": "",
                        "order_price": 1.2,
                        "time_closed": ""
                    }
                ]
            }
        ],
        "total_count": 1,
        "has_next": false
    }
}

错误返回示例

{
    "code": 1000240002,
    "data": null,
    "msg": "enterprise_code校验失败"
}

常见错误码

错误码 错误信息
1000240002 参数格式错误,企业编码超过最大个数1000
其他公共错误码 其他公共错误码
回到页面顶部