TikTok Shop fields

Early Access15 metrics69 dimensions

Search fields

BUYER

buyer_message

Field label	Buyer message
Description	The note from the buyer
Field type	dimension
Data type	string.text.value

buyer_user_id

Field label	Buyer user ID
Description	Buyer user ID
Field type	dimension
Data type	string.text.value

DATASOURCE

dataSourceName

Field label	Data source
Description	The name of the source for this data, as listed on supermetrics.com/docs
Field type	dimension
Data type	string.text.value
Destinations	API, Data warehouse

system_metadata.data_source_logins

Field label	Data source logins
Description	The data source login accounts that were used to authenticate against the data source
Field type	dimension
Data type	string.text.json

system_metadata.data_source_login_owners

Field label	Data source login owners
Description	The Supermetrics users that created the data source login connections
Field type	dimension
Data type	string.text.json

ORDER

order_id

Field label	Order ID
Description	TikTok Shop order ID
Field type	dimension
Data type	string.text.value

order_status

Field label	Order status
Description	Specific order status
Field type	dimension
Data type	string.text.value

order_currency

Field label	Order currency
Description	Currency for payment
Field type	dimension
Data type	string.currency.code

order_tracking_number

Field label	Order tracking number
Description	Tracking number. Available after the package has been shipped
Field type	dimension
Data type	string.text.value

order_shipping_type

Field label	Order shipping type
Description	Delivery method. Available values: - TIKTOK: Shipping service provided by TikTok. The seller should obtain shipping label from TikTok. - SELLER: Seller provides shipping, including through 3rd party fulfillment providers on behalf of the seller
Field type	dimension
Data type	string.text.value

order_delivery_type

Field label	Order delivery type
Description	Indicates whether it is a Pick-Up Drop-Off (PUDO) location. The PUDO location is selected by the buyer when placing orders. Available values: - HOME_DELIVERY: not a PUDO location - COLLECTION_POINT: a PUDO location
Field type	dimension
Data type	string.text.value

order_delivery_option_name

Field label	Order delivery option name
Description	Delivery option name. For display purposes only. Available values: - Economy Shipping - Standard Shipping - Express Shipping
Field type	dimension
Data type	string.text.value

order_delivery_option_id

Field label	Order delivery option ID
Description	Delivery option ID is mapped to seller configured logistics templates ID
Field type	dimension
Data type	string.text.value

order_fulfillment_type

Field label	Order fulfillment type
Description	Fulfillment type. Only orders with fulfillment type can be shipped by sellers. Available values: FULFILLMENT_BY_SELLER, FULFILLMENT_BY_TIKTOK, FULFILLMENT_BY_DILAYANI_TOKOPEDIA
Field type	dimension
Data type	string.text.value

order_is_on_hold

Field label	Order is on hold
Description	Indicates whether the order has been changed to or will be updated to ON_HOLD status
Field type	dimension
Data type	bool

order_is_replacement

Field label	Order is replacement
Description	Whether this is a replacement order
Field type	dimension
Data type	bool

order_is_sample

Field label	Order is sample
Description	Use this field to determine whether the order is a sample order
Field type	dimension
Data type	bool

order_cancel_reason

Field label	Order cancel reason
Description	The cancellation reason
Field type	dimension
Data type	string.text.value

order_cancellation_initiator

Field label	Order cancellation initiator
Description	Cancellation request initiator. Available values: - SELLER - BUYER - SYSTEM
Field type	dimension
Data type	string.text.value

order_payment_method_name

Field label	Order payment method name
Description	Payment method name, for display purposes
Field type	dimension
Data type	string.text.value

order_warehouse_id

Field label	Order warehouse ID
Description	Seller warehouse ID
Field type	dimension
Data type	string.text.value

original_total_product_price

Field label	Items subtotal (before discounts)
Description	Total original price of the products (VAT included for cross-border shops). For the US market, this is pre-tax total amount
Field type	metric
Data type	float.currency.value

seller_discount

Field label	Items subtotal (seller discount)
Description	Product discount by seller
Field type	metric
Data type	float.currency.value

platform_discount

Field label	Items subtotal (TikTok Shop discount)
Description	Product discount by platform
Field type	metric
Data type	float.currency.value

sub_total

Field label	Items subtotal (after discounts)
Description	Buyer paid sub-total of all the SKUs in the order. Items subtotal = Items subtotal (before discounts) - Items subtotal (seller discount) - Items subtotal (TikTok Shop discount) For the US market, this is pre-tax total amount
Field type	metric
Data type	float.currency.value

original_shipping_fee

Field label	Shipping fee (before discounts)
Description	Shipping fee before discount
Field type	metric
Data type	float.currency.value

