接口描述:

  • 验证优惠劵是否可使用。

请求 URL:

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

请求方式:

  • GET
  • POST

是否授权:

  • 需要授权

业务参数:

参数名 类型 是否必须 范围值 默认值 示例值 描述
coupon_give_id integer gt:0 89 优惠劵发放编号
exchange_code string max:10 bq4ZQQr7Ar 优惠劵兑换码
goods_id integer gt[]:0 [1,2,3] 商品编号
pay_amount number gt:0 99.99 支付总金额

响应参数:

参数名 类型 是否返回 示例值 描述
status integer 200 状态码
message string success 消息信息
data object [] 返回对象
data 类型 是否返回 示例值 描述
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 优惠劵类型
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. "coupon_give_id": 106,
  6. "coupon_id": 5,
  7. "user_id": 0,
  8. "order_id": 0,
  9. "exchange_code": "bq4ZQQr7Ar",
  10. "use_time": "",
  11. "create_time": "2018-05-24 15:07:19",
  12. "get_coupon": {
  13. "coupon_id": 5,
  14. "name": "端午节(线下)",
  15. "description": "",
  16. "guide": "",
  17. "type": 1,
  18. "give_code": "",
  19. "money": 30,
  20. "quota": 200,
  21. "category": [],
  22. "exclude_category": [],
  23. "level": [],
  24. "frequency": 1,
  25. "give_num": 200,
  26. "receive_num": 100,
  27. "use_num": 0,
  28. "give_begin_time": "2018-05-24 02:06:00",
  29. "give_end_time": "2018-06-24 02:06:00",
  30. "use_begin_time": "2018-05-24 02:06:00",
  31. "use_end_time": "2018-06-24 02:06:00",
  32. "status": 1,
  33. "is_invalid": 0
  34. }
  35. }
  36. }

不可用示例:

  1. {
  2. "status": 500,
  3. "message": "订单金额不足200"
  4. }

备注:

文档更新时间: 2018-06-25 01:06