抖音开放平台Logo
开发者文档
“/”唤起搜索
控制台
  • OpenAPI 简介
  • 通用参数
  • 小程序 OpenAPI SDK 总览
  • 签名算法
  • 基础能力
  • 触达与营销
  • 支付
  • 运营
  • 生活服务
  • 通用能力
  • 核销工具解决方案
  • 历史版本(不推荐使用)
  • 商铺接入
  • 商铺同步
  • 查询店铺
  • 获取抖音POI ID
  • 店铺匹配任务结果查询
  • 店铺匹配状态查询
  • 提交门店匹配任务
  • 查询全部店铺信息接口(天级别请求5次)
  • 查询店铺全部信息任务返回内容
  • 商品库接入
  • poi数据接入
  • 优惠券接入
  • 端内消息同步
  • 随心团解决方案
  • 垂直行业
  • 其它
  • 将三方门店与抖音门店建立匹配关系。建立匹配关系后,开发者可通过三方系统内的唯一 id 管理商家已完成认领或建立关联关系的抖音门店 id 进行管理。

    使用限制

    接口说明

    业务场景:
      通过门店匹配,将客户系统的三方id和抖音门店ID完成映射,建立匹配关系;方便客户通过自身系统的id进行抖音生活服务业务的门店管理操作;
    注意事项
      门店坐标经纬度信息需使用 GCJ-02 坐标系坐标,否则门店定位会有较大偏差。
      此接口为异步接口,需查询“查询门店匹配任务结果”接口进行获取任务结果。
      当门店已经完成匹配或者正在匹配中时,请不要重复提交匹配;匹配失败后,可再次发起匹配。
      可通过“查询门店匹配状态”获取门店匹配任务 ID 和匹配状态信息。
      匹配成功并不意味着匹配正确,需要自行核对匹配结果中的抖音门店是否为期望门店,若匹配错误,可在线咨询进行解绑。
      咨询问题时,请提供请求响应返回的taskID。

    基本信息

    HTTP URL
    HTTP Method
    POST
    权限要求
    POI权限
    Scope
    poi.product
    权限申请

    请求头

    名称
    类型
    必填
    描述
    Content-Type
    string
    固定值:"application/json"
    access-token
    string
    接口调用凭证
    示例值:"clt.943da17996fb5cebfbc70c044c3fc25a57T54DcjT6HNKGqnUdxzy1KcxFnZ"

    请求参数

    Body

    名称
    类型
    是否必填
    描述
    示例值
    match_data_list
    struct[]
    用于匹配抖音门店的三方系统内的唯一信息列表,建议 <= 1000
    supplier_ext_id
    string
    三方系统内的唯一 id
    "123451"
    poi_id
    string
    抖音门店 id
    (若已获取抖音门店 id,可直接用于关联匹配,以提高匹配成功率)
    "7237783383823091746"
    poi_name
    string
    门店名称
    "测试POI"
    province
    string
    省份名称
    "新疆维吾尔自治区"
    city
    string
    城市名称
    (可为空字符串,仅供问题排查使用)
    "阿克苏地区"
    address
    string
    门店地址信息
    "庐山路华晨大拇指商业广场5楼"
    latitude
    float
    纬度,精度为小数点后6位,需使用 GCJ-02 坐标系统
    82.580195
    longitude
    float
    经度,精度为小数点后6位,需使用 GCJ-02 坐标系统
    40.101612
    extra
    string
    其他信息,可为空字符串
    ""
    contact_phone
    string
    营业手机号
    "13072897065"
    contact_tel
    string
    营业座机号
    "010-78577799"

    请求示例

    curl --location 'https://open.douyin.com/poi/v2/supplier/match/' \ --header 'Content-Type: application/json' \ --header 'access-token: clt.c4944e91479f53a75c554c0575bedbf9N6Nm5pkdYJFE7io9borLftK2GSag' \ --data '{ "match_data_list": [ { "supplier_ext_id": "123451", "poi_id": "7237783383823091746", "poi_name": "测试POI", "province": "新疆维吾尔自治区", "city": "阿克苏地区", "address": "庐山路华晨大拇指商业广场5楼", "latitude": 82.580195, "longitude": 40.101612, "extra": "" } ] }'

    响应参数

    名称
    类型
    描述
    data
    struct
    is_success
    int
    任务提交状态
    1 - 成功
    2 - 失败
    task_id
    int
    匹配任务 id,咨询问题时需提供
    error_code
    int
    错误码,非 0 表示失败
    description
    string
    错误描述
    extra
    error_code
    int
    错误码,非 0 表示失败
    description
    string
    错误描述
    sub_error_code
    int
    子错误码,成功返回 0,此接口暂未使用
    sub_description
    string
    子错误描述,此接口暂未使用
    logid
    string
    抖音侧日志 id,咨询问题时需提供
    now
    int
    请求响应时间,秒级时间戳

    响应示例

    正常示例

    { "data": { "description": "", "error_code": 0, "is_success": 1, "task_id": "7252956489000830988" }, "extra": { "logid": "202307091902332F876B33B5C955E91BA7", "now": 1688900554166 } }

    异常示例

    { "data": { "description": "参数不合法", "error_code": 5 }, "extra": { "description": "参数不合法", "error_code": 5, "logid": "20230709190157A62847113B0BE4049961", "now": 1688900517927, "sub_description": "Request body has an error: doesn't match the schema: Error at \"/match_data_list/0\":Property 'extra' is missing", "sub_error_code": 0 } }