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.
adjustment_amount Metric
The total amount of adjustments applied to the financial statement or transaction.
amount.currency Dimension
The currency code for the associated monetary amount.
amount.value Metric
The numerical value of the monetary amount.
bank_account Dimension
Details pertaining to the bank account for payouts or transactions.
create_time Dimension
The timestamp when the record was created.
create_time_date Dimension
The date when the record was created.
currency Dimension
The currency in which the financial transaction or amount is expressed, such as GBP or USD.
exchange_rate Metric
The exchange rate used for currency conversion.
fee_amount Metric
The total amount of fees incurred.
fee_and_tax_amount Dimension
The combined total amount of fees and taxes.
id Metric
A unique identifier for the record.
line_items.cancel_reason Dimension
The reason provided for the cancellation of a specific line item.
line_items.cancel_user Dimension
The entity (e.g., buyer, seller, system, operator) that initiated the cancellation of the line item.
line_items.currency Dimension
The currency in which the line item's prices and amounts are denominated.
line_items.display_status Dimension
The customer-facing status of a specific line item within an order.
line_items.id Dimension
The unique identifier for a specific line item within an order.
line_items.item_tax Dimension
The tax amount applied to an individual line item.
line_items.original_price Metric
The original price of the product for the line item before any discounts or promotions.
line_items.package_status Dimension
The current shipping or fulfillment status of the package containing the line item.
line_items.platform_discount Metric
The discount amount applied by the platform to the individual line item.
line_items.product_id Dimension
The unique identifier of the product associated with the line item.
line_items.product_name Dimension
The name of the product associated with the line item.
line_items.retail_delivery_fee Metric
The retail delivery fee applied to the individual line item.
line_items.room_id Dimension
The unique identifier of the LIVE session in which an order line item was created, used for live order sorting, reconciliation, and fulfillment.
line_items.rts_time Dimension
The timestamp when the line item was marked as Ready-To-Ship (RTS).
line_items.sale_price Metric
The final selling price of the line item after all applicable discounts and promotions.
line_items.seller_discount Metric
The discount amount applied by the seller to the individual line item.
line_items.seller_sku Dimension
The Seller Stock Keeping Unit (SKU) identifier for the product variant in the line item.
line_items.shipping_provider_id Dimension
The unique identifier of the shipping provider handling the line item's shipment.
line_items.shipping_provider_name Dimension
The name of the shipping provider handling the line item's shipment.
line_items.shipping_vat_amount Metric
The Value Added Tax (VAT) amount applied to shipping for a specific line item.
line_items.shipping_vat_rate Metric
The Value Added Tax (VAT) rate applied to shipping for a specific line item.
line_items.sku_id Dimension
The unique identifier for the SKU (Stock Keeping Unit) of the product variant in the line item.
line_items.sku_image Dimension
The URL of the image associated with the specific SKU in the line item.
line_items.sku_name Dimension
The name or description of the specific SKU (product variant) in the line item.
line_items.sku_type Dimension
The type or classification of the Stock Keeping Unit (SKU) for the line item (e.g., standard, variant).
line_items.tracking_number Dimension
The tracking number for the shipment associated with the line item.
net_sales_amount Metric
The total sales amount after all relevant deductions, such as returns and discounts.
order_create_time Dimension
The Unix timestamp (GMT/UTC+00:00) indicating when the order was created.
order_create_time_date Dimension
The date when the order was created.
order_id Dimension
A unique identifier assigned to each order created by a buyer in TikTok Shop.
orders.auto_combine_group_id Dimension
An identifier assigned to orders from the same customer during a LIVE session to facilitate combined order shipping when 'auto-combination' is activated in Seller Center.
orders.buyer_email Dimension
The anonymized email address of the buyer associated with the order.
orders.buyer_message Dimension
A message or note left by the buyer when placing the order.
orders.cancel_order_sla_time Dimension
The Service Level Agreement (SLA) time by which an order must be cancelled if certain conditions are not met, to prevent automatic cancellation by the platform.
orders.cancel_reason Dimension
The reason provided for the cancellation of the entire order.
orders.cancel_time Dimension
The timestamp when the order's status was updated to 'CANCELLED'.
orders.cancellation_initiator Dimension
The entity that initiated the order cancellation, such as 'BUYER', 'SELLER', or 'SYSTEM'.
orders.collection_due_time Dimension
The time by which the order is scheduled to be collected by the shipping provider.
orders.collection_time Dimension
The actual time when the order was collected by the shipping provider.
orders.commerce_platform Dimension
The commerce platform where the order was originally placed (e.g., TikTok Shop).
orders.create_time Dimension
The Unix timestamp (GMT/UTC+00:00) indicating when the order was created.
orders.create_time_date Dimension
The date when the order was created.
orders.delivery_option_id Dimension
A unique identifier for the selected delivery option for the order.
orders.delivery_option_name Dimension
The name of the selected delivery option for the order.
orders.delivery_sla_time Dimension
The Service Level Agreement (SLA) time for order delivery.
orders.delivery_time Dimension
The actual time when the order was delivered to the recipient.
orders.delivery_type Dimension
The type of delivery service used for the order (e.g., standard, express).
orders.exchange_source_order_id Dimension
The unique identifier of the original order from which an exchange request was initiated.
orders.fast_dispatch_sla_time Dimension
The Service Level Agreement (SLA) time by which an order must be dispatched quickly.
orders.fulfillment_type Dimension
The method or type of fulfillment chosen for the order.
orders.has_updated_recipient_address Dimension
Indicates if the recipient's address for the order has been updated.
orders.id Dimension
A unique identifier assigned to each order created by a buyer in TikTok Shop.
orders.is_cod Dimension
Indicates if the order is Cash on Delivery (COD).
orders.is_on_hold_order Dimension
Indicates whether the order is currently on hold.
orders.is_refundable_sample Dimension
Indicates if an order item is a sample that is eligible for a refund, possibly related to `is_sample_order` property in API responses.
orders.order_type Dimension
The classification or type of the order.
orders.packages Dimension
Information about the packages associated with the order.
orders.paid_time Dimension
The time when the order payment was successfully processed.
orders.payment_auth_code Dimension
The authorization code provided by the payment gateway to confirm the payment for the order.
orders.payment_card_type Dimension
The type of payment card used for the order (e.g., Visa, Mastercard).
orders.payment_method_code Dimension
The code identifying the payment method used for the order.
orders.payment_method_name Dimension
The name of the payment method used for the order (e.g., credit card, digital wallet).
orders.pick_up_cut_off_time Dimension
The cut-off time for pickup for the order.
orders.rts_sla_time Dimension
The Service Level Agreement (SLA) time for when the order should be Ready-To-Ship.
orders.rts_time Dimension
The actual time when the order was marked as Ready-To-Ship.
orders.seller_note Dimension
A private note added by the seller for internal order management.
orders.shipping_provider Dimension
The name of the shipping provider handling the order delivery.
orders.shipping_provider_id Dimension
The unique identifier for the shipping provider handling the order delivery.
orders.shipping_type Dimension
The classification or type of shipping service for the order.
orders.split_or_combine_tag Dimension
A tag indicating if an order has been split into multiple packages or combined with other orders for shipment.
orders.status Dimension
The current status of the order (e.g., UNPAID, AWAITING_SHIPMENT, DELIVERED, CANCELLED).
orders.tracking_number Dimension
The tracking number associated with the order's shipment.
orders.tts_sla_time Dimension
The TikTok Shop Service Level Agreement (SLA) time for the order.
orders.update_time Dimension
The time when the order information was last updated.
orders.update_time_date Dimension
The date when the order information was last updated.
orders.user_id Dimension
The unique identifier of the user who placed the order.
orders.warehouse_id Dimension
The unique identifier of the warehouse from which the order is fulfilled.
package.create_time Dimension
The time when the package was created or registered in the system.
package.delivery_option_id Dimension
A unique identifier for the selected delivery option for the package.
package.delivery_option_name Dimension
The name of the selected delivery option for the package.
package.dimension.height Metric
The height of the package, used for shipping label calculation and logistics.
package.dimension.length Metric
The length of the package, used for shipping label calculation and logistics.
package.dimension.unit Dimension
The unit of measurement for the package dimensions (e.g., cm, inch).
package.dimension.width Metric
The width of the package, used for shipping label calculation and logistics.
package.has_multi_skus Dimension
Indicates whether the package contains multiple unique Stock Keeping Units (SKUs).
package.last_mile_tracking_number Dimension
The tracking number used for the final leg of the package delivery.
package.order_line_item_ids Dimension
A list of unique identifiers for the order line items included in this package.
package.orders Dimension
A list of orders or order identifiers included within a specific package.
package.package_id Dimension
A unique identifier assigned to the package.
package.package_status Dimension
The current status of the package.
package.recipient_address.address_detail Dimension
Additional details for the recipient's address for the package.
package.recipient_address.address_line1 Dimension
The first line of the recipient's address for the package.
package.recipient_address.address_line2 Dimension
The second line of the recipient's address for the package.
package.recipient_address.address_line3 Dimension
The third line of the recipient's address for the package.
package.recipient_address.address_line4 Dimension
The fourth line of the recipient's address for the package.
package.recipient_address.full_address Dimension
The complete formatted address of the package recipient.
package.recipient_address.name Dimension
The full name of the recipient for the package.
package.recipient_address.phone_number Dimension
The phone number of the recipient for the package.
package.recipient_address.postal_code Dimension
The postal code of the recipient's address for the package.
package.recipient_address.region_code Dimension
The region code (e.g., country code) of the recipient's address for the package.
package.sender_address.address_detail Dimension
Additional details for the sender's address for the package.
package.sender_address.address_line1 Dimension
The first line of the sender's address for the package.
package.sender_address.address_line2 Dimension
The second line of the sender's address for the package.
package.sender_address.address_line3 Dimension
The third line of the sender's address for the package.
package.sender_address.address_line4 Dimension
The fourth line of the sender's address for the package.
package.sender_address.full_address Dimension
The complete formatted address of the package sender.
package.sender_address.name Dimension
The full name of the sender for the package.
package.sender_address.phone_number Dimension
The phone number of the sender for the package.
package.sender_address.postal_code Dimension
The postal code of the sender's address for the package.
package.sender_address.region_code Dimension
The region code (e.g., country code) of the sender's address for the package.
package.shipping_provider_id Dimension
The unique identifier for the shipping provider handling this package.
package.shipping_provider_name Dimension
The name of the shipping provider handling this package.
package.shipping_type Dimension
The classification or type of shipping service for the package.
package.tracking_number Dimension
The tracking number assigned to the package.
package.update_time Dimension
The time when the package information was last updated.
package.weight.unit Dimension
The unit of measurement for the package weight (e.g., kg, lb).
package.weight.value Metric
The weight of the package, used for shipping label calculation and logistics.
paid_time Dimension
The timestamp when the payment was made.
paid_time_date Dimension
The date when the payment was made.
partial_refund.amount Metric
The monetary amount of a partial refund issued for an order or item.
partial_refund.currency Dimension
The currency in which the partial refund amount is denominated.
payable_amount Metric
The total amount that is due to be paid.
payment.currency Dimension
The currency in which the financial transaction or amount is expressed, such as GBP or USD.
payment.original_shipping_fee Metric
The original shipping fee before any discounts or adjustments were applied.
payment.original_total_product_price Metric
The original total price of all products in the order before any discounts or adjustments.
payment.payment_platform_discount Metric
The discount amount applied by the platform during the payment transaction.
payment.platform_discount Metric
The discount amount applied by the platform.
payment.product_tax Metric
The tax amount levied on the products in the order.
payment.retail_delivery_fee Metric
The delivery fee charged to the customer at the retail level.
payment.seller_discount Metric
The discount amount applied by the seller.
payment.shipping_fee Metric
The final shipping fee charged for the order after all adjustments.
payment.shipping_fee_cofunded_discount Metric
The co-funded discount amount applied to the shipping fee.
payment.shipping_fee_platform_discount Metric
The platform-applied discount amount specifically for the shipping fee.
payment.shipping_fee_seller_discount Metric
The seller-applied discount amount specifically for the shipping fee.
payment.shipping_fee_tax Metric
The tax amount levied on the shipping fee.
payment.sub_total Metric
The subtotal amount of the payment before taxes, shipping, and discounts are applied.
payment.tax Metric
The total tax amount applied to the order.
payment.total_amount Metric
The total monetary amount of the order, including products, shipping, and taxes, after all discounts.
payment_amount_before_exchange.currency Dimension
The currency code of the payment amount before any currency exchange was applied.
payment_amount_before_exchange.value Metric
The numerical value of the payment amount before any currency exchange was applied.
payment_id Dimension
A unique identifier for a payment record.
payment_status Dimension
The current status of the payment.
recipient_address.address_detail Dimension
Additional details for the recipient's address.
recipient_address.address_line1 Dimension
The first line of the recipient's address.
recipient_address.address_line2 Dimension
The second line of the recipient's address.
recipient_address.address_line3 Dimension
The third line of the recipient's address.
recipient_address.address_line4 Dimension
The fourth line of the recipient's address.
recipient_address.delivery_preferences.drop_off_location Dimension
The preferred location specified by the recipient for dropping off the delivery.
recipient_address.district_info Dimension
Information about the district of the recipient's address.
recipient_address.first_name Dimension
The first name of the recipient.
recipient_address.first_name_local_script Dimension
The first name of the recipient in local script.
recipient_address.full_address Dimension
The complete formatted address of the order recipient.
recipient_address.last_name Dimension
The last name of the recipient.
recipient_address.last_name_local_script Dimension
The last name of the recipient in local script.
recipient_address.name Dimension
The full name of the order recipient.
recipient_address.phone_number Dimension
The phone number of the order recipient.
recipient_address.post_town Dimension
The post town or city of the recipient's address.
recipient_address.postal_code Dimension
The postal code of the recipient's address.
recipient_address.region_code Dimension
The region code (e.g., country code) of the recipient's address.
refund_amount.currency Dimension
The currency of the refund amount.
refund_amount.refund_shipping_fee Metric
The amount of shipping fee that was refunded.
refund_amount.refund_subtotal Metric
The subtotal amount of products that was refunded.
refund_amount.refund_tax Metric
The amount of tax that was refunded.
refund_amount.refund_total Metric
The total amount refunded for the order or transaction.
reserve_amount.currency Dimension
The currency in which the reserved amount is denominated.
reserve_amount.value Metric
The numerical value of the reserved amount.
return_line_items.order_line_item_id Dimension
The unique identifier of the original order line item being returned.
return_line_items.product_image.height Dimension
The height of the product image for the returned item.
return_line_items.product_image.url Dimension
The URL of the product image for the returned item.
return_line_items.product_image.width Dimension
The width of the product image for the returned item.
return_line_items.product_name Dimension
The name of the product being returned.
return_line_items.refund_amount.currency Dimension
The currency of the refund amount for the specific returned line item.
return_line_items.refund_amount.refund_shipping_fee Metric
The amount of shipping fee refunded for this specific returned line item.
return_line_items.refund_amount.refund_subtotal Metric
The subtotal amount refunded for this specific returned line item.
return_line_items.refund_amount.refund_tax Metric
The tax amount refunded for this specific returned line item.
return_line_items.refund_amount.refund_total Metric
The total amount refunded for this specific returned line item.
return_line_items.return_line_item_id Dimension
A unique identifier for the specific line item within a return order.
return_line_items.seller_sku Dimension
The Stock Keeping Unit (SKU) assigned by the seller for the returned product.
return_line_items.sku_id Dimension
A unique identifier for a Stock Keeping Unit (SKU) of the returned product, representing a specific variant.
return_line_items.sku_name Dimension
The name of the Stock Keeping Unit (SKU) for the returned product variant.
return_orders.arbitration_status Dimension
The status of any arbitration process related to the return order.
return_orders.combined_return_id Dimension
A unique identifier if this return is part of a larger combined return.
return_orders.create_time Dimension
The time when the return order was created or initiated.
return_orders.create_time_date Dimension
The date when the return order was created or initiated.
return_orders.discount_amount.currency Dimension
The currency of the discount amount applied to a return order.
return_orders.discount_amount.product_platform_discount Metric
The amount of product discount funded by the platform for a return order.
return_orders.discount_amount.product_seller_discount Metric
The amount of product discount funded by the seller for a return order.
return_orders.discount_amount.shipping_fee_platform_discount Metric
The amount of shipping fee discount funded by the platform for a return order.
return_orders.discount_amount.shipping_fee_seller_discount Metric
The amount of shipping fee discount funded by the seller for a return order.
return_orders.handover_method Dimension
The method by which the returned item was handed over (e.g., drop-off, pickup).
return_orders.is_combined_return Dimension
Indicates whether the return order is part of a combined return.
return_orders.order_id Dimension
The unique identifier of the original order associated with this return.
return_orders.return_id Dimension
A unique identifier assigned to the return order.
return_orders.return_method Dimension
The method chosen for the return (e.g., ship back, refund without return).
return_orders.return_provider_id Dimension
The unique identifier for the provider handling the return shipment.
return_orders.return_provider_name Dimension
The name of the provider handling the return shipment.
return_orders.return_reason Dimension
The coded reason for the return (e.g., damaged, wrong item).
return_orders.return_reason_text Dimension
A descriptive text explaining the reason for the return.
return_orders.return_status Dimension
The current status of the return or refund request.
return_orders.return_tracking_number Dimension
The tracking number assigned to the returned shipment.
return_orders.return_type Dimension
The type of return (e.g., refund only, return and refund).
return_orders.role Dimension
The role of the initiator or processor of the return (e.g., buyer, seller).
return_orders.seller_next_action_response.action Dimension
The specific action the seller needs to take or has taken in response to a return request (e.g., 'Approve', 'Reject').
return_orders.seller_next_action_response.deadline Metric
The timestamp by which the seller must complete their next required action on a return request.
return_orders.shipment_type Dimension
The type of shipment used for the return.
return_orders.shipping_fee_amount.buyer_paid_return_shipping_fee Metric
The amount of the return shipping fee paid by the buyer.
return_orders.shipping_fee_amount.currency Dimension
The currency of the return shipping fee amount.
return_orders.shipping_fee_amount.platform_paid_return_shipping_fee Metric
The amount of the return shipping fee paid by the platform.
return_orders.shipping_fee_amount.seller_paid_return_shipping_fee Metric
The amount of the return shipping fee paid by the seller.
return_orders.update_time Dimension
The time when the return order information was last updated.
return_orders.update_time_date Dimension
The date when the return order information was last updated.
return_warehouse_address.full_address Dimension
The complete formatted address of the warehouse designated for returns.
revenue_amount Dimension
The amount of revenue generated for a specific order or SKU transaction.
settlement_amount Dimension
The amount settled or paid out for the order or transaction after deductions.
settlement_amount.currency Dimension
The currency code for the settlement amount.
settlement_amount.value Metric
The numerical value of the settlement amount.
shipping_cost_amount Dimension
The total cost associated with shipping.
sku_transactions.fee_tax_amount Metric
The total amount of fees and taxes applied to a specific SKU transaction.
sku_transactions.fee_tax_breakdown.fee.affiliate_ads_commission_amount Metric
The commission amount specifically from affiliate ads, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.affiliate_commission_amount Metric
The total affiliate commission amount, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.affiliate_commission_amount_before_pit Metric
The affiliate commission amount before Personal Income Tax (PIT) deductions, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.affiliate_partner_commission_amount Metric
The commission amount paid to affiliate partners, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.bonus_cashback_service_fee_amount Metric
The service fee amount associated with bonus cashback programs, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.cofunded_creator_bonus_amount Metric
The co-funded bonus amount provided to creators, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.cofunded_promotion_service_fee_amount Metric
The co-funded service fee amount for promotions, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.credit_card_handling_fee_amount Metric
The fee amount for credit card transaction handling, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.dynamic_commission_amount Metric
The dynamic commission amount applied based on specific criteria, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.epr_pob_service_fee_amount Metric
The EPR POB (Extended Producer Responsibility / Point of Business) service fee amount, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.external_affiliate_marketing_fee_amount Metric
The marketing fee amount for external affiliates, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.fee_per_item_sold_amount Metric
The fee amount charged per item sold, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.flash_sales_service_fee_amount Metric
The service fee amount associated with flash sales, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.live_specials_fee_amount Metric
The fee amount for live specials promotions, broken down at the SKU level.
sku_transactions.fee_tax_breakdown.fee.mall_service_fee_amount Metric
The amount charged as a mall service fee for the SKU transaction.
sku_transactions.fee_tax_breakdown.fee.platform_commission_amount Metric
The commission charged by the TikTok Shop platform on the sale of the SKU.
sku_transactions.fee_tax_breakdown.fee.pre_order_service_fee_amount Metric
The amount charged as a pre-order service fee for the SKU transaction.
sku_transactions.fee_tax_breakdown.fee.referral_fee_amount Metric
The commission or fee paid to affiliates or creators for driving sales to the TikTok Shop.
sku_transactions.fee_tax_breakdown.fee.refund_administration_fee_amount Metric
The amount charged as an administration fee for processing a refund for the SKU transaction.
sku_transactions.fee_tax_breakdown.fee.seller_paylater_handling_fee_amount Metric
The amount charged to the seller as a handling fee for PayLater transactions for the SKU.
sku_transactions.fee_tax_breakdown.fee.sfp_service_fee_amount Metric
The amount of the SFP service fee for the SKU transaction.
sku_transactions.fee_tax_breakdown.fee.transaction_fee_amount Metric
A general fee applied per SKU transaction by the platform.
sku_transactions.fee_tax_breakdown.fee.tsp_commission_amount Metric
The commission amount charged by the TikTok Shop Platform (TSP) for the SKU transaction.
sku_transactions.fee_tax_breakdown.fee.voucher_xtra_service_fee_amount Metric
The amount charged as an extra service fee related to a voucher for the SKU transaction.
sku_transactions.fee_tax_breakdown.tax.anti_dumping_duty_amount Metric
The amount of anti-dumping duty tax applied to the SKU transaction.
sku_transactions.fee_tax_breakdown.tax.customs_clearance_amount Metric
The amount charged for customs clearance services for the SKU.
sku_transactions.fee_tax_breakdown.tax.customs_duty_amount Metric
The amount of customs duty tax applied to the SKU transaction.
sku_transactions.fee_tax_breakdown.tax.gst_amount Metric
The amount charged as Goods and Services Tax (GST) for the SKU.
sku_transactions.fee_tax_breakdown.tax.import_vat_amount Metric
The amount charged as Import Value Added Tax (VAT) for the SKU.
sku_transactions.fee_tax_breakdown.tax.isr_amount Metric
The amount charged as Income Tax Withholding (ISR) for the SKU.
sku_transactions.fee_tax_breakdown.tax.iva_amount Metric
The amount charged as Value Added Tax (IVA) for the SKU.
sku_transactions.fee_tax_breakdown.tax.pit_amount Metric
The amount charged as Personal Income Tax (PIT) for the SKU.
sku_transactions.fee_tax_breakdown.tax.sst_amount Metric
The amount charged as Sales and Service Tax (SST) for the SKU.
sku_transactions.fee_tax_breakdown.tax.vat_amount Metric
The amount charged as Value Added Tax (VAT) for the SKU.
sku_transactions.product_name Dimension
The name of the product associated with a specific SKU transaction.
sku_transactions.quantity Metric
The number of units of the specific SKU included in the transaction.
sku_transactions.revenue_amount Metric
The gross revenue generated from the sale of this specific SKU before deductions for fees or taxes.
sku_transactions.revenue_breakdown.cod_service_fee_amount Metric
The Cash on Delivery (COD) service fee amount contributing to the revenue breakdown for the SKU transaction.
sku_transactions.revenue_breakdown.refund_cod_service_fee_amount Metric
The refunded Cash on Delivery (COD) service fee amount in the revenue breakdown for the SKU transaction.
sku_transactions.revenue_breakdown.refund_subtotal_before_discount_amount Metric
The subtotal amount before discounts that was refunded for the SKU transaction.
sku_transactions.revenue_breakdown.seller_discount_amount Metric
The amount of discount applied by the seller to the SKU price.
sku_transactions.revenue_breakdown.seller_discount_refund_amount Metric
The amount refunded to the customer that was originally covered by a seller-funded discount.
sku_transactions.revenue_breakdown.subtotal_before_discount_amount Metric
The subtotal selling price of the SKU before any discounts are applied.
sku_transactions.settlement_amount Metric
The final net amount settled for this specific SKU transaction after all fees, taxes, and adjustments.
sku_transactions.shipping_cost_amount Metric
The total shipping cost associated with this specific SKU transaction.
sku_transactions.shipping_cost_breakdown.actual_shipping_fee_amount Metric
The actual shipping fee amount incurred for the SKU transaction.
sku_transactions.shipping_cost_breakdown.customer_paid_shipping_fee_amount Metric
The amount paid by the customer for shipping costs.
sku_transactions.shipping_cost_breakdown.exchange_shipping_fee_amount Metric
The shipping fee amount associated with an exchange for the SKU transaction.
sku_transactions.shipping_cost_breakdown.fbt_fulfillment_fee_reimbursement_amount Metric
The reimbursement amount for Fulfillment by TikTok (FBT) fulfillment fees for the SKU transaction.
sku_transactions.shipping_cost_breakdown.replacement_shipping_fee_amount Metric
The shipping fee amount associated with a replacement for the SKU transaction.
sku_transactions.shipping_cost_breakdown.return_shipping_fee_amount Metric
The shipping fee amount associated with a return for the SKU transaction.
sku_transactions.shipping_cost_breakdown.return_shipping_label_fee_amount Metric
The fee charged for the return shipping label for the SKU transaction.
sku_transactions.shipping_cost_breakdown.seller_self_shipping_service_fee_amount Metric
The service fee for sellers who manage and handle their own shipping for orders.
sku_transactions.shipping_cost_breakdown.shipping_fee_discount_amount Metric
The amount discounted from the shipping fee, often covered by platform subsidies or incentives.
sku_transactions.shipping_cost_breakdown.shipping_insurance_fee_amount Metric
The fee charged for shipping insurance to protect against loss or damage during transit.
sku_transactions.shipping_cost_breakdown.signature_confirmation_fee_amount Metric
The fee for signature confirmation service as part of the shipping cost for the SKU transaction.
sku_transactions.shipping_cost_breakdown.supplementary_component Dimension
A composite field containing additional or supplementary components of shipping costs.
sku_transactions.shipping_cost_breakdown.supplementary_component.customer_shipping_fee_offset_amount Metric
An adjustment or offset applied to the customer's shipping fee.
sku_transactions.shipping_cost_breakdown.supplementary_component.fbm_shipping_cost_amount Metric
The Fulfillment by Merchant (FBM) shipping cost amount within the supplementary component for the SKU transaction.
sku_transactions.shipping_cost_breakdown.supplementary_component.fbt_fulfillment_fee_amount Metric
The fee charged for order fulfillment services when the order is fulfilled by TikTok (Fulfilled By TikTok - FBT).
sku_transactions.shipping_cost_breakdown.supplementary_component.fbt_shipping_cost_amount Metric
The shipping cost incurred for orders where TikTok handles the shipping and fulfillment (Fulfilled By TikTok - FBT).
sku_transactions.shipping_cost_breakdown.supplementary_component.platform_shipping_fee_discount_amount Metric
The discount applied to the shipping fee that is funded by the TikTok Shop platform.
sku_transactions.shipping_cost_breakdown.supplementary_component.promo_shipping_incentive_amount Metric
The promotional shipping incentive amount provided within the supplementary component for the SKU transaction.
sku_transactions.shipping_cost_breakdown.supplementary_component.seller_shipping_fee_discount_amount Metric
The discount amount applied to the seller's shipping fee within the supplementary component for the SKU transaction.
sku_transactions.shipping_cost_breakdown.supplementary_component.shipping_fee_subsidy_amount Metric
The amount subsidized by the platform or other entities to reduce the overall shipping fee.
sku_transactions.sku_id Dimension
A unique identifier for a Stock Keeping Unit (SKU), representing a specific variant of a product within an order.
sku_transactions.sku_name Dimension
The name of the Stock Keeping Unit (SKU) for a product variant.
sku_transactions.statement_id Dimension
The unique identifier of the financial statement that includes this SKU transaction.
statement_time Dimension
The Unix timestamp (UTC+00:00) indicating when the financial statement was generated.
statement_time_date Dimension
The date when the financial statement was generated.
status Dimension
The current status of the financial statement, such as 'SETTLED' or 'UNSETTLED'.
total_count Metric
The total number of transactions included within a financial statement.
total_reserve_amount Metric
The total amount reserved, typically for financial statements or transactions.
total_settlement_amount Metric
The total net amount settled for all transactions within a financial statement.
total_settlement_breakdown.total_adjustment_amount Dimension
The total amount of all adjustments applied within a settlement, which can include corrections for shipping fees or other compensations.
total_settlement_breakdown.total_fee_tax_amount Dimension
The aggregate amount of all fees and taxes applied within a financial settlement.
total_settlement_breakdown.total_revenue_amount Dimension
The total revenue amount recorded for a financial settlement.
total_settlement_breakdown.total_shipping_cost_amount Dimension
The total shipping cost amount incurred within a financial settlement.
transactions.adjustment_amount Metric
An amount that represents manual corrections or special case adjustments applied to a transaction.
transactions.adjustment_id Dimension
A unique identifier for a specific adjustment made to a transaction.
transactions.fee_tax_amount Metric
The total amount of fees and taxes applied to a particular transaction.
transactions.fee_tax_breakdown.fee.affiliate_ads_commission_amount Metric
The commission amount incurred for affiliate advertisements related to the transaction.
transactions.fee_tax_breakdown.fee.affiliate_commission_amount Metric
The total commission amount paid to affiliates for the transaction.
transactions.fee_tax_breakdown.fee.affiliate_commission_amount_before_pit Metric
The affiliate commission amount calculated before any deductions for Personal Income Tax (PIT).
transactions.fee_tax_breakdown.fee.affiliate_partner_commission_amount Metric
The commission amount paid to affiliate partners for the transaction.
transactions.fee_tax_breakdown.fee.bonus_cashback_service_fee_amount Metric
The service fee associated with bonus cashback programs in the transaction.
transactions.fee_tax_breakdown.fee.cofunded_creator_bonus_amount Metric
The amount of bonus co-funded by the platform for creators involved in the transaction.
transactions.fee_tax_breakdown.fee.cofunded_promotion_service_fee_amount Metric
The service fee for promotions that are co-funded by the platform for the transaction.
transactions.fee_tax_breakdown.fee.credit_card_handling_fee_amount Metric
The fee charged for processing credit card payments in the transaction.
transactions.fee_tax_breakdown.fee.dynamic_commission_amount Metric
The amount of commission that is dynamically applied based on specific transaction criteria.
transactions.fee_tax_breakdown.fee.external_affiliate_marketing_fee_amount Metric
The fee incurred for external affiliate marketing activities related to the transaction.
transactions.fee_tax_breakdown.fee.fee_per_item_sold_amount Metric
The fee charged for each item sold within the transaction.
transactions.fee_tax_breakdown.fee.flash_sales_service_fee_amount Metric
The service fee incurred for participating in flash sales within the transaction.
transactions.fee_tax_breakdown.fee.live_specials_fee_amount Metric
The fee associated with live special promotions or events for the transaction.
transactions.fee_tax_breakdown.fee.mall_service_fee_amount Metric
The service fee charged for selling products within the platform's shopping mall feature.
transactions.fee_tax_breakdown.fee.platform_commission_amount Metric
The commission charged by the platform for the transaction.
transactions.fee_tax_breakdown.fee.pre_order_service_fee_amount Metric
The service fee specifically for handling pre-order transactions.
transactions.fee_tax_breakdown.fee.referral_fee_amount Metric
The fee paid for customer referrals that led to the transaction.
transactions.fee_tax_breakdown.fee.refund_administration_fee_amount Metric
The administrative fee charged for processing a refund.
transactions.fee_tax_breakdown.fee.seller_paylater_handling_fee_amount Metric
The handling fee associated with the seller's 'PayLater' payment option.
transactions.fee_tax_breakdown.fee.transaction_fee_amount Metric
A general fee applied to the transaction.
transactions.fee_tax_breakdown.tax.anti_dumping_duty_amount Metric
The amount of anti-dumping duty applied to the transaction.
transactions.fee_tax_breakdown.tax.customs_clearance_amount Metric
The amount charged for customs clearance services for the transaction.
transactions.fee_tax_breakdown.tax.customs_duty_amount Metric
The amount of customs duty applied to the transaction.
transactions.fee_tax_breakdown.tax.gst_amount Metric
The amount of Goods and Services Tax (GST) applied to the transaction.
transactions.fee_tax_breakdown.tax.import_vat_amount Metric
The amount of Import Value Added Tax (VAT) applied to the transaction.
transactions.fee_tax_breakdown.tax.iva_amount Metric
The amount of Impuesto sobre el Valor Añadido (IVA), a type of Value Added Tax, applied to the transaction.
transactions.fee_tax_breakdown.tax.pit_amount Metric
The amount of Personal Income Tax (PIT) applied to the transaction.
transactions.fee_tax_breakdown.tax.sst_amount Metric
The amount of Sales and Service Tax (SST) applied to the transaction.
transactions.fee_tax_breakdown.tax.vat_amount Metric
The amount of Value Added Tax (VAT) applied to the transaction.
transactions.id Metric
The unique identifier for an individual transaction within a financial statement.
transactions.order_create_time Dimension
The Unix timestamp (UTC+00:00) indicating when the order associated with the transaction was created.
transactions.order_create_time_date Dimension
The date when the order associated with the transaction was created.
transactions.order_id Dimension
The unique identifier for an order.
transactions.revenue_amount Metric
The total revenue amount for the transaction within a financial statement.
transactions.revenue_breakdown.cod_service_fee_amount Metric
The service fee incurred for Cash on Delivery (COD) transactions.
transactions.revenue_breakdown.refund_cod_service_fee_amount Metric
The refunded amount of the Cash on Delivery (COD) service fee.
transactions.revenue_breakdown.refund_subtotal_before_discount_amount Metric
The refunded subtotal amount of the order before any discounts were applied.
transactions.revenue_breakdown.seller_discount_amount Metric
The total discount amount provided by the seller for the transaction.
transactions.revenue_breakdown.seller_discount_refund_amount Metric
The refunded portion of the seller's discount amount for the transaction.
transactions.revenue_breakdown.subtotal_before_discount_amount Metric
The subtotal amount of the order before any discounts were applied to the transaction.
transactions.settlement_amount Metric
The total settlement amount for the transaction within a financial statement.
transactions.shipping_cost_amount Metric
The total shipping cost amount for the transaction within a financial statement.
transactions.shipping_cost_breakdown.actual_shipping_fee_amount Metric
The actual cost incurred for shipping the order.
transactions.shipping_cost_breakdown.customer_paid_shipping_fee_amount Metric
The amount of shipping fee paid by the customer for the order.
transactions.shipping_cost_breakdown.exchange_shipping_fee_amount Metric
The shipping fee incurred for an exchange order.
transactions.shipping_cost_breakdown.replacement_shipping_fee_amount Metric
The shipping fee incurred for a replacement order.
transactions.shipping_cost_breakdown.return_shipping_fee_amount Metric
The shipping fee incurred when an item is returned.
transactions.shipping_cost_breakdown.return_shipping_label_fee_amount Metric
The fee for the shipping label used for a return.
transactions.shipping_cost_breakdown.seller_self_shipping_service_fee_amount Metric
The service fee associated with the seller managing their own shipping.
transactions.shipping_cost_breakdown.shipping_fee_discount_amount Metric
The discount amount applied to the shipping fee.
transactions.shipping_cost_breakdown.shipping_insurance_fee_amount Metric
The fee charged for shipping insurance.
transactions.shipping_cost_breakdown.signature_confirmation_fee_amount Metric
The fee for requiring a signature upon delivery confirmation.
transactions.shipping_cost_breakdown.supplementary_component Dimension
A collection of additional components that contribute to the overall shipping cost breakdown.
transactions.shipping_cost_breakdown.supplementary_component.customer_shipping_fee_offset_amount Metric
The amount used to offset or reduce the customer's shipping fee.
transactions.shipping_cost_breakdown.supplementary_component.fbm_shipping_cost_amount Metric
The shipping cost incurred for orders fulfilled by the merchant (FBM).
transactions.shipping_cost_breakdown.supplementary_component.fbt_fulfillment_fee_amount Metric
The fulfillment fee for orders handled by Fulfilled by TikTok (FBT).
transactions.shipping_cost_breakdown.supplementary_component.fbt_shipping_cost_amount Metric
The shipping cost for orders handled by Fulfilled by TikTok (FBT).
transactions.shipping_cost_breakdown.supplementary_component.platform_shipping_fee_discount_amount Metric
The discount amount on shipping fees funded by the platform.
transactions.shipping_cost_breakdown.supplementary_component.promo_shipping_incentive_amount Metric
The amount provided as a promotional incentive related to shipping.
transactions.shipping_cost_breakdown.supplementary_component.seller_shipping_fee_discount_amount Metric
The discount amount on shipping fees funded by the seller.
transactions.shipping_cost_breakdown.supplementary_component.shipping_fee_subsidy_amount Metric
The amount of subsidy provided for shipping fees.
transactions.supplementary_component.customer_payment_amount Metric
The total amount paid by the customer for the transaction.
transactions.supplementary_component.customer_refund_amount Metric
The total amount refunded to the customer for the transaction.
transactions.supplementary_component.platform_cofunded_discount_amount Metric
The discount amount co-funded by the platform for the transaction.
transactions.supplementary_component.platform_cofunded_discount_refund_amount Metric
The refunded amount of the platform co-funded discount for the transaction.
transactions.supplementary_component.platform_discount_amount Metric
The discount amount funded solely by the platform for the transaction.
transactions.supplementary_component.platform_discount_refund_amount Metric
The refunded amount of the platform's discount for the transaction.
transactions.supplementary_component.retail_delivery_fee_amount Metric
The amount of the retail delivery fee applied to the transaction.
transactions.supplementary_component.retail_delivery_fee_payment_amount Metric
The amount paid by the customer for the retail delivery fee.
transactions.supplementary_component.retail_delivery_fee_refund_amount Metric
The refunded amount of the retail delivery fee.
transactions.supplementary_component.sales_tax_amount Metric
The total sales tax amount applied to the transaction.
transactions.supplementary_component.sales_tax_payment_amount Metric
The amount paid by the customer for sales tax.
transactions.supplementary_component.sales_tax_refund_amount Metric
The refunded amount of the sales tax.
transactions.supplementary_component.seller_cofunded_discount_amount Metric
The discount amount co-funded by the seller for the transaction.
transactions.supplementary_component.seller_cofunded_discount_refund_amount Metric
The refunded amount of the seller co-funded discount for the transaction.
transactions.type Dimension
The specific type of the transaction, such as 'ORDER' or 'ADJUSTMENT'.