获取商品库列表
您可以使用本接口获取商务中心账户下的商品库列表和信息。
v1.2与v1.3版本对比
以下表格概括了 v1.2与v1.3接口的变化。
``xtable
|变化内容{30%}|v1.2{35%}|v1.3{35%}|
|---|---|---|
|接口路径| /v1.2/catalog/get/| /v1.3/catalog/get/|
|请求参数类型|bc_id: number<br>catalog_id: number|bc_id: string<br>catalog_id: string|
|返回参数名称|name|catalog_name|
|返回参数类型|bc_id: number<br>catalog_id: number|bc_id: string<br>catalog_id: string|
|新增返回参数| / |ad_creation_eligible<br>additional_config_list`|
## 请求
**地址** https://business-api.tiktok.com/open_api/v1.3/catalog/get/
**方法**
GET
**Header**
```xtable
|字段|类型|描述|
|--- |--- |--- |
|Access-Token {必填}|string|授权访问令牌。可以通过[获取访问令牌](https://ads.tiktok.com/marketing_api/docs?id=1738373164380162)接口获取。|
参数
|字段|类型|描述|
|--- |--- |--- |
|bc_id {必填}|string|商务中心 ID。|
|catalog_id|string|商品库 ID。如果不传该字段，默认返回所有商品库。 |
|page |number |当前页数。默认值: 1，取值范围: ≥ 1。 |
|page_size |number |分页大小。默认值: 10，取值范围：1-100。 |
示例
(code curl http)
curl -X GET -H "Access-Token:YOUR_ACCESS_TOKEN" \
--data-urlencode "bc_id=BC_ID" \
--data-urlencode "catalog_id=CATALOG_ID" \
https://business-api.tiktok.com/open_api/v1.3/catalog/get/
(/code)
返回
|字段|类型|描述|
|--- |--- |--- |
|code |number|返回码，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|message |string|返回信息，详见[附录-返回码](https://ads.tiktok.com/marketing_api/docs?id=1737172488964097)。|
|data|object|返回数据。|
#|list|object[]|商品库列表。|
##|catalog_id|string|商品库ID。|
##|catalog_name|string|商品库名称。|
##|catalog_type|string|商品库类型。<br>枚举值： <ul><li>`ECOM`：电商商品库。</li><li> `HOTEL`：酒店商品库。</li><li>`FLIGHT`：航班商品库。</li><li>`DESTINATION`：目的地商品库。</li><li>`ENTERTAINMENT`：娱乐商品库。</li><li>`AUTO_VEHICLE`：汽车库存商品库。</li><li>`AUTO_MODEL`： 汽车型号商品库。</li><li>`MINI_SERIES`：短剧商品库。</li></ul>|
##|ad_creation_eligible |string|商品库中含有广告样式所需的足量可用商品时，商品库是否可用于广告中。<br><br>枚举值：<ul><li>`NOT_AVAILABLE`: 商品库不可用于广告中。</li><li>`AVAILABLE`: 若商品库中含有广告样式所需的足量可用商品，商品库可用于广告中。</li></ul>|
##|create_time|string|创建时间。|
##|update_time|string|更新时间。|
##|bc_info|object|商务中心信息。|
###|bc_id|string|商务中心ID。|
###|bc_name|string|商务中心名称。|
###|picture_url|string|商务中心头像 URL。若无头像，返回空字符串。|
##|catalog_conf|object|商品库配置信息。|
###|country|string|主要定向地域的二字地区代码。<br><br>若想了解某个地区代码对应的地区，请查看[附录-地区代码](1737585867307010.html)。<br><br>示例: `US`。|
###|currency|string|主要定向地域的币种。<br><br>如需了解支持的币种，请查看[不同币种的预算校验比例及精度](https://business-api.tiktok.com/portal/docs?id=1737585839634433#item-link-%E4%B8%8D%E5%90%8C%E5%B8%81%E7%A7%8D%E7%9A%84%E9%A2%84%E7%AE%97%E6%A0%A1%E9%AA%8C%E6%AF%94%E4%BE%8B%E5%8F%8A%E7%B2%BE%E5%BA%A6)中的<b>编码</b>列。<br><br>示例: `USD`。|
###|channel|string|创建商品库的渠道。<br><br>枚举值:<ul><li>`PARTNER`：第三方合作伙伴。</li><li>`CLIENT`：直客广告主。</li></ul>|
###|additional_config_list|object[]|仅当 `catalog_type` 为 `MINI_SERIES` 时返回本字段。<br><br>额外定向地域的详细信息。|
####|region_code|string|额外定向地域的地区代码。<br><br>若想了解某个地区代码对应的地区，请查看[附录-地区代码](1737585867307010.html)。<br><br>示例: `GB`。|
####|currency|string|额外定向地域的币种。<br><br>如需了解支持的币种，请查看[不同币种的预算校验比例及精度](https://business-api.tiktok.com/portal/docs?id=1737585839634433#item-link-%E4%B8%8D%E5%90%8C%E5%B8%81%E7%A7%8D%E7%9A%84%E9%A2%84%E7%AE%97%E6%A0%A1%E9%AA%8C%E6%AF%94%E4%BE%8B%E5%8F%8A%E7%B2%BE%E5%BA%A6)中的<b>编码</b>列。<br><br>示例: `GBP`。|
#|page_info |object | 分页信息。 |
##|page |number | 当前页数。 |
##|page_size |number | 分页大小。 |
##|total_number |number | 总结果数。 |
##|total_page |number | 总页数。 |
|request_id |string|请求的日志 ID，唯一标识一个请求。|
示例
(code Success-Response http)
HTTPS/1.1 200 OK
{
"message": "OK",
"code": 0,
"data": {
"page_info": {
"total_number": 14,
"page": 1,
"page_size": 14,
"total_page": 1
},
"list": [
{
"update_time": "2021-07-23 10:34:36",
"catalog_name": "test",
"create_time": "2021-07-23 10:34:36",
"bc_info": {
"bc_id": "{{bc_id}}",
"picture_url": "example URL",
"bc_name": "BC Demo"
},
"catalog_type": "ECOM",
"catalog_id": "{{catalog_id}}",
"ad_creation_eligible": "AVAILABLE",
"catalog_conf": {
"currency": "USD",
"country": "US",
"channel": "CLIENT"
}
},
...
]
},
"request_id": "{{request_id}}"
}
(/code);