企迈云-开放平台

请求地址

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

请求参数

参数	参数类型	是否必填	描述
bizId	string	是	业务标识
customerId	string	是	用户id
customerPhone	string	是	会员手机号
exchangeCode	string	是	兑换码，一券一码或通用兑换码
gainCouponChannel	string	否	获取渠道，1-微信小程序，2-支付宝小程序，3-H5页面，4-商家页面，5-内部接口

响应参数

参数	参数类型	描述
status	bool	成功或失败标识
code	int	成功或失败代码
message	string	描述
data	array
├0	array
├activityId	int	活动ID
├activityName	string	活动名称
├activityType	int	活动类型，1-兑换活动，2-领取活动
├applySellerId	int	适用店铺ID
├applySellerName	string	适用店铺名称
├channel	string	品牌渠道
├createScene	string	券生成场景说明
├createdAt	DateTime	创建时间
├customerId	string	归属用户ID
├customerName	string	归属用户名称
├customerPhone	string	归属用户手机号
├gainChannel	int	获取渠道，1-微信小程序，2-支付宝小程序，3-H5页面，4-商家页面，5-内部接口
├gainTime	DateTime	获取时间
├gainType	string	获取方式，1-兑换，2-领取，3-营销发放，4-权益活动发放
├giveState	string	转赠状态：0-未转赠，1-转赠中
├groupId	string	集团ID
├id	string	券id（券码）
├isFixedTimeScope	string	是否指定时段才能使用优惠券，1-是
├orderAmount	string	订单金额
├originalTemplateId	string	保存迁移过来的老数据的id
├retrieveCoupon	string	券回收原因
├retrieveReason	string	回收原因
├retrieveTime	DateTime	回收时间
├retrieveUserCode	string	操作回收账号
├sellerId	string	店铺ID
├sellerName	string	店铺名称
├sellerType	int	店铺类型，2-餐饮，9-零售
├status	int	状态，0-未使用，1-已使用，2-已过期，3-已回收
├surplusAmount	string	沉淀金
├templateId	int	券模板ID
├templateImage	string	券模板图片地址
├templateName	string	券模板名称
├templateType	int	券模板类型：1、代金券 2、折扣券 3、商品券 4、买 A 赠 B 券 5、限制数量免单券 6、免运费/配送费券 7、免排队券 8、停车券
├useAmount	string	核销金额
├useChannel	int	核销渠道：1 - 微信小程序，2- 支付宝口碑，3-支付宝小程序，4-美团，5-饿了吗，6-支付宝插件，7-支付宝H5，8-POS点单，9-代客下单，10-商家后台，11-百度，12-餐道ERP
├useOrderCode	string	使用订单号
├useStoreId	string	核销门店id
├useStoreName	string	核销门店名称
├useStoreNo	string	核销门店编码
├useTime	DateTime	使用时间
├useTimeScope	string	使用时段，json数组格式，[{begin:xx, end:xx}]
├validBeginDate	DateTime	有效开始日期
validBeginDate	DateTime	有效结束日期

请求示例

{
    "OpenId": "6dc05b4ac175cf316d226252b05cf685",
    "GrantCode": "782c281f62",
    "Timestamp": "1547186244",
    "Nonce": "658965",
    "Token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "Action": "coupon.coupon-exchange",
    "Params": {
        "bizId": "",
        "customerId": "",
        "customerPhone": "",
        "exchangeCode": "",
        "gainCouponChannel": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": [
        {
            "activityId": "",
            "activityName": "",
            "activityType": "",
            "applySellerId": "",
            "applySellerName": "",
            "channel": "",
            "createScene": "",
            "createdAt": "",
            "customerId": "",
            "customerName": "",
            "customerPhone": "",
            "gainChannel": "",
            "gainTime": "",
            "gainType": "",
            "giveState": "",
            "groupId": "",
            "id": "",
            "isFixedTimeScope": "",
            "orderAmount": "",
            "originalTemplateId": "",
            "retrieveCoupon": "",
            "retrieveReason": "",
            "retrieveTime": "",
            "retrieveUserCode": "",
            "sellerId": "",
            "sellerName": "",
            "sellerType": "",
            "status": "",
            "surplusAmount": "",
            "templateId": "",
            "templateImage": "",
            "templateName": "",
            "templateType": "",
            "useAmount": "",
            "useChannel": "",
            "useOrderCode": "",
            "useStoreId": "",
            "useStoreName": "",
            "useStoreNo": "",
            "useTime": "",
            "useTimeScope": "",
            "validBeginDate": ""
        }
    ]
}

异常示例

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

错误码

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

2.5.9 根据兑换码兑换优惠券

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

场景描述：根据兑换码兑换优惠券

请求地址

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码