接口描述:

  • 获取订单列表。

请求 URL:

  • http|https://host/api/v1/order/method/get.order.list/

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
is_export integer in:0,1 0 0 是否导出 0=否 1=是
keywords string max:200 PO_I10495… 商品名称或订单号
consignee string max:50 carey 收货人姓名
mobile string length:7,15 15867… 收货人手机号码
payment_code integer egt:0 3 支付方式
is_delete integer in:0,1 0 0 查看回收站订单 0=否 1=是
begin_time datetime beforeTime:end_time 2018-06-01 00:00:00 下单开始时间
end_time datetime afterTime:begin_time 2018-06-30 00:00:00 下单结束时间
status integer between:0,7 0 0 组合状态,详见附属 B
page_no integer gt:0 1 1 页码
page_size integer between:1,40 15 15 每页数量
order_type string in:asc,desc desc asc 排序方式
order_field string 见附属 A order_id status 排序字段

附属 A:
in:order_id,payment_time,finished_time,create_time,update_time

附属 B:
0:所有状态
1:未付款/待付款
2:已付款
3:待发货/配货中
4:已发货/待收货
5:已完成/已收货
6:已取消
7:待评价

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
items array [] 列表项
total_result integer 2 合计计数
items 类型 是否返回 示例值 描述
order_no string PO_I1049550… 订单号
user_id integer 1 账号编号
source integer 0 订单来源(自定义)
pay_amount number 290 订单金额
goods_amount number 300 商品金额
total_amount number 20 应付金额(含运费)
use_money number 694.89 余额抵扣
use_level number 0 会员等级抵扣
use_integral number 10.01 积分抵扣
use_coupon number 10 优惠劵抵扣
use_discount number 0 商品折扣抵扣
use_promotion number 0 订单促销抵扣
use_card number 780 购物卡抵扣
delivery_fee number 1195 运费
payment_no string ZF_I104955… 支付单号(交易流水号)
payment_code string 3 支付编码
card_number string 997156… 购物卡号
delivery_id integer 1 配送方式
consignee string carey 收货人姓名
complete_address string 浙江省 宁波市 江北区 广济街 完整地址
zipcode string 315000 邮编
tel string 0574-8748… 电话
mobile string 15867… 手机号码
buyer_remark string 发韵达 买家备注
invoice_title string 宁波欧瑞网络科技有限公司 发票抬头
tax_number string xxx0909 纳税人识别号
invoice_amount number 10.99 开票费用
trade_status integer 0 交易状态 0=待处理 1=配货中 2=已发货 3=已完成 4=已取消
delivery_status integer 0 配送状态 0=未发 1=已发 2=部分发
payment_status integer 0 支付状态 0=未付 1=已付
adjustment number 19.9 调整价格
integral_pct number 100 记录积分换算比例
give_integral integer 100 赠送积分
give_coupon array [1,2,3] 赠送优惠劵
payment_time datetime 2017-01-04 14:04:25 支付时间
delivery_time datetime 2017-01-04 14:04:25 发货时间
finished_time datetime 2017-01-04 14:04:25 完成时间
create_time datetime 2017-01-04 14:04:25 创建时间
update_time datetime 2017-01-04 14:04:25 更新时间
get_user object [] 账号对象
get_order_goods array [] 订单商品数组
get_user 类型 是否返回 示例值 描述
username string carey 账号
nickname string carey 昵称
head_pic string //host/head_pic.jpg 头像
get_order_goods 类型 是否返回 示例值 描述
order_goods_id integer 1 订单商品编号
goods_name string 一条数据 商品名称
goods_id integer 89 商品编号
goods_image string //image.jpg 商品封面
goods_code string CS27981253 商品货号
goods_sku string SKY001 商品SKU
bar_code string BAR002 商品条码
key_name string 1_3 规格键名
key_value string 规格B 规格值
market_price number 500 市场价
shop_price number 200 本店价
qty integer 2 购买数量
is_comment integer 0 评价状态 0=未评 1=已评 2=追评
is_service integer 0 售后状态 0=可申请 1=售后中 2=已售后 3=不可申
status integer 2 货品状态 0=未发 1=已发 2=收货 3=取消

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "items": [
  6. {
  7. "order_no": "PO_I1049550470892680001",
  8. "user_id": 1,
  9. "source": 0,
  10. "pay_amount": 290,
  11. "goods_amount": 300,
  12. "total_amount": 0.1,
  13. "use_money": 694.89,
  14. "use_level": 0,
  15. "use_integral": 10.01,
  16. "use_coupon": 10,
  17. "use_discount": 0,
  18. "use_promotion": 0,
  19. "use_card": 780,
  20. "delivery_fee": 1195,
  21. "payment_no": "",
  22. "payment_code": "",
  23. "card_number": "9971564621172962",
  24. "delivery_id": 1,
  25. "consignee": "consignee",
  26. "complete_address": "浙江省 宁波市 江北区 address",
  27. "zipcode": "",
  28. "tel": "",
  29. "mobile": "15867430425",
  30. "buyer_remark": "",
  31. "invoice_title": "",
  32. "tax_number": "",
  33. "invoice_amount": 0,
  34. "trade_status": 0,
  35. "delivery_status": 0,
  36. "payment_status": 0,
  37. "adjustment": 0,
  38. "integral_pct": 100,
  39. "give_integral": 100,
  40. "give_coupon": [],
  41. "payment_time": "",
  42. "delivery_time": "",
  43. "finished_time": "",
  44. "create_time": "2018-01-04 00:05:04",
  45. "update_time": "2018-01-04 15:17:53",
  46. "get_user": {
  47. "username": "dnyz520",
  48. "nickname": "careya",
  49. "head_pic": "//host/head_pic.jpg"
  50. },
  51. "get_order_goods": [
  52. {
  53. "order_goods_id": 4,
  54. "goods_name": "添加一条数据",
  55. "goods_id": 89,
  56. "goods_image": "",
  57. "goods_code": "CS27981253",
  58. "goods_sku": "",
  59. "bar_code": "",
  60. "key_name": "1_3",
  61. "key_value": "规格B",
  62. "market_price": 500,
  63. "shop_price": 200,
  64. "qty": 1,
  65. "is_comment": 0,
  66. "is_service": 0,
  67. "status": 3
  68. },
  69. {
  70. "order_goods_id": 5,
  71. "goods_name": "添加一条数据",
  72. "goods_id": 89,
  73. "goods_image": "",
  74. "goods_code": "CS27981253",
  75. "goods_sku": "",
  76. "bar_code": "",
  77. "key_name": "1_2",
  78. "key_value": "规格A",
  79. "market_price": 500,
  80. "shop_price": 100,
  81. "qty": 1,
  82. "is_comment": 0,
  83. "is_service": 0,
  84. "status": 3
  85. }
  86. ]
  87. },
  88. {
  89. "order_no": "PO_I1049550470892670001",
  90. "user_id": 1,
  91. "source": 0,
  92. "pay_amount": 290,
  93. "goods_amount": 300,
  94. "total_amount": 20,
  95. "use_money": 694.89,
  96. "use_level": 0,
  97. "use_integral": 10.01,
  98. "use_coupon": 10,
  99. "use_discount": 0,
  100. "use_promotion": 0,
  101. "use_card": 780,
  102. "delivery_fee": 1195,
  103. "payment_no": "ZF_I1049554124677490001",
  104. "payment_code": "3",
  105. "card_number": "9971564621172962",
  106. "delivery_id": 1,
  107. "consignee": "consignee",
  108. "complete_address": "浙江省 宁波市 江北区 address",
  109. "zipcode": "",
  110. "tel": "",
  111. "mobile": "15867430425",
  112. "buyer_remark": "",
  113. "invoice_title": "",
  114. "tax_number": "",
  115. "invoice_amount": 0,
  116. "trade_status": 0,
  117. "delivery_status": 0,
  118. "payment_status": 0,
  119. "adjustment": 19.9,
  120. "integral_pct": 100,
  121. "give_integral": 100,
  122. "give_coupon": [],
  123. "payment_time": "",
  124. "delivery_time": "2017-01-04 14:04:25",
  125. "finished_time": "2018-01-04 15:17:53",
  126. "create_time": "2018-01-04 00:05:04",
  127. "update_time": "2018-06-12 09:33:13",
  128. "get_user": {
  129. "username": "dnyz520",
  130. "nickname": "careya",
  131. "head_pic": "//host/head_pic.jpg"
  132. },
  133. "get_order_goods": [
  134. {
  135. "order_goods_id": 1,
  136. "goods_name": "添加一条数据",
  137. "goods_id": 89,
  138. "goods_image": "",
  139. "goods_code": "CS27981253",
  140. "goods_sku": "",
  141. "bar_code": "",
  142. "key_name": "1_3",
  143. "key_value": "规格B",
  144. "market_price": 500,
  145. "shop_price": 200,
  146. "qty": 1,
  147. "is_comment": 0,
  148. "is_service": 0,
  149. "status": 2
  150. },
  151. {
  152. "order_goods_id": 2,
  153. "goods_name": "添加一条数据",
  154. "goods_id": 89,
  155. "goods_image": "",
  156. "goods_code": "CS27981253",
  157. "goods_sku": "",
  158. "bar_code": "",
  159. "key_name": "1_2",
  160. "key_value": "规格A",
  161. "market_price": 500,
  162. "shop_price": 100,
  163. "qty": 1,
  164. "is_comment": 0,
  165. "is_service": 1,
  166. "status": 2
  167. }
  168. ]
  169. }
  170. ],
  171. "total_result": 2
  172. }
  173. }

备注:

  1. 该接口支持条件搜索,如果不带入业务参数则使用默认值。

  2. 参数is_export1时,page_nopage_size将无效。

文档更新时间: 2018-06-24 22:29