Profit and loss

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/finance/pnl"

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/finance/pnl', 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/finance/pnl",
  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/finance/pnl"

	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/finance/pnl")

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

{
  "window": {
    "startDate": "2026-09-01",
    "endDate": "2026-09-01"
  },
  "basis": "statement_activity_day_utc",
  "groupBy": "total",
  "currency": "USD",
  "groups": [
    {
      "key": "total",
      "revenue": "120.00",
      "revenueBreakdown": {
        "subtotalBeforeDiscountAmount": "130.00",
        "sellerDiscountAmount": "-10.00"
      },
      "refunds": {
        "refundSubtotalBeforeDiscountAmount": "0",
        "sellerDiscountRefundAmount": "0"
      },
      "shipping": "-6.00",
      "shippingBreakdown": {
        "actualShippingFeeAmount": "-6.00"
      },
      "feesAndTaxes": "-9.70",
      "fees": {
        "platformCommissionAmount": "-3.20",
        "affiliateCommissionAmount": "-4.00",
        "referralFeeAmount": "-2.40"
      },
      "taxes": {
        "salesTaxReferralFeeAmount": "-0.10"
      },
      "platformCommission": "-3.20",
      "affiliateCommission": "-4.00",
      "adjustments": "0",
      "adjustmentsByType": {},
      "reserve": "0",
      "settlement": "104.30",
      "rows": {
        "orders": 1,
        "adjustments": 0,
        "reserves": 0,
        "skus": 0
      },
      "units": "2",
      "cogs": {
        "amount": "25.00",
        "units": "2",
        "unitsCosted": "2",
        "complete": true
      },
      "grossProfit": "79.30"
    }
  ],
  "unallocated": null,
  "statements": {
    "listed": 1,
    "fullyRead": 1,
    "headerTotals": {
      "settlementAmount": "104.30",
      "revenueAmount": "120.00",
      "feeAmount": "-9.70",
      "shippingCostAmount": "-6.00",
      "adjustmentAmount": "0",
      "netSalesAmount": "120.00"
    }
  },
  "coverage": {
    "statementPages": 1,
    "transactionPages": 1,
    "transactionRows": 1,
    "statementsFailed": 0,
    "ordersNeeded": 1,
    "ordersRead": 1,
    "ordersFailed": 0
  },
  "truncated": false,
  "truncatedReasons": [],
  "skusWithoutCogs": []
}

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

Profit and loss

Returns a profit and loss for a date window, built live from TikTok’s settlement statements. Each line (groups[] and totals) has revenue, refunds, shipping, feesAndTaxes with fees and taxes maps, platformCommission, affiliateCommission, adjustments, adjustmentsByType, reserve and settlement, plus row counts. Amounts are exact decimal strings in currency, summed with TikTok’s own signs, so fees are negative. Reserves are kept out of settlement.

start_date and end_date are activity days, YYYY-MM-DD, UTC, both inclusive, at most 365 days apart. TikTok cuts one statement a day at 00:00 UTC covering the day before, so each activity day maps to the statement stamped the next day. group_by is total (default), day or sku. With sku, adjustments, reserves and orders that couldn’t be read go to unallocated. A window whose statements are in more than one currency is rejected.

Large windows can be cut short. When truncated is true, truncatedReasons and coverage say what was left out, and statements.headerTotals still sums the header of every listed statement. Narrow the window to get full coverage.

GET

tik_tok_shop

finance

pnl

Profit and loss

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/finance/pnl"

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/finance/pnl', 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/finance/pnl",
  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/finance/pnl"

	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/finance/pnl")

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

{
  "window": {
    "startDate": "2026-09-01",
    "endDate": "2026-09-01"
  },
  "basis": "statement_activity_day_utc",
  "groupBy": "total",
  "currency": "USD",
  "groups": [
    {
      "key": "total",
      "revenue": "120.00",
      "revenueBreakdown": {
        "subtotalBeforeDiscountAmount": "130.00",
        "sellerDiscountAmount": "-10.00"
      },
      "refunds": {
        "refundSubtotalBeforeDiscountAmount": "0",
        "sellerDiscountRefundAmount": "0"
      },
      "shipping": "-6.00",
      "shippingBreakdown": {
        "actualShippingFeeAmount": "-6.00"
      },
      "feesAndTaxes": "-9.70",
      "fees": {
        "platformCommissionAmount": "-3.20",
        "affiliateCommissionAmount": "-4.00",
        "referralFeeAmount": "-2.40"
      },
      "taxes": {
        "salesTaxReferralFeeAmount": "-0.10"
      },
      "platformCommission": "-3.20",
      "affiliateCommission": "-4.00",
      "adjustments": "0",
      "adjustmentsByType": {},
      "reserve": "0",
      "settlement": "104.30",
      "rows": {
        "orders": 1,
        "adjustments": 0,
        "reserves": 0,
        "skus": 0
      },
      "units": "2",
      "cogs": {
        "amount": "25.00",
        "units": "2",
        "unitsCosted": "2",
        "complete": true
      },
      "grossProfit": "79.30"
    }
  ],
  "unallocated": null,
  "statements": {
    "listed": 1,
    "fullyRead": 1,
    "headerTotals": {
      "settlementAmount": "104.30",
      "revenueAmount": "120.00",
      "feeAmount": "-9.70",
      "shippingCostAmount": "-6.00",
      "adjustmentAmount": "0",
      "netSalesAmount": "120.00"
    }
  },
  "coverage": {
    "statementPages": 1,
    "transactionPages": 1,
    "transactionRows": 1,
    "statementsFailed": 0,
    "ordersNeeded": 1,
    "ordersRead": 1,
    "ordersFailed": 0
  },
  "truncated": false,
  "truncatedReasons": [],
  "skusWithoutCogs": []
}

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

Query Parameters

start_date

string<date>

required

First activity day, YYYY-MM-DD, UTC, inclusive.

end_date

string<date>

required

Last activity day, YYYY-MM-DD, UTC, inclusive. At most 365 days after start_date.

group_by

enum<string>

default:total

total, day (activity day: statement UTC date minus one) or sku.

Available options:

total,

day,

sku

organization_id

integer

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

Response

{ window, basis: statement_activity_day_utc, groupBy, currency, groups: [{ key, ...line }], totals: line, unallocated: line | null, statements: { listed, fullyRead, headerTotals }, coverage: { statementPages, transactionPages, transactionRows, statementsFailed, ordersNeeded, ordersRead, ordersFailed }, truncated, truncatedReasons, skusWithoutCogs }. line = { revenue, revenueBreakdown, refunds, shipping, shippingBreakdown, feesAndTaxes, fees, taxes, platformCommission, affiliateCommission, adjustments, adjustmentsByType, reserve, settlement, rows: { orders, adjustments, reserves, skus }, units, cogs, grossProfit }.

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Profit and loss

Authorizations

Query Parameters

Response