Affiliate order lines

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

import requests

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

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

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

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"
  },
  "sweptThrough": "2026-09-28T06:00:00.000Z",
  "lines": [
    {
      "orderId": "576000000000000001",
      "skuId": "1729000000000000101",
      "orderCreateTime": "2026-09-05T18:22:10.000Z",
      "deliveryTime": "2026-09-09T20:01:00.000Z",
      "productId": "1729000000000000100",
      "productTitle": "Example Serum 30ml",
      "quantity": 1,
      "priceAmount": 24.99,
      "gmvGross": 24.99,
      "currency": "USD",
      "creatorUsername": "creator_one",
      "targetCollaborationId": "7494000000000000001",
      "openCollaborationId": null,
      "campaignId": null,
      "contentType": "VIDEO",
      "contentId": "7550000000000000001",
      "content": {
        "url": "https://cdn.example.com/v/7550000000000000001.mp4",
        "postedAt": "2026-09-03T15:00:00.000Z",
        "viewCount": 18234,
        "format": "VIDEO"
      },
      "settlementStatus": "SETTLED",
      "settlementFinal": true,
      "fullyReturn": false,
      "refund": false,
      "estimatedPaidCommission": 3.75,
      "actualPaidCommission": 3.75,
      "commissionDelta": 0,
      "commissionRate": 0.15,
      "partnerCommissionRate": null,
      "shopAdsCommissionRate": null,
      "commissionModel": null,
      "commissionTierSetting": null,
      "commissionBase": {
        "estimated": 24.99,
        "actual": 24.99
      },
      "paidPartnerCommission": {
        "estimated": null,
        "actual": null
      },
      "paidShopAdsCommission": {
        "estimated": null,
        "actual": null
      },
      "cofundedCreatorBonus": {
        "estimated": null,
        "actual": null
      }
    }
  ],
  "nextCursor": "WyIyMDI2LTA5LTA1VDE4OjIyOjEwLjAwMFoiLCJleGFtcGxlIiwiY3Vyc29yIl0",
  "counts": {
    "lines": 431,
    "refundLines": 12,
    "fullyReturned": 9,
    "ineligible": 5
  },
  "countsStatus": "ok",
  "settlementNote": "settlementStatus and the actual* amounts change in place until a line settles, which lands roughly 15 to 20 days after delivery. settlementFinal marks lines that have stopped moving. commissionDelta is actual minus estimated and stays null until TikTok reports an actual. Rates are fractions: 0.1 is 10%."
}

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

Lists affiliate order lines, one per order and SKU, newest first by order create time. Each line carries the attributed creatorUsername, collab and campaign ids, contentId and the content it points at (URL, post time, views, format; null when unknown), productTitle, quantity, gmvGross, settlementStatus and commission: estimatedPaidCommission, actualPaidCommission and commissionDelta (actual minus estimated, null until TikTok reports an actual), plus base, partner, shop ads and co-funded bonus pairs. Rates are fractions (0.155 = 15.5%).

Settlement status and actual amounts change until a line settles, roughly 15 to 20 days after delivery. settlementFinal is true once a line stops changing. refunds is include (default), only or exclude; a refund line is fully returned or INELIGIBLE. Filter with creator_username or target_collaboration_id.

start_date and end_date are YYYY-MM-DD UTC days, inclusive, at most 365 days apart. limit is up to 500 (default 100); pass nextCursor back as cursor with the same filters. The first page also returns counts for the whole window. Narrow a wide window if the call times out.

GET

tik_tok_shop

affiliate

order_lines

Affiliate order lines

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

import requests

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

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

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

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"
  },
  "sweptThrough": "2026-09-28T06:00:00.000Z",
  "lines": [
    {
      "orderId": "576000000000000001",
      "skuId": "1729000000000000101",
      "orderCreateTime": "2026-09-05T18:22:10.000Z",
      "deliveryTime": "2026-09-09T20:01:00.000Z",
      "productId": "1729000000000000100",
      "productTitle": "Example Serum 30ml",
      "quantity": 1,
      "priceAmount": 24.99,
      "gmvGross": 24.99,
      "currency": "USD",
      "creatorUsername": "creator_one",
      "targetCollaborationId": "7494000000000000001",
      "openCollaborationId": null,
      "campaignId": null,
      "contentType": "VIDEO",
      "contentId": "7550000000000000001",
      "content": {
        "url": "https://cdn.example.com/v/7550000000000000001.mp4",
        "postedAt": "2026-09-03T15:00:00.000Z",
        "viewCount": 18234,
        "format": "VIDEO"
      },
      "settlementStatus": "SETTLED",
      "settlementFinal": true,
      "fullyReturn": false,
      "refund": false,
      "estimatedPaidCommission": 3.75,
      "actualPaidCommission": 3.75,
      "commissionDelta": 0,
      "commissionRate": 0.15,
      "partnerCommissionRate": null,
      "shopAdsCommissionRate": null,
      "commissionModel": null,
      "commissionTierSetting": null,
      "commissionBase": {
        "estimated": 24.99,
        "actual": 24.99
      },
      "paidPartnerCommission": {
        "estimated": null,
        "actual": null
      },
      "paidShopAdsCommission": {
        "estimated": null,
        "actual": null
      },
      "cofundedCreatorBonus": {
        "estimated": null,
        "actual": null
      }
    }
  ],
  "nextCursor": "WyIyMDI2LTA5LTA1VDE4OjIyOjEwLjAwMFoiLCJleGFtcGxlIiwiY3Vyc29yIl0",
  "counts": {
    "lines": 431,
    "refundLines": 12,
    "fullyReturned": 9,
    "ineligible": 5
  },
  "countsStatus": "ok",
  "settlementNote": "settlementStatus and the actual* amounts change in place until a line settles, which lands roughly 15 to 20 days after delivery. settlementFinal marks lines that have stopped moving. commissionDelta is actual minus estimated and stays null until TikTok reports an actual. Rates are fractions: 0.1 is 10%."
}

{
  "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, UTC day of the order create time.

end_date

string

required

Window end, YYYY-MM-DD INCLUSIVE. At most 365 days after start_date, same cap as the other affiliate reads.

creator_username

string

Only lines attributed to this creator username (exact match, as TikTok sent it on the order).

target_collaboration_id

string

Only lines on this target collaboration.

refunds

enum<string>

default:include

include = every line; only = refund lines (fully_return or INELIGIBLE); exclude = everything else. Note the aggregate affiliate reads drop INELIGIBLE lines, this one keeps them by default. refunds=only has no index behind it: on a shop with few refunds it walks the window to fill a page (the last page always walks to the window start), so it can be slow on a wide window and may need a narrower one.

Available options:

include,

only,

exclude

limit

integer

default:100

Lines per page (default 100, max 500).

Required range: 1 <= x <= 500

cursor

string

nextCursor from the previous page, passed back verbatim with the same filters.

organization_id

integer

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

Response

{ window, sweptThrough, lines: [...], nextCursor (null on the last page), counts: { lines, refundLines, fullyReturned, ineligible } | null, countsStatus, settlementNote }.

Overview

Conversions

Tracking events

Campaign affiliates

Organization

Applications

Stats

TikTok Shop

Affiliate order lines

Authorizations

Query Parameters

Response