Skip to main content

【资产类】恢复删除的卡券

基本信息

接口名称：恢复删除的卡券状  态：已完成
接口路径：POST /paas/micro/voucherwallet/recoverWallet更新时间：2023-06-13 00:06:44
Mock地址：https://apimock.e-buychina.com/mock/77/paas/micro/voucherwallet/recoverWallet

请求参数

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：recoverWallet
timestampnumber是请求时间戳Mock：@timestamp
signTypestring是签名类型最大长度：20
最小长度：1
Mock：sha256
signstring是签名值最大长度：500
最小长度：1
Mock：@natural
langstring是语言最大长度：50
最小长度：1
Mock：zh_CN
contentobject是请求报文
　　memberIdstring否会员ID（memberId，thirdOpenId，phoneNumber三选一）最大长度：32
Mock：@string
　　thirdOpenIdstring否第三方用户ID（memberId，thirdOpenId，phoneNumber三选一最大长度：64
Mock：@string
　　phoneNumberstring否手机号（memberId，thirdOpenId，phoneNumber三选一）最大长度：20
Mock：@string
　　startDatestring是删除时间始（yyyyMMddHHmmss），存在转增的卡券又被恢复的可能，所以时间范围尽可能准确Mock：@datetime
　　endDatestring是删除时间止（yyyyMMddHHmmss），存在转增的卡券又被恢复的可能，所以时间范围尽可能准确Mock：@datetime
　　voucherCodeListarray否卡券码

返回数据

参数名称类型必填默认值备注其他信息
uuidstring是请求序列号最大长度：50
最小长度：1
Mock：@now('yyyyMMdd')-@string('lower',32)
successboolean是交易成功与否Mock：@boolean
actionstring是交易类型最大长度：50
最小长度：1
Mock：recoverWallet
timestampnumber是返回时间戳Mock：@timestamp
errorCodestring是错误码最大长度：50
Mock：@word
errorMessagestring是错误描述最大长度：50
Mock：@csentence
signTypestring否签名类型最大长度：20
Mock：sha256
signstring否签名值最大长度：500
Mock：@natural
contentobject是返回报文
　　recoverListarray否恢复的卡券
　　　　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
　　　　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
　　　　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不是

备注

注意：为保证签名的一致性，返回报文中的content字段将以string形式的进行返回，例如：

{
	"content": {
		"userId": 1,
		"userName": "Trump"
	}
}

将返回为：

{
	"content": "{\"userId\":1,\"userName\":\"Trump\"}"
}

变更历史

变更日期变更内容
2023-06-12
2023-06-12
2023-06-12
api-id=35916
No Comments
Back to top
Entity Select