Settled revenue, fees, shipping and settlement for one order, per SKU
GET
/api/public/v1/tik_tok_shop/finance/orders/{orderId}/transactionsConnectorAnswers 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
| Name | In | Type | Notes |
|---|---|---|---|
| orderId | path | string | required |
| organization_id | query | integer |
Responses
200Success
| Field | Type | Notes |
|---|---|---|
| currency | string, nullable | |
| feeAndTaxAmount | number, nullable | |
| orderCreateTime | number, nullable | |
| orderId | string, nullable | |
| revenueAmount | number, nullable | |
| settlementAmount | number, nullable | |
| shippingCostAmount | number, nullable | |
| skuTransactions | array of object, nullable | |
| skuTransactions[].[].feeTaxAmount | number, nullable | |
| skuTransactions[].[].feeTaxBreakdown | object, nullable | |
| skuTransactions[].[].feeTaxBreakdown.fee | object, nullable | |
| skuTransactions[].[].feeTaxBreakdown.fee.affiliateCommissionAmount | number, nullable | |
| skuTransactions[].[].feeTaxBreakdown.fee.referralFeeAmount | number, nullable | |
| skuTransactions[].[].feeTaxBreakdown.fee.transactionFeeAmount | number, nullable | |
| skuTransactions[].[].feeTaxBreakdown.tax | object, nullable | |
| skuTransactions[].[].productName | string, nullable | |
| skuTransactions[].[].quantity | number, nullable | |
| skuTransactions[].[].revenueAmount | number, nullable | |
| skuTransactions[].[].revenueBreakdown | object, nullable | |
| skuTransactions[].[].revenueBreakdown.sellerDiscountAmount | number, nullable | |
| skuTransactions[].[].revenueBreakdown.subtotalBeforeDiscountAmount | number, nullable | |
| skuTransactions[].[].settlementAmount | number, nullable | |
| skuTransactions[].[].shippingCostAmount | number, nullable | |
| skuTransactions[].[].shippingCostBreakdown | object, nullable | |
| skuTransactions[].[].shippingCostBreakdown.actualShippingFeeAmount | number, nullable | |
| skuTransactions[].[].skuId | string, nullable | |
| skuTransactions[].[].skuName | string, nullable | |
| skuTransactions[].[].statementId | string, nullable | |
| totalCount | number, 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.