Product videos and LIVEs

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/products/{productId}/contents"

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/products/{productId}/contents', 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/products/{productId}/contents",
  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/products/{productId}/contents"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/tik_tok_shop/products/{productId}/contents")

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

{
  "shopId": "7494000000000000123",
  "productId": "1729000000000000100",
  "startDate": "2026-09-01",
  "endDate": "2026-09-07",
  "total": 23,
  "contents": [
    {
      "contentId": "7550000000000000001",
      "kind": "video",
      "creatorOecId": "7000000000000000001",
      "creatorHandle": "creator_one",
      "title": "My morning routine with this serum",
      "startedAt": "2026-08-28T16:30:00.000Z",
      "gmv": 874.65,
      "orders": 35,
      "unitsSold": 35,
      "refundedAmount": 0,
      "refundedItems": 0,
      "commission": 131.2,
      "currency": "USD",
      "days": 7,
      "firstDay": "2026-09-01",
      "lastDay": "2026-09-07"
    }
  ]
}

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

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

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

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

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

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

Product videos and LIVEs

Lists the videos and LIVEs that sold one product in a date window, summed per content and ranked by GMV. Each row has contentId, kind, creatorHandle, title, startedAt, gmv, orders, unitsSold, refunds, commission and currency, plus the days counted. total is the number of contents before limit applies.

start_date and end_date are YYYY-MM-DD in the shop region’s local day, both inclusive, at most 31 days including both ends. type is all (default), video or live. limit is 1 to 200 (default 50). Served from Growi’s synced sales data, and the most recent days can still change.

GET

tik_tok_shop

products

{productId}

contents

Product videos and LIVEs

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/products/{productId}/contents"

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/products/{productId}/contents', 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/products/{productId}/contents",
  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/products/{productId}/contents"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.growi.io/api/public/v1/tik_tok_shop/products/{productId}/contents")

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

{
  "shopId": "7494000000000000123",
  "productId": "1729000000000000100",
  "startDate": "2026-09-01",
  "endDate": "2026-09-07",
  "total": 23,
  "contents": [
    {
      "contentId": "7550000000000000001",
      "kind": "video",
      "creatorOecId": "7000000000000000001",
      "creatorHandle": "creator_one",
      "title": "My morning routine with this serum",
      "startedAt": "2026-08-28T16:30:00.000Z",
      "gmv": 874.65,
      "orders": 35,
      "unitsSold": 35,
      "refundedAmount": 0,
      "refundedItems": 0,
      "commission": 131.2,
      "currency": "USD",
      "days": 7,
      "firstDay": "2026-09-01",
      "lastDay": "2026-09-07"
    }
  ]
}

{
  "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

productId

string

required

TikTok product id.

Pattern: ^[0-9]{1,32}$

Query Parameters

start_date

string<date>

required

Window start, YYYY-MM-DD INCLUSIVE (the shop region's local day).

end_date

string<date>

required

Window end, YYYY-MM-DD INCLUSIVE. At most 31 days including both ends.

type

enum<string>

default:all

video, live, or all (default).

Available options:

all,

video,

live

limit

integer

default:50

Contents returned, 1 to 200 (default 50), top by GMV.

Required range: 1 <= x <= 200

organization_id

integer

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

Response

Contents GMV-descending.

shopId

string

productId

string

startDate

string<date>

endDate

string<date>

total

integer

Contents that sold the product in the window, before the limit.

contents

object[]

Show child attributes

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Product videos and LIVEs

Authorizations

Path Parameters

Query Parameters

Response