【SPI】生成订单并冻结优惠
接口说明
- 1.使用场景:发起收银时使用三方码意向金代金券需接入此SPI接口,和【撤销订单并解冻优惠】接口一起接入
- 2.用户使用抖音扫码买单时,需要商家通过开平SPI接口在三方系统冻结优惠资产(如意向金代金券)
- 3.核心能力
- a.operate_type=1,冻结优惠(如意向金代金券)
- b.operate_type=2,生成订单并冻结优惠资产(如意向金代金券),暂不支持,未来开放
- 5.重要:接口需保证幂等性,幂等成功返回成功状态码
流程图
基本信息
名称 | 描述 |
HTTP Method | POST |
Scope | life.capacity.homed.trade.order.createAndFreeze |
权限要求 | 抖音开放平台路径:开发者平台/服务商平台>控制台>应用详情>解决方案 商家授权路径:抖音来客>店铺管理>第三方应用授权 |
请求头
名称 | 字段类型 | 是否必填 | 示例 | 描述 |
content-type | String | 是 | | 固定值"application/json" |
请求参数
参数名 | 参数类型 | 是否必填 | 描述 | 示例值 |
operate_type | int32 | 是 | 操作类型: 1 冻结优惠资产; 2 生成买单订单并冻结优惠资产(意向金or代金券),暂不支持,未来开放; | 1 |
pre_order_id | string | 否 | 抖音侧预订单ID(对应发起收银接口返回的pre_order_id),当operate_type=1时,pre_order_id必填 | "123" |
响应参数
参数名 | 参数类型 | 是否必填 | 描述 | 示例值 |
data | object | 是 | 响应数据 | |
.result_code | int32 | 是 | code:0 表示成功;非0表示失败 | |
.result_description | string | 否 | 结果描述,非0是必填,上报失败原因 | |
响应示例
正常响应示例
{ "data": { "result_code": 0, "result_description": "success" } }
失败响应示例
{ "data": { "result_code": 1, "result_description": "冻结失败,原因xxx" } }
