Запрос

Метод

Пример

Комментарий

Получить все категории

GetRootCategoryInfoList

Пример в документации

ℹ️ Наше АПИ не позволяет получить все продукты во всех категориях сразу. Сначала запрашиваем главные (корневые) категории, затем по-отдельности запрашиваем подкатегории второго, третьего, … уровня

Получить подкатегории в категории

GetCategorySubcategoryInfoList 

Пример в документации

Получить товары в категории (поиск по категории)

BatchSearchItemsFrame

Пример в документации

В xmlParameters указываем номер категории (например, otc-1):

<SearchItemsParameters><CategoryId>otc-1</CategoryId></SearchItemsParameters> 

Получить номер категории можно 2-мя способами:

1️⃣ по АПИ методом http://docs.otapi.net/ru/Documentations/Method?name=BatchGetItemFullInfo. В blockList параметре указываем RootPath

2️⃣ через сайт (https://clip.otcommerce.com/files/40/48/category.jpg). в адресной строке последние цифры - это номер категории

Получить нужное количество товаров провайдера

BatchSearchItemsFrame

Пример в документации

В xmlParameters указываем провайдера и категорию (например, Таобао и категория otc-1):

<SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId></SearchItemsParameters>

В frameSize указываем необходимое количество товаров (например, 20)

Получить полную информацию о товаре с характеристиками

Поиск товара по артикулу (ID)

BatchGetItemFullInfo

Пример в документации

itemId - указываем ID товара (для Таобао без префикса. для других провайдеров указываем префикс)

blockList - добавляем Description, если нужно фото, видео и описание товара

Получить 20 товаров провайдера Таобао

BatchSearchItemsFrame

Пример в документации

В xmlParameters указываем провайдера и категорию (например, Таобао и категория otc-1):

<SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId> </SearchItemsParameters>

В frameSize указываем 20

Получить SKU товара и конфигурации

BatchGetItemFullInfo

Пример в документации

Если у товара есть конфигурации, ответ будет содержать:

<OtapiConfiguredItem>

<Id>..............</Id> - это SKU

В разделе <Attributes> передаются конфигурации товара. Например:

<ItemAttribute Pid="风格" Vid="日韩">

<PropertyName>Style</PropertyName>

<Value>Japanese and Korean</Value>

<OriginalPropertyName>风格</OriginalPropertyName>

<OriginalValue>日韩</OriginalValue>

<IsConfigurator>false</IsConfigurator>

</ItemAttribute>

Pid - идентификатор свойства товара, а VID - значение этого свойства (например, 

Pid="цвет" Vid="черный").

Получить количество проданных товаров

BatchGetItemFullInfo

Пример в документации

Находим значения:

SalesInLast30Days

TotalSales

Поиск товара по слову

BatchSearchItemsFrame

ℹ️ Все параметры поиска в документации

1 провайдер: Пример в документации

В xmlParameters указываем поисковый запрос (например, платье):

<SearchItemsParameters><ItemTitle>платье</ItemTitle></SearchItemsParameters>

ℹ️ Максимально 200 товаров за 1 запрос

Поисковый запрос может быть на любом нужном языке. ℹ️ В стоимость АПИ Ключей K0 Basic, K1 Standard и K2 Advanced входит только 1 язык. Чтобы подключить дополнительный язык, необходимо подключение платного модуля «Мультиязычность». Цена

ℹ️ Для Ключа K3 Enterprise доступно неограниченное количество языков.

Несколько провайдеров:

Пример в документации

В xmlParameters указываем нужный провайдер и поисковый запрос (например, платье на Таобао): 

<SearchItemsParameters><Provider>Taobao</Provider><ItemTitle>платье</ItemTitle></SearchItemsParameters>

ℹ️ Максимально 200 товаров за 1 запрос

Поисковый запрос может быть на любом нужном языке. ℹ️ В стоимость АПИ Ключей K0 Basic, K1 Standard и K2 Advanced входит только 1 язык. Чтобы подключить дополнительный язык, необходимо подключение платного модуля «Мультиязычность». Цена

ℹ️ Для Ключа K3 Enterprise доступно неограниченное количество языков.

Поиск товара по фразе

BatchSearchItemsFrame

1 провайдер: Пример в документации

В xmlParameters указываем поисковый запрос (например, красное платье):

<SearchItemsParameters><ItemTitle>красное платье</ItemTitle></SearchItemsParameters>

ℹ️ Максимально 200 товаров за 1 запрос

Поисковый запрос может быть на любом нужном языке. ℹ️ В стоимость АПИ Ключей K0 Basic, K1 Standard и K2 Advanced входит только 1 язык. Чтобы подключить дополнительный язык, необходимо подключение платного модуля «Мультиязычность». Цена

ℹ️ Для Ключа K3 Enterprise доступно неограниченное количество языков.

Несколько провайдеров:

Пример в документации

В xmlParameters указываем нужный провайдер и поисковый запрос (например, красное платье на Таобао): 

<SearchItemsParameters><Provider>Taobao</Provider><ItemTitle>красное платье</ItemTitle></SearchItemsParameters>

ℹ️ Максимально 200 товаров за 1 запрос

Поисковый запрос может быть на любом нужном языке. ℹ️ В стоимость АПИ Ключей K0 Basic, K1 Standard и K2 Advanced входит только 1 язык. Чтобы подключить дополнительный язык, необходимо подключение платного модуля «Мультиязычность». Цена

ℹ️ Для Ключа K3 Enterprise доступно неограниченное количество языков.

Поиск товара по ссылке

BatchSearchItemsFrame

Пример в документации

В xmlParameters указываем ссылку:

<SearchItemsParameters><ItemTitle>https://detail.1688.com/offer/530220113667.html</ItemTitle></SearchItemsParameters>

Нельзя скопировать и вставить в запрос ссылку на товар в таком виде 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

Есть 2 варианта:

1. Нужно все знаки & внутри ссылки заменить на &amp;. Это делается по правилам стандарта xml, поэтому ссылка должна принять вид 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. Сократить ссылку до https://detail.tmall.com/item.htm?id=......

Поиск товара по фото

BatchSearchItemsFrame

1 провайдер:

Пример в документации 

В xmlParameters указываем ссылку на фото (например, https://img.alicdn.com/imgextra/i1/529782397/O1CN01qnZeTY1TZs3xAcmOv_!!529782397.jpg):

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

ℹ️ Максимально 200 товаров за 1 запрос

⚠️ Ссылка на фото может быть любая, но она должна быть доступна к просмотру в любом браузере

⚠️ Поиск по фото - это дополнительный платный модуль. Стоимость - 170$ (единоразовая оплата) для каждого провайдера.

Несколько провайдеров:

Пример в документации

В xmlParameters указываем нужный провайдер и ссылку на фото (например, на Таобао): <SearchItemsParameters><Provider>Taobao</Provider><ImageUrl>https://img.alicdn.com/imgextra/i1/529782397/O1CN01qnZeTY1TZs3xAcmOv_!!529782397.jpg</ImageUrl></SearchItemsParameters>

ℹ️ Максимально 200 товаров за 1 запрос

⚠️ Ссылка на фото может быть любая, например https://img.alicdn.com/imgextra/i1/529782397/O1CN01qnZeTY1TZs3xAcmOv_!!529782397.jpg, но она должна быть доступна к просмотру в любом браузере

⚠️ Поиск по фото - это дополнительный платный модуль. Стоимость - 170$ (единоразовая оплата) для каждого провайдера

Поиск по бренду

BatchSearchItemsFrame

Для Таобао:

Пример в документации 

Например, бренд Adidas:

1️⃣ добавляем бренд в список брендов в админке АПИ Ключа:

Каталог –> Подборки –> Популярные бренды (https://clip.otcommerce.com/files/ac/f5/brandsrus.jpg). Бренд можно добавить:

- из списка https://clip.otcommerce.com/files/19/3b/brandsrus2.jpg

- по ссылке или Id https://clip.otcommerce.com/files/02/08/brandsrus3.jpg. Ссылку или ID можно взять на сайте 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 надо брать точно из ссылки (например, ot:34657)

2️⃣ далее делаем запрос, используя метод BatchSearchItemsFrame. В xmlParameters указываем <SearchItemsParameters><BrandId>Adidas</BrandId></SearchItemsParameters>

Для других провайдеров:

Пример в документации

Бренд в список брендов в админке АПИ Ключа не добавляем. Делаем запрос как при поиске по слову, фразе, продавцу и другим фильтрам, используя метод BatchSearchItemsFrame.

в xmlParameters указываем бренд (например, Adidas): <SearchItemsParameters><ItemTitle>Adidas</ItemTitle></SearchItemsParameters>

Поиск по продавцу

BatchSearchItemsFrame

Пример в документации 

В xmlParameters указываем имя продавца (https://clip.otcommerce.com/files/21/99/seller.jpg) 

Получить информацию о продавце (местоположение, рейтинг и т.п.)

GetVendorInfo

или 

BatchGetItemFullInfo 

Пример в документации

Пример в документации

В vendorId указываем имя продавца (https://clip.otcommerce.com/files/21/99/seller.jpg). Рейтинг продавца в нашем АПИ - Level

В blockList указываем имя продавца (https://clip.otcommerce.com/files/21/99/seller.jpg). Рейтинг продавца в нашем АПИ - Level

Получить стоимость внутренней доставки

BatchGetItemFullInfo

Пример в документации

В block list указываем DeliveryCosts

В коде ищем по словам Internaldelivery (без пробела)

ℹ️ Невозможно получить стоимость внутренней доставки продукта по определенному адресу через API. Нужно установить его в админке АПИ Ключа.

Сортировка товаров провайдера по убыванию цены

В xmlParameters указываем провайдера, ID категории и порядок сортировки (например, Таобао, otc-1, по убыванию):

<SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId><OrderBy>Price:Desc</OrderBy></SearchItemsParameters>

Подробнее про возможные способы сортировки

Сортировка товаров провайдера по возрастанию цены

В xmlParameters указываем провайдера, ID категории и порядок сортировки (например, Таобао, otc-1, по возрастанию):

<SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId><OrderBy>Price:Asc</OrderBy></SearchItemsParameters>

Подробнее про возможные способы сортировки

Получить товары провайдера, отсортированные по кол-ву отзывов по убыванию

Только при наличии модуля «Отзывы покупателей».

Подробнее про возможные способы сортировки.

Получить языки для АПИ Ключа

GetLanguageInfoList

Пример в документации

ℹ️ В стоимость АПИ Ключей K0 Basic, K1 Standard и K2 Advanced входит только 1 язык. Чтобы подключить дополнительный язык, необходимо подключение платного модуля «Мультиязычность». Цена

ℹ️ Для Ключа K3 Enterprise доступно неограниченное количество языков.