企迈云-开放平台

API 2.0

API 2.0 > 2.5 优惠券 > 2.5.10 创建优惠券兑换活动

2.5.10 创建优惠券兑换活动

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

场景描述：创建优惠券兑换活动

餐饮

请求地址

请求方式	版本信息	请求地址
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-activity-add	接口方法
Params	array	是		业务参数

请求参数

参数	参数类型	是否必填	描述
applyStoreType	string	否	适用门店类型:1-所有门店，2-指定门店，3-指定门店不适用
beginDate	DateTime	否	活动开始时间
belongChannelIds	int	否	所属渠道id
belongClientId	int	否	所属客户id
couponType	int	否	券码制作类型：1-电子券，2-纸质券
displayStyles	string	否	优惠码显示样式 banner: 弹窗 Banner 图片 button_bg: 按钮背景颜色
endDate	DateTime	否	活动结束时间
exchangeKind	string	否	兑换形式：1- 一券一码，2-通用码
id	string	否	活动ID
isEnable	int	否	创建活动是否启用 1-是其他/空-不启用
limitCount	int	否	每人限领数量
memo	string	否	活动备注
name	string	否	活动名称
storeIds	string	否	活动门店列表
templates	array	否
├0	array	否
├amount	string	否	数量
├saleAmount	string	否	销售金额
├templateId	string	否	券模板ID
thirdBizCode	string	否	三方业务券编码
totalCount	string	否	生成总量

响应参数

参数	参数类型	描述
status	bool	成功或失败标识
code	int	成功或失败代码
message	string	描述
data	array
├id	string	活动id
├code	string	活动code

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "coupon.coupon-activity-add",
    "Params": {
        "applyStoreType": "",
        "beginDate": "",
        "belongChannelIds": "",
        "belongClientId": "",
        "couponType": "",
        "displayStyles": "",
        "endDate": "",
        "exchangeKind": "",
        "id": "",
        "isEnable": "",
        "limitCount": "",
        "memo": "",
        "name": "",
        "storeIds": "",
        "templates": [
            {
                "amount": "",
                "saleAmount": "",
                "templateId": ""
            }
        ],
        "thirdBizCode": "",
        "totalCount": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "id": "",
        "code": ""
    }
}

异常示例

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

错误码

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