Item Search - Tabcut Open API

Request

Query Params

itemName

string

optional

Product name

region

string

optional

Country, abbreviated in uppercase English letters. Obtained from the country list interface under metadata.

categoryLv1Id

string

optional

Level 1 category ID. Obtained from the [Get TikTok category list interface].

categoryLv2Id

string

optional

Level 2 category ID. Obtained from the [Get TikTok category list interface].

categoryLv3Id

string

optional

Level 3 category ID. Obtained from the [Get TikTok category list interface].

localPriceBegin

number

optional

Starting value of the price range

localPriceEnd

number

optional

Ending value of the price range

soldCountTotalBegin

integer

optional

Starting value of the sales volume range

soldCountTotalEnd

integer

optional

Ending value of the sales volume range

discoverTimeBegin

string

optional

Starting value of the discovery time range. Format: yyyy-MM-dd HH:mm:ss

discoverTimeEnd

string

optional

Ending value of the discovery time range. Format: yyyy-MM-dd HH:mm:ss

fullManagedFlag

integer

optional

Whether it is a fully managed product. 0: No; 1: Yes

sortField

array[string]

optional

Sorting field. Default: item_sold_count_7d
item_sold_count_7d: 7-day sales volume
item_sold_count_30d: 30-day sales volume
item_rmb_gmv_1d: 1-day GMV
item_rmb_gmv_7d: 7-day GMV
item_rmb_gmv_30d: 30-day GMV
item_sold_growth_rate_1d: 1-day sales volume growth rate
item_sold_growth_rate_7d: 7-day sales volume growth rate
item_sold_growth_rate_30d: 30-day sales volume growth rate
sold_count_total: Total sales volume
local_gmv_total: Total GMV

Example:

[""]

sortOrder

string

optional

Ascending order: asc; Descending order: desc. Default is descending order desc

pageNo

integer

optional

Page number. Default value: 1, maximum 1000

pageSize

integer

optional

Number of items per page. Default value is 10. Minimum: 1; Maximum: 100

Header Params

x-appKey

string

required

Refer【Must-Read】About Signature

Example:

x-timestamp

string

required

Refer【Must-Read】About Signature

Example:

x-sign

string

required

Refer【Must-Read】About Signature

Example:

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request GET 'http://open.tabcut.com:8090/api/item/search?itemName=&region=&categoryLv1Id=&categoryLv2Id=&categoryLv3Id=&localPriceBegin=&localPriceEnd=&soldCountTotalBegin=&soldCountTotalEnd=&discoverTimeBegin=&discoverTimeEnd=&fullManagedFlag=&sortField=&sortOrder=&pageNo=&pageSize=' \
--header 'x-appKey: ' \
--header 'x-timestamp: {{x-timestamp}}' \
--header 'x-sign: {{x-sign}}'

Responses

🟢200Success

application/json

Body

object {0}

Example

{}