TikTok Shop

Orders and adjustments TikTok has not settled yet

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

Operation id listTikTokShopUnsettled

Request

curl

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

Parameters

NameInTypeNotes
search_time_gequeryinteger
search_time_ltqueryinteger
sort_orderquerystringOne of ASCDESC Default DESC
page_sizequeryinteger
page_tokenquerystring
organization_idqueryinteger

Responses

200Success

FieldTypeNotes
currencystring, nullable
nextPageTokenstring, nullable
sumEstAdjustmentAmountnumber, nullable
sumEstFeeAmountnumber, nullable
sumEstRevenueAmountnumber, nullable
sumEstSettlementAmountnumber, nullable
totalCountnumber, nullable
transactionsarray of object, nullable
transactions[].[].adjustmentId, nullable
transactions[].[].adjustmentOrderId, nullable
transactions[].[].currencystring, nullable
transactions[].[].estAdjustmentAmount, nullable
transactions[].[].estFeeTaxAmountnumber, nullable
transactions[].[].estRevenueAmountnumber, nullable
transactions[].[].estSettlementAmountnumber, nullable
transactions[].[].estShippingCostAmountnumber, nullable
transactions[].[].estimatedSettlementstring, nullable
transactions[].[].feeTaxBreakdownobject, nullable
transactions[].[].feeTaxBreakdown.feeobject, nullable
transactions[].[].feeTaxBreakdown.fee.affiliateCommissionAmountnumber, nullable
transactions[].[].feeTaxBreakdown.fee.referralFeeAmountnumber, nullable
transactions[].[].feeTaxBreakdown.fee.transactionFeeAmountnumber, nullable
transactions[].[].feeTaxBreakdown.taxobject, nullable
transactions[].[].idstring, nullable
transactions[].[].orderCreateTimenumber, nullable
transactions[].[].orderDeliveryTimenumber, nullable
transactions[].[].orderIdstring, nullable
transactions[].[].revenueBreakdownobject, nullable
transactions[].[].revenueBreakdown.subtotalBeforeDiscountAmountnumber, nullable
transactions[].[].shippingCostBreakdownobject, nullable
transactions[].[].statusstring, nullable
transactions[].[].typestring, nullable
transactions[].[].unsettledReason, nullable

Example

{
  "currency": "usd",
  "nextPageToken": "string",
  "sumEstAdjustmentAmount": 125.5,
  "sumEstFeeAmount": 125.5,
  "sumEstRevenueAmount": 125.5,
  "sumEstSettlementAmount": 125.5,
  "totalCount": 125.5,
  "transactions": [
    {
      "adjustmentId": "string",
      "adjustmentOrderId": "string",
      "currency": "usd",
      "estAdjustmentAmount": "string",
      "estFeeTaxAmount": 125.5,
      "estRevenueAmount": 125.5,
      "estSettlementAmount": 125.5,
      "estShippingCostAmount": 125.5,
      "estimatedSettlement": "string",
      "feeTaxBreakdown": {
        "fee": {
          "affiliateCommissionAmount": 125.5,
          "referralFeeAmount": 125.5,
          "transactionFeeAmount": 125.5
        },
        "tax": {}
      },
      "id": "string",
      "orderCreateTime": 125.5,
      "orderDeliveryTime": 125.5,
      "orderId": "string",
      "revenueBreakdown": {
        "subtotalBeforeDiscountAmount": 125.5
      },
      "shippingCostBreakdown": {},
      "status": "string",
      "type": "string",
      "unsettledReason": "string"
    }
  ]
}

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

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