Вы просматриваете старую версию данной страницы. Смотрите текущую версию.

Сравнить с текущим просмотр истории страницы

« Предыдущий Версия 29 Следующий »


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 

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/

Request

Method

Example

Comment

Get all categories

GetRootCategoryInfoList

Documentation 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 

GetCategorySubcategoryInfoList 

Documentation example

Search by category (get products in category)

BatchSearchItemsFrame

Documentation example

In xmlParameters specify 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

2️⃣ via website (https://clip.otcommerce.com/files/40/48/category.jpg). in address bar the last digits are category ID

Get certain number of goods from provider

BatchSearchItemsFrame

Documentation example

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)

Get full product info with characteristics

Search product by ID

BatchGetItemFullInfo

Documentation example

Enter product ID in itemId (for Taobao without prefix. for other providers specify Prefix)

Add Description into blockList if you need a photo, video and description of the product

Get product SKU and configurations

BatchGetItemFullInfo

Documentation example

Get number of sold items

BatchGetItemFullInfo

Documentation example

Find values:

SalesInLast30Days

TotalSales

Search product by parameters (ID, word, phrase, seller and other)

BatchSearchItemsFrame

All search parameters are in documentation

1 provider: Documentation example

Specify in xmlParameters search query (for example, dress):

<SearchItemsParameters><ItemTitle>dress</ItemTitle></SearchItemsParameters>

ℹ️ Maximum 200 items per request

Several providers:

Documentation example

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 items per request

Search product by  phrase


BatchSearchItemsFrame

1 provider: Documentation example

Specify in xmlParameters search query (for example, dress):

<SearchItemsParameters><ItemTitle>red dress</ItemTitle></SearchItemsParameters>

ℹ️ Maximum 200 items per request

Several providers:

Documentation example

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 items per request

Search by photo

BatchSearchItemsFrame

1 provider:

Documentation example

Specify in xmlParameters link to photo (for example, https://img.alicdn.com/imgextra/i1/529782397/O1CN01qnZeTY1TZs3xAcmOv_!!529782397.jpg):

<SearchItemsParameters><ImageUrl>https://img.alicdn.com/imgextra/i1/529782397/O1CN01qnZeTY1TZs3xAcmOv_!!529782397.jpg</ImageUrl></SearchItemsParameters>

ℹ️ Maximum 200 items per 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: 

Documentation example

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 items per 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 by brand

BatchSearchItemsFrame

For Taobao:

Documentation example

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)

ℹ️ ID should be copied exactly from the link (for example, ot:34657)

2️⃣ then make request using BatchSearchItemsFrame method. In xmlParameters specify <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 (for example, Adidas): <SearchItemsParameters><ItemTitle>Adidas</ItemTitle></SearchItemsParameters>

Search by vendor/seller

BatchSearchItemsFrame

Documentation example

In xmlParameters specify vendor/seller name (https://clip.otcommerce.com/files/21/99/seller.jpg)

Get vendor info (location, rating, etc.)

GetVendorInfo

or

BatchGetItemFullInfo 

Documentation example

Documentation example

In vendorId specify vendor/seller name (https://clip.otcommerce.com/files/21/99/seller.jpg). Vendor’s rating in our API is Level


In blockList specify vendor/seller name
(https://clip.otcommerce.com/files/21/99/seller.jpg). Vendor’s rating in our API is Level

Get internal delivery price

BatchGetItemFullInfo

Documentation 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

Sorting provider products by price descending

BatchSearchItemsFrame

Documentation example

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>

More about possible sorting methods

Sorting provider products by price ascending


BatchSearchItemsFrame

Documentation 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>

More about possible sorting methods

Get available languages ​​for API Key

GetLanguageInfoList

Documentation example

ℹ️ 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.





framePosition - 0 (this is the beginning of the page)

frameSize - maximum 200. this is the number of products on the page. you can request a maximum of 200 products in one request


To request further, specify:

framePosition: 200 (this is the beginning of the page)

frameSize: 200 (for example)

To request further, specify:

framePosition: 400 (this is the beginning of the page)

frameSize: 200 (for example)

  • Нет меток