Affiliate summary

curl --request GET \
  --url https://api.growi.io/api/public/v1/tik_tok_shop/affiliate/summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/affiliate/summary"

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/affiliate/summary', 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/affiliate/summary",
  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/affiliate/summary"

	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/affiliate/summary")

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

{
  "gmvGross": 15234.5,
  "commissionBase": 14890.1,
  "commissionEstimated": 1823.44,
  "commissionActual": 1210.02,
  "orders": 412,
  "skuOrders": 431,
  "itemsSold": 468,
  "creators": 57,
  "fullyReturnedSkuOrders": 9,
  "currency": "USD",
  "window": {
    "startDate": "2026-09-01",
    "endDate": "2026-09-07"
  },
  "scope": "all",
  "sweptThrough": "2026-09-28T06:00:00.000Z"
}

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

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

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

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

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

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

Affiliate summary

Returns the shop’s affiliate totals over a date window: gmvGross, commission (commissionBase, commissionEstimated, commissionActual), orders, skuOrders, itemsSold, distinct creators and fullyReturnedSkuOrders, in currency.

start_date and end_date are YYYY-MM-DD UTC days, both inclusive, so pass today as end_date to include today. scope is all (default, every affiliate order) or growi (only orders on collabs created through Growi). Served from Growi’s synced order data, not a live TikTok call. sweptThrough is the time orders are synced through (null if the shop has never synced), so the most recent hours can lag.

GET

tik_tok_shop

affiliate

summary

Affiliate summary

curl --request GET \
  --url https://api.growi.io/api/public/v1/tik_tok_shop/affiliate/summary \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/affiliate/summary"

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/affiliate/summary', 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/affiliate/summary",
  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/affiliate/summary"

	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/affiliate/summary")

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

{
  "gmvGross": 15234.5,
  "commissionBase": 14890.1,
  "commissionEstimated": 1823.44,
  "commissionActual": 1210.02,
  "orders": 412,
  "skuOrders": 431,
  "itemsSold": 468,
  "creators": 57,
  "fullyReturnedSkuOrders": 9,
  "currency": "USD",
  "window": {
    "startDate": "2026-09-01",
    "endDate": "2026-09-07"
  },
  "scope": "all",
  "sweptThrough": "2026-09-28T06:00:00.000Z"
}

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

Query Parameters

start_date

string

required

Window start, YYYY-MM-DD INCLUSIVE (local-aggregates convention).

end_date

string

required

Window end, YYYY-MM-DD, inclusive.

scope

enum<string>

default:all

all = every affiliate order in the window; growi = only orders on target collabs created through Growi.

Available options:

all,

growi

organization_id

integer

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

Response

Summary totals plus window {startDate, endDate}, scope, and sweptThrough (ISO timestamp orders are swept through, null when this shop has never swept).

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Affiliate summary

Authorizations

Query Parameters

Response