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 |
Use in Adverity |
|---|---|---|
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 |
dimension |
bank_account |
bank_account |
dimension |
child_title |
child_title |
dimension |
cost_of_goods_sold |
cost_of_goods_sold |
metric |
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 |
dimension |
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 |
gross_sales |
metric |
gross_sales_amount |
gross_sales_amount |
metric |
gross_sales_refund_amount |
gross_sales_refund_amount |
metric |
id |
id |
dimension |
line_items.cancel_reason |
line_items.cancel_reason |
dimension |
line_items.cancel_user |
line_items.cancel_user |
dimension |
line_items.currency |
line_items.currency |
dimension |
line_items.id |
line_items.id |
metric |
line_items.is_gift |
line_items.is_gift |
dimension |
line_items.original_price |
line_items.original_price |
metric |
line_items.package_status |
line_items.package_status |
dimension |
line_items.platform_discount |
line_items.platform_discount |
metric |
line_items.product_id |
line_items.product_id |
dimension |
line_items.product_name |
line_items.product_name |
dimension |
line_items.rts_time |
line_items.rts_time |
dimension |
line_items.sale_price |
line_items.sale_price |
metric |
line_items.seller_discount |
line_items.seller_discount |
metric |
line_items.shipping_provider_id |
line_items.shipping_provider_id |
dimension |
line_items.shipping_provider_name |
line_items.shipping_provider_name |
dimension |
line_items.sku_id |
line_items.sku_id |
dimension |
line_items.sku_image |
line_items.sku_image |
dimension |
line_items.sku_name |
line_items.sku_name |
dimension |
line_items.sku_type |
line_items.sku_type |
dimension |
line_items.tracking_number |
line_items.tracking_number |
dimension |
master_title |
master_title |
dimension |
net_sales |
net_sales |
metric |
net_sales_amount |
net_sales_amount |
metric |
order_amount |
order_amount |
metric |
order_create_time |
order_create_time |
dimension |
order_create_time_date |
order_create_time_date |
dimension |
order_id |
order_id |
dimension |
orders.buyer_email |
orders.buyer_email |
dimension |
orders.buyer_message |
orders.buyer_message |
dimension |
orders.cancel_order_sla_time |
orders.cancel_order_sla_time |
dimension |
orders.cancel_reason |
orders.cancel_reason |
dimension |
orders.cancel_time |
orders.cancel_time |
dimension |
orders.cancellation_initiator |
orders.cancellation_initiator |
dimension |
orders.collection_due_time |
orders.collection_due_time |
dimension |
orders.collection_time |
orders.collection_time |
dimension |
orders.create_time |
orders.create_time |
dimension |
orders.create_time_date |
orders.create_time_date |
dimension |
orders.delivery_option_id |
orders.delivery_option_id |
dimension |
orders.delivery_option_name |
orders.delivery_option_name |
dimension |
orders.delivery_sla_time |
orders.delivery_sla_time |
dimension |
orders.delivery_time |
orders.delivery_time |
dimension |
orders.delivery_type |
orders.delivery_type |
dimension |
orders.fulfillment_type |
orders.fulfillment_type |
dimension |
orders.id |
orders.id |
metric |
orders.is_cod |
orders.is_cod |
dimension |
orders.is_on_hold_order |
orders.is_on_hold_order |
dimension |
orders.order_type |
orders.order_type |
dimension |
orders.packages |
orders.packages |
dimension |
orders.paid_time |
orders.paid_time |
dimension |
orders.payment_card_type |
orders.payment_card_type |
dimension |
orders.payment_method_code |
orders.payment_method_code |
dimension |
orders.payment_method_name |
orders.payment_method_name |
dimension |
orders.pick_up_cut_off_time |
orders.pick_up_cut_off_time |
dimension |
orders.rts_sla_time |
orders.rts_sla_time |
dimension |
orders.rts_time |
orders.rts_time |
dimension |
orders.shipping_provider |
orders.shipping_provider |
dimension |
orders.shipping_provider_id |
orders.shipping_provider_id |
dimension |
orders.shipping_type |
orders.shipping_type |
dimension |
orders.status |
orders.status |
dimension |
orders.tracking_number |
orders.tracking_number |
dimension |
orders.tts_sla_time |
orders.tts_sla_time |
dimension |
orders.update_time |
orders.update_time |
dimension |
orders.update_time_date |
orders.update_time_date |
dimension |
orders.user_id |
orders.user_id |
dimension |
orders.warehouse_id |
orders.warehouse_id |
dimension |
package.create_time |
package.create_time |
dimension |
package.delivery_option_id |
package.delivery_option_id |
dimension |
package.delivery_option_name |
package.delivery_option_name |
dimension |
package.order_line_item_ids |
package.order_line_item_ids |
dimension |
package.orders |
package.orders |
dimension |
package.package_id |
package.package_id |
dimension |
package.package_status |
package.package_status |
dimension |
package.recipient_address.address_detail |
package.recipient_address.address_detail |
dimension |
package.recipient_address.address_line1 |
package.recipient_address.address_line1 |
dimension |
package.recipient_address.address_line2 |
package.recipient_address.address_line2 |
dimension |
package.recipient_address.address_line3 |
package.recipient_address.address_line3 |
dimension |
package.recipient_address.address_line4 |
package.recipient_address.address_line4 |
dimension |
package.recipient_address.full_address |
package.recipient_address.full_address |
dimension |
package.recipient_address.name |
package.recipient_address.name |
dimension |
package.recipient_address.phone_number |
package.recipient_address.phone_number |
dimension |
package.recipient_address.postal_code |
package.recipient_address.postal_code |
dimension |
package.recipient_address.region_code |
package.recipient_address.region_code |
dimension |
package.sender_address.address_detail |
package.sender_address.address_detail |
dimension |
package.sender_address.address_line1 |
package.sender_address.address_line1 |
dimension |
package.sender_address.address_line2 |
package.sender_address.address_line2 |
dimension |
package.sender_address.address_line3 |
package.sender_address.address_line3 |
dimension |
package.sender_address.address_line4 |
package.sender_address.address_line4 |
dimension |
package.sender_address.full_address |
package.sender_address.full_address |
dimension |
package.sender_address.name |
package.sender_address.name |
dimension |
package.sender_address.phone_number |
package.sender_address.phone_number |
dimension |
package.sender_address.postal_code |
package.sender_address.postal_code |
dimension |
package.sender_address.region_code |
package.sender_address.region_code |
dimension |
package.shipping_provider_id |
package.shipping_provider_id |
dimension |
package.shipping_provider_name |
package.shipping_provider_name |
dimension |
package.shipping_type |
package.shipping_type |
dimension |
package.tracking_number |
package.tracking_number |
dimension |
package.update_time |
package.update_time |
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_cofunded_discount |
payment.shipping_fee_cofunded_discount |
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 |
dimension |
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 |
profit_margin |
profit_margin |
metric |
promo_shipping_incentive_amount |
promo_shipping_incentive_amount |
metric |
quantity |
quantity |
metric |
recipient_address.address_detail |
recipient_address.address_detail |
dimension |
recipient_address.address_line1 |
recipient_address.address_line1 |
dimension |
recipient_address.address_line2 |
recipient_address.address_line2 |
dimension |
recipient_address.address_line3 |
recipient_address.address_line3 |
dimension |
recipient_address.address_line4 |
recipient_address.address_line4 |
dimension |
recipient_address.district_info |
recipient_address.district_info |
dimension |
recipient_address.first_name |
recipient_address.first_name |
dimension |
recipient_address.first_name_local_script |
recipient_address.first_name_local_script |
dimension |
recipient_address.full_address |
recipient_address.full_address |
dimension |
recipient_address.last_name |
recipient_address.last_name |
dimension |
recipient_address.last_name_local_script |
recipient_address.last_name_local_script |
dimension |
recipient_address.name |
recipient_address.name |
dimension |
recipient_address.phone_number |
recipient_address.phone_number |
dimension |
recipient_address.post_town |
recipient_address.post_town |
dimension |
recipient_address.postal_code |
recipient_address.postal_code |
dimension |
recipient_address.region_code |
recipient_address.region_code |
dimension |
referral_fee_amount |
referral_fee_amount |
metric |
refund_administration_fee_amount |
refund_administration_fee_amount |
metric |
refund_amount |
refund_amount |
metric |
refund_amount.currency |
refund_amount.currency |
dimension |
refund_amount.refund_shipping_fee |
refund_amount.refund_shipping_fee |
metric |
refund_amount.refund_subtotal |
refund_amount.refund_subtotal |
metric |
refund_amount.refund_tax |
refund_amount.refund_tax |
metric |
refund_amount.refund_total |
refund_amount.refund_total |
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 |
dimension |
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_line_items.order_line_item_id |
return_line_items.order_line_item_id |
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 |
dimension |
return_line_items.product_image.width |
return_line_items.product_image.width |
metric |
return_line_items.product_name |
return_line_items.product_name |
dimension |
return_line_items.refund_amount.currency |
return_line_items.refund_amount.currency |
dimension |
return_line_items.refund_amount.refund_shipping_fee |
return_line_items.refund_amount.refund_shipping_fee |
metric |
return_line_items.refund_amount.refund_subtotal |
return_line_items.refund_amount.refund_subtotal |
metric |
return_line_items.refund_amount.refund_tax |
return_line_items.refund_amount.refund_tax |
metric |
return_line_items.refund_amount.refund_total |
return_line_items.refund_amount.refund_total |
metric |
return_line_items.return_line_item_id |
return_line_items.return_line_item_id |
dimension |
return_line_items.seller_sku |
return_line_items.seller_sku |
dimension |
return_line_items.sku_id |
return_line_items.sku_id |
dimension |
return_line_items.sku_name |
return_line_items.sku_name |
dimension |
return_orders.arbitration_status |
return_orders.arbitration_status |
dimension |
return_orders.can_buyer_keep_item |
return_orders.can_buyer_keep_item |
dimension |
return_orders.combined_return_id |
return_orders.combined_return_id |
dimension |
return_orders.create_time |
return_orders.create_time |
dimension |
return_orders.create_time_date |
return_orders.create_time_date |
dimension |
return_orders.discount_amount |
return_orders.discount_amount |
dimension |
return_orders.handover_method |
return_orders.handover_method |
dimension |
return_orders.is_combined_return |
return_orders.is_combined_return |
dimension |
return_orders.next_return_id |
return_orders.next_return_id |
dimension |
return_orders.order_id |
return_orders.order_id |
dimension |
return_orders.pre_return_id |
return_orders.pre_return_id |
dimension |
return_orders.return_id |
return_orders.return_id |
dimension |
return_orders.return_method |
return_orders.return_method |
dimension |
return_orders.return_provider_id |
return_orders.return_provider_id |
dimension |
return_orders.return_provider_name |
return_orders.return_provider_name |
dimension |
return_orders.return_reason |
return_orders.return_reason |
dimension |
return_orders.return_reason_text |
return_orders.return_reason_text |
dimension |
return_orders.return_status |
return_orders.return_status |
dimension |
return_orders.return_tracking_number |
return_orders.return_tracking_number |
dimension |
return_orders.return_type |
return_orders.return_type |
dimension |
return_orders.role |
return_orders.role |
dimension |
return_orders.seller_next_action_response |
return_orders.seller_next_action_response |
dimension |
return_orders.shipment_type |
return_orders.shipment_type |
dimension |
return_orders.shipping_fee_amount |
return_orders.shipping_fee_amount |
dimension |
return_orders.update_time |
return_orders.update_time |
dimension |
return_orders.update_time_date |
return_orders.update_time_date |
dimension |
return_shipping_fee_amount |
return_shipping_fee_amount |
metric |
return_warehouse_address.full_address |
return_warehouse_address.full_address |
dimension |
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 |
dimension |
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 |
sku |
dimension |
sku_id |
sku_id |
dimension |
sku_name |
sku_name |
dimension |
sku_sales_amount |
sku_sales_amount |
metric |
sku_transactions.product_name |
sku_transactions.product_name |
dimension |
sku_transactions.sku_id |
sku_transactions.sku_id |
dimension |
sku_transactions.sku_name |
sku_transactions.sku_name |
dimension |
sku_transactions.statement_id |
sku_transactions.statement_id |
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 |