Запрос

Метод

Пример

Комментарий (это примеры. указывайте ваши данные для запроса)

Получить информацию о провайдерах, подключенных к вашему АПИ Ключу

GetProviderInfoList

Пример запроса

Товарный провайдер — это сервис (или площадка) для торговли. Именно от товарного провайдера поступает информация о товарах (названия, настройки, конфигурации и тд) и товарных категориях в АПИ и потом, с помощью ключа, транслируется на сайт владельца АПИ Ключа.

Метод позволяет получить список доступных провайдеров для вашего АПИ Ключа и информацию о них.

Доступные для подключения к АПИ Ключу товарные провайдеры

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

GetRootCategoryInfoList

Пример запроса

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

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

GetCategorySubcategoryInfoList 

Пример запроса

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

BatchSearchItemsFrame

1 провайдер:

Пример запроса

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

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

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

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

BatchSearchItemsFrame

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

Пример запроса

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

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

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

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

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

BatchGetItemFullInfo

Пример запроса

В blockList указываем RootPath

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

Получить до 10 000 товаров за 1 запрос

GetBulkItemsResult

GetBulkSearchItemsResult

RunBulkItems

RunBulkSearchItems

Можно получить до 10 000 товаров по критериям поиска или списку идентификаторов, с полной информацией (описанием, характеристиками, конфигурациями) за 1 запрос с использованием методов BulkOperations (GetBulkItemsResult, GetBulkSearchItemsResult, RunBulkItems, RunBulkSearchItems). Платные вызовы считаются только за успешное получение товаров. Например, загрузили 9000 товаров, заплатили за 9000 вызовов.

⚠️ Методы BulkOperations доступны только после покупки АПИ Ключа. Для подключения обратитесь к менеджеру в группе Telegram.

⚒️ Документация

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

BatchGetItemFullInfo

Пример запроса

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

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

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

BatchGetItemFullInfo

Пример запроса

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

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

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

BatchGetItemFullInfo

Пример запроса

Если у товара нет конфигураций, то в ответе будет один раздел <OtapiConfiguredItem>... </OtapiConfiguredItem>.

Если у товара есть конфигурации, для каждой конфигурации найдётся свой раздел. Ответ будет содержать:

<OtapiConfiguredItem>

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

Например, товар – туфли чёрного и белого цвета, чёрные туфли есть 35,38 и 40 размера, а белые - 36 и 42 размера.  В ответе будет 5 разделов  <OtapiConfiguredItem>... </OtapiConfiguredItem>, внутри каждого - информация о цене и количестве в наличии, а также  <Id>... </Id> - это SKU

В разделе <Attributes> можно найти все атрибуты товара  (это может быть назначение товара, сезон применения,  стиль и другие) и также все конфигурации товара с переводом на выбранный вами язык. 

Pid - идентификатор свойства товара, а VID - значение этого свойства (например, Pid="цвет" Vid="черный").

Получить подборки товаров: популярные, рекомендуемые, последние открытые

SearchRatingListItems

Пример запроса

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

<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 - Популярные товары (создаются и обновляются автоматически)

Best - Рекомендуемые товары (нужно формировать/ и обновлять в админке АПИ Ключа самостоятельно)

Last - Последние открытые товары (создаются и обновляются автоматически)

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

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 указываем ссылку на фото:

<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 запрос

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

⚠️ Поиск по фото - это дополнительный платный модуль. Стоимость - 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 указываем бренд: 

<SearchItemsParameters><ItemTitle>Adidas</ItemTitle></SearchItemsParameters>

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

BatchSearchItemsFrame

Пример запроса 

Имя продавца можно найти тут: https://clip.otcommerce.com/files/21/99/seller.jpg

В xmlParameters указываем имя продавца:

<SearchItemsParameters><VendorId>myczx8</VendorId></SearchItemsParameters>

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

GetVendorInfo

Пример запроса

Имя продавца можно найти тут: https://clip.otcommerce.com/files/21/99/seller.jpg

В vendorId указываем имя продавца.

Рейтинг продавца в нашем АПИ - Level

BatchGetItemFullInfo 

Пример запроса

Имя продавца можно найти тут: https://clip.otcommerce.com/files/21/99/seller.jpg

В blockList указываем имя продавца.

Рейтинг продавца в нашем АПИ - Level

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

BatchGetItemFullInfo

Пример запроса

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

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

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

Поиск 20 товаров провайдера Таобао в категории otc-1, отсортированные по кол-ву отзывов по убыванию

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

<SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId><SearchMethod>Reviews</SearchMethod><OrderBy>ReviewCount:Desc</OrderBy></SearchItemsParameters>

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

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

Поиск 20 товаров провайдера Таобао в категории otc-1, отсортированные по кол-ву отзывов по возрастанию

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

