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 was created.	dimension
create_time_date	create_time_date	The date when a record was created.	dimension
currency	currency	The currency code used for all monetary values related to the order or transaction.	dimension
id	id	A unique identifier for a record.	metric
order_create_time	order_create_time	The timestamp when the order was initially created.	dimension
order_create_time_date	order_create_time_date	The date when the order was initially created.	dimension
order_id	order_id	The unique identifier for the order.	dimension
payable_amount	payable_amount	The amount payable to the seller after deducting fees and taxes but before any adjustments, representing the funds due for a transaction or statement.	metric
revenue_amount	revenue_amount	The total revenue generated from the order or transaction.	metric
settlement_amount	settlement_amount	The amount settled or paid out for the order or transaction after deductions.	metric
sku_transactions.product_name	sku_transactions.product_name	The name of the product associated with the SKU in the transaction.	dimension
sku_transactions.revenue_breakdown.refund_subtotal_before_discount_amount	sku_transactions.revenue_breakdown.refund_subtotal_before_discount_amount	The refunded subtotal amount of the SKU before any discounts were applied.	metric
sku_transactions.sku_id	sku_transactions.sku_id	The unique identifier for the Stock Keeping Unit (SKU) involved in the transaction.	dimension
sku_transactions.sku_name	sku_transactions.sku_name	The name or description of the Stock Keeping Unit (SKU) in the transaction.	dimension
sku_transactions.statement_id	sku_transactions.statement_id	The unique identifier for the financial statement to which this SKU transaction belongs.	dimension
status	status	The general status of a record or entity.	dimension
total_count	total_count	The total number of records or items in a collection.	metric
total_settlement_amount	total_settlement_amount	The aggregated total amount settled or paid out across all relevant orders or transactions after deductions.	metric
transactions.adjustment_amount	transactions.adjustment_amount	The amount of any adjustment applied to the transaction.	metric
transactions.adjustment_id	transactions.adjustment_id	A unique identifier for any adjustment applied to the transaction.	dimension
transactions.fee_tax_amount	transactions.fee_tax_amount	The total amount of fees and taxes applied to the transaction.	metric
transactions.id	transactions.id	The unique identifier for the transaction.	metric
transactions.order_create_time	transactions.order_create_time	The timestamp when the order associated with the transaction was created.	dimension
transactions.order_create_time_date	transactions.order_create_time_date	The date when the order associated with the transaction was created.	dimension
transactions.revenue_amount	transactions.revenue_amount	The total revenue amount generated from the transaction.	metric
transactions.settlement_amount	transactions.settlement_amount	The final amount settled for the transaction after all deductions and additions.	metric
transactions.shipping_cost_amount	transactions.shipping_cost_amount	The total shipping cost incurred for the transaction.	metric
transactions.type	transactions.type	The type of the transaction.	dimension