第三方平台
接口说明

查询 POI 商铺匹配状态

接口介绍

该接口用于查询商铺对应的匹配任务和匹配状态。

注意:

  • 需有生活服务商品上传及分发权限才能调用该接口。

请求

基本信息

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

查询参数

参数名参数类型是否必须备注
component_appidstring第三方应用 appid
component_access_tokenstring第三方应用接口调用凭据
supplier_ext_idsstring外部商铺 id 列表,多个商铺 id 用 , 分割,单次查询最多 50 个商铺。

响应

响应体

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

data 说明:

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

match_result_list 说明:

参数名参数类型备注
poi_idstring抖音 POI ID
statusint匹配状态,0:没有匹配,1:匹配中,2:匹配完成,3:匹配失败
supplier_ext_idstring外部商铺 ID
task_idstring对应的匹配任务 ID

响应体示例

{
  "errno": 0,
  "message": "success",
  "data": {
    "match_result_list": [
      {
        "poi_id": "6691586459725465604",
        "status": 2,
        "supplier_ext_id": "test-supplier-1",
        "task_id": "123123123123"
      }
    ]
  }
}

错误码

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