抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • OpenAPI 简介
  • 通用参数
  • 小程序 OpenAPI SDK 总览
  • 签名算法
  • 基础能力
  • 触达与营销
  • 支付
  • 运营
  • 生活服务
  • 通用能力
  • 随心团解决方案
  • 核销工具解决方案
  • 历史版本(不推荐使用)
  • 商铺接入
  • 商铺同步
  • 查询店铺
  • 获取抖音POI ID
  • 店铺匹配任务结果查询
  • 店铺匹配状态查询
  • 提交门店匹配任务
  • 查询全部店铺信息接口(天级别请求5次)
  • 查询店铺全部信息任务返回内容
  • 商品库接入
  • poi数据接入
  • 优惠券接入
  • 端内消息同步
  • poi基础能力
  • 垂直行业
  • 其它
  • Scope: poi.product 需要申请权限 不需要用户授权
    特殊权限暂不支持线上申请,若服务商有合作意向或者接口问题,可联系商务进行商务评估和接入,邮箱:poiservice@bytedance.com

    请求地址

    POST /poi/supplier/sync/

    请求头

      Content-Type: application/json
      access-token: 调用/oauth/client_token/生成的token,此token不需要用户授权。示例: clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ

    请求参数

    Body 请求

    注意:
      1.店铺同步接口同时提供给团购和配送两个业务线使用,如果一个门店同时做团购和配送业务,只需要调本接口一次即可,只需要services列表同时传service_type=9101和new_service_type=270,另外如果services包含了new_service_type=270,配送相关的字段delivery_type和delivery_info也需要传,否则会同步失败。
      2.更新场景除了非必填字段,以下字段也可以不用传:status、services、delivery_info,对于未传字段会继续使用上次同步的数据
    序号
    参数名称
    参数类型
    参数描述
    参数示例
    是否必填
    说明
    1
    contact_phone
    string
    联系手机号
    189xxxx8929
    FALSE
    2
    contact_tel
    string
    联系座机号
    021-58xxxx95
    FALSE
    3
    images
    []string
    店铺图片
    FALSE
    4
    merchant_uid
    string
    商户号;商家担保交易中的收款账户ID
    <nil>
    FALSE
    5
    service_provider
    struct
    服务商资质信息
    <nil>
    FALSE
    6
    business_license_ext_id
    string
    服务商营业执照
    ext_0x1
    FALSE
    7
    industry_license_ext_id
    []string
    服务商行业许可证
    [ext_0x2]
    FALSE
    8
    supplier_ext_id
    string
    接入方店铺id
    x0001
    TRUE
    9
    tags
    []string
    标签
    [可停车 离地铁近]
    FALSE
    10
    latitude
    string
    纬度
    <nil>
    FALSE
    11
    longitude
    string
    经度
    <nil>
    FALSE
    12
    status
    int64
    在线状态 1 - 在线; 2 - 下线
    1
    TRUE
    13
    type_code
    string
    POI品类编码
    <nil>
    FALSE
    14
    type_name
    string
    POI品类描述 eg. 美食;中式餐饮;小龙虾
    <nil>
    FALSE
    15
    address
    string
    店铺地址
    栏学路328弄97号
    FALSE
    16
    avg_cost
    int64
    人均消费(单位分)
    <nil>
    FALSE
    17
    customer_info
    struct
    商家资质信息
    <nil>
    FALSE
    18
    power_of_attorney
    struct
    服务商和商家合作协议/授意书
    <nil>
    FALSE
    19
    ext_id
    string
    合作协议/授意书外部id
    <nil>
    FALSE
    20
    url
    string
    合作协议/授意书链接
    https://XXXXX
    FALSE
    21
    business_license
    struct
    商家营业执照
    <nil>
    FALSE
    22
    company
    string
    服务上营业执照公司名称
    北京字条网络技术有限公司
    FALSE
    23
    ext_id
    string
    商家营业执照外部id
    <nil>
    FALSE
    24
    url
    string
    商家营业执照链接
    https://XXXXX
    FALSE
    25
    industry_license
    []
    行业许可证
    <nil>
    FALSE
    26
    ext_id
    string
    商家营业执行业许可证外部id
    <nil>
    FALSE
    27
    url
    string
    商家行业许可证链接
    https://XXXXX
    FALSE
    28
    other_info
    []
    其他补充材料
    <nil>
    FALSE
    29
    ext_id
    string
    其他补充材料外部id
    <nil>
    FALSE
    30
    url
    string
    其他补充外部链接
    https://XXXXX
    FALSE
    31
    description
    string
    店铺介绍(<=500字)
    <nil>
    FALSE
    32
    name
    string
    店铺名称
    上海几茶.知更民宿(迪士尼店)
    TRUE
    33
    attributes
    struct
    必传,传空结构体
    {}
    TRUE
    34
    recommends
    []
    推荐
    <nil>
    FALSE
    35
    image_url
    string
    推荐内容链接(图片,或者视频链接)
    FALSE
    36
    title
    string
    推荐描述
    石锅浓汤海鲜豆腐窝
    FALSE
    37
    services
    []
    店铺提供的服务列表
    <nil>
    TRUE
    38
    enable
    int64
    上线状态(1:上线,2:下线)
    <nil>
    TRUE
    39
    entry
    struct
    服务入口拼接参数
    <nil>
    TRUE
    40
    entry_mini_app
    struct
    抖音小程序入口参数
    <nil>
    TRUE
    41
    is_test
    int64
    主要用于联调,1-使用测试版的小程序,0或者不填-使用正式版小程序
    1
    FALSE
    42
    params
    string
    服务参数json,跳转链接参数
    {"productId":115511}
    FALSE
    43
    path
    string
    服务路径,小程序跳转链接
    pages/productDetail/productDetail
    TRUE
    44
    app_id
    string
    小程序的appid
    tt34843ubcs
    TRUE
    45
    entry_type
    int64
    入口类型(1:H5,2:抖音小程序)
    <nil>
    TRUE
    46
    new_service_type
    int64
    服务类型,
    含义同service_type字段,
    固定传:270
    <nil>
    TRUE
    47
    open_time
    []
    营业时间, 从周一到周日,list长度为7,不营业则为空字符串
    [10:00-12:00;13:00-22:00 10:00-12:00;13:00-22:00 10:00-12:00;13:00-22:00 10:00-12:00;13:00-22:00 10:00-12:00;13:00-22:00 10:00-12:00;13:00-22:00]
    FALSE
    48
    poi_id
    string
    抖音poi id, 三方如果使用高德poi id可以通过/poi/query/接口转换,其它三方poi id走poi匹配功能进行抖音poi id获取
    6601136930455291912
    TRUE
    49
    type
    int64
    店铺类型 固定传:2 - 餐饮
    2
    TRUE
    50
    delivery_type
    int64
    配送类型,固定传:1
    1
    TRUE
    51
    delivery_info
    struct
    配送信息
    TRUE
    52
    delivery_scope_info_list
    结构体数组[]
    配送范围。支持带洞多边形,0 位置为多边形,1~ n位置为多边形内的洞(即不可配送区域)
    delivery_scope_info_list.scope和delivery_distance二选一必填,若两个都填了,优先生效delivery_scope_info_list
    53
    delivery_price
    string
    配送价,单位分(废弃)
    FALSE
    54
    min_price
    string
    起送价,单位分(废弃)
    FALSE
    55
    scope
    结构体数组[]
    范围,经纬度(gcj02坐标系),至少4个节点
    delivery_scope_info_list传了,该字段必填
    56
    latitude
    string
    TRUE
    57
    longitude
    string
    TRUE
    58
    delivery_distance
    int64
    配送距离,注意:单位米,为骑行距离
    5000
    delivery_scope_info_list和delivery_distance二选一必填,若两个都填了,优先生效delivery_scope_info_list
    59
    display_city_code_list
    字符串数组[]
    可展示小程序的城市列表Code,注意需使用L2城市code。例如["310000"]表示上海,city_code为国家标准行政区划代码(直辖市有特殊逻辑:北京=110000 天津=120000 上海=310000 重庆500000),见附录 1
    ["310000"]
    TRUE
    60
    take_out_info
    TRUE
    61
    brand_name
    string
    品牌名称,在门店详情页小程序 banner 展示,需要人审
    八喜冰淇淋蛋糕(总号)
    TRUE
    62
    subtitle
    string
    副标题,在门店详情页小程序 banner 展示,需要人审
    14 件商品热卖中,低至 ¥118
    TRUE
    63
    banner_url
    string
    banner图片链接
    TRUE
    64
    order_status
    int64
    外卖接单状态,枚举值如下:
    1 - 开启
    2 - 关闭
    3 - 跟随外卖营业时间(废弃)
    1
    TRUE
    65
    support_order_in_non_business_time
    bool
    是否支持提前预订
    TRUE
    TRUE
    66
    order_time_list
    json数组
    外卖营业时间,是一个json数组,每个元素json结构如下:
    {
    "start_time":"08:00", "end_time":"24:00", "week_list":[1,2,3,4,5,6,7]
    }
    如果出现每一天有多个营业时间段/或跨天,json可按如下规则处理:
    [{
    "start_time":"18:00", "end_time":"24:00", "week_list":[1,2,3,4,5,6,7]
    },
    {
    "start_time":"00:00", "end_time":"03:00", "week_list":[1,2,3,4,5,6,7]
    }]
    TRUE
    67
    delivery_fee_rule
    struct
    起步距离3公里,起步价5元--代表3公里内收5元配送费。
    距离加价规则3公里至5公里每500米收0.2元---比如4公里情况下,收配送费为5+(4000-3000)/500*0.2= 5.4元
    TRUE
    68
    calculate_type
    int64
    计算方式:1-按骑行距离;2-按直线距离
    1
    TRUE
    69
    basic_distance
    int64
    必传,单位“米”,起步距离需>=500米
    3000
    TRUE
    70
    basic_price
    int64
    单位“分”,可传0。起步价/起步距离不得大于0.5
    500
    TRUE
    71
    distance_markup_rule_list
    结构体数组
    距离加价。必须连贯,与起步距离连贯,各加价距离必须连续
    FALSE
    72
    start_distance
    int64
    单位“米”,代表大于
    3000
    TRUE
    73
    end_distance
    int64
    单位“米”,代表小于等于
    5000
    TRUE
    74
    distance_unit
    int64
    单位“米” 。加价单元需>=500米
    500
    TRUE
    75
    markup_price
    int64
    单位“分” ,每单元配送费加价金额/加价单元不得大于0.5
    20
    TRUE
    76
    period_markup_rule_list
    结构体数组
    时段加价。各加价时段不能重叠
    FALSE
    77
    start_time
    string
    时-分-秒,代表大于;
    '20-30-00'
    TRUE
    78
    end_time
    string
    时-分-秒,代表小于等于
    '23-59-59'
    TRUE
    79
    markup_price
    int64
    单位“分”;加价金额不得大于5元
    TRUE
    80
    delivery_time_rule
    struct
    案例:起步距离5公里,时长30分钟--代表5公里内30分钟送达。距离加时规则每500米加时3分钟---比如6公里情况下,配送时长为30+(6000-5000)/500*3= 36分钟
    TRUE
    81
    calculate_type
    int64
    计算方式:1-按骑行距离;2-按直线距离
    1
    TRUE
    82
    basic_distance
    int64
    单位“米”,起步距离需>=500米
    5000
    TRUE
    83
    basic_time
    int64
    单位“分钟”,起步时长/起步距离不得大于0.06
    30
    TRUE
    84
    distance_unit
    int64
    单位“米”,加时单元需>=500米
    500
    FALSE
    85
    increase_time
    int64
    单位“分钟”,每加时单元加时时长/加时单元不得大于0.03
    3
    FALSE

    请求样例

    { "supplier_ext_id": "test1", "poi_id":"7117847225422350343", "status":1, "type":2, "delivery_type":1, // x项目必传,固定传1,用于识别为x项目传入 "name":"测试", "attributes":{}, "services" :[ { "new_service_type": 270, // x项目传270 "enable":1, "entry":{ "entry_type":2, "entry_mini_app":{ "app_id":"12345", "path":"test/test" } } } ], "delivery_info":{ "delivery_scope_info_list":[ { "delivery_price":"500", //配送价,单位分 "min_price":"3000", //起送价,单位分 "scope":[ { "latitude":"31.239703", "longitude":"121.499718" }, { "latitude":"31.23735", "longitude":"121.501424" } ] } ], "display_city_code_list":["310000"], // city_code=310000表示上海 "take_out_info":{ "brand_name":"字节跳动", "subtitle":"副标题", "banner_url":"https://xxx", "order_status":3, "support_order_in_non_business_time":false, "order_time_list":[ { "start_time":"08:00", "end_time":"24:00", "week_list":[1,2,3,4,5,6,7] }, { "start_time":"00:00", "end_time":"02:00", "week_list":[1,2,3,4,5,6,7] } ] } } }

    响应参数

    参数名称
    参数类型
    参数描述
    参数示例
    data
    struct
    <nil>
    description
    string
    错误码描述
    error_code
    int64
    错误码
    0
    supplier_id
    string
    抖音平台商户ID
    <nil>

    响应样例

    { "data": { "description": "", "error_code": "0", "supplier_id": "<nil>" } }

    响应错误样例

    { "data": { "description": "Parameter error", "error_code": 2100005 }, "extra": { "logid": "2020070614111601022506808001045D59", "now": 1594015876138 } }

    查询商铺同步状态

    调用商铺同步成功后,通过该接口查询商铺同步的结果(工作时间同步信息人工审核需要等待 1 小时左右)。

    同步返回错误自查工具

    抖音行政区划 L2 Code 列表:参考:https://bytedance.larkoffice.com/docx/doxcn5XlYkJJvUNnnRtzOYPgQQf 中的附录

    错误码

    HTTP 状态码
    错误码
    描述
    排查建议
    200
    2100005
    参数不合法
    检查接口问题,检查参数正确性,规范参数格式
    200
    2116302
    poi不存在
    需要先在企业号或抖音来客认领门店
    200
    2116306
    运营审核驳回
    检查审核资质是否正确重新提交
    200
    2116311
    配送信息不全
    检查配送信息是否正确
    200
    2116100
    系统内部错误
    会包含各种业务报错,会在返回信息提示,根据返回信息处理
    200
    2116100
    系统错误,请重试。
    重试,多次重试仍有问题,请联系该接口提供方
    200
    2116303
    店铺没有匹配到抖音POI
    需要先做门店匹配