抖音开放平台Logo
开发者文档
控制台
  • 接入前准备
  • 通用能力
  • 餐饮
  • 到店餐饮团购解决方案
  • 餐饮订座
  • 批量配置订座
  • 查询订座配置任务结果
  • 订座配置任务完成通知
  • 商户订座业务变更通知
  • 门店订座配置变更
  • 库存变更通知
  • 查询桌台实时库存
  • 查询是否可订
  • 下预订单
  • 手动接单
  • 取消预订
  • 预订单状态变更通知
  • 用户到店确认
  • 券资产转移
  • 餐饮门店管理(连锁门店)
  • POI 匹配/申诉(连锁门店)
  • POI 信息报错(连锁门店)
  • 门店申诉(连锁门店)
  • 商家账单明细(餐饮行业)
  • 三方码发布
  • 订单查询
  • 餐饮评价
  • 餐饮团购退款
  • 餐饮在线点单解决方案
  • 随心团解决方案
  • 大交通
  • 酒旅
  • 综合
  • 历史版本文档(不推荐)
  • 使用限制

    接口说明

    1、下单请求成功:务必确保状态码为 0;
    2、下单请求失败:不可下单情况需要服务商返回原因,如果不在列举的原因内,服务商返回 error_code=20 并附加失败原因;
    3、SPI 超时响应时间为 5s,超时响应则为无效响应;

    基本信息

    HTTP URL
    地址由服务商提供
    HTTP Method
    POST
    权限要求
      需要申请权限 ,路径:抖音开放平台-服务商平台>控制台>应用详情>解决方案
      需要url配置,路径:见下方“服务商/商家侧SPI接口配置”
      需要商家授权,路径:抖音来客>店铺管理>服务应用授权

    请求头

    请求参数

    Body 请求

    参数名称
    参数类型
    参数描述
    request_id
    string
    请求ID
    order_id
    string
    抖音单号,以抖音单号做幂等
    poi_id
    string
    抖音门店id
    participant_number
    int32
    就餐人数
    dinning_time
    string
    就餐时间,格式:2021-10-22 22:22:22
    location_type
    string
    (大厅-0 包间-1 其他-3)
    custmemo
    string
    备注
    create_order_time
    int64
    订单创建时间 时间戳(秒)
    pay_time
    int64
    订单支付时间,13位时间戳,秒时间戳
    update_order_time
    int64
    最新修改时间,13位时间戳,秒时间戳
    amount
    struct
    定金金额
    .original_amount
    int32
    原始金额,单位分
    .pay_amount
    int32
    实付金额,单位分
    .payment_discount
    int32
    支付优惠
    .discount_amount
    int32
    折扣金额,单位分
    contact_name
    string
    姓名
    contact_phone
    string
    联系电话(加密)
    sex
    string
    顾客性别,1男 0女
    备注:字段描述备注了(加密)的字段,需要进行字段解密方可看到字段信息,如何解密请参考本文最下方内容

    请求示例

    { "request_id": "request_id", "order_id":"order_id", "poi_id": "poi_id", "participant_number": 1, "dinning_time": "2017-5-19 10:49:00", "location_type": "1", "custmemo":"靠窗", "create_order_time": 1703052625, "pay_time": 1703052625, "update_order_time": 1703052625, "contact_name":"123", "sex":"male", "contact_phone": "123" }

    响应参数

    参数名称
    参数类型
    参数描述
    data
    struct
    .error_code
    int32
    失败错误码,失败必填
    .description
    string
    失败原因
    .ext_order_id
    string
    第三方订单号
    .receipt_status
    int32
    0:审核中
    1:已接单
    2:已拒单
    .refuse_reason_code
    int32
    拒单原因code
    .refuse_reason
    string
    拒单原因

    响应示例

    正常示例

    { "data": { "error_code": 0, "description": "success", "ext_order_id": "ext_order_id", "receipt_status": 2, "refuse_reason_code": 2 } }

    异常示例

    { "data": { "error_code": 1, "description": "系统异常" } }
    refuse_reason_code
    拒单原因
    是否透传用户
    1
    门店未开通预定
    2
    没有匹配的桌型
    3
    该桌型已订满
    4
    超出门店营业时间
    5
    门店无法正常营业
    20
    其他异常(服务商自定义)

    错误码

    HTTP 状态码
    错误码
    描述
    排查建议