接口描述:

  • 获取优惠劵列表。

请求 URL:

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

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
name string max:50 六一 优惠劵名称
type integer in:0,1,2,3 2 优惠劵类型,详见「备注1」
status integer in:0,1 1 优惠劵状态 0=禁用 1=启用
is_invalid integer in:0,1 0 优惠劵是否作废 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 coupon_id status 排序字段

附属 A:
in:coupon_id,name,type,give_num,receive_num,use_num,status,is_invalid

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
items array [] 列表项
total_result integer 3 合计计数
items 类型 是否返回 示例值 描述
coupon_id integer 11 优惠劵编号
name string 六一快乐 优惠劵名称
description string 活动描述 优惠劵描述
guide string //careyshop.cn 优惠劵引导地址
type integer 2 优惠劵类型,详见「备注1」
give_code string DjEU0GtU9t 优惠劵领取码
money number 100 优惠金额
quota number 1000 限制使用金额(0则不限)
category array ["1","2","3"] 限制商品类目
exclude_category array ["5","6","7"] 排除商品类目
level array [] 限制会员等级
frequency integer 1 限制领取次数(0则不限)
give_num integer 2000 发放数量
receive_num integer 0 累计领取数量
use_num integer 0 累计使用数量
give_begin_time datetime 2018-05-22 10:11:00 发放开始时间
give_end_time datetime 2018-06-05 00:00:00 发放结束时间
use_begin_time datetime 2018-06-01 00:00:00 使用开始时间
use_end_time datetime 2018-06-02 00:00:00 使用结束时间
status integer 1 优惠劵状态 0=禁用 1=启用
is_invalid integer 0 优惠劵是否作废 0=正常 1=作废

响应示例:

  1. {
  2. "status": 200,
  3. "message": "success",
  4. "data": {
  5. "items": [
  6. {
  7. "coupon_id": 3,
  8. "name": "端午节",
  9. "description": "",
  10. "guide": "//careyshop.cn",
  11. "type": 2,
  12. "give_code": "C88lLsckHT",
  13. "money": 30,
  14. "quota": 200,
  15. "category": [],
  16. "exclude_category": [],
  17. "level": [],
  18. "frequency": 1,
  19. "give_num": 200,
  20. "receive_num": 0,
  21. "use_num": 0,
  22. "give_begin_time": "2018-05-24 02:06:00",
  23. "give_end_time": "2018-06-24 02:06:00",
  24. "use_begin_time": "2018-05-24 02:06:00",
  25. "use_end_time": "2018-06-24 02:06:00",
  26. "status": 1,
  27. "is_invalid": 0
  28. },
  29. {
  30. "coupon_id": 2,
  31. "name": "六一快乐",
  32. "description": "活动描述",
  33. "guide": "//careyshop.cn",
  34. "type": 2,
  35. "give_code": "lMoajWAEOD",
  36. "money": 100,
  37. "quota": 1000,
  38. "category": [
  39. "1",
  40. "2",
  41. "3"
  42. ],
  43. "exclude_category": [
  44. "5",
  45. "6",
  46. "7"
  47. ],
  48. "level": [],
  49. "frequency": 1,
  50. "give_num": 2000,
  51. "receive_num": 0,
  52. "use_num": 0,
  53. "give_begin_time": "2018-05-22 10:11:00",
  54. "give_end_time": "2018-06-05 00:00:00",
  55. "use_begin_time": "2018-06-01 00:00:00",
  56. "use_end_time": "2018-06-02 00:00:00",
  57. "status": 1,
  58. "is_invalid": 0
  59. }
  60. ],
  61. "total_result": 3
  62. }
  63. }

备注:

  1. 该接口支持条件搜索,如果不带入业务参数则使用默认值。
文档更新时间: 2019-07-03 16:14