获取已领取优惠劵列表

接口描述：

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

请求 URL：

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

请求方式：

  • GET
  • POST

是否授权：

  • 需要授权

业务参数：

参数名 类型 是否必须 范围值 默认值 示例值 描述
coupon_id integer 否 gt:0 3 优惠劵编号
type integer 否 in:normal,used,invalid,delete used 优惠劵状态，详见附属 A
account string 否 max:80 carey 账号或昵称
page_no integer 否 gt:0 1 1 页码
page_size integer 否 gt:0 15 15 每页数量

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

响应参数：

参数名 类型 是否返回 示例值 描述
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_user object 否 [] 账号对象
get_coupon 类型 是否返回 示例值 描述
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=作废
get_user 类型 是否返回 示例值 描述
username string 否 carey 账号
nickname string 否 carey 昵称
head_pic string 否 //host/head_pic.jpg 头像

响应示例：

  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": "//careyshop.cn",
  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.         "get_user": {
  38.           "username": null,
  39.           "nickname": null,
  40.           "head_pic": null
  41.         }
  42.       },
  43.       {
  44.         "coupon_give_id": 105,
  45.         "coupon_id": 5,
  46.         "user_id": 0,
  47.         "order_id": 0,
  48.         "exchange_code": "4fY2JkneKs",
  49.         "use_time": "",
  50.         "create_time": "2018-05-24 15:07:19",
  51.         "get_coupon": {
  52.           "coupon_id": 5,
  53.           "name": "端午节(线下)",
  54.           "description": "",
  55.           "guide": "//careyshop.cn",
  56.           "type": 1,
  57.           "give_code": "",
  58.           "money": 30,
  59.           "quota": 200,
  60.           "category": [],
  61.           "exclude_category": [],
  62.           "level": [],
  63.           "frequency": 1,
  64.           "give_num": 200,
  65.           "receive_num": 100,
  66.           "use_num": 0,
  67.           "give_begin_time": "2018-05-24 02:06:00",
  68.           "give_end_time": "2018-06-24 02:06:00",
  69.           "use_begin_time": "2018-05-24 02:06:00",
  70.           "use_end_time": "2018-06-24 02:06:00",
  71.           "status": 1,
  72.           "is_invalid": 0
  73.         },
  74.         "get_user": {
  75.           "username": null,
  76.           "nickname": null,
  77.           "head_pic": null
  78.         }
  79.       }
  80.     ],
  81.     "total_result": 102
  82.   }
  83. }

备注:

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