Skip to main content

【资产类】查询卡券包列表

基本信息

接口名称:查询会员卡券包状  态:已完成
接口路径:POST /paas/micro/voucherwallet/getCardVoucherList更新时间:2025-04-02 00:03:34
Mock地址:https://apimock.e-buychina.com/mock/77/paas/micro/voucherwallet/getCardVoucherList

请求参数

Headers:

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

Body:

参数名称类型必填默认值备注其他信息
uuidstring请求序列号,请求的唯一标识,不可重复,格式:8位日期格式-32位随机小写字母或数字,示例:20210602-offmplixuwhggrgezfnuivexeabdvbue最大长度:50
最小长度:1
Mock:@now('yyyyMMdd')-@string('lower',32)
appIdstring请求AppId最大长度:50
最小长度:1
Mock:@natural
actionstring交易类型最大长度:50
最小长度:1
Mock:getCardVoucherList
timestampnumber请求时间戳Mock:@timestamp
signTypestring签名类型最大长度:20
最小长度:1
Mock:sha256
signstring签名值最大长度:500
最小长度:1
Mock:@natural
langstring语言最大长度:50
最小长度:1
Mock:zh_CN
contentobject请求报文
  memberIdstring会员ID(memberId,thirdOpenId不可同时为空,优先以memberId进行查询,其次thirdOpenId)最大长度:32
Mock:@string
  thirdOpenIdstring第三方用户标识(memberId,thirdOpenId不可同时为空,优先以memberId进行查询,其次thirdOpenId)最大长度:32
Mock:@string
  productTypestring卡券的产品类型(Voucher,Cashcard),不送则都返回最大长度:16
Mock:@string
  voucherCodestring卡券码最大长度:200
Mock:@string
  voucherTypestring卡券类型 券类型:
全场代金券(orderVoucher)
单品代金券(productVoucher)
免费产品券(exchangeCoupon)
买产品送产品券(BuyGiveCoupon)
买产品加现金券送产品券(BuyCashGiveCoupon)
全场百分比折扣券(orderDiscountCoupon)
全场满减现金券(orderReduceCoupon)
单品百分比折扣券(productDiscountCoupon)
单品满减现金券(productReduceCoupon)
第M件折减券(anyoneDiscountCoupon)
搭配套餐券(setMenuCoupon)
现金卡类型:(0不记名,1记名)
可使用英文逗号分隔进行部分筛选
最大长度:200
Mock:@string
  voucherScopestring使用场景最大长度:200
Mock:@string
  shopNostring门店号(上传单个门店号,不支持多个门店号筛选)最大长度:200
Mock:@string
  simpleResultTypestring0是否返回简化结果(不包含卡券使用规则),1是 0否最大长度:200
Mock:@string
  voucherSourcestring卡券来源,支持英文逗号多个查询最大长度:200
Mock:@string
  pageNumberinteger第几页Mock:1
  pageSizeinteger每页显示数Mock:10
  orderBystring排序(倒序):createDate创建时间,updateDate更新时间,expireDate过期时间最大长度:200
Mock:@string
  productSkustring商品SKU最大长度:50
Mock:@string
  enableTimeboolean启用时间段内可用券筛选Mock:@boolean
  includeExpiredinteger是否包含不可用卡券,1包含 0不包含,默认0,如果上送了cardVoucherStatusList,以cardVoucherStatusList为准
  cardVoucherStatusListarray卡券状态:券状态(
00可使用
01已使用
02可使用(一码多次使用时,码还有可用次数)
04已冻结
05已作废
06已过期),
现金卡状态(
1可用
2冻结
3已过期
4已退卡
7已用完)
08转增中

返回数据

参数名称类型必填默认值备注其他信息
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
      skuWhiteListarraysku白名单
      skuBlackListarraysku黑名单
    isNewstring是否是新券,1是,0或null不是
  cardListarray卡列表(参照券列表中的结构,结构完全统一不再赘述)
  totalCountnumber总数Mock:@integer
  cardTotalAmountnumber尊礼卡总余额(单位:元)

备注

请求示例:

{
    "uuid": "{{ @now('yyyyMMdd')-@string('lower',32) }}",
    "action": "getCardVoucherList",
    "appId": "ebuy72e8fc6bec8e",
    "timestamp": "{{ @timestamp }}",
    "signType": "sha256",
    "content": {
        "thirdOpenId": "17621530679",
        "voucherCode": "10032864335452126283"
    }}

响应示例:

