Unsettled transactions

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

import requests

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

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

	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/unsettled")

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

{
  "totalCount": 31,
  "currency": "USD",
  "sumEstSettlementAmount": 540.2,
  "sumEstRevenueAmount": 702.5,
  "sumEstAdjustmentAmount": 0,
  "sumEstFeeAmount": -162.3,
  "transactions": [
    {
      "id": "7442000000000000001",
      "type": "ORDER",
      "status": "UNSETTLED",
      "currency": "USD",
      "estimatedSettlement": "1759363200",
      "unsettledReason": null,
      "orderId": "576000000000000002",
      "orderCreateTime": 1758650000,
      "orderDeliveryTime": 1758900000,
      "adjustmentId": null,
      "adjustmentOrderId": null,
      "estAdjustmentAmount": null,
      "estSettlementAmount": 17.49,
      "estRevenueAmount": 24.99,
      "revenueBreakdown": {
        "subtotalBeforeDiscountAmount": 24.99
      },
      "estShippingCostAmount": 0,
      "shippingCostBreakdown": {},
      "estFeeTaxAmount": -7.5,
      "feeTaxBreakdown": {
        "fee": {
          "affiliateCommissionAmount": -3.75,
          "referralFeeAmount": -2,
          "transactionFeeAmount": -1.75
        },
        "tax": {}
      }
    }
  ],
  "nextPageToken": "b2Zmc2V0PTIw"
}

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

Unsettled transactions

Lists orders and adjustments that TikTok hasn’t settled yet, created on or after 2025-01-01. Every amount is TikTok’s estimate and can change before settlement. Final numbers only come from the statement endpoints.

The response has totalCount, the sums sumEstSettlementAmount, sumEstRevenueAmount, sumEstAdjustmentAmount and sumEstFeeAmount, and currency (set only when every row on the page shares one). Each row has type, orderId, orderCreateTime, orderDeliveryTime, unsettledReason, the est* amounts with breakdown maps, and estimatedSettlement: a text rule such as days after delivery before the order is delivered, then a Unix-seconds string. Filter on order create time with search_time_ge (inclusive) and search_time_lt (exclusive), in Unix seconds. Newest first by default. page_size is 1 to 100; pass nextPageToken back as page_token. Read live from TikTok.

GET

tik_tok_shop

finance

unsettled

Unsettled transactions

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

import requests

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

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

	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/unsettled")

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

{
  "totalCount": 31,
  "currency": "USD",
  "sumEstSettlementAmount": 540.2,
  "sumEstRevenueAmount": 702.5,
  "sumEstAdjustmentAmount": 0,
  "sumEstFeeAmount": -162.3,
  "transactions": [
    {
      "id": "7442000000000000001",
      "type": "ORDER",
      "status": "UNSETTLED",
      "currency": "USD",
      "estimatedSettlement": "1759363200",
      "unsettledReason": null,
      "orderId": "576000000000000002",
      "orderCreateTime": 1758650000,
      "orderDeliveryTime": 1758900000,
      "adjustmentId": null,
      "adjustmentOrderId": null,
      "estAdjustmentAmount": null,
      "estSettlementAmount": 17.49,
      "estRevenueAmount": 24.99,
      "revenueBreakdown": {
        "subtotalBeforeDiscountAmount": 24.99
      },
      "estShippingCostAmount": 0,
      "shippingCostBreakdown": {},
      "estFeeTaxAmount": -7.5,
      "feeTaxBreakdown": {
        "fee": {
          "affiliateCommissionAmount": -3.75,
          "referralFeeAmount": -2,
          "transactionFeeAmount": -1.75
        },
        "tax": {}
      }
    }
  ],
  "nextPageToken": "b2Zmc2V0PTIw"
}

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

search_time_ge

integer

Unix seconds, inclusive lower bound on order create time.

Required range: 1 <= x <= 9999999999

search_time_lt

integer

Unix seconds, exclusive upper bound. Must be after search_time_ge.

Required range: 1 <= x <= 9999999999

sort_order

enum<string>

default:DESC

DESC (newest first) unless set. TikTok's own default is ASC.

Available options:

ASC,

DESC

page_size

integer

Rows per page, 1 to 100. TikTok's default is 20.

Required range: 1 <= x <= 100

page_token

string

The nextPageToken from the previous page. Omit on the first page.

organization_id

integer

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

Response

{ totalCount, currency, sumEstSettlementAmount, sumEstRevenueAmount, sumEstAdjustmentAmount, sumEstFeeAmount, transactions: [...], nextPageToken }

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Unsettled transactions

Authorizations

Query Parameters

Response