Get product linkage details of videos in customized posts
POST/gmv_max/creation/shop_video/video_anchors/Via 360: POST https://partner.quantri360.com/v1/tiktok_business/gmv_max/creation/shop_video/video_anchors/
Description
Use this endpoint to retrieve the shop-level or campaign-level product linkage details for videos in customized posts.
Shop-level customized TikTok posts are generated by directly linking your TikTok videos to a product at the TikTok Shop level. If the linked product is part of an active campaign, the video linked to that product will be automatically added to that campaign. In contrast, campaign-level customized TikTok posts are generated by linking your TikTok videos to a product during the Product GMV Max Campaign creation process and are exclusive to the campaign.
Request
Endpoint
POST https://partner.quantri360.com/v1/tiktok_business/gmv_max/creation/shop_video/video_anchors/
Authentication & shop
| Name | In | Type | Sample | Description |
|---|---|---|---|---|
| Authorization | header | header | Bearer q360_live_ab12cd34_… | Khóa API của brand (tạo ở mục API key). Bắt buộc với mọi request. Brand suy từ key — không truyền mã brand. |
| platform_shop_id | query | string | 7000000000000000001 | Tài sản TikTok Business đã kết nối — "Mã tài sản" ở trang Nền tảng hoặc GET /v1/platforms (tài khoản quảng cáo cho Marketing API, tài khoản TikTok cho Organic / Messaging). Có thể bỏ khi chỉ kết nối một tài sản. |
Request parameters
| Name | In | Type | Required | Sample | Description |
|---|---|---|---|---|---|
| store_id | body | string | Yes | The ID of a TikTok Shop.
To obtain a TikTok Shop that is available for GMV Max Campaigns, use /gmv_max/store/list/ and confirm that the returned is_gmv_max_available is true. | |
| store_authorized_bc_id | body | string | Yes | The ID of the Business Center that is authorized to access the TikTok Shop (store_id).
To obtain the ID, check the store_authorized_bc_id for the store_id returned from /gmv_max/store/list/. | |
| item_ids | body | string[] | Yes | The list of TikTok videos for which you want to retrieve product linkage information. To retrieve TikTok videos used in customized posts, use /gmv_max/creation/custom_anchor_video_list/get/. Max size: 20. | |
| campaign_id | body | string | No | Required when the specified TikTok videos have been used in a campaign to create campaign-level customized posts.
The ID of a Product GMV Max Campaign.
To retrieve existing Product GMV Max Campaigns within your ad account, use /gmv_max/campaign/get/ and set filtering to {"gmv_max_promotion_types":["PRODUCT_GMV_MAX"]}. |
Request examples
curl -s -X POST "https://partner.quantri360.com/v1/tiktok_business/gmv_max/creation/shop_video/video_anchors/" \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{"store_id":"","store_authorized_bc_id":"","item_ids":[]}'
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.post(
"https://partner.quantri360.com/v1/tiktok_business/gmv_max/creation/shop_video/video_anchors/",
params={},
json={
"store_id": "",
"store_authorized_bc_id": "",
"item_ids": []
},
headers={"Authorization": f"Bearer {KEY}"},
timeout=60,
)
print(r.status_code)
print(r.json())Node.js
const KEY = 'q360_live_...'; // khóa API của brand
const url = new URL('https://partner.quantri360.com/v1/tiktok_business/gmv_max/creation/shop_video/video_anchors/');
for (const [k, v] of Object.entries({})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
method: 'POST',
headers: { Authorization: `Bearer ${KEY}`, 'Content-Type': 'application/json' },
body: JSON.stringify({"store_id":"","store_authorized_bc_id":"","item_ids":[]}),
});
console.log(r.status, await r.json());PHP
<?php
$key = 'q360_live_...'; // khóa API của brand
$url = 'https://partner.quantri360.com/v1/tiktok_business/gmv_max/creation/shop_video/video_anchors/' . '?' . http_build_query([]);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key, 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"store_id":"","store_authorized_bc_id":"","item_ids":[]}');
$res = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
echo $status, "\n", $res;Response
Response fields (as returned by TikTok Business)
| Name | Type | Sample | Description |
|---|---|---|---|
| code | number | Response code. For the complete list of response codes and descriptions, see Appendix - Return Codes. | |
| message | string | Response message. For details, see Appendix - Return Codes. | |
| request_id | string | The log ID of the request, which uniquely identifies a request. | |
| data | object | Returned data. | |
| video_list | object | The product linkage details for the specified videos. | |
| item_id | string | The ID of the TikTok video. | |
| product_list | object | The list of products that the video is linked to. | |
| spu_id | string | The SPU ID of the product linked to the TikTok video. | |
| title | string | The title of the product. | |
| picture | string | The URL of the product image. | |
| anchor_source | string | The source of the product anchor in the video. Enum values: - `CUSTOM`: custom anchor. The product anchor was added to the video through Shop Creative Hub for GMV Max. The linked product will appear in ads traffic. - `ORGANIC`: organic anchor. The product anchor was added to the video through the TikTok app. The linked product will appear in both ads and organic traffic. |
Response sample
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"video_list": [
{
"item_id": "{{item_id}}",
"product_list": [
{
"anchor_source": "CUSTOM",
"picture": "{{picture}}",
"spu_id": "{{spu_id}}",
"title": "{{title}}"
},
{
"anchor_source": "ORGANIC",
"picture": "{{picture}}",
"spu_id": "{{spu_id}}",
"title": "{{title}}"
}
]
}
]
}
}
Get started
- Sign up for Partner
- Enable a data type of the Ads (Marketing API) group on the platform page
- Create an API key (tick the TikTok Business channel)
- Call it as in the examples above