(To be deprecated) Get details of videos in customized posts
GET/gmv_max/custom_anchor_video_list/get/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/gmv_max/custom_anchor_video_list/get/
Description
Use this endpoint to retrieve the details of videos that have been used in the customized post collection for a Product GMV Max Campaign.
> Important
> This endpoint will be deprecated in the next API version. To ensure a seamless integration, retrieve the details of videos used in customized posts using /gmv_max/creation/custom_anchor_video_list/get/ and /gmv_max/creation/shop_video/video_anchors/.
Request
Endpoint
GET https://partner.quantri360.com/v1/tiktok_business/gmv_max/custom_anchor_video_list/get/
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 |
|---|---|---|---|---|---|
| campaign_id | query | string | Yes | The ID of a GMV Max Campaign. To filter existing GMV Max Campaigns within your ad account, use /gmv_max/campaign/get/. Important: Starting April 30th, 2026, this parameter will be required to enhance security. To ensure a smooth API integration, we recommend that you update your integration to specify this parameter in all future calls. | |
| campaign_custom_anchor_video_id | query | string | Yes | The ID of the collection of customized posts created in a Product GMV Max Campaign.
To obtain the customized post collection associated with a Product GMV Max Campaign, use /campaign/gmv_max/info/ and check the returned campaign_custom_anchor_video_id. | |
| custom_anchor_video_list | query | object[] | Yes | The list of videos with customized product links (custom anchor videos) to filter the results by.
Max size: 20.
To obtain the customized posts associated with a Product GMV Max Campaign, use /campaign/gmv_max/info/ and check the returned custom_anchor_video_list. |
Request examples
curl -s "https://partner.quantri360.com/v1/tiktok_business/gmv_max/custom_anchor_video_list/get/?campaign_id=&campaign_custom_anchor_video_id=&custom_anchor_video_list=%5B%7B%22item_id%22%3A%22%22%2C%22identity_info%22%3A%7B%22identity_id%22%3A%22%22%2C%22identity_type%22%3A%22%22%7D%7D%5D" \ -H "Authorization: Bearer $KEY"
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.get(
"https://partner.quantri360.com/v1/tiktok_business/gmv_max/custom_anchor_video_list/get/",
params={
"campaign_id": "",
"campaign_custom_anchor_video_id": "",
"custom_anchor_video_list": [
{
"item_id": "",
"identity_info": {
"identity_id": "",
"identity_type": ""
}
}
]
},
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/custom_anchor_video_list/get/');
for (const [k, v] of Object.entries({"campaign_id":"","campaign_custom_anchor_video_id":"","custom_anchor_video_list":[{"item_id":"","identity_info":{"identity_id":"","identity_type":""}}]})) url.searchParams.set(k, typeof v === 'object' ? JSON.stringify(v) : String(v));
const r = await fetch(url, {
method: 'GET',
headers: { Authorization: `Bearer ${KEY}` },
});
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/custom_anchor_video_list/get/' . '?' . http_build_query(['campaign_id' => '', 'campaign_custom_anchor_video_id' => '', 'custom_anchor_video_list' => '[{"item_id":"","identity_info":{"identity_id":"","identity_type":""}}]']);
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Authorization: Bearer ' . $key]);
$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 Code. | |
| message | string | Response message. For details, see Appendix - Return Codes. | |
| request_id | string | The log ID of a request, which uniquely identifies the request. | |
| data | object | Returned data. | |
| custom_anchor_video_list | object[] | The list of custom anchor videos. | |
| item_id | string | The ID of the TikTok video. Example: `1234567891234567891`. | |
| text | string | The caption of the TikTok post. Example: `summer`. | |
| spu_id_list | string[] | Returned only when `spu_id_list` is specified in the request. The list of Product SPU IDs that the TikTok post is associated with. | |
| identity_info | object | Information about the identity associated with the TikTok post. | |
| identity_id | string | Identity ID. Example: `identity_12345`. | |
| identity_type | string | Identity type. Enum values: - `AUTH_CODE`: Authorized User. This type of identity is created when you use the authorization code to access a TikTok account or a TikTok post. - `TT_USER`: TikTok User. This type of identity is created when you bind your TikTok For Business account with your TikTok Business Account, or when you bind your TikTok For Business account with your regular TikTok account and then upgrade the account to Business Account. - `BC_AUTH_TT`: TikTok Account User in Business Center. This type of identity is created when you add a TikTok account to your Business Center, and the TikTok account owner approves your request. - `TTS_TT`: TikTok Account User for TikTok Shop. This type of identity is created when you set an official TikTok account for the TikTok Shop. | |
| identity_authorized_bc_id | string | Returned only when `identity_type` is `BC_AUTH_TT`. The ID of the Business Center that a TikTok Account User in Business Center identity is associated with. | |
| identity_authorized_shop_id | string | Returned for some `BC_AUTH_TT` identities. The ID of the TikTok Shop that the TikTok Account User in Business Center identity is associated with. | |
| store_id | string | Returned only when `identity_type` is `TTS_TT`. The ID of the TikTok Shop that a TikTok Account User for TikTok Shop identity is associated with. | |
| profile_image | string | Temporary profile image URL for the TikTok account that is associated with the identity. Validity period: around 48 hours. The expiration time is included in the URL after the `x-expires` parameter, in the format of an Epoch/Unix timestamp in seconds. Once the URL expires, you need to call /gmv_max/custom_anchor_video_list/get/ to obtain a new URL. | |
| user_name | string | The username of the TikTok account that is associated with the identity. | |
| video_info | object | Details of the video in the post. | |
| video_id | string | The ID of the video. Example: `video_12345`. | |
| video_cover_url | string | Temporary URL for the video cover. Validity period: around 24 hours. The expiration time is included in the URL after the `x-expires` parameter, in the format of an Epoch/Unix timestamp in seconds. Once the URL expires, you need to call /gmv_max/custom_anchor_video_list/get/ to obtain a new URL. | |
| preview_url | string | Temporary preview URL for the video. Validity period: six hours. Once the URL expires, you need to call /gmv_max/custom_anchor_video_list/get/ to obtain a new URL. | |
| height | number | The height of the video in pixels. Example: 1920. | |
| width | number | The width of the video in pixels. Example: 1080. | |
| bit_rate | number | The bit rate of the video in bps. Example: 8500323. | |
| duration | number | The duration of the video in seconds. Example: 3.669. | |
| size | number | The size of the video in bytes. Example: 3898461. | |
| signature | string | The MD5 of the video. Example: `ab1cd2345e678fghi91jkl23b456m7no`. | |
| format | string | The format of the video. Example: `mp4`. | |
| definition | string | The definition of the video. Example: `1080p`. | |
| fps | number | The frames per second (FPS) of the video. Example: 27. |
Response sample
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"custom_anchor_video_list": [
{
"identity_info": {
"identity_id": "{{identity_id}}",
"identity_type": "TT_USER",
"profile_image": "{{profile_image}}",
"user_name": "{{user_name}}"
},
"item_id": "{{item_id}}",
"spu_id_list": [
"{{spu_id}}"
],
"text": "{{text}}",
"video_info": {
"bit_rate": 824497,
"definition": "540p",
"duration": 10.444,
"format": "mp4",
"fps": 30,
"height": 960,
"preview_url": "{{preview_url}}",
"signature": "{{signature}}",
"size": 1076382,
"video_cover_url": "{{video_cover_url}}",
"video_id": "{{video_id}}",
"width": 540
}
}
]
}
}
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