stable本次发布有变化全部展示
来自 TikTok Shop 官方资料快照 ·
- 当前资料结构化阅读页
- 固定快照已留存,可追溯
- 官方原文可核对
资料正文
§1 Path: /product/202312/global_products/search
#§2 Method: [POST]
#§3 Function Description
Retrieve a list of global products that meet the specified conditions. This API will only return the key product properties. You can pass a returned global product ID to the Get Global Product API to obtain more details about the product.
§4 Common Parameters
For common parameters, refer to How to call TikTok Shop APIs - Common Parameters
| Properties | Location | Type | Require | Sample | Properties description |
|---|---|---|---|---|---|
| content-type | header | string | Y | application/json | Allowed type: application/json |
§5 Request Query Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| app_key | string | Y | 38abcd | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign | string | Y | 5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp | int | Y | 1623812664 | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| page_size | int | Y | 100 | The number of results to be returned per page. |
| Valid range: [1-100] | ||||
| page_token | string | N | b2Zmc2V0PTAK | 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. |
§6 Request Body Parameters
| Properties | Type | Require | Sample | Properties description |
|---|---|---|---|---|
| status | string | N | PUBLISHED | Filter global products by their status. |
| Possible values: |
- PUBLISHED
- UNPUBLISHED
- DRAFT
- DELETED | seller_skus |[]string |N |["Color-Red-001"] |Filter global products by these seller SKU codes. | create_time_ge |int |N |1694576429 |Filter global products to show only those that are created on or after the specified date and time. Unix timestamp.
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. | create_time_le |int |N |1694576429 |Filter global products to show only those that are created on or before the specified date and time. Unix timestamp. Refer to notes in "create_time_ge" for more usage information. | update_time_ge |int |N |1694576429 |Filter global products to show only those that are updated on or after the specified date and time. Unix timestamp.
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. | update_time_le |int |N |1694576429 |Filter global products to show only those that are updated on or before the specified date and time. Unix timestamp. Refer to notes in
update_time_gefor more usage information. |
§7 Request Sample
Query
https://open-api.tiktokglobalshop.com/product/202312/global_products/search?app_key=123abc&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1625484268&page_size=100&page_token=b2Zmc2V0PTAK
Body
{"status":"PUBLISHED","seller_skus":["Color-Red-001"],"create_time_ge":1694576429,"create_time_le":1694576429,"update_time_ge":1694576429,"update_time_le":1694576429}
§8 Response Parameters
| Properties | Type | Sample | Properties description |
|---|---|---|---|
| code | int | 0 | The success or failure status code returned in API response. |
| message | string | Success | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | 202203070749000101890810281E8C70B7 | Request log |
| data | object | Specific return information | |
| ^next_page_token | string | b2Zmc2V0PTAK | 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. |
| ^total_count | int | 100 | The total number of global products that meet the query conditions. |
| ^global_products | []object | The list of global products that meet the query conditions. | |
| ^^id | string | 1729592969712207008 | The global product ID in TikTok Shop. |
| ^^title | string | Men's Fashion Sports Low Cut Cotton Breathable Ankle Short Boat Invisible Socks | The product title. |
| ^^status | string | PUBLISHED | The status of the product. |
| Possible values: |
- PUBLISHED
- UNPUBLISHED
- DRAFT
- DELETED | ^^skus |[]object | |A list of global Stock Keeping Units (SKUs) used to identify distinct variants of the product. | ^^^id |string |1729592969712207012 |The global SKU ID in TikTok Shop. One product can contain multiple SKU IDs. | ^^^seller_sku |string |Color-Red-XM001 |An internal code/name for managing SKUs, not visible to buyers. | ^^create_time |int |1694576429 |The time when the product is created. Unix timestamp. | ^^update_time |int |1694576429 |The time when the product is last updated. Unix timestamp. |
§9 Response Sample
{"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"}
§10 Error Code
For common error codes, refer to How to call TikTok Shop APIs - Common Error Code
| Code | Message |
|---|---|
| 12019015 | The number of SKU exceed the limit |
| 12019108 | page number is invalid |
| 12019109 | page size is invalid |
| 12019118 | search create time invalid |
| 12019119 | search update time invalid |
| 12052032 | The product does not exist |
| 12052180 | The total number of search results can not exceed 10000. |
| 12052700 | The seller is inactive. |
| 36009003 | Internal error. Please try again. If the issue persists after multiple attempts, please contact platform support. |
| 12052901 | The product in its current status is not available for this operation. Change the product status and try again. |
| 12052910 | Invalid input parameters. Refer to the API documentation for details. |
