- 小程序 OpenAPI SDK 总览
- OpenAPI 简介
- 用户登录态签名
- 签名算法
- 联合授权
- 接口调用凭证
- 登录
- 小程序码与小程序链接
- Web 化接入
- 私信和群聊
- 解决方案
- 线索组件
- 隐私协议
- 视频能力
- 搜索能力
- 任务能力
- 电商
- 生活服务
- 短剧行业
- 用户信息
- 分享
- 客服
- 交易工具
- 小程序券
- 交易系统
- 素材库
- 内容安全
- 泛知识
- 担保支付
- 评价
- 其它
- 订阅消息
- 小程序推广计划
- 挂载
- 分发
- 数据分析
- 服务类目
- 直播间能力
- 抖音开放能力
- 能力申请
- 页面结构自定义
- 普通二维码绑定
- 抖音号绑定
- 流量主
- 抖店绑定
营销查询算价二合一
更新时间 2024-07-24 02:58:49
收藏
我的收藏模版组件提单页通过本接口从开发者的服务获取可用的相关营销信息和对应的算价结果展示给用户。
下单时,抖音开平交易系统会携带用户选择营销信息,通过本接口从开发者的服务获取对应的算价结果。
使用限制
无
接口说明
无
基本信息
基本信息 | ||||
HTTP URL | ||||
HTTP Method | POST |
请求头
请求参数
名称 | 类型 | 是否必填 | 描述 | 示例值 |
msg | string | 是 | 营销查询算价请求细节 JSON 字符串。 注意:
| |
type | string | 是 | 枚举值:
| "query_and_calculate" |
version | string | 是 | 固定值: 2.0。 callback 版本,用于开发者识别回调参数的变更 | "2.0" |
msg 字段
说明:
- 1.need_default_marketing=true,开发者需返回默认最优的营销组合和算价结果
- 2.need_default_marketing=false,且用户选中具体的优惠信息时(商品/订单的selected_marketing不为空),开发者需返回用户选中优惠的算价结果
- 3.goods_marketing_info和order_marketing_info结构体中selected_marketing的区别是优惠适用的维度不同:
- ◦goods_marketing_info下的优惠是作用于具体商品的,比如星冰乐单品优惠立减5元
- ◦order_marketing_info下的优惠是作用于整个订单的,比如订单满200-20
- ◦对于一个具体的优惠券,不能同时出现在goods_marketing_info和order_marketing_info中,它适用的优惠维度是明确的
名称 | 类型 | 是否必填 | 描述 | 示例值 |
open_id | string | 是 | 用户 open_id | "123rq0gjhdfoqierug" |
goods_marketing_info | list<object> | 否 | 商品维度用户选用的营销信息 | [goods_calculation1, goods_calculation2] |
order_marketing_info | object | 否 | 订单维度用户选用的营销信息 | order_calculation_info |
app_id | string | 是 | 小程序 id | "ttcfdbb96650e33351" |
union_id | string | 否 | 用户的 UnionID | "123rq0gjhdfoqieee" |
callback_data | string | 否 | 透传参数 | |
need_default_marketing | bool | 是 | 是否需要默认算价(首次获取营销信息时为true) | true |
goods_marketing_info 元素结构说明
名称 | 类型 | 是否必填 | 描述 | 示例值 | 校验逻辑 |
goods_id | string | 是 | 商品id | "123rq0gjhdfoqierug" | 非空 |
sku_id | string | 否 | skuid | "71273" | |
quantity | number | 是 | 购买数量 | 1 | 须不为 0 且小于等于 50 |
total_amount | number | 是 | 商品总价,单位分 | 10000 | 须大于 0 |
selected_marketing | object(MarketingBundle) | 否 | 用户所选营销策略信息,仅包含该商品的商品层优惠信息 | selected_marketing | |
order_marketing_info 结构说明
名称 | 类型 | 是否必填 | 描述 | 示例值 | 校验逻辑 |
selected_marketing | object(MarketingBundle) | 否 | 用户所选营销策略信息,仅包含该订单的订单层优惠信息 | selected_marketing | |
total_amount | number | 是 | 订单总价,单位分 | 10000 | 须大于 0 |
MarketingBundle 结构说明
名称 | 类型 | 是否必填 | 描述 | 示例值 | 校验逻辑 |
membership_info | list<object> | 否 | 用户身份信息(如会员) | [membership1, membership2] | |
coupon_info | list<object> | 否 | 优惠券信息 | [coupon1, coupon2] | |
activity_info | list<object> | 否 | 活动信息 | [activity1, activity2] | |
score_info | list<object> | 否 | 积分信息 | [score1, score2] | |
membership_info 元素结构说明
名称 | 类型 | 是否必填 | 描述 | 示例值 | 检验逻辑 |
id | string | 是 | 用户身份 id | "abcd33234" | 非空,<=64 字节 |
desc | string | 是 | 用户身份描述 | "京东 plus 会员" | <= 128字节 |
coupon_info 元素结构说明
名称 | 类型 | 是否必填 | 描述 | 示例值 | 检验逻辑 |
id | string | 是 | 优惠券id | "abcd33234" | 非空,<= 64 字节 |
code | string | 是 | 优惠券编码 | "49dkjg04jf04kg" | 非空,<= 64 字节 |
type | number | 是 | 优惠券类型:
| 1 | |
name | string | 是 | 优惠券名称 | "满100减20立减券" | 非空,<= 64 字节 |
receive_time | number | 否 | 优惠券领取时间戳,单位毫秒 | 1920423870232 | |
start_time | number | 是 | 有效起始时间戳,单位毫秒 | 1920423870232 | |
end_time | number | 是 | 有效结束时间戳,单位毫秒 | 1920423870232 | 晚于 start_time |
discount_amount | number | 否 | 优惠价格,单位分 | 20000 | > 0(不允许没有折扣的优惠券) |
deduct_percentage | number | 否 | 折扣百分比,填 0~100,折扣抵 30% 则填 30 | 30 | 0~100 |
detail_url | string | 否 | 优惠券详情跳转链接 | "page/index/index" | <= 512 字节 |
rule | string | 是 | 使用规则描述,包含适用范围描述,使用条件,退款时的处理说明等 | "适用于该店铺所有商品,周一到周五可使用" | 非空,<= 256 字节 |
deny_reasons | list<string> | 否 | 不可用原因。当优惠券不可用时,开发者可传入不可用原因。 | 未达到满减门槛 | 原因不超过3个,单个原因不超过22个字符 |
activity_info 元素结构说明
名称 | 类型 | 是否必填 | 描述 | 示例值 | 检验逻辑 |
id | string | 是 | 活动 id | "abcd33234" | 非空,<= 64 字节 |
name | string | 是 | 活动名称 | 1 | 非空,<= 64 字节 |
start_time | number | 否 | 有效起始时间戳 | 192042387023234 | |
end_time | number | 否 | 有效结束时间戳 | 192042387023235 | 晚于 start_time |
rule | string | 是 | 活动规则 | "限时秒杀立减 100 元" | 非空,<= 256 字节 |
score_info 元素结构说明
名称 | 类型 |