第三方平台
接口说明

查询 POI 商品信息

接口介绍

该接口用于查询商品的信息和状态。

注意:

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

请求

基本信息

基本
HTTP URLhttps://open.microapp.bytedance.com/openapi/v1/microapp/operation/poi/spu/get
HTTP MethodGET
权限要求授权小程序授予运营管理权限

查询参数

参数名参数类型是否必须备注
component_appidstring第三方应用 appid
authorizer_access_tokenstring授权小程序接口调用凭据
spu_ext_idstring外部商品 ID
need_spu_draftbool是否需要商品草稿数据(带有商品的审核状态,只展示最近 30 天的数据)
spu_draft_countint需要商品草稿数据的数目(0-20),超过这个范围默认返回 20 个
supplier_ids_for_filter_reasonArray<string>外部商铺 ID 列表,查询商品在商铺下的过滤状态

响应

响应体

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

data 说明:

参数名参数类型备注
spu_detailobject线上商品状态
spu_draftArray<object>审核版商品信息,以创建时间降序排序

data.spu_detail 说明:

参数名参数类型备注
statusint状态,1:上架,2:下架
highlightsArray<object>商品亮点标签
priceint现价,单位分
spu_filter_statusArray<object>过滤状态
spu_idint抖音 SPU ID
spu_typeint商品类型,30:预售券,90:门票,91:团购券
status_descstring状态描述
supplier_ext_id_listArray<string>接入方商铺 ID 列表
front_category_tagArray<object>前台品类标签
entry_infoobject小程序跳转信息
image_listArray<string>商品图片
stockint库存
attributeobjectSPU 属性字段
origin_priceint原价,单位分
sort_weightint排序权重,按降序排列
spu_ext_idstring外部商品 ID
namestring商品名称

data.spu_detail.spu_filter_status 说明:

参数名参数类型备注
supplier_idstring外部商铺 id
spu_poi_filter_statusArray<object>商品在 POI 下的过滤状态

data.spu_detail.spu_filter_status.spu_poi_filter_status 说明:

参数名参数类型备注
filterbool是否被过滤
poi_idstring商铺对应的抖音 POI Id
reasonstring过滤原因
codeint过滤码

data.spu_draft 说明:

参数名参数类型备注
statusint状态,1:上架,2:下架
highlightsArray<object>商品亮点标签
priceint现价,单位分
spu_idint抖音 SPU ID
spu_typeint商品类型,30:预售券,90:门票,91:团购券
status_descstring状态描述
supplier_ext_id_listArray<string>接入方商铺 ID 列表
front_category_tagArray<object>前台品类标签
entry_infoobject小程序跳转信息
image_listArray<string>商品图片
stockint库存
attributeobjectSPU 属性字段
origin_priceint原价,单位分
sort_weightint排序权重,按降序排列
spu_ext_idstring外部商品 ID
namestring商品名称

响应体示例

{
  "errno": 0,
  "message": "success",
  "data": {
    "spu_detail": {
      "attribute": {
        "9001": {
          "is_need_pick": true,
          "nearest_order_time": {
            "time": "6",
            "time_type": 5
          },
          "refund_policy": 1
        }
      },
      "entry_info": {
        "entry_miniApp": {
          "app_id": "tt631f15a2fc245243",
          "params": "{\"id\":43235}",
          "path": "pages/goodsDetail/goodsDetail/3"
        }
      },
      "image_list": ["https://xxxxxx"],
      "name": "xxxx",
      "spu_ext_id": "test-sc-spu-1",
      "spu_id": 7007997933283018765,
      "spu_type": 91,
      "status": 1,
      "supplier_ext_id_list": ["test-1"]
    },
    "spu_draft": [
      {
        "attribute": {
          "9001": {
            "is_need_pick": true,
            "nearest_order_time": {
              "time": "6",
              "time_type": 5
            },
            "refund_policy": 1
          }
        },
        "entry_info": {
          "entry_miniApp": {
            "app_id": "tt631f15a2fc245243",
            "params": "{\"id\":43235}",
            "path": "pages/goodsDetail/goodsDetail/3"
          }
        },
        "image_list": ["https://xxxxxx"],
        "name": "xxxx",
        "spu_ext_id": "test-sc-spu-1",
        "spu_id": 7007997933283018765,
        "spu_type": 91,
        "status": 4,
        "status_desc": "success",
        "supplier_ext_id_list": ["test-1"]
      }
    ]
  }
}

错误码

错误码message
40001参数错误
40003找不到相关第三方应用
40004找不到相关授权小程序
40020第三方应用 authorizer_access_token 不正确或者已过期
40051没有生活服务商品上传及分发权限
41301查询过于频繁,请稍后再试
点击纠错
评价此篇文档