Settlement reconciliation

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

import requests

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

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

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

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-07"
  },
  "basis": "affiliate_orders.order_create_time_utc",
  "sweptThrough": "2026-09-29T06:00:00.000Z",
  "tolerance": "0.01",
  "currency": "USD",
  "orders": [
    {
      "orderId": "576000000000000001",
      "orderCreateTime": "2026-09-06T10:00:00.000000Z",
      "status": "settled",
      "stored": {
        "skuLines": 1,
        "units": "2",
        "gmv": "60.00",
        "currency": "USD",
        "settlementStatuses": [
          "SETTLED"
        ],
        "fullyReturned": false,
        "estimatedCommission": "4.00",
        "actualCommission": "4.00"
      },
      "settled": {
        "currency": "USD",
        "settlementAmount": "40.00",
        "revenueAmount": "50.00",
        "feeAndTaxAmount": "-6.00",
        "shippingCostAmount": "-4.00",
        "affiliateCommission": "-5.50",
        "statementIds": [
          "7400000000000000001"
        ]
      },
      "unsettled": null,
      "mismatch": {
        "field": "affiliate_commission",
        "against": "actual",
        "settled": "5.50",
        "stored": "4.00",
        "delta": "1.50"
      },
      "error": null
    }
  ],
  "summary": {
    "orders": 1,
    "settled": {
      "count": 1,
      "settlementAmount": "40.00"
    },
    "partiallySettled": 0,
    "unsettled": {
      "count": 0,
      "estSettlementAmount": "0"
    },
    "notFound": 0,
    "unknown": 0,
    "unchecked": 0,
    "errors": 0,
    "mismatches": 1
  },
  "nextCursor": null,
  "truncated": false,
  "truncatedReasons": []
}

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

Settlement reconciliation

Checks orders created in a window against what TikTok actually settled. The orders are the shop’s affiliate orders, the same set as Affiliate order lines, so orders with no creator attribution aren’t included. Each order gets a status: settled, partially_settled (settled rows plus a later unsettled row, such as an adjustment), unsettled, not_found, unknown, unchecked or error.

Per order you get stored (Growi’s synced view: SKU lines, units, gmv, settlement statuses, estimated and actual commission), settled (TikTok’s settlementAmount, revenueAmount, feeAndTaxAmount, shippingCostAmount, affiliateCommission and statementIds) and unsettled (TikTok’s estimates). For settled orders, mismatch compares the affiliate commission TikTok deducted at settlement with the commission reported on the affiliate order; against says whether that was the actual or estimated figure, and delta (settled minus stored) is flagged when it exceeds tolerance (default 0.01). summary counts the page by status. Amounts are exact decimal strings.

start_date and end_date are order-create days, YYYY-MM-DD, UTC, inclusive, at most 365 days apart. Orders are newest first. limit is up to 50 (default 25), and each order costs one TikTok call. Pass nextCursor back as cursor with the same window. sweptThrough shows how fresh the stored side is. When time runs out, truncated is true and some orders come back unchecked or unknown.

GET

tik_tok_shop

finance

reconciliation

Settlement reconciliation

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

import requests

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

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

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

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-07"
  },
  "basis": "affiliate_orders.order_create_time_utc",
  "sweptThrough": "2026-09-29T06:00:00.000Z",
  "tolerance": "0.01",
  "currency": "USD",
  "orders": [
    {
      "orderId": "576000000000000001",
      "orderCreateTime": "2026-09-06T10:00:00.000000Z",
      "status": "settled",
      "stored": {
        "skuLines": 1,
        "units": "2",
        "gmv": "60.00",
        "currency": "USD",
        "settlementStatuses": [
          "SETTLED"
        ],
        "fullyReturned": false,
        "estimatedCommission": "4.00",
        "actualCommission": "4.00"
      },
      "settled": {
        "currency": "USD",
        "settlementAmount": "40.00",
        "revenueAmount": "50.00",
        "feeAndTaxAmount": "-6.00",
        "shippingCostAmount": "-4.00",
        "affiliateCommission": "-5.50",
        "statementIds": [
          "7400000000000000001"
        ]
      },
      "unsettled": null,
      "mismatch": {
        "field": "affiliate_commission",
        "against": "actual",
        "settled": "5.50",
        "stored": "4.00",
        "delta": "1.50"
      },
      "error": null
    }
  ],
  "summary": {
    "orders": 1,
    "settled": {
      "count": 1,
      "settlementAmount": "40.00"
    },
    "partiallySettled": 0,
    "unsettled": {
      "count": 0,
      "estSettlementAmount": "0"
    },
    "notFound": 0,
    "unknown": 0,
    "unchecked": 0,
    "errors": 0,
    "mismatches": 1
  },
  "nextCursor": null,
  "truncated": false,
  "truncatedReasons": []
}

{
  "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 order-create day, YYYY-MM-DD, UTC, inclusive.

end_date

string<date>

required

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

limit

integer

default:25

Orders per page. Each order costs one TikTok call.

Required range: 1 <= x <= 50

cursor

string

nextCursor from the previous page, same window.

tolerance

string

default:0.01

Absolute commission difference allowed before a settled order is a mismatch.

Pattern: ^\d{1,9}(\.\d{1,6})?$

organization_id

integer

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

Response

{ window, basis: affiliate_orders.order_create_time_utc, sweptThrough, tolerance, currency, orders: [{ orderId, orderCreateTime, status, stored, settled, unsettled, mismatch, error }], summary: { orders, settled: { count, settlementAmount }, partiallySettled, unsettled: { count, estSettlementAmount }, notFound, unknown, unchecked, errors, mismatches }, nextCursor, truncated, truncatedReasons }

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Settlement reconciliation

Authorizations

Query Parameters

Response