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

开发者入驻和接入

根据以下指南完成开放平台的入驻和自助化接入

开通解决方案及能力

    1.登录服务商平台。
    2.在右上角点击「控制台」,在「我的应用」页面选择「生活服务商家应用」,然后点击目标应用。
    3.在应用左侧导航栏点击「解决方案」
    4.在「解决方案」页面到店「餐饮点单解决方案」,点击「开通能力权限」,等待平台审核。审核通过后,即可以使用相关能力。
​

接口对接流程

商品对接流程图

​
​

交易对接流程时序图

​

接口清单

服务商必接接口说明,对于必接接口必须对接,否则验收不予通过
能力名称
是否必接
接口
说明
门店接单信息设置
必接
1.设置门店接单状态和时间,必须先在抖音来客完成门店认领
2.serve_week 参数长度固定为 7,代表周一至周日的接单信息
3.当系统同时命中 serve_date 和 serve_week 的配置规则时,优先使用 serve_date 的配置
​
4.POI ID 单次最多支持批量设置 20 个
必接
设置门店接单状态和时间,必须先在抖音来客完成门店认领
点单相关商品发布
(来客创品可不接)
必接
标品创建更新
必接
标品上下架
必接
点单品创建更新
必接
点单品上下架
可选(如果有小料必接)
加料品创建更新
可选(如果有小料必接)
加料品上下架
可选
​
必接
将点单标品与团购券进行绑定
必接
门店点单品上下架
点单相关商品查询
(来客创品可不接)
可选(如果团购品有可选加料品必须对接)
使用加料品ID或外部ID查询加料品线上数据
可选(如果团购品有可选加料品必须对接)
查询加料品的门店沽清信息
必接
查询团购已经绑定的点单标品信息
必接
查询点单品信息
必接
查询商品类目,创建商品前可获取类目信息。
商品发布
(来客创品可不接)
必接
用于商品审核完以后向商家通知审核结果(包含点单品和加料品)
在线点单交易能力
必接
抖音侧通知第三方创建点单订单。仅支持 支付前 通知第三方创单。
必接
抖音侧通知第三方取消订单。
通知类型接口“请勿返回业务类型错误”(譬如订单不存在)
必接
抖音侧通知第三方支付成功。
通知类型接口“请勿返回业务类型错误”(譬如订单不存在),返回系统类型的错误抖音侧可以重试。
必接
支付成功之后,抖音侧通知第三方准备接单。
通知类型接口“请勿返回业务类型错误”(譬如订单不存在),返回系统类型的错误抖音侧可以重试。
必接
抖音在某些场景下(商家10分钟没有接单)需要主动查询商家/第三方的订单状态,判断接单结果,进而做下一步订单流转处理。
必接
抖音侧完成退款后,通知第三方实际退款结果。
通知类型接口“请勿返回业务类型错误”(譬如订单不存在)
必接
抖音侧通知第三方“待接单”后,商家同步请求该接口进行接单或拒单,接单时需支持回传取餐号。
必接
商家接单后,需要通过接口回传备餐/出餐/取餐信息。
​
必接
商家接单后,可以通过接口发起退款。
推荐接入
将生服点单订单的履约备餐状态变更通知外部商家,如备餐中、已出餐、已取餐事件。
推荐接入
点单订单查询能力
可选
点单查询 AXB 电话
​
必接
用户创建点单订单后,可以主动申请取消点单订单。商家审批通过后完成取消申请。商家可以通过同步spi接口(用户申请取消点单)或者该openApi接口完成审核。
商家账单明细
必接
账单金额均为绝对值,不显示正负,调用时请注意账单的结算类型。
2.核销后 1 小时内撤销或退款的订单不会生成账单,无法通过本接口查询
​
生活服务用户信息转换
选接
1、须传入open_id和商家life_account_id
2、根据抖音uid(open_id映射)、life_account_id生成唯t一固定标识
​

【自研商家】餐饮在线点单创单回调优先级设置

场景简介

餐饮在线点单场景下,平台会在用户下单后,通过SPI将订单同步给开发者;
原则上,同一个商户的订单,仅能同步给一个生活服务商家应用,以避免订单同步给多个生活服务商家应用后,订单操作出现冲突;
如果自研商家有多个生活服务商家应用同时对接了餐饮在线点单解决方案,需要在抖音开放平台设置优先回调应用,以保障交易链路的稳定性。
注意
•本配置仅适用于自研商家类型的开发者,仅在抖音开放平台开放,服务商类型的开发者不适用;
•配置的回调优先级适用于餐饮在线点单解决方案的通知外部商家创单SPI。
​

操作步骤

具体操作步骤如下:
第二步:在生活服务商家应用中选择目标应用,点击进入。
第三步:在应用详情页的左侧导航栏选中解决方案,找到餐饮在线点单解决方案,点击「回调优先级配置」按钮打开弹窗。
第四步:在所有对接了餐饮在线点单解决方案的生活服务商家应用中,选择一个优先回调应用,点击「确定」按钮保存配置。
注意
    •只能在已对接餐饮在线点单解决方案的生活服务商家应用(至少开通了一个餐饮在线点单解决方案的能力的应用)中选择;
    •配置为账号粒度,只需设置一次,对自研商家账号下所有生活服务商家应用都生效;
    •设置优先回调应用后,后续创单完成后将优先同步给该应用;
    •设置完成后,除特殊情况外,应避免修改该应用,以保障线上交易链路的稳定性。
​