开发指南
API
官网
API 2.0
API 2.0 > 7.4 优惠券相关操作 > 7.4.15 查询优惠券详情(卡券中心)

7.4.15 查询优惠券详情(卡券中心)

开启令牌和权限后可调用。签名方式请查看开发指南
查询优惠券详情, 不区分业务
餐饮

请求地址

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

公共参数

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

请求参数

参数 参数类型 是否必填 默认值 描述
userCouponCode string 是 用户券id(券码)

响应参数

参数 参数类型 描述
activityId int 活动ID
activityName string 活动名称
activityType int 活动类型，1-兑换活动，2-领取活动
applySellerId int 适用店铺ID
applySellerName string 适用店铺名称
channel string 品牌渠道
createScene string 券生成场景说明
createdAt string 创建时间(date-time)
customerId string 归属用户ID
customerName string 归属用户名称
customerPhone string 归属用户手机号
gainChannel int 获取渠道，1-微信小程序，2-支付宝小程序，3-H5页面，4-商家页面，5-内部接口
gainStoreId int 领取门店id
gainTime string 获取时间(date-time)
giveState int 转赠状态：0-未转赠，1-转赠中
id string 券id（券码）
isBelongCompanyStaff int 企业员工专属: 1-是 0：否
isFixedTimeScope int 是否指定时段才能使用优惠券，1-是
orderAmount number 订单金额/元
originalTemplateId int 保存迁移过来的老数据的id
retrieveCoupon string 券回收原因
retrieveReason string 回收原因
retrieveTime string 回收时间(date-time)
retrieveUserCode string 操作回收账号
sellerId int 店铺ID
sellerName string 店铺名称
sellerType int 店铺类型，2-餐饮，9-零售
status int 状态，0-未使用，1-已使用，2-已过期，3-已回收
surplusAmount number 沉淀金/元
templateId int 券模板ID
templateImage string 券模板图片地址
templateName string 券模板名称
templateType int 券模板类型：1、代金券 2、折扣券 3、商品券 4、买 A 赠 B 券 5、限制数量免单券 6、免运费/配送费券 7、免排队券 8、停车券, 12 次券
useAmount number 核销金额/元
useChannel int 核销渠道：1 - 微信小程序，2- 支付宝口碑，3-支付宝小程序，4-美团，5-饿了吗，6-支付宝插件，7-支付宝H5，8-POS点单，9-代客下单，10-商家后台，11-百度，12-餐道ERP
useOrderCode string 使用订单号
useStoreId int 核销门店id
useStoreName string 核销门店名称
useStoreNo string 核销门店编码
useTime string 使用时间(date-time)
useTimeScope string 使用时段，json数组格式，[{begin:xx, end:xx}]
validBeginDate string 有效开始日期(纸质券)
validEndDate string 有效结束日期(纸质券)
templateInfo array
 ├applyGiveCategoryIds array 赠送适用商品分类ids
 ├applyGiveGoodsIds array 赠送适用商品ids
 ├applyGiveGoodsType integer 赠送适用商品类型：1-全部商品，2-指定商品，3-指定不适用商品
 ├applyGoodsType integer 适用商品类型：1-全部商品，2-指定商品，3-指定不适用商品
 ├applyStoreType integer 适用门店：1-所有门店，2-指定门店，3-指定门店不适用
 ├buyCount integer 购买数量
 ├createdAt string 创建时间
 ├discountAmount number 优惠内容(次卡是优惠次数)
 ├discountGoodsCount integer 优惠商品数量
 ├discountType integer 优惠方式：1-优惠最高价格商品，2-优惠最低价格商品，3-优惠次高价格商品 4-指定商品全部优惠
 ├discountUnit integer 优惠单位 1-元，2-折,3-次
 ├expressDiscount string 免运费券优惠内容，1-抵扣快递运费，2-抵扣同城配送费，多个逗号分隔，如1,2
 ├giveCount integer 赠送数量
 ├goodsCategoryIds array 适用商品分类ids
 ├goodsIds array 适用商品ids
 ├id integer 模板ID
 ├instruction string 使用说明
 ├isDiscountShared integer 是否优惠共享：1-是，0-否
 ├isFixedTimeScope integer 是否指定时段才能使用优惠券，0-否，1-是
 ├isNewCustomerShared integer 是否新用户专享 ：1-是
 ├kind integer 属性，1-兑换券，2-领取券，3-权益券
 ├maxUseCount integer 最大使用数量，开启使用限制，一天最多使用的数量
 ├name string 模板名称
 ├otherInfos string 其他信息:imageUrl：券模板图片\n；billingKind：账务属性1-视为折扣，2-视为业绩，3-视为预存\n；billingAmount：账务金额\n；isMarkTag：是否打用户标签0-否，1-是息\n；userTags：用户标签\n；isGive：赠送设置0-不可赠送，1-可赠送; weChatGiveCouponImage:微信转增图片;zfbGiveCouponImage:支付宝转增图片
 ├parkDiscount integer 停车券优惠内容,1-面值，2-折扣
 ├sellerId string 店铺id
 ├status integer 状态，0-未启用，1-启用中，2-已失效
 ├storeIds array 适用门店ids
 ├multiMarks array 适用门店编码
 ├thirdBizCode string 三方业务券编码
 ├thresholdType integer 使用门槛类型：1、无门槛 2、满 xx 元 3、满 xx 件 4-满xx千克
 ├type integer 券类型：1、代金券 2、折扣券 3、商品券 4、买 A 赠 B 券 5、限制数量免单券 6、免运费/配送费券 7、免排队券 8、停车券, 12 次券
 ├useChannel string 使用渠道，1-小程序（线上），2-POS机（线下）,3-windows收银机；4-andriod收银机；5-蜻蜓；6-如意RO，多个逗号分隔，如1,2
 ├useCountLimit integer 使用数量限制, 0-不限制，1-限制
 ├useScene string 使用场景:1-外卖，2-食堂，3.买单 多个逗号分隔，4.预约单（堂食预约单+外卖预约单），5-自提，6-快递（商城） 如1,2,3
 ├useThreshold number 订单满多少元可用
 ├useTimeScope string 使用时段，json数组格式，[{begin:xx, end:xx}]
 ├validBeginDate string 有效开始日期
 ├validDays integer 有效天数
 ├validEndDate string 有效结束日期
 ├validMonths string 有效月数
 ├validStartDay integer 生效时间，0-当日生效，1-次日生效
 ├validType integer 有效期类型，1-固定日期，2-获得券当日/次日开始 x 个自然日内有效,3-获得券当日/次日开始 x 个自然月内有效,4-发放时指定有效期
 ├memberDiscountSet int 会员折扣设置： 1-入会员折扣 2-不入会员折扣
