Order settlement

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/finance/orders/{orderId}/transactions"

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/orders/{orderId}/transactions', 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/orders/{orderId}/transactions",
  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/orders/{orderId}/transactions"

	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/orders/{orderId}/transactions")

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

{
  "orderId": "576000000000000001",
  "orderCreateTime": 1757096530,
  "currency": "USD",
  "revenueAmount": 24.99,
  "feeAndTaxAmount": -7.5,
  "shippingCostAmount": 0,
  "settlementAmount": 17.49,
  "totalCount": 1,
  "skuTransactions": [
    {
      "skuId": "1729000000000000101",
      "skuName": "30ml",
      "productName": "Example Serum",
      "statementId": "7440000000000000001",
      "quantity": 1,
      "settlementAmount": 17.49,
      "revenueAmount": 24.99,
      "revenueBreakdown": {
        "subtotalBeforeDiscountAmount": 24.99,
        "sellerDiscountAmount": 0
      },
      "shippingCostAmount": 0,
      "shippingCostBreakdown": {
        "actualShippingFeeAmount": 0
      },
      "feeTaxAmount": -7.5,
      "feeTaxBreakdown": {
        "fee": {
          "affiliateCommissionAmount": -3.75,
          "referralFeeAmount": -2,
          "transactionFeeAmount": -1.75
        },
        "tax": {}
      }
    }
  ]
}

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

Order settlement

Returns the settled revenue, fees, shipping and settlement for one order, split per SKU. Order-level fields are revenueAmount (net sales), feeAndTaxAmount, shippingCostAmount, settlementAmount and currency. Each skuTransactions row adds skuId, skuName, productName, quantity, statementId (the payout it landed in) and breakdown maps.

Affiliate commission is feeTaxBreakdown.fee.affiliateCommissionAmount, plus affiliatePartnerCommissionAmount, affiliateAdsCommissionAmount and cofundedCreatorBonusAmount when present. An order that hasn’t settled yet has no rows here; use Unsettled transactions for estimates. Read live from TikTok.

GET

tik_tok_shop

finance

orders

{orderId}

transactions

Order settlement

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

import requests

url = "https://api.growi.io/api/public/v1/tik_tok_shop/finance/orders/{orderId}/transactions"

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/orders/{orderId}/transactions', 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/orders/{orderId}/transactions",
  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/orders/{orderId}/transactions"

	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/orders/{orderId}/transactions")

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

{
  "orderId": "576000000000000001",
  "orderCreateTime": 1757096530,
  "currency": "USD",
  "revenueAmount": 24.99,
  "feeAndTaxAmount": -7.5,
  "shippingCostAmount": 0,
  "settlementAmount": 17.49,
  "totalCount": 1,
  "skuTransactions": [
    {
      "skuId": "1729000000000000101",
      "skuName": "30ml",
      "productName": "Example Serum",
      "statementId": "7440000000000000001",
      "quantity": 1,
      "settlementAmount": 17.49,
      "revenueAmount": 24.99,
      "revenueBreakdown": {
        "subtotalBeforeDiscountAmount": 24.99,
        "sellerDiscountAmount": 0
      },
      "shippingCostAmount": 0,
      "shippingCostBreakdown": {
        "actualShippingFeeAmount": 0
      },
      "feeTaxAmount": -7.5,
      "feeTaxBreakdown": {
        "fee": {
          "affiliateCommissionAmount": -3.75,
          "referralFeeAmount": -2,
          "transactionFeeAmount": -1.75
        },
        "tax": {}
      }
    }
  ]
}

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

orderId

string

required

The TikTok order id.

Pattern: ^\d{1,32}$

Query Parameters

organization_id

integer

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

Response

{ orderId, orderCreateTime, currency, revenueAmount, feeAndTaxAmount, shippingCostAmount, settlementAmount, totalCount, skuTransactions: [...] }

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Order settlement

Authorizations

Path Parameters

Query Parameters

Response