TikTok Shop

The shop's daily settlement statements

GET/api/public/v1/tik_tok_shop/finance/statements
ConnectorAnswers empty results in the documented shape until the brand switches on this connection.

Operation id listTikTokShopStatements

Request

curl

curl "https://creator.growthdept.ai/api/public/v1/tik_tok_shop/finance/statements" \
  -H "Authorization: Bearer gdc_..."

Parameters

NameInTypeNotes
statement_time_gequeryinteger
statement_time_ltqueryinteger
payment_statusquerystringOne of PAIDFAILEDPROCESSING
sort_orderquerystringOne of ASCDESC Default DESC
page_sizequeryinteger
page_tokenquerystring
organization_idqueryinteger

Responses

200Success

FieldTypeNotes
nextPageTokenstring, nullable
statementsarray of object, nullable
statements[].[].adjustmentAmountnumber, nullable
statements[].[].currencystring, nullable
statements[].[].feeAmountnumber, nullable
statements[].[].idstring, nullable
statements[].[].netSalesAmountnumber, nullable
statements[].[].paymentIdstring, nullable
statements[].[].paymentStatusstring, nullable
statements[].[].paymentTimenumber, nullable
statements[].[].revenueAmountnumber, nullable
statements[].[].settlementAmountnumber, nullable
statements[].[].shippingCostAmountnumber, nullable
statements[].[].statementTimenumber, nullable

Example

{
  "nextPageToken": "string",
  "statements": [
    {
      "adjustmentAmount": 125.5,
      "currency": "usd",
      "feeAmount": 125.5,
      "id": "string",
      "netSalesAmount": 125.5,
      "paymentId": "string",
      "paymentStatus": "string",
      "paymentTime": 125.5,
      "revenueAmount": 125.5,
      "settlementAmount": 125.5,
      "shippingCostAmount": 125.5,
      "statementTime": 125.5
    }
  ]
}

Errors: 400401403404422429502with an error and usually a message. See errors.

Example values are made up from each field's type and name.