Skip to main content

【资产类】查询单张卡券详情

基本信息

接口名称：查询单张卡券详情状  态：已完成
接口路径：POST /paas/micro/voucherwallet/queryVoucherDetail更新时间：2024-06-21 19:48:23
Mock地址：https://apimock.e-buychina.com/mock/77/paas/micro/voucherwallet/queryVoucherDetail

请求参数

Headers:

参数名称参数值是否必填
Content-Typeapplication/json是

Body:

参数名称类型必填默认值备注其他信息
uuidstring是uuid最大长度：50
最小长度：1
Mock：@now('yyyyMMdd')-@string('lower',32)
appIdstring是应用id最大长度：50
最小长度：1
Mock：@string
actionstring是交易名称最大长度：50
最小长度：1
Mock：queryVoucherDetail
timestampnumber是时间戳Mock：@timestamp
signTypestring是签名类型最大长度：50
最小长度：1
Mock：sha256
signstring是签名最大长度：50
最小长度：1
Mock：@natural
contentobject是请求报文
　　voucherCodestring是券码最大长度：50
最小长度：1
Mock：@string
　　shopNostring是当前门店号最大长度：50
最小长度：1
Mock：@string
langstring是语言最大长度：50
最小长度：1
Mock：zh_CN

返回数据

参数名称类型必填默认值备注其他信息
uuidstring是请求序列号最大长度：50
最小长度：1
Mock：@now('yyyyMMdd')-@string('lower',32)
successboolean是交易成功与否Mock：@boolean
actionstring是交易类型最大长度：50
最小长度：1
Mock：getCardVoucherList
timestampnumber是返回时间戳Mock：@timestamp
errorCodestring是错误码最大长度：50
Mock：@word
errorMessagestring是错误描述最大长度：50
Mock：@csentence
signTypestring否签名类型最大长度：20
Mock：sha256
signstring否签名值最大长度：500
Mock：@natural
contentobject是返回报文
　　voucherListarray否券列表（卡、券统一结构）
　　　　memberIdstring否会员ID最大长度：32
最小长度：1
Mock：@word
　　　　phoneNumberstring否手机号最大长度：32
最小长度：1
Mock：@string
　　　　tenancyIdnumber否租户IDMock：@natural
　　　　brandNamestring否品牌名称最大长度：100
最小长度：1
Mock：@string
　　　　ebuyMemberIdstring否易百会员IDMock：@string
　　　　thirdOpenIdstring否第三方用户标识Mock：@string
　　　　productTypestring是卡券的产品类型：
Voucher 电子券
Cashcard 现金卡		最大长度：16
最小长度：1
Mock：@string
　　　　productCodestring是卡券的产品编码最大长度：32
最小长度：1
Mock：@string
　　　　voucherTypestring是卡券类型 券类型：
全场代金券(orderVoucher)
单品代金券(productVoucher)
免费产品券(exchangeCoupon)
买产品送产品券(BuyGiveCoupon)
买产品加现金券送产品券(BuyCashGiveCoupon)
全场百分比折扣券(orderDiscountCoupon)
全场满减现金券(orderReduceCoupon)
单品百分比折扣券(productDiscountCoupon)
单品满减现金券(productReduceCoupon)
第M件折减券(anyoneDiscountCoupon)
搭配套餐券(setMenuCoupon)
现金卡类型：（0不记名，1记名）
可使用英文逗号分隔进行部分筛选		最大长度：16
最小长度：1
Mock：@string
　　　　voucherParentTypestring否卡券父类型：
全场代金券（orderVoucher）
产品兑换券（exchangeCoupon）
全场折扣券（orderDiscountCoupon）
单品折扣券（productDiscountCoupon）		最大长度：16
最小长度：1
Mock：@string
　　　　voucherNamestring否卡券名称最大长度：32
最小长度：1
　　　　voucherCodestring否卡券码最大长度：32
最小长度：1
Mock：@string
　　　　voucherStatusstring是卡券状态：
00可使用
01已使用
02可使用（一码多次使用时，码还有可用次数）
03未激活
04已冻结
05已作废
06已过期
07未生效
08转赠中
09码异常

