第三方平台
接口说明

发起 POI 匹配任务

接口介绍

该接口用于发起 POI 匹配,匹配的作用是为了将服务商的商铺和抖音的 POI 进行绑定。

注意:

  • 需有生活服务商品上传及分发权限才能调用该接口。
  • supplier_ext_id需要由服务商自定义,一个supplier_ext_id只能绑定一个抖音 POI Id,发起匹配任务时,请务必确保自己的supplier_ext_id的唯一性。
  • 当商铺已经完成匹配或者正在匹配中,请不要重复提交匹配,重复提交匹配,会导致该次商铺匹配失败。
  • 匹配失败之后,可再次发起匹配。
  • 一个匹配任务的 match_data_list 不要超过 3000 条,但也不要一个匹配任务只有一条匹配数据。

请求

基本信息

基本
HTTP URLhttps://open.microapp.bytedance.com/openapi/v1/tp/poi/supplier/match
HTTP MethodPOST

查询参数

参数名参数类型是否必须备注
component_appidstring第三方应用 appid
component_access_tokenstring第三方应用接口调用凭据

请求体(json)

参数名参数类型是否必须备注
match_data_listArray<object>上传的匹配数据

match_data_list 说明

参数名参数类型是否必须备注
latitudefloat纬度
longitudefloat经度
poi_namestringPOI 名称
supplier_ext_idstring外部商铺 ID
addressstringPOI 地址
amap_idstring高德 POI ID
citystringPOI 所在城市
provincestringPOI 所在省份
poi_idstring高德 POI ID 或 抖音 POIID
extrastring其他信息

响应

响应体

参数名参数类型备注
errnoint错误码
messagestring错误信息
dataobject

data 说明:

参数名参数类型备注
task_idint匹配任务 ID

响应体示例

{
  "errno": 0,
  "message": "success",
  "data": {
    "task_id": "70199550603101232"
  }
}

错误码

错误码message
40001参数错误
40003找不到相关第三方应用
40009第三方应用 component_access_token 已过期
40010第三方应用 component_access_token 不正确
40051没有生活服务商品上传及分发权限
点击纠错
评价此篇文档