shipping_fee_seller_discount

Field label	Shipping fee (seller discount)
Description	Shipping fee discount provided by seller for an order that will not qualify for co-funded reimbursement. Note: If an order meets the minimum order value for co-funded reimbursement, this will be 0. In this case, refer to Shipping fee (co-funded discount) for the shipping discount the buyer received
Field type	metric
Data type	float.currency.value

shipping_fee_cofunded_discount

Field label	Shipping fee (co-funded discount)
Description	Shipping fee discount provided by seller, eligible for co-funded reimbursement upon order delivery, based on Co-Funded Free Shipping program terms. Note: This will be 0 for orders that did not meet minimum order value for co-funded reimbursement. In this case, refer to shipping_fee_seller_discount for the shipping discount the buyer received
Field type	metric
Data type	float.currency.value

shipping_fee_platform_discount

Field label	Shipping fee (TikTok Shop discount)
Description	Shipping fee discount provided by platform
Field type	metric
Data type	float.currency.value

shipping_fee_after_discounts

Field label	Shipping fee (after discounts)
Description	Buyer paid shipping fee. Shipping fee = Shipping fee (before discounts) - Shipping fee (seller discount) - Shipping fee (TikTok Shop discount) For the US market, this is pre-tax total amount
Field type	metric
Data type	float.currency.value

product_tax

Field label	Tax (product)
Description	The tax on the total item price
Field type	metric
Data type	float.currency.value

shipping_fee_tax

Field label	Tax (shipping fee)
Description	The tax on the shipping price
Field type	metric
Data type	float.currency.value

tax

Field label	Tax
Description	Buyer paid total taxes for the order. Applicable to both cross-border shops and the US market
Field type	metric
Data type	float.currency.value

retail_delivery_fee

Field label	Retail delivery fee
Description	Retail delivery fee (RDF). Note: Only available in the US market
Field type	metric
Data type	float.currency.value

total_amount

Field label	Total amount
Description	Buyer paid total payment. Total amount = Items subtotal + Shipping fee + Tax + Retail delivery fee
Field type	metric
Data type	float.currency.value

orders

Field label	Orders
Description	Total number of orders in the search result
Field type	metric
Data type	int.number.value

QUERY

system_metadata.query_date_range_start

Field label	Start date
Description	The start date of the requested query
Field type	dimension
Data type	string.time.date

system_metadata.query_date_range_end

Field label	End date
Description	The end date of the requested query
Field type	dimension
Data type	string.time.date

system_metadata.query_timezone

Field label	Timezone
Description	The timezone that is supplied to the query
Field type	dimension
Data type	string.time.timezone

system_metadata.query_filters

Field label	Filters
Description	All filters used in the query
Field type	dimension
Data type	string.text.json

system_metadata.query_date_start

Field label	Start
Description	When the query was started
Field type	dimension
Data type	string.time.datetime

system_metadata.query_date_end

Field label	End
Description	When the query completed
Field type	dimension
Data type	string.time.datetime

system_metadata.query_duration

Field label	Duration
Description	The duration in seconds of the query
Field type	dimension
Data type	int.duration.seconds

system_metadata.query_accounts

Field label	Accounts
Description	A list of accounts of which the data was pulled from
Field type	dimension
Data type	string.text.json

RECIPIENT

recipient_name

Field label	Recipient name
Description	Recipient name. Data not available under UNPAID and ON_HOLD statuses
Field type	dimension
Data type	string.text.value

recipient_first_name

Field label	Recipient first name
Description	Recipient first name. If the recipient first and last names are not provided separately, this parameter will have the same value as the name parameter. Note: Applicable only for the US, UK, and JP markets. Data not available under UNPAID and ON_HOLD statuses
Field type	dimension
Data type	string.text.value

recipient_last_name

Field label	Recipient last name
Description	Recipient last name. If the recipient first and last names are not provided separately, this parameter will be empty. Note: Applicable only for the US, UK, and JP markets. Data not available under UNPAID and ON_HOLD statuses
Field type	dimension
Data type	string.text.value

recipient_phone_number

Field label	Recipient phone number
Description	Recipient telephone number. Note: If this order uses platform logistics, the phone number will be desensitized. Data not available under UNPAID and ON_HOLD statuses
Field type	dimension
Data type	string.text.phone

recipient_full_address

Field label	Recipient full address
Description	Complete recipient address information. Data not available under UNPAID and ON_HOLD statuses
Field type	dimension
Data type	string.geo.street

recipient_address_line_1

