本文档使用 SmartWiki 发布

领取优惠券

简要描述：

领取优惠券(会返回优惠券的信息,返回的数据结构和"优惠券中心"接口返回的数据的结构是一样的)

请求域名:

请求URL

/addons/yun_shop/api.php?&m=yun_shop&do=6148&i=2&route=coupon.member-coupon.get-coupon&coupon_id=5

参数:

参数名	是否必须	类型	说明
coupon_id	是	int	优惠券ID
pagesize	否	int	分页 - 每页的优惠券数量(如果不设置,默认为10)

返回示例:

正确时返回:

{
    "result": 1, 
    "msg": "ok", 
    "data": {
        "total": 8, 
        "per_page": 10, 
        "current_page": 1, 
        "last_page": 1, 
        "next_page_url": null, 
        "prev_page_url": null, 
        "from": 1, 
        "to": 8, 
        "data": [
            {
                "id": 141, 
                "name": "打8折", 
                "coupon_method": 2, 
                "deduct": 0, 
                "discount": 8, 
                "enough": 88, 
                "use_type": 1, 
                "category_ids": [
                    "15", 
                    "3", 
                    "6", 
                    "74"
                ], 
                "categorynames": [
                    "测试分类", 
                    "电器", 
                    "服装"
                ], 
                "goods_ids": null, 
                "goods_names": null, 
                "time_limit": 0, 
                "time_days": 30, 
                "time_start": "2017-04-28 00:00:00", 
                "time_end": "2017-05-05 00:00:00", 
                "get_max": -1, 
                "total": 300, 
                "has_many_member_coupon_count": 1, 
                "member_got_count": 0, 
                "api_availability": 1, 
                "api_remaining": -1, 
                "api_limit": "测试分类,电器,服装"
            }, 
            {
                "id": 142, 
                "name": "立减100元", 
                "coupon_method": 1, 
                "deduct": 100, 
                "discount": 10, 
                "enough": 1000, 
                "use_type": 0, 
                "category_ids": null, 
                "categorynames": null, 
                "goods_ids": null, 
                "goods_names": null, 
                "time_limit": 0, 
                "time_days": 30, 
                "time_start": "2017-04-27 00:00:00", 
                "time_end": "2017-05-04 00:00:00", 
                "get_max": 10, 
                "total": 300, 
                "has_many_member_coupon_count": 14, 
                "member_got_count": 0, 
                "api_availability": 1, 
                "api_remaining": 10, 
                "api_limit": "商城通用"
            }
        ]
    }
}

错误时返回:

{
    "result": 0, 
    "msg": "没有找到记录", 
    "data": [ ]
}

返回参数说明:

参数名	类型	说明
name	str	优惠券名称
coupon_method	int	优惠方式: 1为立减deduct, 2为折扣discount
deduct	int	立减多少元(注意,coupon_method为1时,该数据才有意义)
discount	float	折扣(注意,coupon_method为2时,该数据才有意义; 例子:7表示打7折,即原价的0.7倍)
enough	int	消费满多少元, 优惠券才可用(空或0为不限制)
use_type	int	适用范围，0商城通用 1指定分类 2指定商品
category_ids	array	适用的分类ID (受use_type影响)
categorynames	array	适用的分类名称 (受use_type影响)
goods_ids	array	适用的商品ID (受use_type影响)
goods_names	array	适用的商品名称 (受use_type影响)
time_limit	int	时间限制类型: 0领取后几天有效, 1时间范围
time_days	int	领取后几天有效(受time_limit影响)
time_start	int	有效期的起始时间(受time_limit影响)
time_end	int	有效期的终止时间(受time_limit影响)
get_max	int	每人限领的上限
total	int	发放总数量限制( -1 为不限制)
has_many_member_coupon_count	int	已经被领取多少张
member_got_count	int	该用户已经领取该优惠券多少张
api_availability	int	优惠券是否可用: 1 可领取, 2 已经领取, 3 已经被抢光
api_remaining	int	优惠券还剩多少张
belongs_to_coupon. api_limit	str	适用范围的描述, 比如"适用于下列商品: 测试商品-电视1,99测试"

备注:

正确时返回的数据中, coupon_method 是"优惠方式", 1为立减deduct, 2为折扣discount; 所以当它的值为 1 时, deduct 字段才有意义, discount 无意义(之所以有值是因为可能用户期间变更了优惠方式类型,但是旧有的数据会残留)
正确时返回的数据中, use_type 是"适用范围", 0商城通用 1指定分类 2指定商品; 所以当它的值为 1 时, categorynames 字段才有意义, goods_names 无意义
同样的, time_limit 是"时间限制类型", 0领取后几天有效, 1为时间范围; 当它的值为 0 时, time_days 才有意义, 同时 time_start 和 time_end 无意义