商品订单页获取优惠信息
请求参数
参数中文名称 | 参数英文名称 | 类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
商户收单pid | pid | String | 否 | 如果需要查询券信息,则需要传入配置在券上面的 PID 账号,如果没有传入则会根据 APPID 进行补全(补全可能存在不准确的情况)。 |
订单详细信息 | orderDetailInfo | Object | 是 | - |
L 订单总金额 | L amount | String | 是 | 订单总金额 |
L 商品详情列表 | L itemDetailInfoList | Object[] | 是 | - |
LL 外部商品Id | LL outItemId | String | 是 | - |
LL 外部商品skuId | LL outSkuId | String | 是 | - |
LL 价格 | LL price | String | 是 | - |
LL 数量 | LL quantity | String | 是 | - |
LL 商品id(支付券使用) | LL goodsId | String | 否 | 支付券对应商品id,有则配置。 |
公共响应参数
参数中文名称 | 参数英文名称 | 类型 | 参数描述 |
---|---|---|---|
错误码 | resultCode | String | - |
错误信息 | resultMsg | String | - |
是否调用成功 | success | Boolean | - |
响应参数
参数中文名称 | 参数英文名称 | 类型 | 参数描述 |
---|---|---|---|
订单优惠信息 | orderDiscountDetailInfo | Object | - |
L 展示状态 | L showStatus | String | 用于判断是否可以展示前置优惠组件。ture:可以展示组件false:不可以展示组件如果没有会员积分、消费金等优惠的情况不展示组件。 |
L 限制购买 | L buyRestrict | boolean | 判断当前sku是否限制购买的状态:ture:可以购买false:不可以购买注意:如果商品可以使用原价下单情况,则不会限制购买。 |
L 咨询ID | L activityConsultId | String | 重要参数,用于保障当前查询订单和用户下单的优惠信息保持一致。 |
L 总优惠金额 | L totalPromoAmount | String | 订单总的优惠金额 = 券优惠 + 红包优惠 + 渠道优惠 |
L 券优惠金额 | L voucherPromoAmount | String | 订单总的券优惠金额 |
L 红包优惠金额 | L couponPromoAmount | String | 订单总的红包优惠金额 |
L 渠道优惠金额 | L channelPromoAmount | String | 专享价 |
L 优惠列表 | L promoAmountInfoList | List | 目前单渠道暂时只会存在一种优惠 |
LL 优惠类型 | LL salePromoType | String | ANT_MEMBER : 会员积分CONSUME_GOLD:消费金 |
LL 总积分 | LL totalPointAmount | String | 订单总共消耗多少会员积分,或者消费金。 |
LL 渠道指定总优惠 | LL totalChannelPromoAmount | String | 如消费金抵扣的总优惠、渠道立减总优惠 |
LL 背景图片地址 | LL backgroundPic | String | - |
LL 背景标识 | LL backgroundTag | String | 支付宝会员 |
LL 文案 | LL backgroundContent | String | 已满2000消费金抵¥20 |
L sku优惠明细 | L itemConsultDetailInfoList | String | - |
LL 商品id | LL outItemId | String | - |
LL skuid | LL outskuId | String | - |
LL 限制购买状态 | LL restrictCode | String | - |
LL 限制购买原因 | LL restrictReason | String | ![]() |
LL 优惠类型 | LL salePromoType | String | ANT_MEMBER : 会员积分CONSUME_GOLD:消费金DISCOUNT:渠道优惠 |
LL 优惠子类型 | LL promoType | String | 会员积分价 -AntMemberPromotionTypeEnum.MEMBER_POINTS会员等级价 -AntMemberPromotionTypeEnum.LEVEL_PRICE |
LL 单次消耗积分 | LL singleConsume | String | 商品消耗的积分,以下几种情况:在消费金,会员积分场景,展示需要消耗的积分值。会员等级价情况数值为0,异常情况可能返回为空,展示时需要进行兜底处理 。比如:9.9元 + 100积分。 |
LL 优惠幅度 | LL promoAmount | String | 原价-优惠后售价 |
LL 原价 | LL originalPrice | String | - |
LL 优惠后售价 | LL salePrice | String | - |
L 券列表 | L voucherConsultInfoList | List | 展示sku下可以展示的券列表。 |
LL 券资产编码 | LL _assetsCode | String | - |
LL 券ID | LL voucherId | String | - |
LL 券名称 | LL voucherName | String | 券的名称 |
LL 券类型 | LL voucherType | String | 券类型: 全场券: ALL单品券: ITEM |
LL 优惠类型 | LL promoType | String | 优惠类型包括:满减券 - CASH_COUPON折扣券 - DISCOUNT_COUPON特价券 - SPECIAL_OFFER_COUPON |
LL 优惠子类型 | LL promotionSubType | String | 优惠子类型包括:优惠券 - PLATFORM_VOUCHER红包 - COUPON |
LL 券金额(满减券) | LL reductionAmount | String | - |
LL 减至金额(特价券) | LL specifiedAmount | String | - |
LL 折扣力度(折扣券) | LL reductionRatio | String | - |
LL 封顶优惠金额 | LL ceilingAmount | String | - |
LL 优惠门槛文案 | LL thresholdAmountContent | String | 用于展示券使用门槛文案。比如:满100元可用。 |
LL 券失效时间 | LL expiredTime | String | - |
LL 红包金额 | LL couponAmount | String | 如果有红包的话,返回红包金额。 |
请求示例
// 引入插件
const plugin = requirePlugin('tradePay');
Page({
async onLoad() {
const params = {
// 订单详细信息,仅为代码说明,具体参数参考入参表格!
orderDetailInfo: {
amount: '2', // 订单总金额
itemDetailInfoList: [{
outItemId: 'zh030206',
outSkuId: 'zh030206-1',
price: '100.1', // 商品价格
quantity: 2, // 数量
}],
},
};
const discountResult = await plugin.getOrderPageDiscountInfo(params);
const {
success,
resultCode, // 错误码
resultMsg, // 错误信息
showStatus, // 是否要展示组件
buyRestrict, // 是否允许下单
activityConsultId, // 咨询ID,在调用支付 API 时回传
totalPromoAmount, // 平台优惠-总优惠金额
totalOrderAmount, // 平台优惠-总订单金额
voucherPromoAmount, // 券优惠金额
couponPromoAmount, // 红包优惠金额
channelPromoAmount, // 渠道优惠金额
promoAmountInfoList, // 优惠金额详细信息
itemConsultDetailInfoList, // 商品详细信息
voucherConsultInfoList, // 优惠详细信息
} = discountResult;
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:23