抖音开放平台Logo
开发者文档
控制台
  • 接入前准备
  • 通用能力
  • 门店相关接口
  • 团购核销
  • 团购对账
  • 会员接入
  • 订单查询
  • 三方码
  • 预下单
  • 发券
  • 发券回调
  • 退款
  • 审核回调
  • 信息同步
  • 商品发布
  • 代运营
  • 团购退款
  • 商品查询
  • 招商入驻
  • KA核销对账
  • 餐饮
  • 大交通
  • 酒旅
  • 综合
  • 历史版本文档(不推荐)
  • 预下单

    收藏
    我的收藏
    抖音侧调用第三方服务商接口推送用户预下单消息,返回结果。

    使用限制

    接口说明

      1.预下单请求成功:务必确保状态码为 0。
      2.预下单请求失败:不可下单情况需要服务商返回原因,如果不在列举的原因内,服务商返回 error_code=20 并附加失败原因。
      3.SPI 超时响应时间为 5s,超时响应则为无效响应。
      4.接口需要返回手机号信息,需要找抖音侧业务同学反馈该需求,业务审批后才会有用户留资信息。
      5.如果第三方响应不规范或者响应超时,抖音默认允许下单,会走后续链路。
      6.抖音侧会重试,需保证接口幂等(唯一键抖音订单ID:order_id)

    基本信息

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

    服务商/商家侧 SPI 接口配置

    配置路径:开放平台-服务商平台/开发者平台-控制台-应用详情页-开发设置- SPI 回调。
    需配置接口:
    接口
    回调场景(配置SPI回调地址时可见)
    需提供信息
    是否必填
    预下单
    抖音请求三方系统预下单
    回调地址:预下单URL
    必填
    发券
    抖音请求三方系统发码
    回调地址:发券URL
    必填
    退款
    抖音请求三方系统退款审核
    回调地址:退款URL
    必填
    信息同步
    抖音向三方系统同步退款信息
    回调地址:信息同步URL
    必填

    签名规则

    签名规则参考查看 这个地址 的说明。

    请求参数

    Body 请求

    参数名称
    参数类型
    参数描述
    order_id
    string
    抖音订单ID
    sku_id
    string
    抖音的商品ID
    third_product_id
    string
    第三方商品ID
    count
    int32
    该笔订单包含的券数量
    order_item_id
    list
    券维度的订单id,抖音内部使用,服务商可忽略
    third_sku_id
    string
    三方服务商侧的商品ID
    order_type
    int32
    订单类型,21-团购 31-预售 41-配送
    original_amount
    int32
    原始金额,单位分(含税)
    currency_code
    string
    货币类型(默认人民币CNY)
    create_order_time
    int64
    订单创建时间 时间戳(秒)
    tourists
    struct
    游客信息,使用人,景区门票等场景使用
    .name
    string
    姓名
    2024年2月29日起,若用户下单商品不属于下列一级商品类目(住宿(8000000), 游玩(18000000), 度假旅游服务(32000000), 交通出行(31000000)),该字段脱敏
    .phone
    string
    联系电话(加密)
    2024年2月29日起,若用户下单商品不属于下列一级商品类目(住宿(8000000), 游玩(18000000), 度假旅游服务(32000000), 交通出行(31000000)),该字段脱敏
    .id_card
    string
    身份证号(加密)
    2024年2月29日起,若用户下单商品不属于下列一级商品类目(住宿(8000000), 游玩(18000000), 度假旅游服务(32000000), 交通出行(31000000)),该字段脱敏
    .name_info_list
    struct
    姓名信息
    ..name_type
    int64
    姓名类型
    1:中文
    2:英文
    ..name_value
    string
    姓名全称
    ..first_name
    string
    英文名的名
    ..last_name
    string
    英文名的姓
    .license_info_list
    struct
    证件信息
    ..license_type
    int64
    证件类型
    1:身份证
    2:港澳通行证
    3:台湾通行证
    4:回乡证
    5:台胞证
    6:护照
    7:外籍护照
    8:外国人永居证
    ..license_id
    string
    证件号
    ..license_validity
    string
    证件有效期
    .contact_info_list
    struct
    联系方式信息
    ..contact_info_type
    int64
    联系方式类型
    1:电话号码
    2:邮箱
    ..contact_info_value
    string
    联系方式值
    ..area_code
    string
    电话号码的区号
    contact
    struct
    游客信息,联系人,用户手机号信息
    .complete_phone
    string
    联系电话(加密)
    2024年2月29日起,若用户下单商品不属于下列一级商品类目(住宿(8000000), 游玩(18000000), 度假旅游服务(32000000), 交通出行(31000000)),该字段下线
    .name
    string
    姓名
    2024年2月29日起,若用户下单商品不属于下列一级商品类目(住宿(8000000), 游玩(18000000), 度假旅游服务(32000000), 交通出行(31000000)),该字段脱敏
    .phone
    string
    联系电话(脱敏)
    .name_info_list
    struct
    姓名信息
    ..name_type
    int64
    姓名类型
    1:中文
    2:英文
    ..name_value
    string
    姓名全称
    ..first_name
    string
    英文名的名
    ..last_name
    string
    英文名的姓
    .contact_info_list
    struct
    联系方式信息
    ..contact_info_type
    int64
    联系方式类型
    1:电话号码
    2:邮箱
    ..contact_info_value
    string
    联系方式值
    ..area_code
    string
    电话号码的区号
    备注:字段描述备注了(加密)的字段,需要进行字段解密方可看到字段信息,如何解密请参考本文最下方内容。

    请求示例

    { "order_id": "order_id", "third_product_id": "third_product_id", "sku_id": "1", "count": 1, "order_item_id": ["order_item_id"], "third_sku_id": "1", "order_type": 21, "original_amount": 1, "currency_code": "CNY", "create_order_time": 1, "contact": { "name": "name", "phone": "123", "complete_phone": "123", "name_info_list": [ { "name_type": 1, "name_value": "name" } ], "contact_info_list": [ { "contact_info_type": 1, "contact_info_value": "123" } ] }, "tourists": [ { "name": "张三", "phone": "13800000000", "id_card": "310115199807013370" "name_info_list": [ { "name_type": 1, "name_value": "张三" } ], "license_info_list": [ { "license_type": 1, "license_id": "310115199807013370", "license_validity": "" } ], "contact_info_list": [ { "contact_info_type": 1, "contact_info_value": "13800000000" } ] }, { "name": "李四", "phone": "13900000000", "id_card": "310115199912130020" "name_info_list": [ { "name_type": 1, "name_value": "李四" } ], "license_info_list": [ { "license_type": 1, "license_id": "310115199912130020", "license_validity": "" } ], "contact_info_list": [ { "contact_info_type": 1, "contact_info_value": "13900000000" } ] } ] }

    响应参数

    参数名称
    参数类型
    参数描述
    data
    struct
    .error_code
    int32
    失败错误码,失败必填
    .description
    string
    失败原因
    .ext_order_id
    string
    第三方订单号,成功情况下必填

    响应示例

    { "data": { "error_code": 0, "description": "success", "ext_order_id": "11" //三方订单号 } }

    错误码

    error_code
    失败原因
    是否透传用户
    1
    商品不存在
    2
    商品已下线
    3
    未到商品开始售卖时间
    4
    已过商品结束售卖时间
    5
    商品库存售罄
    6
    已达到购买上限
    7
    价格校验失败
    20
    其他异常(服务商自定义)
    100
    抖音侧会重试

    加密字段解密