TikTok Shop: Most-used fields

The table below gives information about most-used fields that you can import from TikTok Shop. Other fields might also be available in Adverity.

The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs.

API name	Adverity UI name	Description	Use in Adverity
create_time	create_time	The timestamp when a record or entity was created.	dimension
create_time_date	create_time_date	The date when a record or entity was created.	dimension
fee_amount	fee_amount	The total amount of fees associated with a financial transaction or statement.	metric
id	id	A unique identifier for the specific entity, such as an order, payment, or statement.	dimension
payable_amount	payable_amount	The final amount payable to the seller after all deductions, including fees, commissions, shipping costs, and taxes.	metric
payment_id	payment_id	A unique identifier for a payment record, retrieved from payment data.	dimension
payment_status	payment_status	The current status of a payment (e.g., pending, paid, failed).	dimension
settlement_amount	settlement_amount	The amount settled or paid out for the order or transaction after deductions.	metric
statement_time	statement_time	The timestamp when a financial statement was generated or finalized.	dimension
statement_time_date	statement_time_date	The date when a financial statement was generated or finalized.	dimension
status	status	The current status of the order (e.g., UNPAID, PAID, SHIPPED, DELIVERED).	dimension
total_settlement_amount	total_settlement_amount	The total amount settled for an order or a collection of orders within a statement, after all deductions and compensations.	metric
transactions.fee_tax_breakdown.fee.affiliate_ads_commission_amount	transactions.fee_tax_breakdown.fee.affiliate_ads_commission_amount	The commission amount paid to affiliates for sales generated specifically through advertisements they run.	metric
transactions.fee_tax_breakdown.fee.affiliate_commission_amount	transactions.fee_tax_breakdown.fee.affiliate_commission_amount	The commission fee charged to a seller by an Affiliate (TikTok Creator) for successful product sales and promotion services, calculated based on the item price minus seller discounts.	metric
transactions.fee_tax_breakdown.fee.affiliate_commission_amount_before_pit	transactions.fee_tax_breakdown.fee.affiliate_commission_amount_before_pit		metric
transactions.fee_tax_breakdown.fee.affiliate_partner_commission_amount	transactions.fee_tax_breakdown.fee.affiliate_partner_commission_amount	The commission fee paid to an affiliate partner (TikTok Creator) for facilitating sales and promotional activities.	metric
transactions.fee_tax_breakdown.fee.external_affiliate_marketing_fee_amount	transactions.fee_tax_breakdown.fee.external_affiliate_marketing_fee_amount		metric
transactions.id	transactions.id	A unique identifier for a financial transaction.	metric
transactions.order_create_time	transactions.order_create_time	The timestamp indicating when the order was created.	dimension
transactions.order_create_time_date	transactions.order_create_time_date	The date when the order was created, derived from the order creation timestamp.	dimension
transactions.revenue_amount	transactions.revenue_amount	The revenue amount generated from the transaction.	metric
transactions.settlement_amount	transactions.settlement_amount	The amount of funds settled for a specific transaction.	metric
transactions.shipping_cost_amount	transactions.shipping_cost_amount	The cost associated with shipping for the transaction.	metric
transactions.type	transactions.type	The type of the financial transaction or adjustment (e.g., Shipping fee adjustment, Chargeback, Promotion adjustment).	dimension