Request

Method

Request example

Comments

Get info on enabled providers for API Key 

GetProviderInfoList

Trade provider is a service (or marketplace) for trading. Information about goods (titles, settings, configuration, etc.) and categories is sent to OT API from trade provider and then is broadcasted to website via OT API Key.

Method allows to get list of available providers for your API Key and information about them.

Available trade providers for API Key connection

Get all categories

GetRootCategoryInfoList

ℹ️ Our API does not allow to get all products in all categories at once. first we request the main (root) categories, then separately request subcategories of second, third, ... level

Get subcategories in category 

GetCategorySubcategoryInfoList 

Get products in category (Search product by category)

BatchSearchItemsFrame

1 provider:

Request example

BatchSearchItemsFrame

Several providers:

Request example

Get parent categories list for category (root path)

BatchSearchItemsFrame

Request example

Get parent categories list for item (root path)

GetItemRootPath

Request example

Get number of goods in category

BatchSearchItemsFrame

Request example

In

code find: <TotalCount>...</TotalCount>

Via website https://open-demo.otcommerce.com

Indicate category number in address bar and get number of products found in search results: https://clip.otcommerce.com/files/4b/7e/totalcounteng.jpg 

Get full product info with characteristics

BatchGetItemFullInfo

For Taobao enter itemID without prefix.

For other providers specify Prefix

Add Description into blockList

if you need product photo, video and description

Get short product info

BatchGetSimplifiedItemFullInfo

Request example

For Taobao enter itemID without prefix.

For other providers specify Prefix

Get product category number 

BatchGetItemFullInfo

Request example

