TikTok Shop
The table below gives information about all the data fields that you can import from TikTok Shop.
The fields that you can fetch in Adverity are updated regularly to reflect updates to data source APIs. As a result, the fields shown here may not be the same as the fields available in Adverity. If you notice a difference between this documentation and the fields you see in Adverity, please contact your Adverity account manager for more information.
To see the fields you can collect from another data source, go back to the Available fields in Adverity overview.
|
Field UI name |
Field API name |
Description |
Use in Adverity |
Docs |
|---|---|---|---|---|
|
actual_return_shipping_fee_amount |
actual_return_shipping_fee_amount |
|
metric |
|
|
actual_shipping_fee_amount |
actual_shipping_fee_amount |
|
metric |
|
|
adjustment_amount |
adjustment_amount |
|
metric |
|
|
affiliate_ads_commission_amount |
affiliate_ads_commission_amount |
|
metric |
|
|
affiliate_commission_amount |
affiliate_commission_amount |
|
metric |
|
|
affiliate_commission_before_pit |
affiliate_commission_before_pit |
|
metric |
|
|
affiliate_partner_commission_amount |
affiliate_partner_commission_amount |
|
metric |
|
|
after_seller_discounts_subtotal_amount |
after_seller_discounts_subtotal_amount |
|
metric |
|
|
amount.currency |
amount.currency |
|
dimension |
|
|
amount.value |
amount.value |
|
metric |
|
|
bank_account |
bank_account |
|
dimension |
|
|
create_time |
create_time |
|
dimension |
|
|
create_time_date |
create_time_date |
|
dimension |
|
|
currency |
currency |
|
dimension |
|
|
customer_order_refund_amount |
customer_order_refund_amount |
|
metric |
|
|
customer_paid_shipping_fee_amount |
customer_paid_shipping_fee_amount |
|
metric |
|
|
customer_paid_shipping_fee_refund_amount |
customer_paid_shipping_fee_refund_amount |
|
metric |
|
|
customer_payment_amount |
customer_payment_amount |
|
metric |
|
|
customer_refund_amount |
customer_refund_amount |
|
metric |
|
|
customer_shipping_fee_amount |
customer_shipping_fee_amount |
|
metric |
|
|
customer_shipping_fee_offset_amount |
customer_shipping_fee_offset_amount |
|
metric |
|
|
exchange_rate |
exchange_rate |
|
metric |
|
|
fbm_shipping_cost_amount |
fbm_shipping_cost_amount |
|
metric |
|
|
fbt_fulfillment_fee_amount |
fbt_fulfillment_fee_amount |
|
metric |
|
|
fbt_shipping_cost_amount |
fbt_shipping_cost_amount |
|
metric |
|
|
fee_amount |
fee_amount |
|
metric |
|
|
gross_sales_amount |
gross_sales_amount |
|
metric |
|
|
gross_sales_refund_amount |
gross_sales_refund_amount |
|
metric |
|
|
id |
id |
|
dimension |
|
|
net_sales_amount |
net_sales_amount |
|
metric |
|
|
order_id |
order_id |
|
dimension |
|
|
paid_time |
paid_time |
|
dimension |
|
|
paid_time_date |
paid_time_date |
|
dimension |
|
|
payment.buyer_service_fee |
payment.buyer_service_fee |
|
dimension |
|
|
payment.currency |
payment.currency |
|
dimension |
|
|
payment.handling_fee |
payment.handling_fee |
|
dimension |
|
|
payment.item_insurance_fee |
payment.item_insurance_fee |
|
dimension |
|
|
payment.original_shipping_fee |
payment.original_shipping_fee |
|
metric |
|
|
payment.original_total_product_price |
payment.original_total_product_price |
|
metric |
|
|
payment.platform_discount |
payment.platform_discount |
|
metric |
|
|
payment.product_tax |
payment.product_tax |
|
metric |
|
|
payment.retail_delivery_fee |
payment.retail_delivery_fee |
|
metric |
|
|
payment.seller_discount |
payment.seller_discount |
|
metric |
|
|
payment.shipping_fee |
payment.shipping_fee |
|
metric |
|
|
payment.shipping_fee_platform_discount |
payment.shipping_fee_platform_discount |
|
metric |
|
|
payment.shipping_fee_seller_discount |
payment.shipping_fee_seller_discount |
|
metric |
|
|
payment.shipping_fee_tax |
payment.shipping_fee_tax |
|
metric |
|
|
payment.shipping_insurance_fee |
payment.shipping_insurance_fee |
|
dimension |
|
|
payment.small_order_fee |
payment.small_order_fee |
|
dimension |
|
|
payment.sub_total |
payment.sub_total |
|
metric |
|
|
payment.tax |
payment.tax |
|
metric |
|
|
payment.total_amount |
payment.total_amount |
|
metric |
|
|
payment_amount_before_exchange.currency |
payment_amount_before_exchange.currency |
|
dimension |
|
|
payment_amount_before_exchange.value |
payment_amount_before_exchange.value |
|
metric |
|
|
payment_id |
payment_id |
|
dimension |
|
|
payment_method_name |
payment_method_name |
|
dimension |
|
|
payment_status |
payment_status |
|
dimension |
|
|
pit_amount |
pit_amount |
|
metric |
|
|
platform_commission_amount |
platform_commission_amount |
|
metric |
|
|
platform_discount_amount |
platform_discount_amount |
|
metric |
|
|
platform_discount_refund_amount |
platform_discount_refund_amount |
|
metric |
|
|
platform_refund_subsidy_amount |
platform_refund_subsidy_amount |
|
metric |
|
|
platform_shipping_fee_discount_amount |
platform_shipping_fee_discount_amount |
|
metric |
|
|
product_name |
product_name |
|
dimension |
|
|
promo_shipping_incentive_amount |
promo_shipping_incentive_amount |
|
metric |
|
|
quantity |
quantity |
|
metric |
|
|
referral_fee_amount |
referral_fee_amount |
|
metric |
|
|
refund_administration_fee_amount |
refund_administration_fee_amount |
|
metric |
|
|
refund_shipping_cost_discount_amount |
refund_shipping_cost_discount_amount |
|
metric |
|
|
reserve_amount.currency |
reserve_amount.currency |
|
dimension |
|
|
reserve_amount.value |
reserve_amount.value |
|
metric |
|
|
retail_delivery_fee_amount |
retail_delivery_fee_amount |
|
metric |
|
|
retail_delivery_fee_payment_amount |
retail_delivery_fee_payment_amount |
|
metric |
|
|
retail_delivery_fee_refund_amount |
retail_delivery_fee_refund_amount |
|
metric |
|
|
return_shipping_fee_amount |
return_shipping_fee_amount |
|
metric |
|
|
revenue_amount |
revenue_amount |
|
metric |
|
|
sales_tax_amount |
sales_tax_amount |
|
metric |
|
|
sales_tax_payment_amount |
sales_tax_payment_amount |
|
metric |
|
|
sales_tax_refund_amount |
sales_tax_refund_amount |
|
metric |
|
|
seller_discount_amount |
seller_discount_amount |
|
metric |
|
|
seller_discount_refund_amount |
seller_discount_refund_amount |
|
metric |
|
|
settlement_amount |
settlement_amount |
|
metric |
|
|
settlement_amount.currency |
settlement_amount.currency |
|
dimension |
|
|
settlement_amount.value |
settlement_amount.value |
|
metric |
|
|
shipping_cost_amount |
shipping_cost_amount |
|
metric |
|
|
shipping_cost_discount_amount |
shipping_cost_discount_amount |
|
metric |
|
|
shipping_fee_amount |
shipping_fee_amount |
|
metric |
|
|
shipping_fee_subsidy_amount |
shipping_fee_subsidy_amount |
|
metric |
|
|
shipping_insurance_fee_amount |
shipping_insurance_fee_amount |
|
metric |
|
|
signature_confirmation_fee_amount |
signature_confirmation_fee_amount |
|
metric |
|
|
sku_id |
sku_id |
|
dimension |
|
|
sku_name |
sku_name |
|
dimension |
|
|
statement_id |
statement_id |
|
dimension |
|
|
statement_time |
statement_time |
|
dimension |
|
|
statement_time_date |
statement_time_date |
|
dimension |
|
|
status |
status |
|
dimension |
|
|
transaction_fee_amount |
transaction_fee_amount |
|
metric |
|
|
transaction_id |
transaction_id |
|
dimension |
|
|
update_time |
update_time |
|
dimension |
|
|
update_time_date |
update_time_date |
|
dimension |
|