POST Search Goods Info
Search Goods Info Shop Required scope: seller.fbt.info This API is used to retrieve a list of goods belonging to the merchant that meet the specified conditions. It returns detailed information about the goods, including their IDs, names, and other attributes, such as the goods-SKU relationship, dimensions, and weight as verified by the warehouse. Version 202409
POST/fbt/202409/goods/search
Request
Header
| Properties | Type | Description |
|---|---|---|
| content-type Required | string | Allowed type: application/json |
| x-tts-access-token Required | string | The seller access_token value from Get Access Token, when user_type = 0. Follow this guide to get seller access_token. |
Query
| Properties | Type | Description |
|---|---|---|
| page_size Required | int | The number of results to be returned per page. Valid range: [1-100]. |
| page_token | string | 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. |
| app_key Required | string | Every single app will have a unique key. Please use the specific key assigned to your app. |
| sign Required | string | Signature generated by gen algorithm. When you send API requests to TTS, you must sign them so that TTS can identify the senders. |
| timestamp Required | string | Unix timestamp GMT (UTC+00:00). This timestamp is used across all API requests. Developers can use this convert to local time. |
| shop_cipher Required | string | Use this property to pass shop information in requesting the API. Failure in passing the correct value when requesting the API for cross-border shops will return incorrect response. Get by API Get Authorization Shop |
Body
| Properties | Type | Description |
|---|---|---|
| goods_ids | []string | Identifier for goods generated by Fulfilled by TikTok system, maximum length 100. Filter the goods information to display only those with specific goods IDs.Note: When goods_ids, reference_codes, sku_ids, or product_ids include two or more values, the result will return the intersection of the goods information. For example, if the input includes both goods_ids and sku_ids, it will return only the goods that meet both the goods_ids and sku_ids criteria. If requested with all criteria empty, it will return a page_size number of goods defined by the merchant, sorted by creation time, with the latest first. |
| product_ids | []string | Identifier for product generated by TikTok Shop system, maximum length 100. Filter the goods information to display only those with specific product IDs. |
| reference_codes | []string | Identifier for goods defined by merchant, maximum length 100. Filter the goods information to display only those with specific reference codes. |
| sku_ids | []string | Identifier for Stock Keeping Unit (SKU) generated by TikTok Shop system, maximum length 100. Filter the goods information to display only those with specific SKU IDs. |
Example
CurlGoNode.jsJavaEnable word wrap
123456789101112131415161718curl-X POST 'https://open-api.tiktokglobalshop.com/fbt/202409/goods/search?shop_cipher=GCP_XF90igAAAABh00qsWgtvOiGFNqyubMt3&page_size=50&page_token=cGFnZV9udW1iZXI9Mg==&app_key=38abcd&sign=5361235029d141222525e303d742f9e38aea052d10896d3197ab9d6233730b8c×tamp=1623812664' -H 'x-tts-access-token: TTP_pwSm2AAAAABmmtFz1xlyKMnwg74T2GJ5s0uQbS8jPjb_GkdFVCxPqzQXSyuyfXdQa0AqyDsea2tYFNVf4XeqgZHFfPyv0Vs659QqyLYfsGzanZ5XZAin3_ZkcIxxS0_In6u6XDeU96k' -H 'content-type: application/json' -d '{ "goods_ids": [ "256080616234" ], "product_ids": [ "256990616123" ], "reference_codes": [ "SELLERSKU 123456" ], "sku_ids": [ "256086568895" ]}'
Response Parameters
| Properties | Type | Description |
|---|---|---|
| code | int | The success or failure status code returned in API response. |
| message | string | The success or failure messages returned in API response. Reasons of failure will be described in the message. |
| request_id | string | Request log |
| data | object | Specific return information |
Example
JSONEnable word wrap
{"code":0,"data":{"next_page_token":"cGFnZV9udW1iZXI9Mg==","total_count":123,"goods":[{"id":"86533997569","name":"water1.0","barcodes":[{"code":"014673829105","type":"UPC"}],"reference_code":"abc32323","image_url":"https://p-boei18n.byted.org/tos-boei18n-i-0euhj0x6u9/beec7f914a044902a0c5dc929b97d064~tplv-k3ldphp9j8-origin-jpeg.jpeg?","merchant_declaration_info":{"weight":{"value":"1.122","unit":"GRAM"},"dimension":{
Error Code
View common error codes
| Code | Message | | --- | --- | | Empty. No business logic error codes. |
Is this content helpful?Helpful
Not Helpful
PreviousNext