Оглавление
...
All API methods and basic methods
➡️ All API methods are available here
Instance key is your API Key
Secret is secret Key used to protect API Key (Instance key) if third-party programmers were involved for development or someone from the company quit, etc. Usually not required. We can generate one for you in future and Signature and timestamp will be automatically generated. Here is more information if you need to use Secret key http://docs.otapi.net/en/Documentations/Description/MethodSignature
The most basic methods to get almost all product information:
GetRootCategoryInfoList - get root categories
BatchSearchItemsFrame - search by сategory Id, item, vendor, brand, word, phrase, link, photo and other parameters (configurators)
BatchGetItemFullInfo - get product info with characteristics
XML and JSON
To get response in XML To get response in XML format send request to http://otapi.net/service/
To get response in JSON format send request to http://otapi.net/service-json/
Examples of requests
Request | Method | Example |
Arguments and values (these are examples. enter your data |
for request) |
Get |
ℹ️ Our API does not allow to get all products in all categories at once. first we request the main (root) categories, then we separately request the subcategories of the second, third, ... level
info on providers for your API Key | Request example | 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. | |
Get all categories | Request example | ℹ️ Our API does not allow to get all products in all categories at once. first we request the main (root) categories, then we separately request the subcategories of the second, third, ... level | |
Get subcategories in category | Request example | In parentCategoryId specify category |
Get subcategories in category
| number | |
Search by category (get products in category) |
1 provider: | In xmlParametersspecify category ID (for example, otc-1): <SearchItemsParameters><CategoryId>otc-1</CategoryId></SearchItemsParameters> |
You can get category ID in 2 ways:
1️⃣ via API using http://docs.otapi.net/en/Documentations/Method?name=BatchGetItemFullInfo method. In blockList parameter specify RootPath
In frameSize specify required number of products (for example, 20). ⚠️ Maximum 200 products per 1 request | |||
Several providers: | In xmlParameters specify provider and category (for example, Taobao and category otc-1): <SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId></SearchItemsParameters> In frameSize specify required number of products (for example, 20). ⚠️ Maximum 200 products per 1 request | ||
Get product category number | In blockList specify RootPath 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 |
In xmlParameters specify provider and category (for example, Taobao and category otc-1):
<SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId></SearchItemsParameters>
In frameSize specify required number of products (for example, 20)
ℹ️ Maximum 200 items per request
Get up to 10 000 products in 1 request
up to 10 000 products in 1 request | 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. | |
Get full product info with characteristics |
| Request example | itemId - enter product ID (for Taobao without prefix. for other providers specify Prefix) blockList - add Description if you need product photo, video and description |
Search product by ID |
| Request example | itemId - enter product ID (for Taobao without prefix. for other providers specify Prefix) blockList - add Description if you need product photo, video and description |
Get product SKU and configurations |
| Request example | If product has no configurations, the response will have one section <OtapiConfiguredItem>... </OtapiConfiguredItem>. If product has configurations, there will be a section for each configuration. Response will contain: <OtapiConfiguredItem> <Id>..............</Id> is the SKU 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> - this is SKU 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. Pid is product identifier property, VID is value identifier property (for example, Pid="color" Vid="black"). |
Get product collections: popular, best, last |
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 items (required to create/update in API Key admin panel) Last - Latest opened items (created and updated automatically) | |
Get number of sold items |
| Request example | Find values: SalesInLast30Days TotalSales |
Search product by word |
All search parameters are in documentation
1 provider: |
Specify in xmlParameters search query (for example, dress): <SearchItemsParameters><ItemTitle>dress</ItemTitle></SearchItemsParameters> |
⚠️ Maximum 200 |
products per 1 request ⚠️ 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. |
Several providers: |
If there are several providers, in xmlParameters specify provider and search query (for example, dress on Taobao): <SearchItemsParameters><Provider>Taobao</Provider><ItemTitle>dress</ItemTitle></SearchItemsParameters> |
⚠️ Maximum 200 |
products per 1 request ⚠️ 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 | ||
Search product by phrase | 1 provider: |
Specify in xmlParameters search query (for example, dress): <SearchItemsParameters><ItemTitle>red dress</ItemTitle></SearchItemsParameters> |
⚠️ Maximum 200 |
products per 1 request ⚠️ 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 |
Several providers: |
If there are several providers, in xmlParameters specify provider and search query (for example, dress on Taobao): <SearchItemsParameters><Provider>Taobao</Provider><ItemTitle>red dress</ItemTitle></SearchItemsParameters> |
⚠️ Maximum 200 |
products per 1 request ⚠️ 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 | |
Search product by link |
In xmlParameters specify link: <SearchItemsParameters><ItemTitle>https://detail.1688.com/offer/530220113667.html</ItemTitle></SearchItemsParameters > 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 | ||
Search product by photo | 1 provider: |
Specify in xmlParameters link to photo: <SearchItemsParameters><ImageUrl>https://img.alicdn.com/imgextra/i1/529782397/O1CN01qnZeTY1TZs3xAcmOv_!!529782397.jpg</ImageUrl></SearchItemsParameters> |
⚠️ Maximum 200 |
products per 1 request ℹ️ 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 |
Several providers: |
Specify in xmlParameters required provider and link to photo (for example, https://img.alicdn.com/imgextra/i1/529782397/O1CN01qnZeTY1TZs3xAcmOv_!!529782397.jpg): <SearchItemsParameters><Provider>Taobao</Provider><ImageUrl>https://img.alicdn.com/imgextra/i1/529782397/O1CN01qnZeTY1TZs3xAcmOv_!!529782397.jpg</ImageUrl></SearchItemsParameters> |
⚠️ Maximum 200 |
products per 1 request ℹ️ 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 product by brand | For Taobao: |
For example, Adidas:
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. In xmlParameters specify brand: <SearchItemsParameters><BrandId>Adidas</BrandId></SearchItemsParameters> | |
For other providers: | 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. In xmlParameters specify brand |
. ⚠️ If you specify brand ID, it should be copied exactly from the link (for example, ot:34657) <SearchItemsParameters><ItemTitle>Adidas</ItemTitle></SearchItemsParameters> |
Search product by |
brand in certain category |
For Taobao: | 1️⃣ Add brand into brands list in admin panel of API Key: Catalog –> Collections –> Popular brands (https:// |
In xmlParameters specify vendor/seller name:
<SearchItemsParameters><VendorId>myczx8</VendorId></SearchItemsParameters>
Get vendor info (location, rating, etc.)
). You can add brand: - from list https://clip.otcommerce.com/files/54/91/brandsrus2%20%281%29.jpg - by link or ID |
Vendor’s rating in our API is Level
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/ |
Get internal delivery price
In blockList specify DeliveryCosts
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
In xmlParameters specify provider, category ID and sorting order (for example, Taobao, otc-1, descending):
<SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId><OrderBy>Price:Desc</OrderBy></SearchItemsParameters>
Sorting provider products by price ascending
In xmlParameters specify provider, category ID and sorting order (for example, Taobao, otc-1, ascending):
<SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId><OrderBy>Price:Asc</OrderBy></SearchItemsParameters>
ℹ️ More about possible sorting methodsIn blockList specify vendor/seller name
Vendor’s rating in our API is Level
⚠️ 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: | 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 ⚠️ If you specify brand ID, it should be copied exactly from the link (for example, ot:34657) 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 by vendor/seller | You can find vendor/seller name here: https://clip.otcommerce.com/files/21/99/seller.jpg In xmlParameters specify vendor/seller name: <SearchItemsParameters><VendorId>myczx8</VendorId></SearchItemsParameters> | ||
Get vendor info (location, rating, etc.) | You can find vendor/seller name here https://clip.otcommerce.com/files/21/99/seller.jpg In vendorId specifyvendor/seller name Vendor’s rating in our API is Level | ||
You can find vendor/seller name here https://clip.otcommerce.com/files/21/99/seller.jpg In blockList specify vendor/seller name Vendor’s rating in our API is Level | |||
Get internal delivery price | Request example | In blockList specify DeliveryCosts 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 |
Search 20 items of Taobao in category otc-1 sorted by descending reviews count | BatchSearchItemsFrame |
| Request example | In xmlParameters specify: <SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId><SearchMethod>Reviews</SearchMethod><OrderBy>ReviewCount:Desc</OrderBy></SearchItemsParameters> ℹ️ Available with "Customers reviews" module only. |
Search 20 items of Taobao in category otc-1 sorted by ascending reviews count | BatchSearchItemsFrame |
| Request example | In xmlParameters specify: <SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId><SearchMethod>Reviews</SearchMethod><OrderBy>ReviewCount:Asc</OrderBy></SearchItemsParameters> ℹ️ Available with "Customers reviews" module only. |
Search 20 items in category dress with reviews after purchase | BatchSearchItemsFrame |
| Request example | In xmlParameters specify: <SearchItemsParameters><CategoryId>162104</CategoryId><SearchMethod>Reviews</SearchMethod><Features><Feature Name="PurchasedItemReviews">true</Feature></Features></SearchItemsParameters> |
Search 20 T-shirts by descending sales count |
| Request example | In xmlParameters specify: <SearchItemsParameters><ItemTitle>T-shirt</ItemTitle><OrderBy>Volume:Desc</OrderBy></SearchItemsParameters> |
Search 20 T-shirts by ascending sales count |
| Request example | In xmlParameters specify: <SearchItemsParameters><ItemTitle>T-shirt</ItemTitle><OrderBy>Volume:Asc</OrderBy></SearchItemsParameters> |
Search T-shirts by minimal vendor's rating 19 | BatchSearchItemsFrame |
| Request example | In xmlParameters specify: <SearchItemsParameters><ItemTitle>T-shirt</ItemTitle><MinVendorRating>19</MinVendorRating></SearchItemsParameters> ℹ️ 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 T-shirts by price interval: from 10 to 40 yuan | BatchSearchItemsFrame |
| Request example | In xmlParameters specify: <SearchItemsParameters><ItemTitle>T-shirt</ItemTitle><CurrencyCode>CNY</CurrencyCode><MinPrice>10</MinPrice><MaxPrice>40</MaxPrice></SearchItemsParameters> Selection includes items with promotion price (PromotionPrice). Currency (if not explicit) gets from administrators panel (first currency from list) and converts. |
Search T-shirts by USD equivalent price not exceed 3 | BatchSearchItemsFrame |
| Request example | In xmlParameters specify: <SearchItemsParameters><ItemTitle>T-shirt</ItemTitle><MaxPrice>3</MaxPrice><CurrencyCode>USD</CurrencyCode></SearchItemsParameters> Get currency code (CurrencyCode) by using GetCurrencyInstanceList or GetInstanceCurrencyInfoList methods. |
Search T-shirts with minimal sales count of 50 | BatchSearchItemsFrame |
| Request example | In xmlParameters specify: <SearchItemsParameters><ItemTitle>T-shirt</ItemTitle><MinVolume>50</MinVolume></SearchItemsParameters> |
Search T-shirts with minimal first lot 5 | BatchSearchItemsFrame |
| Request example | In xmlParameters specify: <SearchItemsParameters><Provider>Alibaba1688</Provider><ItemTitle>T-shirt</ItemTitle><MinFirstLot>5</MinFirstLot></SearchItemsParameters> ℹ️ Method works only for 1688 |
Search T-shirts with maximal first lot 1 (equals to retail order) | BatchSearchItemsFrame |
| Request example | In xmlParameters specify: <SearchItemsParameters><Provider>Alibaba1688</Provider><ItemTitle>T-shirt</ItemTitle><MaxFirstLot>1</MaxFirstLot></SearchItemsParameters> |
Search NEW T-shirts | BatchSearchItemsFrame |
| Request example | In xmlParameters specify: <SearchItemsParameters><ItemTitle>T-shirt</ItemTitle><StuffStatus>New</StuffStatus></SearchItemsParameters> We have 2 conditions: New and Second. |
Search by attribute: red coloured XL size T-shirt | BatchSearchItemsFrame |
| Request example | Search attributes for selected item by using BatchGetItemFullInfo (example's item - id 646674173023) (<Attributes> ) ℹ️ More about additional information blocks In xmlParameters specify: <SearchItemsParameters><ItemTitle>T-shirt</ItemTitle><Configurators><Configurator Pid="20509" Vid="28317" /><Configurator Pid=" |
1627207" Vid="13535612018" /></Configurators></SearchItemsParameters> | |||
Search T-shirts with discount | BatchSearchItemsFrame | Request example | In xmlParameters specify: <SearchItemsParameters><ItemTitle>T-shirt</ItemTitle><Features><Feature Name="Discount">true</Feature></Features>< |
/SearchItemsParameters> |
Search TMall T-shirts |
| BatchSearchItemsFrame |
| Request example | In xmlParameters specify: <SearchItemsParameters><ItemTitle>T-shirt</ItemTitle><Features><Feature Name=" |
Tmall">true</Feature></Features></SearchItemsParameters> |
Sorting provider products by price descending |
| Request example | In xmlParameters specify |
<SearchItemsParameters><ItemTitle>T-shirt</ItemTitle><Features><Feature Name="IsStock">true</Feature></Features></SearchItemsParameters>
Search TMall T-shirts
In xmlParameters specify:
<SearchItemsParameters><ItemTitle>T-shirt</ItemTitle><Features><Feature Name="Tmall">true</Feature></Features></SearchItemsParameters>
provider, category ID and sorting order (for example, Taobao, otc-1, descending): <SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId><OrderBy>Price:Desc</OrderBy></SearchItemsParameters> | |||
Sorting provider products by price ascending | Request example | In xmlParameters specify provider, category ID and sorting order (for example, Taobao, otc-1, ascending): <SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId><OrderBy>Price:Asc</OrderBy></SearchItemsParameters> |
Get available languages for API Key |
| Request example | ⚠️ 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 |
It's possible to request maximum 200 products in one request
...
frameSize: 200 (for example)