商品详情页获取优惠信息
收款请求参数
参数中文名称 | 参数英文名称 | 类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
商户收单PID | pid | String | 否 | 如果需要查询券信息,则需要传入配置在券上面的 PID 账号,如果没有传入则会根据 APPID 进行补全(补全可能存在不准确的情况)。 |
商品详细信息 | itemDetailInfo | Object | 是 | - |
L外部商品itemId | L outItemId | String | 是 | 如果只传入outItemId,则返回所有sku的信息。如果传入skuId,则返回指定sku的信息。 |
L外部商品skuId | L outSkuId | String | 否 | 如果传入skuId,则返回指定sku的信息。 |
L商品id(支付券使用) | L goodsId | String | 否 | 支付券对应商品id,有则配置。 |
公共响应参数
参数中文名称 | 参数英文名称 | 类型 | 参数描述 |
---|---|---|---|
错误码 | resultCode | String | - |
错误信息 | resultMsg | String | - |
是否调用成功 | success | Boolean | - |
响应参数
参数中文名称 | 参数英文名称 | 类型 | 参数描述 |
---|---|---|---|
优惠详细信息 | discountDetailInfo | Object[] | - |
L最优的skuId | L preferSkuId | String | 多skuId的情况下,返回优惠力度最大的skuId。 |
L展示状态 | L showStatus | boolean | 用于判断是否可以展示前置优惠组件。ture:可以展示组件false:不可以展示组件如果没有会员积分、消费金等优惠的情况不展示组件。 |
L sku优惠详细信息 | L consultDetailInfoList | List | sku优惠信息列表 |
LL 外部商品skuid | LL outSkuId | String | 外部skuId |
LL 是否限制购买 | LL buyRestrict | boolean | 判断当前sku是否限制购买的状态:ture:可以购买false:不可以购买注意:如果商品可以使用原价下单情况,则不会限制购买。 |
LL 限制购买原因 | LL restrictReason | String | 如果限制购买,则返回原因。返回业务错误码。 |
LL 原价 | LL originalPrice | String | 商品sku原价 |
LL 售价 | LL salePrice | String | 商品sku售价 |
LL 优惠金额 | LL promoAmount | String | 收银台可抵扣的券、红包总优惠金额。 |
LL 优惠类型 | LL salePromoType | String | 商品优惠类型包括:ANT_MEMBER : 会员积分CONSUME_GOLD:消费金 |
LL 优惠子类型 | LL promoType | String | 商品 优惠子类型包括:AntMemberPromotionTypeEnum.MEMBER_POINTS:会员积分价 AntMemberPromotionTypeEnum.LEVEL_PRICE:会员等级价 |
LL 单次消耗积分 | LL singleConsume | String | 商品消耗的积分,以下几种情况:在消费金,会员积分场景,展示需要消耗的积分值。会员等级价情况数值为0,异常情况可能返回为空,展示时需要进行兜底处理。比如:9.9元 + 100积分。 |
LL 会员等级 | LL identityType | String | 会员商品才会返回,每一种等级对应展示的图片和文案是不同的,会员等级如下:primary:大众会员golden:黄金会员platinum:铂金会员diamond:钻石会员 |
LL 会员等级说明 | LL identityTypeDesc | String | 会员商品才会返回,每一种等级对应展示的图片和文案是不同的。 |
LL 背景图片地址 | LL backgroundPic | String | 商品优惠的素材图片,用于渲染商品优惠的氛围。 |
LL 背景标识 | LL backgroundTag | String | 商品优惠的素材图片,用于渲染商品优惠的氛围。 |
LL 文案 | LL backgroundContent | String | 商品优惠的文案,用于展示商品优惠的说明文案。比如:已满2000消费金抵¥20 |
LL 券列表 | LL voucherConsultInfoList | List | 展示sku下可以展示的券列表。 |
LLL 券资产编码 | LLL assetsCode | String | - |
LLL 券ID | LLL voucherId | String | - |
LLL 券名称 | LLL voucherName | String | - |
LLL 券类型 | LLL voucherType | String | 券类型包括: 全场券: ALL单品券: ITEM |
LLL 优惠类型 | LLL promoType | String | 优惠类型包括:满减券 - CASH_COUPON折扣券 - DISCOUNT_COUPON特价券 - SPECIAL_OFFER_COUPON |
LLL 优惠子类型 | LLL promotionSubType | String | 优惠子类型包括:平台优惠 - PLATFORM_VOUCHER红包 - COUPON |
LLL 券金额(满减券) | LLL reductionAmount | String | - |
LLL 减至金额(特价券) | LLL specifiedAmount | String | - |
LLL 折扣力度(折扣券) | LLL reductionRatio | String | - |
LLL 封顶优惠金额 | LLL ceilingAmount | String | - |
LLL 优惠门槛文案 | LLL thresholdAmountContent | String | 用于展示券使用门槛文案。比如:满100元可用。 |
LLL 券失效时间 | LLL expiredTime | String | - |
LLL 红包金额 | LLL couponAmount | String | 如果有红包的话,返回红包金额。 |
请求示例
// 引入插件
const plugin = requirePlugin('tradePay');
Page({
async onLoad() {
const params = {
// 仅为代码说明,具体参数参考入参表格!
itemDetailInfo: {
outItemId: 'zh030206',
outSkuId: 'zh030206-1',
price: '100.1',
},
};
const res = await plugin.getDetailPageDiscountInfo(params) || {};
const {
success,
resultCode, // 错误码
resultMsg, // 错误信息
showStatus, // 是否要展示组件
buyRestrict, // 是否允许购买
consultDetailInfoList = [], // 商品每个sku的优惠信息详情
} = res;
if (!success) {
console.error('商详前置优惠接口失败');
}
......
}
});
错误码
公共错误码
错误码 | 错误码描述 |
---|---|
INVALID_PARAMETER | 非法参数 |
SERVICE_NOT_NOT_EXIST | 商品状态异常 |
SERVICE_NOT_AVAILABLE | 商品状态异常 |
CONSULT_RESULT_ERROR | 系统错误 |
SYSTEM_ERROR | 系统错误 |
业务错误码
会员积分场景
错误码 | 错误码描述 |
---|---|
MEMBER_ASSERT_UNAVAILABLE | 会员优惠不可用 |
MEMBER_POINT_INSUFFICIENT | 用户会员积分余额不足 |
PROMO_BUDGET_NOT_ENOUGH | 优惠库存不足 |
PROMO_COUNT_LIMIT | 优惠计次超限 |
会员等级场景
错误码 | 错误码描述 |
---|---|
NOT_QULIFIED_MEMBER_GRADE | 用户当前会员等级不准入 |
MEMBER_ASSERT_UNAVAILABLE | 会员优惠不可用 |
PROMO_BUDGET_NOT_ENOUGH | 优惠库存不足 |
PROMO_COUNT_LIMIT | 优惠计次超限 |
消费金场景
错误码 | 错误码描述 |
---|---|
CONSUME_GOLD_UNAVAILABLE | 消费金不可用 |
CONSUME_GOLD_FREEZE | 消费金不可用 |
CONSUME_GOLD_UNREGISTER | 消费金不可用 |
CONSUME_GOLD_INSUFFICIENT | 消费金不足 |
CONSUME_GOLD_UNAUTHORIZED | 消费金未授权 |
PROMO_BUDGET_NOT_ENOUGH | 优惠库存不足 |
PROMO_COUNT_LIMIT | 优惠计次超限 |
修改于 2023-11-21 08:27:05