第三方平台
接口说明

查询最近同步的 POI 商铺信息

接口介绍

该接口用于查询最近一次同步的 POI 商铺状态和信息。

注意:

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

请求

基本信息

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

查询参数

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

响应

响应体

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

data 说明:

参数名参数类型备注
sync_statusobject最近一次的商铺同步结果
data_detailobject最近一次的商铺同步的数据,与商铺同步的数据相同

sync_status 说明:

参数名参数类型备注
fail_reasonstring同步失败原因
last_sync_statusint最近一次同步状态, 0:未处理,1:通过,2:未通过

data_detail 说明:

参数名参数类型备注
namestring商铺名称
poi_idstring抖音 POI ID
servicesArray<object>商铺提供的服务列表
statusint商铺状态 1:上线,2:下线
supplier_ext_idstring外部商铺 ID
typeint64商铺类型 1:酒店民宿,2:餐饮,3:景区,4:电商,5:教育,6:丽人,7:爱车,8:亲子,9:宠物,10:家装,11:娱乐场所,12:图文快印

services 说明

参数名参数类型备注
enableint状态,1:上线,2:下线
service_typeint服务类型,201:预约点餐服务, 202:预约订位服务, 203:排队取号服务, 9001:门票预订服务, 9101:团购套餐服务, 9102:领优惠劵服务, 9201:在线预约服务, 9301:外卖服务, 40:住宿服务, 200:预约券服务
entryobject服务入口参数

entry 说明

参数名参数类型备注
entry_mini_appobject小程序入口参数

entry_mini_app 说明

参数名参数类型备注
app_idstring小程序 app id
pathstring页面路径
paramsstring页面参数

响应体示例

{
  "errno": 0,
  "message": "success",
  "data": {
    "sync_status": {
      "fail_reason": "",
      "last_sync_status": 1
    },
    "data_detail": {
      "sync_status": {
        "fail_reason": "",
        "last_sync_status": 1
      },
      "data_detail": {
        "name": "测试门店",
        "poi_id": "6601138963681921037",
        "services": [
          {
            "enable": 1,
            "entry": {
              "entry_mini_app": {
                "app_id": "tt631f15a2fc245243",
                "params": "{\"id\":43235}",
                "path": "pages/goodsDetail/goodsDetail/3"
              }
            },
            "service_type": 9101
          }
        ],
        "status": 1,
        "supplier_ext_id": "test-2",
        "type": 2
      }
    }
  }
}

错误码

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