{
  "uuid": "20240617-infvqmywrnlbazrkgxfmnkxmzpimphwl",
  "action": "getCardVoucherList",
  "content": {
    "cardList": [],
    "voucherList": [
      {
        "remainTimes": 1,
        "bindingTime": "20240617131443",
        "useRule": {
          "productSku": {
            "1000030005123": 1
          }
        },
        "memberId": "c9ecd73cc44cb12233a946b6fcd548a7",
        "walletId": "5c4c2fbcd9d648a5a2431d3310c69bd4",
        "voucherStatusDesc": "可使用",
        "brandName": "赛百味",
        "thirdOpenId": "18621868307",
        "tenancyId": 78,
        "voucherName": "多选1套餐测试",
        "phoneNumber": "18621868307",
        "totalTimes": 1,
        "updateDate": 1718601283000,
        "ebuyMemberId": "bf2cf7262068d5763d5dd48c9a8fceea",
        "productSku": "1000030005123",
        "validEndTime": "20231208230423",
        "voucherDescUrl": "https://test-paas-ui-static.e-buy.com//views/cardVoucher/data/Voucher_1000030005123.json",
        "voucherCode": "10032864335452126283",
        "productType": "Voucher",
        "createDate": 1718601283000,
        "validStartTime": "20231205230700",
        "isNew": "1",
        "surfaceUrl": "https://ebuyimg.e-mallchina.com/paas-app-admin/20240617124337Z4LwkU6A.jpg",
        "voucherScope": "all",
        "templateUrl": "https://test-paas-ui-static.e-buy.com//views/cardVoucher/voucherDetail.html?ticketType=Voucher&ticketId=1000030005123&data=D3E9E4FE9EC786701C52175A1C0B36C5E9BB620C57FD2C5CCEFDC341A98B32856047F0C370ACE73B933028E57B10F1F1B2CB8DA3AA9D1AFAFB13CE1389FF29E4D51A1145050B6690B7610CFD628DCAE0CC3D455094A8FC03097DDB19ED11CDAE475857985D3796CC",
        "productCode": "1000030005123",
        "voucherStatus": "00",
        "faceValue": 50,
        "voucherExtend": "{\"outerOrderId\":\"task_20240617yihIRT0h_0\",\"saleChannelName\":\"中国移动\",\"ticketDetail\":{\"supportNextDayCancel\":\"N\",\"netValue\":\"43.00\",\"voucherImage\":\"https://ebuyimg.e-mallchina.com/paas-app-admin/20240617124337Z4LwkU6A.jpg\",\"faceValue\":\"50.00\",\"defaultGoodsId\":\"5021002,5021001|5021006,5031005\",\"supportSameDayCancel\":\"N\"}}"
      }
    ],
    "totalCount": 1
  },
  "success": true,
  "errorCode": "",
  "errorMessage": "",
  "timestamp": 1718601753127,
  "signType": "sha256",
  "sign": "32cf99a63757500d2a59a490d6f4b9c3ec9ce75fd2388afcca8355bf4190c07c"
}

其中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)

变更历史

变更日期变更内容
2025-04-01
2025-04-01
2025-03-28
2025-03-28
2025-03-28
2024-08-27
2024-08-27
2024-03-07
2023-12-14
2023-12-06
2023-05-22
2023-04-07
2023-04-07
2023-04-03
2022-10-25
2022-08-10
2022-08-02
2022-07-29
2022-07-29
2022-07-28
2022-07-28
2022-07-28
2022-07-28
2022-07-28
2022-07-28
2022-07-28
2022-07-28
2022-07-28
2022-07-27
2022-07-27
2022-06-17
2022-06-17
2022-06-17
2022-06-17
2022-06-17
2022-06-17
2022-06-17
2022-06-17
2022-05-18
2022-04-26
2022-02-24
2021-07-22
2021-06-18
2021-06-18
2021-06-09
2021-06-09
2021-06-09
2021-06-07
2021-06-04
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-06-02
2021-05-31
2021-05-31
2021-05-30
2021-05-30
2021-05-30
2021-05-30
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-28
2021-05-12
2021-05-12
2021-05-12
2021-04-02
2021-04-02
2021-04-02
2021-04-02
2021-04-02
2021-04-02
2021-04-02
2021-04-02
2021-04-02
2021-04-02
2021-04-02
2021-04-02
2021-04-02
2021-02-04
2021-01-21
2020-12-19
2020-12-07
2020-12-07
2020-12-07
2020-12-07
2020-12-07
2020-12-07
2020-12-04
2020-12-04
api-id=24792