接口描述:

  • 获取已领取优惠劵列表。

请求 URL:

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

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
type integer in:normal,used,invalid,delete used 优惠劵状态,详见附属 A
page_no integer gt:0 1 1 页码
page_size integer between:1,40 15 15 每页数量

附属 A:
normal=正常状态优惠劵;used=已使用优惠劵;invalid=无效优惠劵;delete=回收站优惠劵;

附属 B:
0=管理组成员向指定的顾客组发放;
1=批量生成后可以导出,可用于线下或海报;
2=由顾客组成员主动领取;
3=由后台促销活动设置,达到条件后赠送指定的优惠劵;

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
items array [] 列表项
total_result integer 102 合计计数
items 类型 是否返回 示例值 描述
coupon_give_id integer 106 优惠劵发放编号
coupon_id integer 5 优惠劵编号
user_id integer 0 账号编号 0=未领取
order_id integer 0 订单编号 0=未使用
exchange_code string bq4ZQQr7Ar 优惠劵兑换码
use_time datetime 2018-05-24 16:00:00 使用时间
create_time datetime 2018-05-24 15:07:19 创建时间
get_coupon object [] 优惠劵对象
get_coupon 类型 是否返回 示例值 描述
coupon_id integer 11 优惠劵编号
name string 六一快乐 优惠劵名称
description string 活动描述 优惠劵描述
guide string //careyshop.cn 优惠劵引导地址
type integer 2 优惠劵类型,详见附属 B
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_give_id": 106,
  8. "coupon_id": 5,
  9. "user_id": 0,
  10. "order_id": 0,
  11. "exchange_code": "bq4ZQQr7Ar",
  12. "use_time": "",
  13. "create_time": "2018-05-24 15:07:19",
  14. "get_coupon": {
  15. "coupon_id": 5,
  16. "name": "端午节(线下)",
  17. "description": "",
  18. "guide": "",
  19. "type": 1,
  20. "give_code": "",
  21. "money": 30,
  22. "quota": 200,
  23. "category": [],
  24. "exclude_category": [],
  25. "level": [],
  26. "frequency": 1,
  27. "give_num": 200,
  28. "receive_num": 100,
  29. "use_num": 0,
  30. "give_begin_time": "2018-05-24 02:06:00",
  31. "give_end_time": "2018-06-24 02:06:00",
  32. "use_begin_time": "2018-05-24 02:06:00",
  33. "use_end_time": "2018-06-24 02:06:00",
  34. "status": 1,
  35. "is_invalid": 0
  36. }
  37. },
  38. {
  39. "coupon_give_id": 105,
  40. "coupon_id": 5,
  41. "user_id": 0,
  42. "order_id": 0,
  43. "exchange_code": "4fY2JkneKs",
  44. "use_time": "",
  45. "create_time": "2018-05-24 15:07:19",
  46. "get_coupon": {
  47. "coupon_id": 5,
  48. "name": "端午节(线下)",
  49. "description": "",
  50. "guide": "",
  51. "type": 1,
  52. "give_code": "",
  53. "money": 30,
  54. "quota": 200,
  55. "category": [],
  56. "exclude_category": [],
  57. "level": [],
  58. "frequency": 1,
  59. "give_num": 200,
  60. "receive_num": 100,
  61. "use_num": 0,
  62. "give_begin_time": "2018-05-24 02:06:00",
  63. "give_end_time": "2018-06-24 02:06:00",
  64. "use_begin_time": "2018-05-24 02:06:00",
  65. "use_end_time": "2018-06-24 02:06:00",
  66. "status": 1,
  67. "is_invalid": 0
  68. }
  69. }
  70. ],
  71. "total_result": 102
  72. }
  73. }

备注:

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