Docs

Query TikTok Shop Products

User Interaction - Products API endpoint

Query Parameters

Key	Type	Description	Example	Required
category	string	The data category for which the analysis is planned. As the scripting language is the same across various data categories, this value will help determine what data to fetch.	tiktok_shop_products	Yes
condition_groups	object	Specifications for what data should be used for querying. The data can be: product_name,shop_id, shop_name	condition_groups = [ { "operator": "and", "conditions": [ { "field": "shop_id", "operator": "eq", "field_values": ["12345678910"] } ] }]	No
fields	string	Data fields to be returned. Interface will only return the fields listed here.	shop_name,product_id,product_sold_count,product_description,product_price,product_review_count,product_name,product_rating_1_count,product_rating_2_count,product_rating_3_count,product_rating_4_count,product_rating_5_count	No
limit	int	The maximum number of records that will be returned. Test Stage The default value is 10. Execution Stage The default value is 100.		No

Query Condition

Key	Type	Description	Required
and	list<Condition>	The `and` conditions specify that all the conditions in the list must be met	No
or	list<Condition>	The `or` conditions specify that at least one of the conditions in the list must be met	No
not	list<Condition>	The `not` conditions specify that none of the conditions in the list must be met	No

Response

Key

Type

Description

Example

result

string

Data fields returned from the query. Interface will only return the fields listed here for products sold in the EU.

shop_name,product_id,product_sold_count,product_description,product_price,product_review_count,product_name,product_rating_1_count,product_rating_2_count,product_rating_3_count,product_rating_4_count,product_rating_5_count

Was this document helpful?