You can get product category ID via website address bar (https://clip.otcommerce.com/files/40/48/category.jpg). The last digits in address bar are category ID

Get up to 10 000 products in 1 request

GetBulkItemsResult

GetBulkSearchItemsResult

RunBulkItems

RunBulkSearchItems

It's possible to get up to 10 000 products by search criteria or a list of identifiers, with full information (descriptions, characteristics, configurations) in 1 request with the use of Bulk methods (GetBulkItemsResult, GetBulkSearchItemsResult, RunBulkItems, RunBulkSearchItems). Paid calls are counted only for successful receipt of goods. For example, 9 000 goods were loaded, 9 000 calls are counted.

⚠️ Methods are available only after API Key purchase. Contact manager in Telegram group to enable.

⚒️ Documentation

Get product SKU and configurations

BatchGetItemFullInfo

If product has no configurations, the response will have one section <OtapiConfiguredItem>... </OtapiConfiguredItem>.

If product has configurations, then the response will have several sections <OtapiConfiguredItem>... </OtapiConfiguredItem>. <Id>...</Id> of the product is its configuration (SKU) and below it are all the product parameters (quantity in stock, price, etc.)

For example, product is black and white shoes, black shoes which are available in sizes 35, 38 and 40, and white ones are available in sizes 36 and 42. Response will have 5 sections <OtapiConfiguredItem>... </OtapiConfiguredItem>, inside each - information about price and quantity in stock, as well as  <Id>... </Id> 

Pid is product identifier property, Vid is value identifier property (for example, Pid="color" Vid="black").

In section <Attributes> you can find all product attributes (this can be product purpose, season, style and others) and also all product configurations with translation into selected language.

Get product collections: popular, best, last

SearchRatingListItems

Request example

In xmlParameters specify:

<RatingListItemSearchParameters><CategoryId>0</CategoryId><ItemRatingType>Popular</ItemRatingType></RatingListItemSearchParameters>

<RatingListItemSearchParameters><CategoryId>0</CategoryId><ItemRatingType>Best</ItemRatingType></RatingListItemSearchParameters>

<RatingListItemSearchParameters><CategoryId>0</CategoryId><ItemRatingType>Last</ItemRatingType></RatingListItemSearchParameters>

Popular - Popular goods (created and updated automatically)

Best - Recomended products (required to create/update in API Key admin panel)

Last - Latest opened products (created and updated automatically)

Get number of sold products in the last 30 days or total

BatchGetItemFullInfo

Find values:

SalesInLast30Days

TotalSales

Get product price with discount

Request example

In

code find: <Promotions>

Get product internal reviews (from OTCommerce customers)

⚠️ Available with "Customers reviews" module only.

Get products in category with internal reviews (from OTCommerce customers)

⚠️ Available with "Customers reviews" module only.

⚠️ Available with "Customers reviews" module only.

Get

product external reviews (from provider)

SearchItemReviews

Request example

In

code find: <Text>

ℹ️ "Customers reviews" module is not required

BatchGetItemFullInfo

Request example

In code find block: <ProviderReviews><Content>

ℹ️ "Customers reviews" module is not required

Get vendor info (location, rating, etc.)

GetVendorInfo

Request example

VendorId can be found via https://

open-demo.otcommerce.com/

. Find vendor via search on the site, then scroll down to "All items of this seller": https://clip.otcommerce.com/files/

76/

c7/

GoodsENG%20%281%29.jpg

Copy vendor ID from browser address bar: https://clip.otcommerce.com/files/5d/cd/VendorENG.jpg

Vendor’s rating in our API is Level

BatchGetItemFullInfo 

Request example

You can find vendor/seller name here https://clip.otcommerce.com/files/21/99/seller.jpg

Vendor’s rating in our API is Level

Get internal (domestic, local) delivery price 

BatchGetItemFullInfo

In

the code search for words InternalDelivery (without a space)

⚠️ It's impossible to get internal shipping charge of a product for a specific address via api. You should set it in admin panel of API Key

Sorting provider products by price descending 

BatchSearchItemsFrame

ℹ️ More about possible sorting methods

Sorting provider products by price ascending 

BatchSearchItemsFrame

ℹ️ More about possible sorting methods

Sorting products by the number of sales in ascending order

In xmlParameters, you must use sorting <OrderBy>Volume:Asc</OrderBy>

<Value Name="SalesInLast30Days">...</Value> parameter returns results in ascending order

Sorting products by the number of sales in descending order

In xmlParameters

, you must use sorting <OrderBy>Volume:Desc</OrderBy>

<Value Name="SalesInLast30Days">...</Value> parameter returns results in descending order

Get enabled languages ​​for API Key

GetLanguageInfoList

⚠️ API Keys K0 Basic, K1 Standard and K2 Advanced include only 1 language. To connect additional language, you need to connect "Multililanguage" module. Unlimited number of languages ​​are available for K3 Enterprise Key. Price of Multilanguage module 

⚒️ Languages and Multilanguage module documentation

Search

Search product by category ID

BatchSearchItemsFrame

1 provider:

Request example

BatchSearchItemsFrame

Several providers:

Request example

Search product by category name

BatchSearchItemsFrame

Request example

There is no direct product search by category name, but if you specify category name or part of it in xmlParameters and HintCategories in blockList, search will display matching categories.

Search product by ID

BatchGetItemFullInfo

For Taobao enter itemID without prefix.

For other providers specify Prefix

Add Description into blockList

if you need product photo, video and description

Search product by word

BatchSearchItemsFrame

1 provider:

Request example

⚠️ Search query can be in any required language. API Keys K0 Basic, K1 Standard and K2 Advanced include only 1 language. To connect additional language, you need to connect paid module "Multilingualism". Price. Unlimited number of languages ​​are available for K3 Enterprise Key.

⚒️ Languages and Multilanguage module documentation

Several providers:

Request example

⚠️ Search query can be in any required language. API Keys K0 Basic, K1 Standard and K2 Advanced include only 1 language. To connect additional language, you need to connect "Multililanguage" module. Unlimited number of languages ​​are available for K3 Enterprise Key. Price of Multilanguage module  

⚒️ Languages and Multilanguage module documentation

Search product by phrase or key words

BatchSearchItemsFrame

1 provider:

Request example

⚠️ Search query can be in any required language. API Keys K0 Basic, K1 Standard and K2 Advanced include only 1 language. To connect additional language, you need to connect "Multililanguage" module. Unlimited number of languages ​​are available for K3 Enterprise Key. Price of Multilanguage module  

⚒️ Languages and Multilanguage module documentation

Several providers:

Request example

⚠️ Search query can be in any required language. API Keys K0 Basic, K1 Standard and K2 Advanced include only 1 language. To connect additional language, you need to connect "Multililanguage" module. Unlimited number of languages ​​are available for K3 Enterprise Key. Price of Multilanguage module  

⚒️ Languages and Multilanguage module documentation

Search product by link

BatchSearchItemsFrame

Request example

You can't copy and paste a product link into a request in this form https://item.taobao.com/item.htm?spm=a21wu.241046-global.4691948847.9.41cab6cb6SlLhG&scm=1007.15423.84311.100200300000001&id=566279369923&pvid=0c5ba9c6-4ad1-4735-b0d3-b30089f3bdb3

There are 2 variants:

1. All & signs inside the link need to be replaced with &amp;. This is done according to XML standard rules, so the link should look like this https://item.taobao.com/item.htm?spm=a21wu.241046-global.4691948847.9.41cab6cb6SlLhG&amp;scm=1007.15423.84311.100200300000001&amp;id=566279369923&amp;pvid=0c5ba9c6-4ad1-4735-b0d3-b30089f3bdb3

2. Shorten the link to https://detail.tmall.com/item.htm?id=......

Search product by photo

BatchSearchItemsFrame

1 provider:

Request example

ℹ️ Link to photo can be any but it must be viewable in any browser

⚠️ Search by photo is an

additional module. it costs 170$ (one-time payment) for each provider

⚒️ Search by photo documentation

Several

providers: 

Request example

ℹ️ Link to photo can be any but it must be viewable in any browser

⚠️ Search by photo is an additional module. it costs 170$ (one-time payment) for each provider

⚒️ Search by photo documentation

Search product by brand

BatchSearchItemsFrame

For Taobao:

Request example

1️⃣ Add brand into brands list in admin panel of API Key:

Catalog –> Collections –> Popular brands (https://clip.otcommerce.com/files/71/3f/brandseng.jpg). You can add brand:

- from list https://clip.otcommerce.com/files/54/91/brandsrus2%20%281%29.jpg 

- by link or ID https://clip.otcommerce.com/files/e7/68/brandseng3.jpg. You can copy link or ID from website https://open-demo.otcommerce.com/?q=brands (https://clip.otcommerce.com/files/3d/cd/brandsrus4.jpg -> https://clip.otcommerce.com/files/dc/40/brandsrus5.jpg)

⚠️ If you specify brand ID, it should be copied exactly from the link (for example, ot:34657)

2️⃣ Make request using BatchSearchItemsFrame method. 

For other providers:

Request example

Don’t add brand to brands list in admin panel of API Key. Make a request as when searching by word, phrase, seller and other filters, using BatchSearchItemsFrame method.

Search product by brand in category 

BatchSearchItemsFrame

For Taobao:

Request example 1

Request example 2

1️⃣ Add brand into brands list in admin panel of API Key:

Catalog –> Collections –> Popular brands (https://clip.otcommerce.com/files/71/3f/brandseng.jpg). You can add brand:

- from list https://clip.otcommerce.com/files/54/91/brandsrus2%20%281%29.jpg 

- by link or ID https://clip.otcommerce.com/files/e7/68/brandseng3.jpg. You can copy link or ID from website https://open-demo.otcommerce.com/?q=brands (https://clip.otcommerce.com/files/3d/cd/brandsrus4.jpg -> https://clip.otcommerce.com/files/dc/40/brandsrus5.jpg)

⚠️ If you specify brand ID, it should be copied exactly from the link (for example, ot:34657)

2️⃣ Call clarifying categories list for specific brand to narrow search for necessary products.

In xmlParameters specify provider and brand:

<SearchItemsParameters><Provider>Taobao</Provider><BrandId>Adidas</BrandId></SearchItemsParameters>

In blockList specify: HintCategories

In response we receive categories list, select category ID

3️⃣ Request products by brand and specifying category.

In xmlParameters specify category ID containing products of this brand and brand:

<SearchItemsParameters><Provider>Taobao</Provider><CategoryId>201566723</CategoryId><BrandId>Adidas</BrandId></SearchItemsParameters> 

For other providers:

Request example 1

Request example 2

Don’t add brand to brands list in admin panel of API Key. 

1️⃣ Call clarifying categories list for specific brand to narrow search for necessary products. 

In xmlParameters specify provider and brand as a keyword: 

<SearchItemsParameters><Provider>Alibaba1688</Provider><ItemTitle>Adidas</ItemTitle></SearchItemsParameters>

In blockList specify: HintCategories

In response we receive categories list, select category ID

2️⃣ Request products by brand and specifying category.

In xmlParameters specify category ID containing products of this brand and brand:

<SearchItemsParameters><CategoryId>abb-10282</CategoryId><ItemTitle>Adidas</ItemTitle></SearchItemsParameters>

Search product/s by vendor/seller 

BatchSearchItemsFrame

Request example

You can find vendor/seller name here: https://clip.otcommerce.com/files

/21/99/seller.jpg

Search product with internal reviews (from OTCommerce customers)

⚠️ Available with "Customers reviews" module only.

Search product in category with internal product reviews (from OTCommerce customers)

⚠️ Available with "Customers reviews" module

only.

⚠️ Available with "Customers reviews" module only.

Search product with external reviews (from provider)

SearchItemReviews

Request example

In

code find: <Text>

ℹ️ "Customers reviews" module is not required

BatchGetItemFullInfo

Request example

In

code find block: <ProviderReviews><Content>

ℹ️ "Customers reviews" module is not required

Search provider products in category sorted by descending internal reviews (from OTCommerce customers

) count

ℹ️ Available with "Customers reviews" module only.

ℹ️ More about available sorting methods

Search provider products in category sorted by ascending internal reviews (from OTCommerce customers) count

⚠️ Available with "Customers reviews" module only.

ℹ️ More about available sorting methods

Search productby descending sales count

BatchSearchItemsFrame

ℹ️ More about available sorting methods

Search product by ascending sales count

BatchSearchItemsFrame

ℹ️ More about available sorting methods

Search product by minimal vendor's rating ...

ℹ️ Maximum seller rating value varies from provider to provider.

It can be found in available search methods of provider.

In this particular example, the only provider is Taobao and maximum seller rating for this provider is 20

Search productby price interval: from ... to

..

. in CNY

Selection includes products with promotion price (PromotionPrice). Currency (if not explicit) gets from administrators panel (first currency from list) and converts.

 Search productby USD equivalent price not exceed ...

Get currency code (CurrencyCode) by using GetCurrencyInstanceList or GetInstanceCurrencyInfoList methods.

Search product with minimal sales count of ...

Search product with minimal first lot ...

ℹ️ Method works only for 1688

 Search productwith maximal first lot ... (equals to retail order)

Search NEW products

We have 2 conditions: New and Second.

Or you can sort by UpdatedTime

Search by attribute: product,  size, color 

Search attributes for selected item by using BatchGetItemFullInfo (example's item - id 646674173023) (<Attributes> )
<ItemAttribute Pid="20509" Vid="28317"> (for XL size)
<ItemAttribute Pid="1627207" Vid="13535612018"> (for "red" colour)

ℹ️ More about additional

information blocks

Search product with discount

Search TMall products

Sort goods in stock