TikTok Shop

Settled revenue, fees, shipping and settlement for one order, per SKU

GET/api/public/v1/tik_tok_shop/finance/orders/{orderId}/transactions
ConnectorAnswers empty results in the documented shape until the brand switches on this connection.

Operation id getTikTokShopOrderSettlement

Request

curl

curl "https://creator.growthdept.ai/api/public/v1/tik_tok_shop/finance/orders/<orderId>/transactions" \
  -H "Authorization: Bearer gdc_..."

Parameters

NameInTypeNotes
orderIdpathstringrequired
organization_idqueryinteger

Responses

200Success

FieldTypeNotes
currencystring, nullable
feeAndTaxAmountnumber, nullable
orderCreateTimenumber, nullable
orderIdstring, nullable
revenueAmountnumber, nullable
settlementAmountnumber, nullable
shippingCostAmountnumber, nullable
skuTransactionsarray of object, nullable
skuTransactions[].[].feeTaxAmountnumber, nullable
skuTransactions[].[].feeTaxBreakdownobject, nullable
skuTransactions[].[].feeTaxBreakdown.feeobject, nullable
skuTransactions[].[].feeTaxBreakdown.fee.affiliateCommissionAmountnumber, nullable
skuTransactions[].[].feeTaxBreakdown.fee.referralFeeAmountnumber, nullable
skuTransactions[].[].feeTaxBreakdown.fee.transactionFeeAmountnumber, nullable
skuTransactions[].[].feeTaxBreakdown.taxobject, nullable
skuTransactions[].[].productNamestring, nullable
skuTransactions[].[].quantitynumber, nullable
skuTransactions[].[].revenueAmountnumber, nullable
skuTransactions[].[].revenueBreakdownobject, nullable
skuTransactions[].[].revenueBreakdown.sellerDiscountAmountnumber, nullable
skuTransactions[].[].revenueBreakdown.subtotalBeforeDiscountAmountnumber, nullable
skuTransactions[].[].settlementAmountnumber, nullable
skuTransactions[].[].shippingCostAmountnumber, nullable
skuTransactions[].[].shippingCostBreakdownobject, nullable
skuTransactions[].[].shippingCostBreakdown.actualShippingFeeAmountnumber, nullable
skuTransactions[].[].skuIdstring, nullable
skuTransactions[].[].skuNamestring, nullable
skuTransactions[].[].statementIdstring, nullable
totalCountnumber, nullable

Example

{
  "currency": "usd",
  "feeAndTaxAmount": 125.5,
  "orderCreateTime": 125.5,
  "orderId": "string",
  "revenueAmount": 125.5,
  "settlementAmount": 125.5,
  "shippingCostAmount": 125.5,
  "skuTransactions": [
    {
      "feeTaxAmount": 125.5,
      "feeTaxBreakdown": {
        "fee": {
          "affiliateCommissionAmount": 125.5,
          "referralFeeAmount": 125.5,
          "transactionFeeAmount": 125.5
        },
        "tax": {}
      },
      "productName": "Example name",
      "quantity": 125.5,
      "revenueAmount": 125.5,
      "revenueBreakdown": {
        "sellerDiscountAmount": 125.5,
        "subtotalBeforeDiscountAmount": 125.5
      },
      "settlementAmount": 125.5,
      "shippingCostAmount": 125.5,
      "shippingCostBreakdown": {
        "actualShippingFeeAmount": 125.5
      },
      "skuId": "string",
      "skuName": "Example name",
      "statementId": "string"
    }
  ],
  "totalCount": 125.5
}

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

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