<SearchItemsParameters><Provider>Taobao</Provider><CategoryId>otc-1</CategoryId><SearchMethod>Reviews</SearchMethod><OrderBy>ReviewCount:Asc</OrderBy></SearchItemsParameters>

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

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

Поиск товаров в категории платья с отзывами после покупки

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

<SearchItemsParameters><CategoryId>162104</CategoryId><SearchMethod>Reviews</SearchMethod><Features><Feature Name="PurchasedItemReviews">true</Feature></Features></SearchItemsParameters>

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

Поиск футболок по убыванию количества продаж

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

<SearchItemsParameters><ItemTitle>футболка</ItemTitle><OrderBy>Volume:Desc</OrderBy></SearchItemsParameters>

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

Поиск футболок по возрастанию количества продаж

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

<SearchItemsParameters><ItemTitle>футболка</ItemTitle><OrderBy>Volume:Asc</OrderBy></SearchItemsParameters>

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

Поиск футболок по рейтингу продавца не меньше 19 

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

<SearchItemsParameters><ItemTitle>футболка</ItemTitle><MinVendorRating>19</MinVendorRating></SearchItemsParameters>

ℹ️ Максимальное значение рейтинга продавца у разных провайдеров разное.

Его можно найти в доступных поисковых методах провайдера.

В данном конкретном примере единственный провайдер Таобао и максимальный рейтинг  продавца у этого провайдера 20

Поиск футболок с ограниченной стоимостью: от 10 до 40 юаней

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

<SearchItemsParameters><ItemTitle>футболка</ItemTitle><CurrencyCode>CNY</CurrencyCode><MinPrice>10</MinPrice><MaxPrice>40</MaxPrice></SearchItemsParameters>

В выборку попадают товары со скидочной ценой (PromotionPrice). Валюта (если не передана в явном виде) берётся из витрины (первая валюта) и конвертируется.

Поиск футболок с ценой в долларах (эквивалент) не выше 3

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

<SearchItemsParameters><ItemTitle>футболка</ItemTitle><MaxPrice>3</MaxPrice><CurrencyCode>USD</CurrencyCode></SearchItemsParameters>

Код валюты (CurrencyCode) берём в GetCurrencyInstanceList или в GetInstanceCurrencyInfoList

Поиск футболок с минимальным объёмом продаж 50 штук

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

<SearchItemsParameters><ItemTitle>футболка</ItemTitle><MinVolume>50</MinVolume></SearchItemsParameters>

Поиск футболок с минимальной партией заказа от 5 штук

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

<SearchItemsParameters><Provider>Alibaba1688</Provider><ItemTitle>футболка</ItemTitle><MinFirstLot>5</MinFirstLot></SearchItemsParameters>

ℹ️ Метод доступен только для провайдера 1688

Поиск футболок с максимальной партией заказа 1 штука (аналог заказа в розницу)

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

<SearchItemsParameters><Provider>Alibaba1688</Provider><ItemTitle>футболка</ItemTitle><MaxFirstLot>1</MaxFirstLot></SearchItemsParameters>

Поиск только НОВЫХ футболок

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

<SearchItemsParameters><ItemTitle>футболка</ItemTitle><StuffStatus>New</StuffStatus></SearchItemsParameters>

ℹ️ На данный момент работает 2 состояния: новый (new) и б/у (Second).

Поиск по характеристике: футболка размера XL, красного цвета

• При помощи BatchGetItemFullInfo находим атрибуты для конкретного товара (в примере - id 646674173023) (<Attributes> )

<ItemAttribute Pid="20509" Vid="28317"> (для размера XL)

<ItemAttribute Pid="1627207" Vid="13535612018"> (для цвета “красный”)

• При передаче доп. блока SearchProperties (побробнее про дополнительные блоки)

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

<SearchItemsParameters><ItemTitle>футболка</ItemTitle><Configurators><Configurator Pid="20509" Vid="28317" /><Configurator Pid="1627207" Vid="13535612018" /></Configurators></SearchItemsParameters>

Поиск футболок со скидкой

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

<SearchItemsParameters><ItemTitle>футболка</ItemTitle><Features><Feature Name="Discount">true</Feature></Features></SearchItemsParameters>

Поиск футболок в наличии

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

<SearchItemsParameters><ItemTitle>футболка</ItemTitle><Features><Feature Name="IsStock">true</Feature></Features></SearchItemsParameters>

 Поиск футболок в Tмall

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

<SearchItemsParameters><ItemTitle>футболка</ItemTitle><Features><Feature Name="Tmall">true</Feature></Features></SearchItemsParameters>

ℹ️ Список возможных особенностей (фич) в документации

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

В 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 доступно неограниченное количество языков. Стоимость модуля Мультиязычность

⚒️ Документация