发券
收藏我的收藏
使用限制
无
接口 SLA
请求服务商接口,每个服务商各不相同
接口说明
1、发码中,必须十分钟内通过发码回调接口回调抖音侧告知发码结果,否则第10分钟抖音侧会自动发码失败,发起退款,会走服务商退款审核,此时服务商可以通过退款拒绝做补码操作。
2、发码成功,则必须在响应中直接返回正确的码 (后面不需要要求回调)。
3、发码失败,则抖音侧会发起退款申请,不走服务商退款审核,即服务商明确返回发码失败,不过退款审核,无法做补码,直接退款给用户
(1)接口请求成功时务必确保 error_code=0, 发放券码的结果通过 data.result 字段返回。
(2)若 error_code 不为 0,不处理 data 中的数据,抖音会十分钟内多次重试发券请求。
4、金额说明:
(1)商家实收(抽佣前)=原始金额-商家营销金额;
(2)商家实收(抽佣后)此接口不提供;
(3)平台营销金额:平台补贴的金额;
(4)支付优惠金额:使用平台支付优惠的平台补贴金额。
5、SPI 响应超时时间为 8s,超过 8s 则为无效响应。
6、抖音侧重试间隔10s、30s 、60s 、120s、120s 、240s,最多重试6次
请求参数
Body 请求
参数名称 | 参数类型 | 参数描述 | 必需 |
order_id | string | 抖音侧的订单号 | 是 |
count | int32 | 购买份数 | 是 |
sku | object | 组品商品信息 | 是 |
.sku_name | string | 抖音商品名 | 是 |
.sku_id | string | 抖音的组品商品ID | 是 |
.third_sku_id | string | 三方服务商侧的商品ID | 是 |
.groupon_type | int32 | 商品类型(1=团餐券; 2=代金券;3=次卡) | 是 |
open_id | string | 下单人在抖音本地生活的openid | 是 |
start_time | int | 券有效期开始时间,时间戳,秒 | 是 |
expire_time | int | 券有效期截至时间,时间戳,秒 | 是 |
amount | struct | 订单金额信息 | 否 |
.original_amount | int | 售卖金额,单位分 | 否 |
.pay_amount | int | 用户实付金额,单位分 | 否 |
.ticket_amount | int | 平台营销金额,单位分 | 否 |
.merchant_ticket_amount | int | 商家营销金额,单位分 | 否 |
.payment_discount_amount | int | 支付优惠金额,单位分 | 否 |
tourists | list(object) | 出行人信息 | 否 |
.name | string | 姓名 | 否 |
.phone | string | 联系电话 | 否 |
.id_card | string | 证件号码 | 否 |
.credential_type | int32 | 证件类型(1=身份证; 2=港澳通行证; 3=台湾通行证; 4=回乡证; 5=台胞证; 6=护照) | 否 |
combination | list | 券组套信息 | 是 |
.combination_id | string | 组套id,代表x个子品组成一个主品 | 是 |
.certificates | list<object> | | |
..certificate_id | string | 抖音内部券ID,用于回调映射 = 履约内部的execute_id | 是 |
..sku_id | string | 券维度sku_id (代表子商品ID) | 是 |
..third_sku_id | string | 券维度三方服务商侧的商品ID (代表子商品ID) | 是 |
请求示例
{ "order_id": "12345678", "count": 2, "sku": { "sku_name": "商品", "sku_id": "bb", "third_sku_id": "qq", "groupon_type": 1 }, "amount": { "original_amount": 10000, "pay_amount": 8000, "ticket_amount": 1000, "merchant_ticket_amount": 1000, "payment_discount_amount": 1000, "coupon_pay_amount": 1000 }, "tourists": [ { "name": "张三", "phone": "13800000000", "id_card": "310115199807013370", "credential_type": 1 } ], "start_time": 1664553600, "expire_time": 1665158399, "combination": [ { "combination_id": "com1", "certificates": [ { "certificate_id": "a111", "sku_id": "a333","third_sku_id": "a444" }, { "certificate_id": "b111", "sku_id": "b333", "third_sku_id": "c222" } ] } ] }
响应参数
响应示例
字段名称 | 字段类型 | 字段描述 | 是否必填 | |
data | object | | | |
.error_code | int64 | 接口错误码 | 是 | |
.description | string | 接口错误描述 | 是 | |
.result | int | 发码结果. 0:发码中(走凭证回调接口回传) 1:成功 2:失败 | 是 | |
.fail_reason | string | 失败原因 | 否 | |
.certificates | list | 券 result=1必须返回,根据请求certificates返回所 有对应的凭证code | 是 | |
..certificate_id | string | 抖音内部券ID | 是 | |
..code | string | 服务商侧券码 | 是 | |
- 1.发码结果
- a.发码中,则必须十分钟内通过凭证回调接口回调抖音侧告知结果,否则会自动退款
- b.发码成功,则必须在响应中直接返回正确的凭证 (不需要再走凭证回调接口)
- c.发码失败,
- i.接口请求成功时务必确保 error_code=0, 发放券码的结果通过 data.result 字段返回。
- ii.若 error_code 不为 0,不处理 data 中的数据,抖音会十分钟内多次重试发券请求。
- 2.凭证
- a.entrance和projects不能同时都为空
- b.id_cards、qrcodes、certificate_nos、urls、credentials不能同时都为空
- c.vouchers的size需要与发码请求的count一致
- d.订单维度project_id需要唯一,不能重复,核销接口需传入
响应示例
正常示例
- •发码中
{ "data": { "error_code": 0, "description": "success", "result": 0 } }
- •发码成功
{ "data": { "error_code": 0, "description": "success", "result": 1, "certificates": [ { "certificate_id": "a111", "code": "a" }, { "certificate_id": "b111", "code": "b" } ] } }
