企迈云-开放平台

请求地址

请求方式	版本信息	请求地址
POST	V3	http://openapi.zvcms.com/v3/cy/customer/chooseCouponAsOne

公共参数

参数	参数类型	是否必填	描述
openId	string	是	密钥Id
grantCode	string	是	授权code
token	string	是	签名，参考《数字签名sign》
timestamp	string	是	当前时间戳
nonce	string	是	随机正整数
params	array	是	业务参数

请求参数

参数	参数类型	是否必填	描述
customerCode	string	否	会员码, 会员ID和会员码必传一个, 同时存在取会员ID
customerId	bigint	是	会员ID
tradeMarks	array	否
├0	array	否
├num	int	是	商品数量
├tradeMark	string	是	商品标识
├price	money(元)	是	商品单价/元
├discountMoney	money(元)	否	本商品总的优惠金额/元
discountPrice	money(元)	是	订单折扣金额
typeCate	int	是	1堂食,3外卖
multiMark	string	是	门店编码

响应参数

参数	参数类型	描述
status	int	请求成功或失败
code	int	成功/错误编码
message	string	成功/错误描述
data	array
├0	array
├beginAt	string	生效时间, yyyy-MM-dd HH:mm:ss
├endAt	string	到期时间, yyyy-MM-dd HH:mm:ss
├cardId	int	用户券ID(券码)
├couponCenterType	int	券类型：1、代金券 2、折扣券 3、商品券 4、买 A 赠 B 券 5、限制数量免单券 6、免运费/配送费券 7、免排队券 8、停车券
├couponExplain	string	优惠券说明
├couponId	int	优惠券模板ID
├couponType	int	优惠形式0-指定金额,1-折扣券
├customerId	int	会员ID
├expireDesc	string	有效期说明
├imageUrl	string	优惠券图片
├sellerName	string	店铺名称
├takeAvatar	string	领取会员头像
├takeCustomerId	string	领取会员ID
├takeCustomerUserName	string	领取会员昵称
├takeTime	string	领取时间
├templateId	string	优惠券规则ID
├title	string	优惠券名称
├unUseDesc	string	优惠券不可用原因
├unUseStatus	int	优惠券是否可用,0不可用，1可用
├useStatus	int	劵状态:0：未使用/已冲正、1：已核销、2：已冻结、4：转赠中、5：转赠超时、6：已失效、7：已删除/已回收
├userCouponCanDisAmount	money(元)	订单计算中，优惠券可优惠的金额/元
├couponTemplate	array
├applyGoodsType	int	适用商品类型：1-全部商品，2-指定商品，3-指定不适用商品
├applyStoreType	int	功能：适用的门店 1-所有门店，2-指定门店，3-指定门店不适用
├buyCount	int	购买数量，针对买A赠B券
├couponWhere	字符串数组	优惠券使用说明
├discountAmount	string	优惠内容
├discountGoodsCount	int	优惠商品数量
├discountType	int	优惠方式：1-优惠最高价格商品，2-优惠最低价格商品，3-优惠次高价格商品 4-指定商品全部优惠
├discountUnit	int	优惠单位：1-元，2-折
├expireDesc	string	有效期说明
├giveCount	int	赠送数量
├goodsCategoryIds	字符串数组	功能：商品类目限制
├goodsIds	int数组	功能：适合商品的ID
├id	int	模板ID
├imageUrl	string	图片地址
├instruction	string	优惠券描述
├isFixedTimeScope	int	是否指定时段才能使用优惠券，0-否，1-是
├isNewCustomerShared	int	是否新用户专享：0-否，1-是
├kind	int	属性，1-兑换券，2-领取券，3-权益券
├maxUseCount	int	最大使用数量，开启使用限制，一天最多使用的数量
├name	string	模板名称
├otherInfos	array
├addGoodsBillingKind	int	加料商品财务属性-1-视为折扣，2-视为业绩
├billingAmount	money(元)	账务金额
├billingKind	int	账务属性1-视为折扣，2-视为业绩，3-视为预存
├imageUrl	string	券模板图片
├isGive	int	赠送设置0-不可赠送，1-可赠送
├isMarkTag	int	是否打用户标签0-否，1-是
├showQrCode	int	是否显示二维码0-不显示, 1-显示
├userTags	string	用户标签
├weChatGiveCouponImage	string	微信转增图片
├zfbGiveCouponImage	string	支付宝转增图片

请求示例

{
    "openId": "6dc05b4ac175cf316d226252b05cf685",
    "grantCode": "782c281f62",
    "timestamp": "1547186244",
    "nonce": "658965",
    "token": "0%2B%2B3c6hthjwAml4ABAXOYF4Q6UY%3D",
    "params": {
        "customerCode": "",
        "customerId": "",
        "tradeMarks": [
            {
                "num": "2",
                "tradeMark": "",
                "price": "1",
                "discountMoney": ""
            }
        ],
        "discountPrice": "0",
        "typeCate": "1",
        "multiMark": ""
    }
}

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": [
        {
            "beginAt": "",
            "endAt": "",
            "cardId": "",
            "couponCenterType": "",
            "couponExplain": "",
            "couponId": "",
            "couponType": "",
            "customerId": "",
            "expireDesc": "",
            "imageUrl": "",
            "sellerName": "",
            "takeAvatar": "",
            "takeCustomerId": "",
            "takeCustomerUserName": "",
            "takeTime": "",
            "templateId": "",
            "title": "",
            "unUseDesc": "",
            "unUseStatus": "",
            "useStatus": "",
            "userCouponCanDisAmount": "",
            "couponTemplate": {
                "applyGoodsType": "",
                "applyStoreType": "",
                "buyCount": "",
                "couponWhere": "",
                "discountAmount": "",
                "discountGoodsCount": "",
                "discountType": "",
                "discountUnit": "",
                "expireDesc": "",
                "giveCount": "",
                "goodsCategoryIds": "",
                "goodsIds": "",
                "id": "",
                "imageUrl": "",
                "instruction": "",
                "isFixedTimeScope": "",
                "isNewCustomerShared": "",
                "kind": "",
                "maxUseCount": "",
                "name": "",
                "otherInfos": {
                    "addGoodsBillingKind": "",
                    "billingAmount": "",
                    "billingKind": "",
                    "imageUrl": "",
                    "isGive": "",
                    "isMarkTag": "",
                    "showQrCode": "",
                    "userTags": "",
                    "weChatGiveCouponImage": "",
                    "zfbGiveCouponImage": ""
                }
            }
        }
    ]
}

异常示例

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

错误码

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

7.4.6 筛选用户可用优惠券

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

场景描述：通过商品标识码筛选用户可用优惠券

请求地址

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码