云服务 API 参考行业场景垂直行业解决方案App Mall开放能力订单管理搜索订单列表

搜索订单列表

更新时间：2024-01-12 02:39:48下载pdf

本文介绍搜索订单列表的 API。

接口描述

根据条件筛选订单列表。

接口地址

GET: /v1.0/sellercenter/order/search

请求参数

参数名	类型	参数位置	是否必填	说明
mall_code	String	query	true	商城编码
site_code	String	query	false	站点编码
order_id	String	query	false	订单ID
commodity_name	String	query	false	商品名称
order_status	String	query	false	订单状态
start_time	Long	query	false	下单时间区间（启）
end_time	Long	query	false	下单时间区间（止）
page	Integer	query	false	页码
page_size	Integer	query	false	页宽
lang	String	query	false	语种编码

返回参数

参数名	类型	说明
result	PaginationModel	搜索结果

result 说明

参数名	类型	说明
total	Integer	总数
page	Integer	页数
data_list	List	结果集
page_size	Integer	页宽

data_list 说明

参数名	类型	说明
order_id	String	订单 ID
order_type_code	String	订单类型编码
order_status	String	订单状态
amount_origin	String	订单原价
amount_trade	String	订单成交价
amount_paid	String	订单已支付金额
amount_rest	String	剩余要支付的金额
price_trade_list	List	订单总价明细
gmt_order_create	Long	订单创建时间
commodity_list	List	订单商品信息
currency	String	货币单位
payment_list	List	订单支付流水
refund_status	Integer	订单退款状态

commodity_list 说明

参数名	类型	说明
commodity_code	String	商品编码
specification_code	String	商品SKU
commodity_name	String	商品名称
iconUrl	String	商品图片
currency	String	货币单位
unit_price_origin	String	单价原价
unit_price_trade	String	单价成交价
unit_name	String	单价单位。片、件、次等
quantity	Integer	商品数量
attach_json	Integer	商品附加信息

price_trade_list 说明

参数名	类型	说明
key	String	价格明细code
price_detail_name	String	价格明细名称
amount	BigDecimal	成交价格
amount_coupon	BigDecimal	优惠券优惠金额
amount_origin	BigDecimal	订单原价

payment_list 说明

参数名	类型	说明
trade_amount	String	支付金额
currency	String	货币单位
paid_provider	String	支付提供商
paid_type	String	支付类型
gmt_create	Long	创建时间
trade_status	String	支付状态

请求示例

GET: /v1.0/sellercenter/order/search?mall_code=MALL_CODE&site_code=SITE_CODE&order_id=ORDER_ID&commodity_name=COMMODITY_NAME&order_status=ORDER_STATUS&start_time=START_TIME&end_time=END_TIME&page=PAGE&page_size=PAGE_SIZE&lang=LANG

返回示例

{
    "result": {
        "data_list": [
            {
                "amount_paid": {
                    "Value": "0.00"
                },
                "refund_status": -2,
                "amount_origin": {
                    "Value": "1.04"
                },
                "amount_rest": {
                    "Value": "1.04"
                },
                "amount_trade": {
                    "Value": "1.04"
                },
                "payment_list": [
                ],
                "order_type_code": "INT_OEM_APP_MALL",
                "commodity_list": [
                    {
                        "icon_url": "ecommerce/1574312631184_1574312631_bo7di3rmtq.png",
                        "commodity_code": "CM93hvx7num2i3",
                        "quantity": 2,
                        "unit_price_origin": {
                            "Value": "0.02"
                        },
                        "attach_json": {
                            "amount_after_coupon": {
                                "Value": "0.00"
                            },
                            "commodity_amount_origin": {
                                "Value": "0.00"
                            },
                            "sku_value_list": [
                                "绿色"
                            ]
                        },
                        "unit_price_trade": {
                            "Value": "0.02"
                        },
                        "specification_code": "SK93hvx7p8k1eg",
                        "currency": "CNY",
                        "commodity_name": "青越的第一个商品"
                    }
                ],
                "order_status": "created",
                "currency": "CNY",
                "gmt_order_create": 1576848986974,
                "order_id": "SO20191220923442"
            }
        ],
        "total": 1,
        "page": 1,
        "page_size": 10
    },
    "t": 1635167502107,
    "success": true
}

错误码

参考错误码。

上一篇获取订单详情

下一篇订单发货