第三方平台
接口说明

查询 POI 匹配任务

接口介绍

该接口用于查询 POI 匹配任务的结果。

注意:

  • 需有生活服务商品上传及分发权限才能调用该接口。
  • 只有匹配任务完成之后,才会返回match_result_list,否则为 null
  • mismatch_status_desc 出现 匹配已完成 字段,说明该supplier_ext_id在之前的匹配任务已经完成匹配,请不要重复提交匹配
  • mismatch_status_desc 出现 匹配进行中 字段,说明该supplier_ext_id已经发起过匹配,并且之前的匹配任务还未完成匹配,请等待之前的匹配任务完成。

请求

基本信息

基本
HTTP URLhttps://open.microapp.bytedance.com/openapi/v1/tp/poi/supplier/query/match_task
HTTP MethodGET

查询参数

参数名参数类型是否必须备注
component_appidstring第三方应用 appid
component_access_tokenstring第三方应用接口调用凭据
task_idsstringPOI 匹配任务 ID 列表,多个任务 ID 用 , 分割,单次查询最多 10 个任务。

响应

响应体

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

data 说明:

参数名参数类型备注
match_result_listArray<object>匹配结果

match_result_list 说明:

参数名参数类型备注
addressstringPOI 地址
citystringPOI 所在城市
extrastring其他信息
match_statusint匹配状态 0:没有匹配,1:匹配中,2:匹配完成 3:匹配失败
mismatch_status_descstring匹配状态描述
poi_idstring抖音 POI ID
poi_namestringPOI 名称
provincestringPOI 所在省份
supplier_ext_idstring外部商铺 ID

响应体示例

{
  "errno": 0,
  "message": "success",
  "data": {
    "match_result_list": [
      {
        "address": "南山路15号",
        "city": "",
        "extra": "南山路15号",
        "match_status": 3,
        "mismatch_status_desc": "POI地理位置不合法",
        "poi_id": "",
        "poi_name": "",
        "province": "",
        "supplier_ext_id": "SC10001"
      }
    ]
  }
}

错误码

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