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
currency	currency	The currency code used for all monetary values related to the order or transaction.	dimension
fee_and_tax_amount	fee_and_tax_amount	The total amount of fees and taxes applied to an order transaction.	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
refund_amount.currency	refund_amount.currency	The currency of the refund amount.	dimension
refund_amount.refund_shipping_fee	refund_amount.refund_shipping_fee	The amount of shipping fee refunded.	metric
refund_amount.refund_subtotal	refund_amount.refund_subtotal	The gross subtotal amount of the refund before any specific deductions or additions.	metric
refund_amount.refund_tax	refund_amount.refund_tax	The tax amount included in the refund.	metric
refund_amount.refund_total	refund_amount.refund_total	The total amount refunded for a return or cancellation.	metric
refund_amount.retail_delivery_fee	refund_amount.retail_delivery_fee		metric
return_line_items.order_line_item_id	return_line_items.order_line_item_id	The identifier of the original order line item being returned.	dimension
return_line_items.product_image.height	return_line_items.product_image.height	The height of the product image for the returned line item.	metric
return_line_items.product_image.url	return_line_items.product_image.url	The URL of the product image for the returned line item.	dimension
return_line_items.product_image.width	return_line_items.product_image.width	The width of the product image for the returned line item.	metric
return_line_items.product_name	return_line_items.product_name	The name of the product in the returned line item.	dimension
return_line_items.refund_amount.currency	return_line_items.refund_amount.currency	The currency of the refund amount for the returned line item.	dimension
return_line_items.refund_amount.refund_shipping_fee	return_line_items.refund_amount.refund_shipping_fee	The shipping fee portion of the refund for the returned line item.	metric
return_line_items.refund_amount.refund_subtotal	return_line_items.refund_amount.refund_subtotal	The subtotal portion of the refund for the returned line item.	metric
return_line_items.refund_amount.refund_tax	return_line_items.refund_amount.refund_tax	The tax portion of the refund for the returned line item.	metric
return_line_items.refund_amount.refund_total	return_line_items.refund_amount.refund_total	The total refund amount for the individual returned line item.	metric
return_line_items.refund_amount.retail_delivery_fee	return_line_items.refund_amount.retail_delivery_fee		metric
return_line_items.return_line_item_id	return_line_items.return_line_item_id	A unique identifier for the returned line item.	dimension
return_line_items.seller_sku	return_line_items.seller_sku	The Seller’s Stock Keeping Unit (SKU) for the product in the returned line item.	dimension
return_line_items.sku_id	return_line_items.sku_id	A unique identifier for the Stock Keeping Unit (SKU) of the product variant in the returned line item.	dimension
return_line_items.sku_name	return_line_items.sku_name	The name of the SKU (product variant) in the returned line item.	dimension
return_orders.arbitration_status	return_orders.arbitration_status	The status of any arbitration process related to the return order.	dimension
return_orders.combined_return_id	return_orders.combined_return_id	The identifier for a combined return order, if applicable.	dimension
return_orders.create_time	return_orders.create_time	The timestamp when the return order was created.	dimension
return_orders.create_time_date	return_orders.create_time_date	The date when the return order was created.	dimension
return_orders.discount_amount	return_orders.discount_amount	The total discount amount applied to the return order.	dimension
return_orders.handover_method	return_orders.handover_method	The method used for handing over the returned items.	dimension
return_orders.is_combined_return	return_orders.is_combined_return	Indicates if the return is part of a combined return order.	dimension
return_orders.order_id	return_orders.order_id	The identifier of the original order associated with the return.	dimension
return_orders.pre_return_id	return_orders.pre_return_id	The identifier of the previous return order in a sequence, if any.	dimension
return_orders.return_id	return_orders.return_id	A unique identifier for the return order.	dimension
return_orders.return_method	return_orders.return_method	The method chosen for the return (e.g., mail, drop-off).	dimension
return_orders.return_provider_id	return_orders.return_provider_id	A unique identifier for the provider handling the return.	dimension
return_orders.return_provider_name	return_orders.return_provider_name	The name of the provider handling the return.	dimension
return_orders.return_reason	return_orders.return_reason	The code or category indicating the reason for the return.	dimension
return_orders.return_reason_text	return_orders.return_reason_text	A detailed text description of the reason for the return.	dimension
return_orders.return_status	return_orders.return_status	The current status of the return order (e.g., PENDING, APPROVED, REJECTED).	dimension
return_orders.return_tracking_number	return_orders.return_tracking_number	The tracking number for the return shipment.	dimension
return_orders.return_type	return_orders.return_type	The type of return (e.g., refund only, return and refund).	dimension
return_orders.role	return_orders.role	The role of the entity associated with the return order.	dimension
return_orders.seller_next_action_response	return_orders.seller_next_action_response	The seller’s response regarding the next action to take for the return order.	dimension
return_orders.shipment_type	return_orders.shipment_type	The type of shipment associated with the return order.	dimension
return_orders.shipping_fee_amount	return_orders.shipping_fee_amount	The amount of shipping fee associated with the return order.	dimension
return_orders.update_time	return_orders.update_time	The timestamp when the return order was last updated.	dimension
return_orders.update_time_date	return_orders.update_time_date	The date when the return order record was last updated or processed.	dimension
return_warehouse_address.full_address	return_warehouse_address.full_address	The complete address of the warehouse where returned items are to be sent or were received.	dimension
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
shipping_cost_amount	shipping_cost_amount	The monetary amount charged for shipping the order.	metric
sku_transactions.fee_tax_amount	sku_transactions.fee_tax_amount	The total amount of fees and taxes associated with a specific SKU transaction.	metric
sku_transactions.fee_tax_breakdown.fee.affiliate_ads_commission_amount	sku_transactions.fee_tax_breakdown.fee.affiliate_ads_commission_amount		metric
sku_transactions.fee_tax_breakdown.fee.affiliate_commission_amount	sku_transactions.fee_tax_breakdown.fee.affiliate_commission_amount		metric
sku_transactions.fee_tax_breakdown.fee.affiliate_commission_amount_before_pit	sku_transactions.fee_tax_breakdown.fee.affiliate_commission_amount_before_pit		metric
sku_transactions.fee_tax_breakdown.fee.affiliate_partner_commission_amount	sku_transactions.fee_tax_breakdown.fee.affiliate_partner_commission_amount		metric
sku_transactions.fee_tax_breakdown.fee.bonus_cashback_service_fee_amount	sku_transactions.fee_tax_breakdown.fee.bonus_cashback_service_fee_amount		metric
sku_transactions.fee_tax_breakdown.fee.cofunded_creator_bonus_amount	sku_transactions.fee_tax_breakdown.fee.cofunded_creator_bonus_amount		metric
sku_transactions.fee_tax_breakdown.fee.cofunded_promotion_service_fee_amount	sku_transactions.fee_tax_breakdown.fee.cofunded_promotion_service_fee_amount	The service fee amount for promotions that are co-funded by the platform for a SKU transaction.	metric
sku_transactions.fee_tax_breakdown.fee.credit_card_handling_fee_amount	sku_transactions.fee_tax_breakdown.fee.credit_card_handling_fee_amount	The fee charged for processing credit card payments for a SKU transaction.	metric
sku_transactions.fee_tax_breakdown.fee.dynamic_commission_amount	sku_transactions.fee_tax_breakdown.fee.dynamic_commission_amount		metric
sku_transactions.fee_tax_breakdown.fee.epr_pob_service_fee_amount	sku_transactions.fee_tax_breakdown.fee.epr_pob_service_fee_amount		metric
sku_transactions.fee_tax_breakdown.fee.external_affiliate_marketing_fee_amount	sku_transactions.fee_tax_breakdown.fee.external_affiliate_marketing_fee_amount		metric
sku_transactions.fee_tax_breakdown.fee.fee_per_item_sold_amount	sku_transactions.fee_tax_breakdown.fee.fee_per_item_sold_amount	The fee charged per item sold within a SKU transaction.	metric
sku_transactions.fee_tax_breakdown.fee.flash_sales_service_fee_amount	sku_transactions.fee_tax_breakdown.fee.flash_sales_service_fee_amount		metric
sku_transactions.fee_tax_breakdown.fee.live_specials_fee_amount	sku_transactions.fee_tax_breakdown.fee.live_specials_fee_amount		metric
sku_transactions.fee_tax_breakdown.fee.mall_service_fee_amount	sku_transactions.fee_tax_breakdown.fee.mall_service_fee_amount		metric
sku_transactions.fee_tax_breakdown.fee.platform_commission_amount	sku_transactions.fee_tax_breakdown.fee.platform_commission_amount	The commission amount charged by the platform for a SKU transaction.	metric
sku_transactions.fee_tax_breakdown.fee.pre_order_service_fee_amount	sku_transactions.fee_tax_breakdown.fee.pre_order_service_fee_amount		metric
sku_transactions.fee_tax_breakdown.fee.referral_fee_amount	sku_transactions.fee_tax_breakdown.fee.referral_fee_amount		metric
sku_transactions.fee_tax_breakdown.fee.refund_administration_fee_amount	sku_transactions.fee_tax_breakdown.fee.refund_administration_fee_amount	The administrative fee charged for processing a refund for a SKU transaction.	metric
sku_transactions.fee_tax_breakdown.fee.seller_paylater_handling_fee_amount	sku_transactions.fee_tax_breakdown.fee.seller_paylater_handling_fee_amount		metric
sku_transactions.fee_tax_breakdown.fee.sfp_service_fee_amount	sku_transactions.fee_tax_breakdown.fee.sfp_service_fee_amount		metric
sku_transactions.fee_tax_breakdown.fee.transaction_fee_amount	sku_transactions.fee_tax_breakdown.fee.transaction_fee_amount	The general fee charged for a SKU transaction.	metric
sku_transactions.fee_tax_breakdown.fee.tsp_commission_amount	sku_transactions.fee_tax_breakdown.fee.tsp_commission_amount		metric
sku_transactions.fee_tax_breakdown.fee.voucher_xtra_service_fee_amount	sku_transactions.fee_tax_breakdown.fee.voucher_xtra_service_fee_amount	The extra service fee amount related to vouchers applied to a SKU transaction.	metric
sku_transactions.fee_tax_breakdown.tax.anti_dumping_duty_amount	sku_transactions.fee_tax_breakdown.tax.anti_dumping_duty_amount		metric
sku_transactions.fee_tax_breakdown.tax.customs_clearance_amount	sku_transactions.fee_tax_breakdown.tax.customs_clearance_amount		metric
sku_transactions.fee_tax_breakdown.tax.customs_duty_amount	sku_transactions.fee_tax_breakdown.tax.customs_duty_amount		metric
sku_transactions.fee_tax_breakdown.tax.gst_amount	sku_transactions.fee_tax_breakdown.tax.gst_amount	The Goods and Services Tax (GST) amount applied to a SKU transaction.	metric
sku_transactions.fee_tax_breakdown.tax.import_vat_amount	sku_transactions.fee_tax_breakdown.tax.import_vat_amount	The Import Value Added Tax (VAT) amount applied to a SKU transaction.	metric
sku_transactions.fee_tax_breakdown.tax.isr_amount	sku_transactions.fee_tax_breakdown.tax.isr_amount		metric
sku_transactions.fee_tax_breakdown.tax.iva_amount	sku_transactions.fee_tax_breakdown.tax.iva_amount	The Impuesto al Valor Agregado (IVA) tax amount applied to a SKU transaction.	metric
sku_transactions.fee_tax_breakdown.tax.pit_amount	sku_transactions.fee_tax_breakdown.tax.pit_amount	The Personal Income Tax (PIT) amount applied to a SKU transaction.	metric
sku_transactions.fee_tax_breakdown.tax.sst_amount	sku_transactions.fee_tax_breakdown.tax.sst_amount	The Sales and Service Tax (SST) amount applied to a SKU transaction.	metric
sku_transactions.fee_tax_breakdown.tax.vat_amount	sku_transactions.fee_tax_breakdown.tax.vat_amount	The Value Added Tax (VAT) amount applied to a SKU transaction.	metric
sku_transactions.product_name	sku_transactions.product_name	The name of the product associated with the SKU in the transaction.	dimension
sku_transactions.quantity	sku_transactions.quantity	The quantity of the specific SKU involved in the transaction.	metric
sku_transactions.revenue_amount	sku_transactions.revenue_amount	The revenue generated from the specific SKU transaction.	metric
sku_transactions.revenue_breakdown.cod_service_fee_amount	sku_transactions.revenue_breakdown.cod_service_fee_amount	The service fee amount for Cash on Delivery (COD) for a SKU transaction.	metric
sku_transactions.revenue_breakdown.refund_cod_service_fee_amount	sku_transactions.revenue_breakdown.refund_cod_service_fee_amount	The refunded service fee amount for Cash on Delivery (COD) for a SKU transaction.	metric
sku_transactions.revenue_breakdown.refund_subtotal_before_discount_amount	sku_transactions.revenue_breakdown.refund_subtotal_before_discount_amount	The subtotal amount of the refund for a SKU transaction before any discounts are applied.	metric
sku_transactions.revenue_breakdown.seller_discount_amount	sku_transactions.revenue_breakdown.seller_discount_amount	The discount amount provided by the seller for a SKU transaction.	metric
sku_transactions.revenue_breakdown.seller_discount_refund_amount	sku_transactions.revenue_breakdown.seller_discount_refund_amount	The refund amount specifically for seller-provided discounts on a SKU transaction.	metric
sku_transactions.revenue_breakdown.subtotal_before_discount_amount	sku_transactions.revenue_breakdown.subtotal_before_discount_amount	The subtotal amount for a SKU transaction before any discounts are applied.	metric
sku_transactions.settlement_amount	sku_transactions.settlement_amount	The net amount settled for a specific SKU transaction, after all fees, taxes, and adjustments.	metric
sku_transactions.shipping_cost_amount	sku_transactions.shipping_cost_amount	The total shipping cost associated with a specific SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.actual_shipping_fee_amount	sku_transactions.shipping_cost_breakdown.actual_shipping_fee_amount	The actual shipping fee incurred for a SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.customer_paid_shipping_fee_amount	sku_transactions.shipping_cost_breakdown.customer_paid_shipping_fee_amount	The shipping fee amount paid by the customer for a SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.exchange_shipping_fee_amount	sku_transactions.shipping_cost_breakdown.exchange_shipping_fee_amount		metric
sku_transactions.shipping_cost_breakdown.fbt_fulfillment_fee_reimbursement_amount	sku_transactions.shipping_cost_breakdown.fbt_fulfillment_fee_reimbursement_amount	The reimbursement amount for Fulfilled by TikTok (FBT) fulfillment fees for a SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.replacement_shipping_fee_amount	sku_transactions.shipping_cost_breakdown.replacement_shipping_fee_amount		metric
sku_transactions.shipping_cost_breakdown.return_shipping_fee_amount	sku_transactions.shipping_cost_breakdown.return_shipping_fee_amount	The shipping fee amount charged for returning an item from a SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.return_shipping_label_fee_amount	sku_transactions.shipping_cost_breakdown.return_shipping_label_fee_amount	The fee amount for the return shipping label for a SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.seller_self_shipping_service_fee_amount	sku_transactions.shipping_cost_breakdown.seller_self_shipping_service_fee_amount		metric
sku_transactions.shipping_cost_breakdown.shipping_fee_discount_amount	sku_transactions.shipping_cost_breakdown.shipping_fee_discount_amount	The discount amount applied to the shipping fee for a SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.shipping_insurance_fee_amount	sku_transactions.shipping_cost_breakdown.shipping_insurance_fee_amount	The insurance fee amount for shipping a SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.signature_confirmation_fee_amount	sku_transactions.shipping_cost_breakdown.signature_confirmation_fee_amount	The fee charged for signature confirmation upon delivery of a SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.supplementary_component	sku_transactions.shipping_cost_breakdown.supplementary_component		dimension
sku_transactions.shipping_cost_breakdown.supplementary_component.customer_shipping_fee_offset_amount	sku_transactions.shipping_cost_breakdown.supplementary_component.customer_shipping_fee_offset_amount		metric
sku_transactions.shipping_cost_breakdown.supplementary_component.fbm_shipping_cost_amount	sku_transactions.shipping_cost_breakdown.supplementary_component.fbm_shipping_cost_amount		metric
sku_transactions.shipping_cost_breakdown.supplementary_component.fbt_fulfillment_fee_amount	sku_transactions.shipping_cost_breakdown.supplementary_component.fbt_fulfillment_fee_amount	The fulfillment fee amount for Fulfilled by TikTok (FBT) services for a SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.supplementary_component.fbt_shipping_cost_amount	sku_transactions.shipping_cost_breakdown.supplementary_component.fbt_shipping_cost_amount	The shipping cost amount for Fulfilled by TikTok (FBT) services for a SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.supplementary_component.platform_shipping_fee_discount_amount	sku_transactions.shipping_cost_breakdown.supplementary_component.platform_shipping_fee_discount_amount	The shipping fee discount amount provided by the platform for a SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.supplementary_component.promo_shipping_incentive_amount	sku_transactions.shipping_cost_breakdown.supplementary_component.promo_shipping_incentive_amount	The amount of promotional incentive applied to shipping costs for a SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.supplementary_component.seller_shipping_fee_discount_amount	sku_transactions.shipping_cost_breakdown.supplementary_component.seller_shipping_fee_discount_amount	The shipping fee discount amount provided by the seller for a SKU transaction.	metric
sku_transactions.shipping_cost_breakdown.supplementary_component.shipping_fee_subsidy_amount	sku_transactions.shipping_cost_breakdown.supplementary_component.shipping_fee_subsidy_amount	The amount of subsidy provided for shipping fees for a SKU transaction.	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
total_count	total_count	The total number of records available, typically used for pagination.	metric