Check the availability of a TikTok Shop for Product GMV Max Campaigns
GET/gmv_max/store/shop_ad_usage_check/Via 360: GET https://partner.quantri360.com/v1/tiktok_business/gmv_max/store/shop_ad_usage_check/
Description
Use this endpoint to check whether a TikTok Shop has been occupied by enabled Video Shopping Ads or Product Shopping Ads, and whether the TikTok Shop can be used to create Product GMV Max Campaigns by promoting all products in the TikTok Shop.
Request
Endpoint
GET https://partner.quantri360.com/v1/tiktok_business/gmv_max/store/shop_ad_usage_check/
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 | query | string | Yes | The ID of the 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. |
Request examples
curl -s "https://partner.quantri360.com/v1/tiktok_business/gmv_max/store/shop_ad_usage_check/?store_id=" \ -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/store/shop_ad_usage_check/",
params={
"store_id": ""
},
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/store/shop_ad_usage_check/');
for (const [k, v] of Object.entries({"store_id":""})) 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/store/shop_ad_usage_check/' . '?' . http_build_query(['store_id' => '']); $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. | |
| promote_all_products_allowed | boolean | Whether the TikTok Shop can be used to create Product GMV Max Campaigns by promoting all products in the TikTok Shop. Supported values: `true`, `false`. | |
| is_running_custom_shop_ads | boolean | Whether the TikTok Shop is being used in enabled Video Shopping Ads or Product Shopping Ads. Supported values: `true`, `false`. |
Response sample
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"is_running_custom_shop_ads": true,
"promote_all_products_allowed": false
}
}
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