企迈云-开放平台

API 2.0

API 2.0 > 2.5 优惠券 > 2.5.8 券包详情

2.5.8 券包详情

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

场景描述：根据劵包id，查询劵包详情

餐饮

请求地址

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

公共参数

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

请求参数

参数	参数类型	是否必填	描述
id	int	是	券包id
user_id	int	否	用户id
num	int	否	购买数量

响应参数

参数	参数类型	描述
status	bool	成功或失败标识
code	int	成功失败状态
message	string	描述
data	array
├id	int	券包id
├store_id	int	店铺id
├title	string	标题
├image	string	券包主图
├amount	int	金额
├num	int	可售数量
├limit_num	int	0不限制大于0则限制数量
├sale_num	int	已售数量
├start_at	DateTime	开始时间
├end_at	DateTime	结束时间
├content	string	购买须知
├status	int	1下架 2上架
├created_at	DateTime	创建时间
├updated_at	DateTime	更新时间
├deleted_at	DateTime	删除时间
├third_party_id	int	是否赠送第三方权益,0不赠送,1赠送
├send_num	int	第三方权益赠送数量
├has_send_num	int	已经赠送的第三方权益数量
├third_party_name	string	第三方权益名称
├discount_amount_desc	int	自定义展示的优惠金额
├paid_coupon_agreement	string	付费券包协议
├show_place	int	展示位置：0 券包列表 1 券包活动
├coupons	array
├0	array
├packages_id	int	券包活动id
├coupon_id	int	优惠券模板id
├coupon_num	int	赠送优惠券数量

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "coupon.package-detail",
    "Params": {
        "id": "",
        "user_id": "",
        "num": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "id": "",
        "store_id": "",
        "title": "",
        "image": "",
        "amount": "",
        "num": "",
        "limit_num": "",
        "sale_num": "",
        "start_at": "",
        "end_at": "",
        "content": "",
        "status": "",
        "created_at": "",
        "updated_at": "",
        "deleted_at": "",
        "third_party_id": "",
        "send_num": "",
        "has_send_num": "",
        "third_party_name": "",
        "discount_amount_desc": "",
        "paid_coupon_agreement": "",
        "show_place": "",
        "coupons": [
            {
                "packages_id": "",
                "coupon_id": "",
                "coupon_num": ""
            }
        ]
    }
}

异常示例

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

错误码

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