抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台

接入前准备

根据以下文档完成开发者账号开通认证、生活服务应用的创建、申请解决方案和能力(参考对接能力)。

开通认证开发者账号、创建生活服务应用

•技术服务商:技术服务商接入指南

开通解决方案及能力

开通流程

•登录服务商平台
•在右上角点击「控制台」,在「我的应用」页面选择「生活服务商家应用」,然后点击目标应用
•在应用左侧导航栏点击「解决方案」,在「解决方案」页面到店餐饮行业解决方案的「操作」列点击「查看详情」。
•在到店餐饮行业解决方案面板中选择「到店餐饮解决方案」中所需要的能力,点击「申请开通」,等待平台审核。审核通过后,即可以使用相关能力。
•开通按钮如果是灰色,点联系我们,注意飞书消息,加SaaS服务商建联群

开发指南

•API调用指南:生成 client-token

业务对接流程

业务流程

商品流程图

交易验券时序图

接口清单

抖音码团购

开放能力
是否必接
对接接口
接口说明
商品发布及查询
必接
查询商品类目,创建商品前可获取类目信息。
返回类目新增【餐饮->其他->实物周边】
必接
用于创建商品前查询商品模板信息。
必接
1.创建或更新商品,限制商品发布范围
a.限制为美食类目
b.限制为团购、代金券、次卡
组合券包新增属性字段-组套规则,基础字段-商品形态类型
必接
上下架商品。
注意事项:子品不允许操作上下架
必接
免审修改团购、代金券
注意事项:不支持通过此接口修改券包、子品实付价,否则会导致券包商品价格校验不通过-待确认
必接
用于查询商品草稿数据。
必接
用于查询商品草稿数据列表。
必接
1.使用商品 ID 或外部商品 ID 查询商品线上数据。
必接
通过接口查询商品线上数据列表
必接
用于餐饮团购商品审核流程结束以后向商家通知审核结果
团购核销
抖音码必接
抖音团购券码的核销, 需要先调用本接口, 查询订单的券列表,选择要验的券,再调用验券接口,核销券码。
必接
用于核销券码,同时适用于抖音团购券码与三方券码,抖音券码的核销需要先调用准备接口,再调用本接口,三方券码的核销直接调用本接口即可。
必接
针对“抖音团购券码、三方券码”两种券码误核销之后的撤销操作,订单状态由“已使用”回改为“待使用”,用于验券错误需要撤回验券等场景, 有时间限制,验券超过一个小时就不可再撤销。
订单查询
选接
通过接口查询指定范围的订单列表及订单详情:
选接
通过接口查询指定范围的订单列表及订单详情:
必接
用于用户下单完以后向商家通知券消息,和订单消息区别是维度不一样,一张订单下面可能会有多张券
餐饮交易退款
选接
支持通过订单id和券id查询售后详情
团购对账
必接
用于生活服务餐饮行业商家查询账单明细。不同行业返回参数不同,其他行业商家请勿查询此接口。

三方码团购

开放能力
是否必接
对接接口
接口说明
商品发布及查询
必接
查询商品类目,创建商品前可获取类目信息。
返回类目新增【餐饮->其他->实物周边】
必接
用于创建商品前查询商品模板信息。
必接
1.创建或更新商品,限制商品发布范围
a.限制为美食类目
b.限制为团购、代金券、次卡
组合券包新增属性字段-组套规则,基础字段-商品形态类型
必接
上下架商品。
注意事项:子品不允许操作上下架
必接
免审修改团购、代金券
注意事项:不支持通过此接口修改券包、子品实付价,否则会导致券包商品价格校验不通过-待确认
必接
用于查询商品草稿数据。
必接
用于查询商品草稿数据列表。
必接
1.使用商品 ID 或外部商品 ID 查询商品线上数据。
必接
通过接口查询商品线上数据列表
必接
用于餐饮团购商品审核流程结束以后向商家通知审核结果
三方码
必接
抖音侧调用第三方服务商接口推送用户预下单消息,返回结果。
必接
抖音侧向商家/服务商发起券码申请,务必做到接口幂等,因为会存在网络等原因或出现超时,抖音会重试发券。
必接
抖音侧先申请服务商发码,如果能同步返回结果则不需要本接口,如果异步返回结果则调用本接口通知抖音。
必接
抖音侧向服务商发起退款的申请。
选接
审核结果为拒绝时必须要告知抖音拒绝原因,若没有原因将会返回报错,拦截本次审核结果
选接
用于抖音侧向商家侧同步退款状态信息变更。
团购核销
必接
用于核销券码,同时适用于抖音团购券码与三方券码,抖音券码的核销需要先调用准备接口,再调用本接口,三方券码的核销直接调用本接口即可。
必接
针对“抖音团购券码、三方券码”两种券码误核销之后的撤销操作,订单状态由“已使用”回改为“待使用”,用于验券错误需要撤回验券等场景, 有时间限制,验券超过一个小时就不可再撤销。
订单查询
选接
通过接口查询指定范围的订单列表及订单详情:
选接
通过接口查询指定范围的订单列表及订单详情:
必接
用于用户下单完以后向商家通知券消息,和订单消息区别是维度不一样,一张订单下面可能会有多张券
注:当设置不可部分退,用户已经部分核销掉了,未核销部分到期后会自动核销,通过券消息通知接口action字段判断核销状态,如果事件丢失可调用验券历史查询接口做券状态对齐
餐饮交易退款
选接
支持通过订单id和券id查询售后详情
团购对账
必接
用于生活服务餐饮行业商家查询账单明细。不同行业返回参数不同,其他行业商家请勿查询此接口。
选接
1、查询某个企业号下的一个或多个门店在一段时间内的全部验券历史
2、通过 size 与 cursor 参数进行分页查询

常见问题