现金卡状态：
0未激活
1可用
2冻结
3已过期
4已退卡
5已销卡
7已用完		最大长度：16
最小长度：1
Mock：@string
　　　　voucherStatusDescstring是卡券状态描述最大长度：32
Mock：@string
　　　　faceValuenumber否面值（单位：元）Mock：@float
　　　　remainTimesinteger否剩余可用次数（券）Mock：@integer
　　　　totalTimesinteger否总可用次数（券）
　　　　voucherAmountnumber否可用金额（单位：元）Mock：@float
　　　　merchantRealAmountnumber否商户实收金额（单位：元）Mock：@float
　　　　discountAmountnumber否折扣金额（单位：元）Mock：@float
　　　　surfaceUrlstring否卡面URL（大图）最大长度：256
最小长度：1
Mock：@string
　　　　templateUrlstring否卡券模板链接最大长度：50
最小长度：1
Mock：@string
　　　　validStartTimestring是有效期开始时间yyyyMMddHHmmss最大长度：20
最小长度：14
Mock：@string
　　　　validEndTimestring是有效期结束时间yyyyMMddHHmmss最大长度：20
最小长度：14
Mock：@string
　　　　bindingTimestring是发卡券时间yyyyMMddHHmmss最大长度：20
最小长度：14
Mock：@string
　　　　voucherSourcestring否卡券来源最大长度：32
最小长度：1
Mock：@string
　　　　voucherSourceNamestring否卡券来源中文名称最大长度：32
最小长度：1
Mock：@string
　　　　voucherChannelstring否显示渠道(多个渠道逗号分隔)最大长度：32
最小长度：1
Mock：@string
　　　　voucherScopestring否使用场景最大长度：256
最小长度：1
Mock：@string
　　　　voucherDescstring否卡券描述最大长度：2000
最小长度：1
Mock：@string
　　　　voucherDescUrlstring否卡券描述url(阿里云OSS全路径，json格式,包含使用说明、图片等)最大长度：500
最小长度：1
Mock：@string
　　　　packageIdstring否转增时的包裹id最大长度：32
Mock：@string
　　　　voucherExtendstring是获取小图"{\"smallImgUrl\": }"最大长度：20
Mock：@string
　　　　useRuleobject否卡券使用规则
　　　　　　productSkuobject否可使用的产品sku和最小数量，如{"11111":1,"22222",3,"33333":1}，key表示sku id，value表示满足卡券使用的sku最小数量
　　　　　　giveProductSkuobject否赠送的产品sku和数量，如{"11111":1,"22222",3,"33333":1}，key表示sku id，value表示赠送的sku数量
　　　　　　discountRatenumber否折扣率，0.6表示6折Mock：@float
　　　　　　maxDiscountAmountnumber否最大折扣金额，元Mock：@float
　　　　　　discountAmountnumber否折扣金额，元Mock：@float
　　　　　　minUseAmountnumber否使用门槛(最小订单金额)，元Mock：@float
　　　　　　extraCashnumber否额外需补的现金，元Mock：@float
　　　　　　enableWeekdaysarray否周几可使用(1 2 3 4 5 6 7 日一二三四五六)周日开头
　　　　　　enableDailyTimesarray否每天可用时间段，以“-”分割，如18:00-23:59
　　　　　　overlayboolean否是否可以叠加使用Mock：false
　　　　　　allowGivenboolean否是否允许转增Mock：false
　　　　isNewstring否是否是新券，1是，0或null不是
　　cardListarray否卡列表（参照券列表中的结构，结构完全统一不再赘述）
　　totalCountnumber否总数Mock：@integer

备注

请求示例：

{
    "uuid": "{{ @now('yyyyMMdd')-@string('lower',32) }}",
    "appId": "BKiHoW",
    "action": "queryVoucherDetail",
    "timestamp": 1717577924,
    "signType": "sha256",
    "sign": "5423097783884964",
    "content": {
        "voucherCode": "10032864335452126283",
        "shopNo": "123456"
    },
    "lang": "zh_CN"
}

响应示例：

{
  "uuid": "20240617-ttoreysoulzgreboymzwowghxqwhlngx",
  "action": "queryVoucherDetail",
  "content": {
    "cardList": [],
    "voucherList": [
      {
        "remainTimes": 1,
        "voucherStatusDesc": "可使用",
        "voucherName": "多选1套餐测试",
        "totalTimes": 1,
        "validEndTime": "20240914235959",
        "voucherCode": "10032864335452126283",
        "productType": "Voucher",
        "createDate": 1718601283000,
        "validStartTime": "20240617000000",
        "createBy": "system",
        "voucherStatus": "00",
        "faceValue": 50,
        "voucherExtend": "{\"ticketDetail\":{\"supportNextDayCancel\":\"N\",\"netValue\":\"43.00\",\"voucherImage\":\"https://ebuyimg.e-mallchina.com/paas-app-admin/20240617124337Z4LwkU6A.jpg\",\"supportVerify\":true,\"faceValue\":\"50.00\",\"defaultGoodsId\":\"5021002,5021001|5021006,5031005\",\"supportSameDayCancel\":\"N\"}}"
      }
    ],
    "totalCount": 1
  },
  "success": true,
  "errorCode": "",
  "errorMessage": "",
  "timestamp": 1718601817526,
  "signType": "sha256",
  "sign": "7da1453ac14759291b24872a52f13c9f38982085d66ea82677d2225eec3ab601"
}

其中voucherExtend中ticketDetail字段相关含义如下：
supportVerify: true/false 门店是否可用
supportNextDayCancel：是否支持隔日退
supportSameDayCancel：是否支持当日退
faceValue：面值
netValue：净值
minLimit：门槛金额（有则返回）
discountAmount：折扣金额（有则返回）
weekTimes：可用时间段（JSONArray有则返回）
/*
* 可用时间段
* times: 000000235959(前六位是开始时间, 后6位是结束时间)
* weekDay: 0011000(周日周一周二周三周四周五周六，0:不可用, 1:可用)
*/
cityBlackList: 城市黑名单列表（有则返回）
cityWhiteList: 城市白名单列表（有则返回）
shopBlackList：门店黑名单列表（有则返回）
shopWhiteList：门店白名单列表（有则返回）
voucherType: 券类型（约定值，示例：product表示产品券）
skuList：可用商品列表
defaultGoodsId: 多组n选1套餐(示例:“defaultGoodsld":"110507,110508,11509|124138,123103,123204"表示A组商品:110507110508，110509二选1，B组商品:124138，123103，123204选1)

变更历史

变更日期变更内容
2024-06-07
2024-06-07
2024-06-07
2024-06-07
2024-06-07
2024-06-07
2024-06-07
2024-05-23
2024-05-23
2024-05-23
2024-05-23
2024-05-23
2024-05-23
2024-05-23
2024-05-23
api-id=36480
No Comments
Back to top
Entity Select