Create a max delivery or creative boost session
POST/campaign/gmv_max/session/create/Via 360: POST https://partner.quantri360.com/v1/tiktok_business/campaign/gmv_max/session/create/
Write endpoint — changes data on TikTok Business. The key must be created with "Allow write API calls" ticked, otherwise you get 403 write_not_allowed. Every call is logged.
Description
Use this endpoint to create a max delivery session for a specific product or a creative boost session for a specific video in a Product GMV Max Campaign.
- Max delivery for GMV Max uses an additional budget and maximizes gross revenue for selected products in your campaign over a selected period of time. Learn more about Max delivery optimization for GMV Max.
- Creative Boost is a functionality within Product GMV Max that allows sellers to manually promote specific videos by allocating extra daily budget.
Request
Endpoint
POST https://partner.quantri360.com/v1/tiktok_business/campaign/gmv_max/session/create/
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 | body | string | Yes | The ID of the Product GMV Max Campaign.
- To create a Product GMV Max Campaign and obtain the campaign ID, use /campaign/gmv_max/create/ and set shopping_ads_type to PRODUCT.
- To filter 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"]}. | |
| store_id | body | string | Yes | The ID of the TikTok Shop. To obtain the ID of the TikTok Shop that is associated with a GMV Max Campaign, use /campaign/gmv_max/info/. | |
| session | body | object | Yes | Details about the max delivery mode for the campaign. |
Request examples
curl -s -X POST "https://partner.quantri360.com/v1/tiktok_business/campaign/gmv_max/session/create/" \
-H "Authorization: Bearer $KEY" \
-H "Content-Type: application/json" \
-d '{"campaign_id":"","store_id":"","session":{"bid_type":"","product_list":[{"spu_id":""}],"budget":0}}'
Python
import requests
KEY = "q360_live_..." # khóa API của brand
r = requests.post(
"https://partner.quantri360.com/v1/tiktok_business/campaign/gmv_max/session/create/",
params={},
json={
"campaign_id": "",
"store_id": "",
"session": {
"bid_type": "",
"product_list": [
{
"spu_id": ""
}
],
"budget": 0
}
},
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/campaign/gmv_max/session/create/');
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({"campaign_id":"","store_id":"","session":{"bid_type":"","product_list":[{"spu_id":""}],"budget":0}}),
});
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/campaign/gmv_max/session/create/' . '?' . 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, '{"campaign_id":"","store_id":"","session":{"bid_type":"","product_list":[{"spu_id":""}],"budget":0}}');
$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. | |
| session_id | string | The ID of the max delivery session for the product or of the creative boost session for the video in the Product GMV Max Campaign. |
Response sample
HTTPS/1.1 200 OK
{
"code": 0,
"message": "OK",
"request_id": "{{request_id}}",
"data": {
"session_id": "{{session_id}}"
}
}
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