Creator promotion details

curl --request GET \
  --url https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "products": [
    {
      "productId": "1729000000000000001",
      "title": "Vitamin C serum",
      "imageUrl": "https://p16-oec-va.ibyteimg.com/example.image",
      "price": {
        "min": {
          "amount": "24.99",
          "currency": "USD"
        },
        "max": {
          "amount": "24.99",
          "currency": "USD"
        }
      },
      "promotionPrice": null,
      "productStatusCode": "1",
      "commission": {
        "targetRateBps": 2200,
        "openRateBps": 1000,
        "targetAdsRateBps": null,
        "previousTargetRateBps": null,
        "previousTargetAdsRateBps": null,
        "effectiveAtMs": 1756684800000,
        "adsEffectiveAtMs": null
      },
      "isCommissionEffective": true,
      "addedToShowcase": true,
      "videoCount": 2,
      "liveCount": 1
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Creator promotion details

Returns one creator’s results in one target collaboration, per product: commission rates (targetRateBps, openRateBps and the ads rates, in 1/10000ths, so 2200 = 22%), whether the creator added the product to their showcase, and how many promo videos and LIVEs they made for it. Rows also carry title, imageUrl, price, promotionPrice and productStatusCode (1 active, 2 sold out, 3 deactivated by seller, 4 deactivated by platform, 5 rejected, 6 deleted).

creatorOpenId is required and invitationId is optional. Narrow to one product with query plus queryType (PRODUCT_ID or PRODUCT_NAME), and filter by showcase status with addedType (ALL, ADDED or NOT_ADDED). Not paged. Read live from TikTok, so the shop has to be connected through TikTok’s official API.

GET

tik_tok_shop

target_collabs

{collaborationId}

promotion_details

Creator promotion details

curl --request GET \
  --url https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/tik_tok_shop/target_collabs/{collaborationId}/promotion_details")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "products": [
    {
      "productId": "1729000000000000001",
      "title": "Vitamin C serum",
      "imageUrl": "https://p16-oec-va.ibyteimg.com/example.image",
      "price": {
        "min": {
          "amount": "24.99",
          "currency": "USD"
        },
        "max": {
          "amount": "24.99",
          "currency": "USD"
        }
      },
      "promotionPrice": null,
      "productStatusCode": "1",
      "commission": {
        "targetRateBps": 2200,
        "openRateBps": 1000,
        "targetAdsRateBps": null,
        "previousTargetRateBps": null,
        "previousTargetAdsRateBps": null,
        "effectiveAtMs": 1756684800000,
        "adsEffectiveAtMs": null
      },
      "isCommissionEffective": true,
      "addedToShowcase": true,
      "videoCount": 2,
      "liveCount": 1
    }
  ]
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "code": "<string>"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

collaborationId

string

required

Target collaboration id, sent as invitation_group_id. INFERRED (not yet probed) to be the same id: TikTok's web surface uses it that way.

Query Parameters

creatorOpenId

string

required

The creator's TikTok open id.

invitationId

string

The creator's invitation id inside the collab, when known. Optional.

query

string

Narrow to one product by id or by name. Requires queryType.

queryType

enum<string>

What query matches. Requires query.

Available options:

PRODUCT_ID,

PRODUCT_NAME

addedType

enum<string>

ADDED = only products the creator added to their showcase, NOT_ADDED = the rest.

Available options:

ALL,

ADDED,

NOT_ADDED

organization_id

integer

Use the TikTok Shop of this child brand (organization id) of your API key's organization

Response

Per-product results

products

object[]

required

Show child attributes

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Creator promotion details

Authorizations

Path Parameters

Query Parameters

Response