获取橱窗中的可用商品

您可以使用本接口获取可定向所指定国家或地区的橱窗商品。

请求

地址 https://business-api.tiktok.com/open_api/v1.3/showcase/product/get/

方法 GET

Header

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|

参数

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
| advertiser_id {必填} | string | 广告主ID。 |
| identity_id {必填} | string | 与橱窗绑定且有橱窗权限的认证身份的ID。 |
| identity_type{必填}  | string | 认证身份类型。<br> 枚举值：`TT_USER` （TikTok 用户）， `BC_AUTH_TT`（添加到商务中心的 TikTok 用户）。<br> 您可以查看[认证身份](https://ads.tiktok.com/marketing_api/docs?id=1738958351620097)了解不同认证身份类型。 |
| identity_authorized_bc_id {+条件必填} | string | 当 `identity_type` 为 `BC_AUTH_TT` 时必填。  <br><br>与添加到商务中心的 TikTok 用户这一认证身份绑定的商务中心的 ID。 |
| region_codes {必填} | string[] | 您想要使用橱窗商品定向的国家或地区代码列表。 |
| filtering | object | 筛选条件。 |
#| item_group_ids | string[] | 商品的 SPU （标准化产品单元）ID 列表。<br><br>最大数量：10。 |
| page | number | 当前页数。<br>默认值：1。取值范围：≥1。 |
| page_size| number |分页大小。<br>默认值：10。取值范围：[1, 1000]。 |

示例

(code curl http)
curl --location --request GET 'https://business-api.tiktok.com/open_api/v1.3/showcase/product/get/?identity_id={{identity_id}}&identity_type={{identity_type}}&advertiser_id={{advertiser_id}}&region_codes=["ID"]' \
--header 'Access-Token: {{Access-Token}}' \
(/code)

|字段{30%}|类型{15%}|描述{55%}|
|---|---|---|
|code |number| 返回码。完整返回码列表及描述，参见 [附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string| 返回信息。更多信息参见 [附录 - 返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。 |
|request_id |string| 请求的日志ID，唯一标识一个请求。 |
|data |object| 返回数据。 |
#| showcase_products | object[] |可用于定向所指定国家或地区的橱窗商品列表。 |
##| item_group_id | string | 商品的 SPU ID。 |
##| title | string | 商品的标题。 |
##| product_image_url | string | 商品图片的 URL 。 |
##| min_price | string | 商品的最低价格。<br><br><p><span style="color:darkred"><b>注意</b></span>：若您仅为商品设置了一个固定价格，则 `min_price` 和 `max_price` 将返回相同的值。 |
##| max_price | string | 商品的最高价格。<br><br><p><span style="color:darkred"><b>注意</b></span>：若您仅为商品设置了一个固定价格，则 `min_price` 和 `max_price` 将返回相同的值。 |
##| currency | string | 商品价格（`min_price` 和 `max_price`）对应的币种代码。<br><br>若想了解币种代码对应的币种，请查看[不同币种的预算校验比例和取值范围](1737585839634433.html)。 |
##| category | string | 商品的分类。 |
##| status | string | 商品的状态。<br><br>枚举值：<ul><li>`AVAILABLE`：商品可用于创建广告。</li><li>`NOT_AVAILABLE`：商品不可用于创建广告。</li></ul> |
##| catalog_id {-即将废弃}| string | 商品（`item_group_id`）所属的商品库 ID。<br><br><p><span style="color:darkred"><b>注意</b></span>：自 2024 年 6 月 30 日起，将不再返回本字段。 |
##| store_id | string | 商品（`item_group_id`）所属的店铺 ID。<br>请注意本字段仅支持 TikTok Shop 店铺。 |
#| page_info | object | 分页信息。 |
##| page | number | 当前页码。 |
##| page_size | number | 当前页面大小。 |
##| total_number | number | 结果总数。 |
##| total_page | number | 总页数。 |

示例

(code Success-Response http)
HTTPS/1.1 200 OK
{
    "code": 0,
    "message": "OK",
    "request_id": "{{request_id}}",
    "data": {
        "showcase_products": [
            {
                "category": "{{category}}",
                "title": "{{title}}",
                "status": "NOT_AVAILABLE",
                "item_group_id": "{{item_group_id}}",
                "store_id": "{{store_id}}",
                "catalog_id": "{{catalog_id}}",
                "currency": "IDR",
                "min_price": "1000",
                "product_image_url": "{{product_image_url}}",
                "max_price": "1000"
            }
        ],
        "page_info": {
            "total_page": 1,
            "page_size": 10,
            "total_number": 1,
            "page": 1
        }
    }
}
(/code)