简要描述
请求url
https://www.商城域名.com/index.php?s=/api/order/list
请求方式
是否需授权登录
请求header
参数名 |
类型 |
是否必须 |
示例值 |
说明 |
storeId |
int |
必填 |
10001 |
商城ID |
platform |
string |
必填 |
H5 |
当前请求的客户端(APP、小程序、H5等) |
Access-Token |
string |
选填 |
- |
当前登录用户的 Token |
请求参数
参数名 |
类型 |
是否必须 |
示例值 |
说明 |
dataType |
string |
必填 |
all |
订单类型(all全部、payment待支付、delivery待发货、received待收货、comment待评价) |
page |
int |
选填 |
1 |
当前页码 |
返回示例
{
"status": 200,
"message": "success",
"data": {
"list": {
"total": 4,
"per_page": 15,
"current_page": 1,
"last_page": 1,
"data": [
{
"order_id": 10200,
"order_no": "2022022551549797",
"total_price": "669.77",
"order_price": "669.77",
"coupon_id": 0,
"coupon_money": "0.00",
"points_money": "0.00",
"points_num": 0,
"pay_price": "669.77",
"update_price": {
"symbol": "+",
"value": "0.00"
},
"buyer_remark": "",
"pay_type": 20,
"pay_method": "",
"pay_status": 10,
"pay_time": "",
"trade_id": 0,
"delivery_type": 10,
"extract_shop_id": 0,
"extract_clerk_id": 0,
"express_price": "0.00",
"express_id": 0,
"express_no": "",
"delivery_status": 10,
"delivery_time": "",
"receipt_status": 10,
"receipt_time": "",
"order_status": 10,
"points_bonus": 32,
"is_settled": 0,
"transaction_id": "",
"is_comment": 0,
"order_source": 10,
"order_source_id": 0,
"platform": "H5",
"user_id": 10125,
"is_delete": 0,
"create_time": "2022-02-25 12:52:35",
"goods": [
{
"order_goods_id": 10202,
"goods_id": 10019,
"goods_name": "清野の木 56L灰色特大号 塑料收纳箱整理箱环保加厚储物箱",
"image_id": 10364,
"deduct_stock_type": 10,
"spec_type": 10,
"goods_sku_id": "0",
"goods_props": null,
"goods_no": "",
"goods_price": "32.14",
"line_price": "0.00",
"goods_weight": 0,
"is_user_grade": 1,
"grade_ratio": 10,
"grade_goods_price": "31.50",
"grade_total_money": "1.93",
"coupon_money": "0.00",
"points_money": "0.00",
"points_num": 0,
"points_bonus": 4,
"total_num": 3,
"total_price": "94.49",
"total_pay_price": "94.49",
"delivery_status": 10,
"delivery_num": 0,
"is_comment": 0,
"order_id": 10200,
"user_id": 10125,
"goods_source_id": 0,
"goods_image": "2a6e0c0ea7d1e5f0f2ac3e406198850c.jpg"
},
{
"order_goods_id": 10203,
"goods_id": 10020,
"goods_name": "耐克 男子 NIKE AIR FORCE 1'07 运动鞋",
"image_id": 10378,
"deduct_stock_type": 10,
"spec_type": 20,
"goods_sku_id": "10052",
"goods_props": [
{
"group": {
"name": "尺码",
"id": 10007
},
"value": {
"name": "39",
"id": 10052
}
}
],
"goods_no": "",
"goods_price": "587.02",
"line_price": "999.00",
"goods_weight": 4,
"is_user_grade": 1,
"grade_ratio": 10,
"grade_goods_price": "575.28",
"grade_total_money": "11.74",
"coupon_money": "0.00",
"points_money": "0.00",
"points_num": 0,
"points_bonus": 28,
"total_num": 1,
"total_price": "575.28",
"total_pay_price": "575.28",
"delivery_status": 10,
"delivery_num": 0,
"is_comment": 0,
"order_id": 10200,
"user_id": 10125,
"goods_source_id": 0,
"goods_image": "b72822760ccc4bb892cc658b33af939e.jpg"
}
],
"state_text": "待支付"
},
{
"order_id": 10196,
"order_no": "2022012698511019",
"total_price": "12.90",
"order_price": "12.90",
"coupon_id": 0,
"coupon_money": "0.00",
"points_money": "0.00",
"points_num": 0,
"pay_price": "12.90",
"update_price": {
"symbol": "+",
"value": "0.00"
},
"buyer_remark": "",
"pay_type": 20,
"pay_method": "",
"pay_status": 10,
"pay_time": "",
"trade_id": 0,
"delivery_type": 10,
"extract_shop_id": 0,
"extract_clerk_id": 0,
"express_price": "0.00",
"express_id": 0,
"express_no": "",
"delivery_status": 10,
"delivery_time": "",
"receipt_status": 10,
"receipt_time": "",
"order_status": 10,
"points_bonus": 0,
"is_settled": 0,
"transaction_id": "",
"is_comment": 0,
"order_source": 30,
"order_source_id": 10116,
"platform": "H5",
"user_id": 10125,
"is_delete": 0,
"create_time": "2022-01-26 15:08:27",
"goods": [
{
"order_goods_id": 10193,
"goods_id": 10018,
"goods_name": "简约风条纹客厅沙发卧室床头抱枕靠垫套",
"image_id": 10389,
"deduct_stock_type": 10,
"spec_type": 10,
"goods_sku_id": "0",
"goods_props": null,
"goods_no": "",
"goods_price": "0.01",
"line_price": "129.00",
"goods_weight": 0.8,
"is_user_grade": 0,
"grade_ratio": 0,
"grade_goods_price": "0.00",
"grade_total_money": "0.00",
"coupon_money": "0.00",
"points_money": "0.00",
"points_num": 0,
"points_bonus": 0,
"total_num": 1,
"total_price": "12.90",
"total_pay_price": "12.90",
"delivery_status": 10,
"delivery_num": 0,
"is_comment": 0,
"order_id": 10196,
"user_id": 10125,
"goods_source_id": 10028,
"goods_image": "41cdb778199f99ebebb6090680f382fc.png"
}
],
"state_text": "待支付"
}
]
}
}
}
返回参数
参数名 |
类型 |
示例值 |
说明 |
status |
int |
200 |
请求状态(200:请求成功;500:请求错误/失败) |
message |
string |
success |
请求结果的信息,默认为 success |
data |
object |
- |
返回的业务数据 |
data 参数
参数名 |
类型 |
示例值 |
说明 |
list |
object |
- |
列表数据 |
data.list 参数
参数名 |
类型 |
示例值 |
说明 |
total |
int |
2 |
总记录数 |
per_page |
int |
15 |
每页条数 |
current_page |
int |
1 |
当前页码 |
last_page |
int |
1 |
最后页码 |
data |
array |
- |
列表数组 |
data.list.data 参数
参数名 |
类型 |
示例值 |
说明 |
order_id |
int |
10200 |
订单ID |
order_no |
string |
2022022551549797 |
订单号 |
total_price |
string |
669.77 |
商品总金额 (不含优惠折扣) |
order_price |
string |
669.77 |
订单金额 (含优惠折扣) |
coupon_id |
int |
- |
优惠券ID |
coupon_money |
string |
0.00 |
优惠券抵扣金额 |
points_money |
string |
0.00 |
积分抵扣金额 |
points_num |
int |
- |
积分抵扣数量 |
pay_price |
string |
669.77 |
实际付款金额 (包含运费) |
update_price |
object |
- |
后台修改的订单金额 (差价) |
buyer_remark |
string |
- |
买家留言 |
pay_method |
string |
- |
支付方式(余额/微信/支付宝) |
pay_status |
int |
10 |
付款状态(10未付款 20已付款) |
pay_time |
string |
- |
付款时间 |
trade_id |
int |
- |
第三方交易记录ID |
delivery_type |
int |
10 |
配送方式 (10快递配送 20门店自提) |
extract_shop_id |
int |
- |
自提门店ID |
extract_clerk_id |
int |
- |
核销店员ID |
express_price |
string |
0.00 |
运费金额 |
express_id |
int |
- |
物流公司ID (废弃) |
express_no |
string |
- |
物流单号 (废弃) |
delivery_status |
int |
10 |
发货状态 (10未发货 20已发货 30部分发货) |
delivery_time |
string |
- |
发货时间 |
receipt_status |
int |
10 |
收货状态 (10未收货 20已收货) |
receipt_time |
string |
- |
收货时间 |
order_status |
int |
10 |
订单状态 (10进行中 20取消 21待取消 30已完成) |
points_bonus |
int |
32 |
赠送的积分数量 |
is_comment |
int |
- |
是否已评价 (0否 1是) |
order_source |
int |
10 |
订单来源 (10普通订单 20砍价订单 30秒杀订单) |
order_source_id |
int |
- |
来源记录ID |
platform |
string |
H5 |
下单客户端 (APP、H5、小程序等) |
user_id |
int |
10125 |
用户ID |
create_time |
string |
2022-02-25 12:52:35 |
订单创建时间 |
goods |
array |
- |
订单商品信息 |
state_text |
string |
待支付 |
订单状态文字(待支付、待发货、部分发货、待收货、已完成、已取消、待取消) |
data.list.data.update_price 参数
参数名 |
类型 |
示例值 |
说明 |
symbol |
string |
+ |
变动类型 (+增加金额、-减免金额) |
value |
string |
0.00 |
金额数值 |
data.list.data.goods 参数
参数名 |
类型 |
示例值 |
说明 |
order_goods_id |
int |
10202 |
订单商品ID |
goods_id |
int |
10019 |
商品ID |
goods_name |
string |
清野の木 56L灰色特大号 塑料收纳箱整理箱环保加厚储物箱 |
商品标题/名称 |
image_id |
int |
10364 |
商品封面图ID |
deduct_stock_type |
int |
10 |
库存计算方式 (10下单减库存 20付款减库存) |
spec_type |
int |
10 |
规格类型 (10单规格 20多规格) |
goods_sku_id |
string |
- |
商品SKU唯一标识 |
goods_props |
null |
null |
SKU的规格属性(json格式) |
goods_no |
string |
- |
商品编码 |
goods_price |
string |
32.14 |
商品价格(单价) |
line_price |
string |
0.00 |
商品划线价 |
goods_weight |
int |
- |
商品重量(Kg) |
is_user_grade |
int |
1 |
是否使用会员等级折扣 |
grade_ratio |
int |
10 |
会员折扣比例(0-10) |
grade_goods_price |
string |
31.50 |
会员折扣的商品单价 |
grade_total_money |
string |
1.93 |
会员折扣的总额差 |
coupon_money |
string |
0.00 |
优惠券折扣金额 |
points_money |
string |
0.00 |
积分金额 |
points_num |
int |
- |
积分抵扣数量 |
points_bonus |
int |
4 |
赠送的积分数量 |
total_num |
int |
3 |
购买数量 |
total_price |
string |
94.49 |
商品总价 (数量×单价) |
total_pay_price |
string |
94.49 |
实际付款价 (折扣和优惠后) |
delivery_status |
int |
10 |
发货状态 (10未发货 20已发货 30部分发货) |
delivery_num |
int |
- |
已发货数量 |
is_comment |
int |
- |
是否已评价(0否 1是) |
order_id |
int |
10200 |
订单ID |
user_id |
int |
10125 |
用户ID |
goods_source_id |
int |
- |
来源记录ID |
goods_image |
string |
2a6e0c0ea7d1e5f0f2ac3e406198850c.jpg |
商品封面图 |