Field label	Recipient address line 1
Description	The first line of the street address. Data not available under UNPAID and ON_HOLD statuses
Field type	dimension
Data type	string.text.value

recipient_address_line_2

Field label	Recipient address line 2
Description	The second line of the street address. Data not available under UNPAID and ON_HOLD statuses
Field type	dimension
Data type	string.text.value

recipient_address_line_3

Field label	Recipient address line 3
Description	The third line of the street address. Usually only for the Brazilian market. Data not available under UNPAID and ON_HOLD statuses
Field type	dimension
Data type	string.text.value

recipient_address_line_4

Field label	Recipient address line 4
Description	The fourth line of the street address. Usually only for the Brazilian market. Data not available under UNPAID and ON_HOLD statuses
Field type	dimension
Data type	string.text.value

recipient_postal_code

Field label	Recipient postal code
Description	The postal code that can be used by seller for shipping. For the US market, this refers to the ZIP Code. Data not available under UNPAID and ON_HOLD statuses
Field type	dimension
Data type	string.geo.zip

recipient_region_code

Field label	Recipient region code
Description	Region code. Data not available under UNPAID and ON_HOLD statuses
Field type	dimension
Data type	string.geo.region

SHOP

seller_name

Field label	Seller name
Description	The seller name you are authorizing the app for
Field type	dimension
Data type	string.text.value

shop_name

Field label	Shop name
Description	The TikTok Shop name
Field type	dimension
Data type	string.text.value

shop_code

Field label	Shop code
Description	The TikTok Shop code, which is also displayed on Seller Center
Field type	dimension
Data type	string.text.value

shop_id

Field label	Shop ID
Description	An internal identifier for the TikTok Shop
Field type	dimension
Data type	string.text.value

shop_region

Field label	Shop region
Description	The region of the shop
Field type	dimension
Data type	string.geo.region

shop_seller_type

Field label	Shop seller type
Description	The type of seller. Possible values: - CROSS_BORDER: Cross border sellers with multiple shops in different countries. - LOCAL: Local sellers with only 1 shop
Field type	dimension
Data type	string.text.value

TIME

today

Field label	Today
Description	Today's date, e.g. 2017-01-31
Field type	dimension
Data type	string.time.date
Destinations	API, Data warehouse

year

Field label	Year
Field type	dimension
Data type	string.time.year

year_of_week

Field label	Year of week (Sun-Sat)
Field type	dimension
Data type	string.time.year

year_of_week_iso

Field label	Year of week (Mon-Sun)
Field type	dimension
Data type	string.time.year

year_month

Field label	Year & month
Field type	dimension
Data type	string.time.yearmonth

month

Field label	Month
Field type	dimension
Data type	string.time.month

year_week

Field label	Year & week (Sun-Sat)
Field type	dimension
Data type	string.time.yearweek

year_week_iso

Field label	Year & week (Mon-Sun)
Field type	dimension
Data type	string.time.yearweekiso

week

Field label	Week (Sun-Sat)
Field type	dimension
Data type	string.time.week

week_iso

Field label	Week (Mon-Sun)
Field type	dimension
Data type	string.time.weekiso

day_of_month

Field label	Day of month
Field type	dimension
Data type	string.time.dayofmonth

day_of_week_name

Field label	Day of week (Sun-Sat)
Field type	dimension
Data type	string.time.dayofweek

day_of_week_name_iso

Field label	Day of week (Mon-Sun)
Field type	dimension
Data type	string.time.dayofweekiso

date

Field label	Date
Field type	dimension
Data type	string.time.date

atom

Field label	Datetime
Field type	dimension
Data type	string.time.datetime

TIMESTAMP

order_created_date

Field label	Order created date
Description	The date that the order was created
Field type	dimension
Data type	string.time.date

order_created_datetime

Field label	Order created datetime
Description	The date and time that the order was created
Field type	dimension
Data type	string.time.datetime

order_updated_date

Field label	Order updated date
Description	Date of order status change
Field type	dimension
Data type	string.time.date

order_updated_datetime

Field label	Order updated datetime
Description	Date and time of order status change
Field type	dimension
Data type	string.time.datetime

order_paid_date

Field label	Order paid date
Description	The date that the order was paid
Field type	dimension
Data type	string.time.date

order_paid_datetime

Field label	Order paid datetime
Description	The date and time that the order was paid
Field type	dimension
Data type	string.time.datetime

order_canceled_date

Field label	Order canceled date
Description	The Date an order's status was updated to CANCELLED
Field type	dimension
Data type	string.time.date

order_canceled_datetime

Field label	Order canceled datetime
Description	The Date and time an order's status was updated to CANCELLED
Field type	dimension
Data type	string.time.datetime