接口描述:

  • 获取购物卡列表。

请求 URL:

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

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
name string max:50 线下 购物卡名称
status integer in:0,1 1 购物卡状态 0=禁用 1=启用
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 card_id status 排序字段

附属 A:
in:card_id,name,money,give_num,active_num,create_time,end_time,status

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
items array [] 列表项
total_result integer 2 合计计数
items 类型 是否返回 示例值 描述
card_id integer 1 购物卡编号
name string 实体购物卡 购物卡名称
description string 线下发放 购物卡描述
money number 500 购物卡面额
category array ["1","2","3"] 限制商品类目
exclude_category array ["4","5","6"] 排除商品类目
give_num integer 100 发放数量
active_num integer 0 激活数量
create_time string 2018-05-27 00:55:19 创建时间
end_time datetime 2019-05-30 00:00:00 截止有效期
status integer 1 购物卡状态 0=禁用 1=启用

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "items": [
  6. {
  7. "card_id": 2,
  8. "name": "电子购物卡",
  9. "description": "线上购买",
  10. "money": 500,
  11. "category": [],
  12. "exclude_category": [],
  13. "give_num": 50,
  14. "active_num": 0,
  15. "create_time": "2018-05-27 01:59:21",
  16. "end_time": "",
  17. "status": 1
  18. },
  19. {
  20. "card_id": 1,
  21. "name": "实体购物卡",
  22. "description": "线下发放",
  23. "money": 500,
  24. "category": [
  25. "1",
  26. "2",
  27. "3"
  28. ],
  29. "exclude_category": [
  30. "4",
  31. "5",
  32. "6"
  33. ],
  34. "give_num": 100,
  35. "active_num": 0,
  36. "create_time": "2018-05-27 00:55:19",
  37. "end_time": "2019-05-30 00:00:00",
  38. "status": 1
  39. }
  40. ],
  41. "total_result": 2
  42. }
  43. }

备注:

  1. 该接口支持条件搜索,如果不带入业务参数则使用默认值。
文档更新时间: 2018-05-27 02:12