第三方平台
接口说明

POI 商铺同步

接口介绍

该接口用于同步创建商铺。

注意:

  • 需有生活服务商品上传及分发权限才能调用该接口。
  • 在同步商铺之前,必须要先进行 POI 匹配,只有 POI 匹配成功的商铺才能同步商品。
  • 测试期间,最多只能上传 10 个商铺。

请求

基本信息

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

查询参数

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

请求体(json)

参数名参数类型是否必须备注
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页面参数,传入 json 格式的 string,例如: {"params_a":"xxx", "params_b":"xxx"}

注意:

  • path 开头不要带有 /,合法的例子: pages/result,不合法的例子: /pages/result
  • 商铺的services.service_type 和 商品的spu_type(商品类型)有对应关系,例如:商铺有团购套餐服务的服务类型,则该商铺能同步团购券,否则无法同步团购券。

商铺服务类型和商品类型对应关系 说明

商品类型商铺 services.service_type商品 spu_type
团购券910191
门票900190
预售券20030

请求体示例

{
  "supplier_ext_id": "test-supplier-1",
  "address": "测试商铺的地址",
  "status": 1,
  "type": 2,
  "name": "测试商铺",
  "poi_id": "660113721511851123123",
  "services": [
    {
      "enable": 1,
      "service_type": 9101,
      "entry": {
        "entry_mini_app": {
          "params": "{\"id\":43235}",
          "path": "pages/goodsDetail/goodsDetail/3",
          "app_id": "ttadas123123113"
        }
      }
    }
  ]
}

响应

响应体

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

响应体示例

{
  "errno": 0,
  "message": "success"
}

错误码

错误码message
40001参数错误
40003找不到相关第三方应用
40009第三方应用 component_access_token 已过期
40010第三方应用 component_access_token 不正确
40051没有生活服务商品上传及分发权限
40052测试期间,最多上传 10 个
41312POI 不存在
41316运营审核驳回
点击纠错
评价此篇文档