Retrieve a list of global products that meet the specified conditions. Results are sorted by creation time in descending order. This API returns only key product properties. To obtain more details, pass a returned global product ID to the Get Global Product API.
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Query Parameters
Section titled “Query Parameters”The number of results to be returned per page. Valid range: [1-100]
An opaque token used to retrieve the next page of a paginated result set. Retrieve this value from the result of the next_page_token from a previous response. It is not needed for the first page.
Request Body
Section titled “Request Body”object
Filter global products by their status. Possible values:
- PUBLISHED
- UNPUBLISHED
- DRAFT
- DELETED
A Seller SKU used to filter global products. Provide no more than one Seller SKU. The API returns global products that include the specified Seller SKU.
Filter global products to show only those that are created on or after the specified date and time. Unix timestamp in seconds.
Note: The “create_time_ge” and “create_time_le” together constitute the creation time filter condition.
- If “create_time_ge” is filled but “create_time_le” is empty, “create_time_le” will default to the current time.
- If “create_time_le” is filled but “create_time_ge” is empty, “create_time_ge” will default to the earliest shop time.
Filter global products to show only those that are created on or before the specified date and time. Unix timestamp in seconds. Refer to notes in “create_time_ge” for more usage information.
Filter global products to show only those that are updated on or after the specified date and time. Unix timestamp in seconds.
Note: The fields “update_time_ge” and “update_time_le” together define the update time filter condition.
- If “update_time_ge” is filled but “update_time_le” is empty, “update_time_le” will default to the current time.
- If “update_time_le” is filled but “update_time_ge” is empty, “update_time_ge” will default to the earliest shop time.
Filter global products to show only those that are updated on or before the specified date and time. Unix timestamp in seconds.
Refer to notes in update_time_ge for more usage information.
Example
{ "status": "PUBLISHED", "seller_skus": [ "Color-Red-001" ], "create_time_ge": 1694576429, "create_time_le": 1694576429, "update_time_ge": 1694576429, "update_time_le": 1694576429}Responses
Section titled “Responses”Success
object
Status code; 0 means success.
Success or failure message.
Request log ID.
object
An opaque token used to retrieve the next page of a paginated result set. Provide this value in the page_token parameter of your request if the current response does not return all the results.
The total number of global products that meet the query conditions.
The list of global products that meet the query conditions.
object
The global product ID in TikTok Shop.
The product title.
The status of the product. Possible values:
- PUBLISHED
- UNPUBLISHED
- DRAFT
- DELETED
A list of global Stock Keeping Units (SKUs) used to identify distinct variants of the product.
object
The global SKU ID in TikTok Shop. One product can contain multiple SKU IDs.
An internal code/name for managing SKUs, not visible to buyers.
The time when the product is created. Unix timestamp in seconds.
The time when the product is last updated. Unix timestamp in seconds.
Example
{ "code": 0, "data": { "next_page_token": "b2Zmc2V0PTAK", "total_count": 100, "global_products": [ { "id": "1729592969712207008", "title": "Men's Fashion Sports Low Cut Cotton Breathable Ankle Short Boat Invisible Socks", "status": "PUBLISHED", "skus": [ { "id": "1729592969712207012", "seller_sku": "Color-Red-XM001" } ], "create_time": 1694576429, "update_time": 1694576429 } ] }, "message": "Success", "request_id": "202203070749000101890810281E8C70B7"}