企迈云-开放平台

API 2.0

API 2.0 > 2.5 优惠券 > 2.5.5 获取店铺优惠券列表

2.5.5 获取店铺优惠券列表

开启令牌和权限后可调用。签名方式请查看开发指南

场景描述：获取店铺优惠券列表

零售

请求地址

请求方式	版本信息	请求地址
POST	V2	http://openapi.zvcms.com/api/v2

公共参数

参数	参数类型	是否必填	默认值	描述
OpenId	string	是		密钥Id
GrantCode	string	是		授权code
Token	string	是		签名，参考《数字签名sign》
Timestamp	string	是		当前时间戳
Nonce	string	是		随机正整数
Action	string	是	coupon.coupon-store-list	接口方法
Params	array	是		业务参数

请求参数

参数	参数类型	是否必填	默认值	描述
page	int	否	1	第几页
page_size	int	否	10	每页数量
status	int	否		是否可用
expire	string	否		即将过期
keywords	string	否		标题筛选
coupon_type	int	否	-1	优惠券类型
exclude_ids	int	否		ID过滤
stock_status	string	否	all	库存状态 all/salable/sellout
user_receive_type	int	否	1	1领取/2兑换
include_newcomer_only	int	否		是否包含新人专享

响应参数

参数	参数类型	描述
current_page	int	当前页
total	int	总页数
last_page	int	最后一页
reta_list	array
├0	array
├id	int	忧患券 ID
├name	string	优惠券名称
├coupon_type	int	类型
├amount	int	面额
├condition	string	使用门槛
├discounts_content	string	描述
├goods_range_type	intstring	商品限制goods_range_type
├shop_range_type	string	门店限制shop_range_type
├apply_stores	string	门店限制apply_stores
├apply_goods	string	商品限制apply_goods
├expire_type	int	到期类型
├expire_days	int	天数expire_days
├expire_date_text	int	到期文字
├total	int	总量
├number_of_user	int	领取人数
├used	int	已使用
├number	int	领取张数
├status	int	状态
├expire_status	int	过期状态
├is_newcomer_only	int	是否新人专享

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "coupon.coupon-store-list",
    "Params": {
        "page": "1",
        "page_size": "10",
        "status": "",
        "expire": "",
        "keywords": "",
        "coupon_type": "-1",
        "exclude_ids": "",
        "stock_status": "all",
        "user_receive_type": "1",
        "include_newcomer_only": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "current_page": "",
        "total": "",
        "last_page": "",
        "reta_list": [
            {
                "id": "",
                "name": "",
                "coupon_type": "",
                "amount": "",
                "condition": "",
                "discounts_content": "",
                "goods_range_type": "",
                "shop_range_type": "",
                "apply_stores": "",
                "apply_goods": "",
                "expire_type": "",
                "expire_days": "",
                "expire_date_text": "",
                "total": "",
                "number_of_user": "",
                "used": "",
                "number": "",
                "status": "",
                "expire_status": "",
                "is_newcomer_only": ""
            }
        ]
    }
}

异常示例

{
    "status": true,
    "code": "异常编码，根据不同的业务返回编码",
    "message": "异常说明：查询的信息不存在"
}

错误码

{
    "status": false,
    "code": "系统错误编码：详见全局返回编码",
    "message": "系统错误说明"
}