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 or SKU 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 code used for all monetary values within the refund amount details. |
dimension |
refund_amount.refund_shipping_fee |
refund_amount.refund_shipping_fee |
The amount of shipping fee that was refunded. |
metric |
refund_amount.refund_subtotal |
refund_amount.refund_subtotal |
The subtotal amount of the refund before any discounts or fees are applied. |
metric |
refund_amount.refund_tax |
refund_amount.refund_tax |
The total tax amount that was refunded. |
metric |
refund_amount.refund_total |
refund_amount.refund_total |
The total amount refunded, including products, shipping, and taxes, after all discounts. |
metric |
refund_amount.retail_delivery_fee |
refund_amount.retail_delivery_fee |
The retail delivery fee amount that was refunded. |
metric |
return_line_items.order_line_item_id |
return_line_items.order_line_item_id |
The unique identifier of the original order line item being returned. |
dimension |
return_line_items.product_image.height |
return_line_items.product_image.height |
metric |
|
return_line_items.product_image.url |
return_line_items.product_image.url |
The URL for the image of the product associated with the returned line item. |
dimension |
return_line_items.product_image.width |
return_line_items.product_image.width |
metric |
|
return_line_items.product_name |
return_line_items.product_name |
The name of the product associated with the returned line item. |
dimension |
return_line_items.refund_amount.currency |
return_line_items.refund_amount.currency |
The currency code for the refund amount of this specific return 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 this specific return line item. |
metric |
return_line_items.refund_amount.refund_subtotal |
return_line_items.refund_amount.refund_subtotal |
The subtotal portion of the refund for this specific return line item. |
metric |
return_line_items.refund_amount.refund_tax |
return_line_items.refund_amount.refund_tax |
The tax portion of the refund for this specific return line item. |
metric |
return_line_items.refund_amount.refund_total |
return_line_items.refund_amount.refund_total |
The total refund amount for this specific return line item. |
metric |
return_line_items.refund_amount.retail_delivery_fee |
return_line_items.refund_amount.retail_delivery_fee |
The retail delivery fee amount that was refunded for a specific return line item. |
metric |
return_line_items.return_line_item_id |
return_line_items.return_line_item_id |
The unique identifier for this specific return line item. |
dimension |
return_line_items.seller_sku |
return_line_items.seller_sku |
The Stock Keeping Unit (SKU) identifier assigned by the seller for the product in this returned line item. |
dimension |
return_line_items.sku_id |
return_line_items.sku_id |
The unique identifier for the Stock Keeping Unit (SKU) associated with this returned line item. |
dimension |
return_line_items.sku_name |
return_line_items.sku_name |
The name of the Stock Keeping Unit (SKU) associated with this 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 if this return order is part of a combined return. |
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 item(s) by the buyer. |
dimension |
return_orders.is_combined_return |
return_orders.is_combined_return |
Indicates whether this return order is part of a combined return process. |
dimension |
return_orders.next_return_id |
return_orders.next_return_id |
dimension |
|
return_orders.order_id |
return_orders.order_id |
The unique identifier of the original order associated with this return. |
dimension |
return_orders.pre_return_id |
return_orders.pre_return_id |
dimension |
|
return_orders.return_id |
return_orders.return_id |
The unique identifier for the return order. |
dimension |
return_orders.return_method |
return_orders.return_method |
The method chosen for the return, such as drop-off or pickup. |
dimension |
return_orders.return_provider_id |
return_orders.return_provider_id |
The unique identifier of the provider handling the return shipment. |
dimension |
return_orders.return_provider_name |
return_orders.return_provider_name |
The name of the provider handling the return shipment. |
dimension |
return_orders.return_reason |
return_orders.return_reason |
The code or reason for the return (e.g., damaged, wrong item). |
dimension |
return_orders.return_reason_text |
return_orders.return_reason_text |
A detailed text description provided for the reason of the return. |
dimension |
return_orders.return_status |
return_orders.return_status |
The current status of the return order (e.g., initiated, pending, completed). |
dimension |
return_orders.return_tracking_number |
return_orders.return_tracking_number |
The tracking number assigned to the return shipment. |
dimension |
return_orders.return_type |
return_orders.return_type |
The type of return process, such as a full refund or exchange. |
dimension |
return_orders.role |
return_orders.role |
The role of the party involved in the return order, such as buyer or seller. |
dimension |
return_orders.seller_next_action_response |
return_orders.seller_next_action_response |
dimension |
|
return_orders.shipment_type |
return_orders.shipment_type |
The type of shipping service used for the return order, such as ‘TikTok Shipping’ or ‘Seller Shipping’. |
dimension |
return_orders.shipping_fee_amount |
return_orders.shipping_fee_amount |
The shipping fee amount specifically incurred for returning the SKU in a return order. |
dimension |
return_orders.update_time |
return_orders.update_time |
The timestamp when the return order record was last updated. |
dimension |
return_orders.update_time_date |
return_orders.update_time_date |
The date when the return order record was last updated. |
dimension |
return_warehouse_address.full_address |
return_warehouse_address.full_address |
The complete, formatted address of the warehouse designated for processing returns. |
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 cost incurred for shipping the order. |
metric |
sku_transactions.fee_tax_amount |
sku_transactions.fee_tax_amount |
The total amount of fees and taxes for 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 |
The commission amount related to affiliate advertising for the SKU transaction. |
metric |
sku_transactions.fee_tax_breakdown.fee.affiliate_commission_amount |
sku_transactions.fee_tax_breakdown.fee.affiliate_commission_amount |
The commission amount paid to affiliates for the SKU transaction. |
metric |
sku_transactions.fee_tax_breakdown.fee.affiliate_commission_amount_before_pit |
sku_transactions.fee_tax_breakdown.fee.affiliate_commission_amount_before_pit |
The affiliate commission amount before Personal Income Tax for the SKU transaction. |
metric |
sku_transactions.fee_tax_breakdown.fee.affiliate_partner_commission_amount |
sku_transactions.fee_tax_breakdown.fee.affiliate_partner_commission_amount |
The commission amount paid to an affiliate partner for the SKU transaction. |
metric |
sku_transactions.fee_tax_breakdown.fee.bonus_cashback_service_fee_amount |
sku_transactions.fee_tax_breakdown.fee.bonus_cashback_service_fee_amount |
The amount of service fee incurred for bonus cashback promotions, detailed at the SKU transaction level. This is part of the overall fees and taxes breakdown. |
metric |
sku_transactions.fee_tax_breakdown.fee.cofunded_creator_bonus_amount |
sku_transactions.fee_tax_breakdown.fee.cofunded_creator_bonus_amount |
The amount of bonus co-funded by the platform for creator promotions, detailed at the SKU transaction level. This is part of the overall fees and taxes breakdown. |
metric |
sku_transactions.fee_tax_breakdown.fee.cofunded_promotion_service_fee_amount |
sku_transactions.fee_tax_breakdown.fee.cofunded_promotion_service_fee_amount |
The amount of service fee for promotions co-funded by the platform, detailed at the SKU transaction level. This is part of the overall fees and taxes breakdown. |
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 amount for handling credit card payments for the SKU transaction. |
metric |
sku_transactions.fee_tax_breakdown.fee.dynamic_commission_amount |
sku_transactions.fee_tax_breakdown.fee.dynamic_commission_amount |
The amount of dynamic commission applied to the SKU transaction. This is part of the overall fees and taxes breakdown. |
metric |
sku_transactions.fee_tax_breakdown.fee.epr_pob_service_fee_amount |
sku_transactions.fee_tax_breakdown.fee.epr_pob_service_fee_amount |
The amount of the EPR POB service fee applied to the SKU transaction. |
metric |
sku_transactions.fee_tax_breakdown.fee.external_affiliate_marketing_fee_amount |
sku_transactions.fee_tax_breakdown.fee.external_affiliate_marketing_fee_amount |
The marketing fee amount paid for external affiliate services, detailed at the SKU transaction level. This is part of the overall fees and taxes breakdown. |
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 amount charged per item sold within the 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 |
The service fee amount for participation in flash sales events, detailed at the SKU transaction level. This is part of the overall fees and taxes breakdown. |
metric |
sku_transactions.fee_tax_breakdown.fee.live_specials_fee_amount |
sku_transactions.fee_tax_breakdown.fee.live_specials_fee_amount |
The fee amount associated with live special promotions or events, detailed at the SKU transaction level. This is part of the overall fees and taxes breakdown. |
metric |
sku_transactions.fee_tax_breakdown.fee.mall_service_fee_amount |
sku_transactions.fee_tax_breakdown.fee.mall_service_fee_amount |
The service fee amount incurred for selling through the platform’s mall feature, detailed at the SKU transaction level. This is part of the overall fees and taxes breakdown. |
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 TikTok platform for the 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 |
The service fee amount for pre-order processing, detailed at the SKU transaction level. This is part of the overall fees and taxes breakdown. |
metric |
sku_transactions.fee_tax_breakdown.fee.referral_fee_amount |
sku_transactions.fee_tax_breakdown.fee.referral_fee_amount |
The fee amount charged for referring a sale (marketplace commission) for the SKU transaction. |
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, detailed at the SKU transaction level. This is part of the overall fees and taxes breakdown. |
metric |
sku_transactions.fee_tax_breakdown.fee.seller_paylater_handling_fee_amount |
sku_transactions.fee_tax_breakdown.fee.seller_paylater_handling_fee_amount |
The handling fee incurred by the seller for ‘PayLater’ transactions, detailed at the SKU transaction level. This is part of the overall fees and taxes breakdown. |
metric |
sku_transactions.fee_tax_breakdown.fee.sfp_service_fee_amount |
sku_transactions.fee_tax_breakdown.fee.sfp_service_fee_amount |
The amount of the SFP service fee applied to the SKU transaction. |
metric |
sku_transactions.fee_tax_breakdown.fee.transaction_fee_amount |
sku_transactions.fee_tax_breakdown.fee.transaction_fee_amount |
The fee amount associated with the overall transaction for the SKU. |
metric |
sku_transactions.fee_tax_breakdown.fee.tsp_commission_amount |
sku_transactions.fee_tax_breakdown.fee.tsp_commission_amount |
The amount of TSP commission applied to the SKU transaction. |
metric |
sku_transactions.fee_tax_breakdown.fee.voucher_xtra_service_fee_amount |
sku_transactions.fee_tax_breakdown.fee.voucher_xtra_service_fee_amount |
The service fee amount for additional voucher promotions, detailed at the SKU transaction level. This is part of the overall fees and taxes breakdown. |
metric |
sku_transactions.fee_tax_breakdown.tax.anti_dumping_duty_amount |
sku_transactions.fee_tax_breakdown.tax.anti_dumping_duty_amount |
The tax amount related to anti-dumping duties for the SKU transaction. |
metric |
sku_transactions.fee_tax_breakdown.tax.customs_clearance_amount |
sku_transactions.fee_tax_breakdown.tax.customs_clearance_amount |
The amount charged for customs clearance for the SKU transaction. |
metric |
sku_transactions.fee_tax_breakdown.tax.customs_duty_amount |
sku_transactions.fee_tax_breakdown.tax.customs_duty_amount |
The amount charged for customs duty for the SKU transaction. |
metric |
sku_transactions.fee_tax_breakdown.tax.gst_amount |
sku_transactions.fee_tax_breakdown.tax.gst_amount |
The Goods and Services Tax (GST) amount for the 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 for the SKU transaction. |
metric |
sku_transactions.fee_tax_breakdown.tax.isr_amount |
sku_transactions.fee_tax_breakdown.tax.isr_amount |
The Income Tax Withholding (ISR) amount for the SKU transaction. |
metric |
sku_transactions.fee_tax_breakdown.tax.iva_amount |
sku_transactions.fee_tax_breakdown.tax.iva_amount |
The Value Added Tax (IVA) amount for the 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 for the 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 for the 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 for the 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 included in the transaction. |
metric |
sku_transactions.revenue_amount |
sku_transactions.revenue_amount |
The total revenue amount 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 the SKU transaction. |
metric |
sku_transactions.revenue_breakdown.refund_cod_service_fee_amount |
sku_transactions.revenue_breakdown.refund_cod_service_fee_amount |
The refund amount for the Cash on Delivery (COD) service fee for the SKU transaction. |
metric |
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.revenue_breakdown.seller_discount_amount |
sku_transactions.revenue_breakdown.seller_discount_amount |
The discount amount applied by the seller to the SKU transaction. |
metric |
sku_transactions.revenue_breakdown.seller_discount_refund_amount |
sku_transactions.revenue_breakdown.seller_discount_refund_amount |
The refund amount for the seller’s discount applied to the SKU transaction. |
metric |
sku_transactions.revenue_breakdown.subtotal_before_discount_amount |
sku_transactions.revenue_breakdown.subtotal_before_discount_amount |
The subtotal amount of the SKU before any discounts were applied. |
metric |
sku_transactions.settlement_amount |
sku_transactions.settlement_amount |
The final amount settled for the specific SKU transaction after all deductions and additions. |
metric |
sku_transactions.shipping_cost_amount |
sku_transactions.shipping_cost_amount |
The total shipping cost for the 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 the SKU. |
metric |
sku_transactions.shipping_cost_breakdown.customer_paid_shipping_fee_amount |
sku_transactions.shipping_cost_breakdown.customer_paid_shipping_fee_amount |
The amount of shipping fee paid by the customer for the SKU, combining initial and refunded amounts. |
metric |
sku_transactions.shipping_cost_breakdown.exchange_shipping_fee_amount |
sku_transactions.shipping_cost_breakdown.exchange_shipping_fee_amount |
The shipping fee amount for an order exchange, detailed at the SKU transaction level. This is part of the shipping cost breakdown. |
metric |
sku_transactions.shipping_cost_breakdown.fbt_fulfillment_fee_reimbursement_amount |
sku_transactions.shipping_cost_breakdown.fbt_fulfillment_fee_reimbursement_amount |
A reimbursement from TikTok Shop for Fulfilled by TikTok (FBT) orders that do not qualify for free shipping. |
metric |
sku_transactions.shipping_cost_breakdown.replacement_shipping_fee_amount |
sku_transactions.shipping_cost_breakdown.replacement_shipping_fee_amount |
The shipping fee amount for a replacement order, detailed at the SKU transaction level. This is part of the shipping cost breakdown. |
metric |
sku_transactions.shipping_cost_breakdown.return_shipping_fee_amount |
sku_transactions.shipping_cost_breakdown.return_shipping_fee_amount |
The shipping fee amount for returning the SKU. |
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, detailed at the SKU transaction level. This is part of the shipping cost breakdown. |
metric |
sku_transactions.shipping_cost_breakdown.seller_self_shipping_service_fee_amount |
sku_transactions.shipping_cost_breakdown.seller_self_shipping_service_fee_amount |
The service fee amount for seller self-shipping, detailed at the SKU transaction level. This is part of the shipping cost breakdown. |
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 the SKU. |
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, detailed at the SKU transaction level. This is part of the shipping cost breakdown. |
metric |
sku_transactions.shipping_cost_breakdown.signature_confirmation_fee_amount |
sku_transactions.shipping_cost_breakdown.signature_confirmation_fee_amount |
The fee amount for requiring signature confirmation upon delivery, detailed at the SKU transaction level. This is part of the shipping cost breakdown. |
metric |
sku_transactions.shipping_cost_breakdown.supplementary_component |
sku_transactions.shipping_cost_breakdown.supplementary_component |
A breakdown of supplementary components contributing to the shipping cost for the SKU. |
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 |
The fee to offset TikTok Shop Shipping Incentive or customer-paid shipping fee, resulting in a net charge of $0 to the seller. |
metric |
sku_transactions.shipping_cost_breakdown.supplementary_component.fbm_shipping_cost_amount |
sku_transactions.shipping_cost_breakdown.supplementary_component.fbm_shipping_cost_amount |
The shipping cost incurred when the order is Fulfilled by Merchant (FBM). |
metric |
sku_transactions.shipping_cost_breakdown.supplementary_component.fbt_fulfillment_fee_amount |
sku_transactions.shipping_cost_breakdown.supplementary_component.fbt_fulfillment_fee_amount |
The shipping fee incurred by the seller for orders fulfilled by TikTok (FBT). |
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 fee incurred by the seller for orders fulfilled by TikTok (FBT). |
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. |
metric |
sku_transactions.shipping_cost_breakdown.supplementary_component.promo_shipping_incentive_amount |
sku_transactions.shipping_cost_breakdown.supplementary_component.promo_shipping_incentive_amount |
Additional logistics incentives provided by TikTok Shop for sellers participating in co-funded free shipping programs. |
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 discount amount applied to the seller’s shipping fee, which is a supplementary component of the shipping cost breakdown. |
metric |
sku_transactions.shipping_cost_breakdown.supplementary_component.shipping_fee_subsidy_amount |
sku_transactions.shipping_cost_breakdown.supplementary_component.shipping_fee_subsidy_amount |
The shipping fee subsidy funded by TikTok Shop for seller shipping, where a positive amount represents a subsidy received by the seller. |
metric |
sku_transactions.sku_id |
sku_transactions.sku_id |
The unique identifier for the Stock Keeping Unit (SKU) involved in the transaction. |
metric |
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. |
metric |
total_count |
total_count |
The total number of records or items in a collection. |
metric |