originCount int 初始次数(次券使用)
usableCount int 可用次数(次券使用)
amount int 数量(纸质券)
name string 名称(纸质券)
validDays int 有效天数(纸质券)
validMonths int 有效月数(纸质券)
validStartDay int 生效时间，0-当日生效，1-次日生效(纸质券)
validType int 有效期类型，1-固定日期，2-获得券当日/次日开始 x 个自然日内有效,3-获得券当日/次日开始 x 个自然月内有效(纸质券)

请求示例

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

响应示例

{
    "status": "true",
    "code": "0",
    "message": "说明",
    "data": {
        "activityId": "",
        "activityName": "",
        "activityType": "",
        "applySellerId": "",
        "applySellerName": "",
        "channel": "",
        "createScene": "",
        "createdAt": "",
        "customerId": "",
        "customerName": "",
        "customerPhone": "",
        "gainChannel": "",
        "gainStoreId": "",
        "gainTime": "",
        "giveState": "",
        "id": "",
        "isBelongCompanyStaff": "",
        "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": "",
        "validEndDate": "",
        "templateInfo": {
            "applyGiveCategoryIds": "",
            "applyGiveGoodsIds": "",
            "applyGiveGoodsType": "",
            "applyGoodsType": "",
            "applyStoreType": "",
            "buyCount": "",
            "createdAt": "",
            "discountAmount": "",
            "discountGoodsCount": "",
            "discountType": "",
            "discountUnit": "",
            "expressDiscount": "",
            "giveCount": "",
            "goodsCategoryIds": "",
            "goodsIds": "",
            "id": "",
            "instruction": "",
            "isDiscountShared": "",
            "isFixedTimeScope": "",
            "isNewCustomerShared": "",
            "kind": "",
            "maxUseCount": "",
            "name": "",
            "otherInfos": "",
            "parkDiscount": "",
            "sellerId": "",
            "status": "",
            "storeIds": "",
            "multiMarks": "",
            "thirdBizCode": "",
            "thresholdType": "",
            "type": "",
            "useChannel": "",
            "useCountLimit": "",
            "useScene": "",
            "useThreshold": "",
            "useTimeScope": "",
            "validBeginDate": "",
            "validDays": "",
            "validEndDate": "",
            "validMonths": "",
            "validStartDay": "",
            "validType": "",
            "memberDiscountSet": ""
        },
        "originCount": "",
        "usableCount": "",
        "amount": "",
        "name": "",
        "validDays": "",
        "validMonths": "",
        "validStartDay": "",
        "validType": ""
    }
}

异常示例

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

错误码

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

免费升级

营销功能、插件持续每月更新开发升级

免费专业培训

每月建站、微信营销、电商等互联网增值培训

7×24小时服务支持

400电话、QQ、微信、在线等多渠道售后支持

 

安徽智迈科技股份有限公司 版权所有 Copyright 2009-2018 皖公网安备 34019202000074号 增值电信业务经营许可证：皖B2-20170075