Сравнение версий

Ключ

  • Эта строка добавлена.
  • Эта строка удалена.
  • Изменено форматирование.

 

Оглавление

...

Все АПИ методы и основные методы

 ➡️ Все АПИ методы доступны здесь

Image Removed

Instance key - это ваш АПИ Ключ

Secret - секретный ключ, используется для защиты АПИ Ключа (Instance key), если для разработки были привлечены сторонние программисты или кто-то из компании уволился и т.п. Обычно не требуется. Мы можем сгенерировать его для вас в будущем, и подпись и временная метка будут сгенерированы автоматически. Дополнительная информация, если вам нужно использовать секретный ключ http://docs.otapi.net/ru/Documentations/Description/MethodSignature 

Image Added

Основные методы для получения почти всей информации о товарах:

GetRootCategoryInfoList - получение информации о корневых категориях

BatchSearchItemsFrame - поиск по ID категории, продавцу, товару, бренду, слову, фразе, ссылке, фото и другим параметрам (конфигураторам)

BatchGetItemFullInfo - получение информации о продукте с характеристиками

XML и JSON

Для получения ответа в формате XML делаем запрос на http://otapiДля получения ответа в формате XML делаем запрос на http://otapi.net/service/

Для получения ответа в формате JSON делаем запрос на http://otapi.net/service-json/


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

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

Комментарий данные, которые запрашиваете вы

BatchSearchItemsFrame

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

BatchSearchItemsFrame

BatchSearchItemsFrame

1 провайдер:

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

 

GetVendorInfo

Запрос

Метод

Пример

Аргументы и значения (это примеры. указывайте

ваши данные для запроса)

Получить

все категории

инфо о подключенных провайдерах к АПИ Ключу

GetProviderInfoList

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

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

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

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

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

GetRootCategoryInfoList

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

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

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

GetCategorySubcategoryInfoList 

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

В parentCategoryId указываем номер категории

GetRootCategoryInfoList

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

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

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

GetCategorySubcategoryInfoList 

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

📂 

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

BatchSearchItemsFrame

1 провайдер:

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

В 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). в адресной строке последние цифры - это номер категории

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

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

BatchSearchItemsFrame

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

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

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

BatchSearchItemsFrame

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

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

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

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

ℹ️ Провайдер, категорию и количество товаров меняете по вашему запросу

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

BatchGetItemFullInfo

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

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

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

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

📂 Получить список родительских категорий для категории (путь к корню)

BatchSearchItemsFrame

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

В xmlParameters указываем подкатегорию:

<SearchItemsParameters><CategoryId>abb-201967404</CategoryId></SearchItemsParameters>

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

📂 Получить список родительских категорий для товара (путь к корню)

GetItemRootPath

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

В itemId указываем артикул товара

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

BatchGetItemFullInfo

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

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

BatchGetItemFullInfo

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

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

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

Получить 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="черный").

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

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

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

BatchGetSimplifiedItemFullInfo

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

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

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

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.

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

👗 Получить 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

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

BatchGetItemFullInfo

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

В blockList указываем: Promotions

В коде ищем: <Promotions>

👗Получить внутренние отзывы о товаре (от покупателей ОТКоммерс)

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

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

<SearchParameters><ItemId>546425262438</ItemId><Source>Internal</Source></SearchParameters>

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

👗Получить товары в категории с внутренними отзывами (от покупателей ОТКоммерс)


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

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

<SearchItemsParameters><CategoryId>otc-824</CategoryId><SearchMethod>Reviews</SearchMethod></SearchItemsParameters>

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

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

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

<SearchParameters><CategoryId>otc-824<string>CategoryId</string></CategoryId><ProviderType>Taobao</ProviderType></SearchParameters>

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

👗Получить внешние отзывы о товаре (от провайдера)



SearchItemReviews

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

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

<SearchParameters><ItemId>546425262438</ItemId><Source>Provider</Source></SearchParameters>

В коде ищем: <Text>

ℹ️ Модуль Отзывы покупателей не нужен

BatchGetItemFullInfo

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

В blockList указываем: ProviderReviews

В коде ищем блок <ProviderReviews><Content>

ℹ️ Модуль Отзывы покупателей не нужен

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

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 (без пробела)

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

🔍📂🆔 Поиск товаров по номеру категории (ID)



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

🔍📂🆎 Поиск товаров по названию категории (ID)

BatchSearchItemsFrame

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

Прямого поиска товаров по названию категории нет, но если вы укажете название категории или часть названия в xmlParameters и HintCategories в blockList, то помимо прочего поиск отобразит подходящие категории

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

<SearchItemsParameters><ItemTitle>Eletronic components</ItemTitle></SearchItemsParameters>

В blockList указываем: HintCategories

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

BatchGetItemFullInfo

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

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

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

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

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

⚠️

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

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

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

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

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

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

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

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

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

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

BatchSearchItemsFrame



1 провайдер: Пример запроса

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

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


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

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

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

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

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

Стоимость модуля Мультиязычность

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

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

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

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

<SearchItemsParameters><ItemTitle><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

В 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 варианта:
1. Нужно все знаки & внутри ссылки заменить на &amp;. Это делается по правилам стандарта xml, поэтому ссылка должна принять вид

2. Сократить ссылку до https://itemdetail.taobaotmall.com/item.htm?spmid=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=......

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

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

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

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

.

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

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



Для Таобао:

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








 

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

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

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

- по ссылке или Idhttps://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

Для Таобао:

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

 

запроса 1

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

1️⃣ Добавляем

Например, бренд 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/ac02/f508/brandsrusbrandsrus3.jpg). Бренд можно добавить:- из спискаСсылку или ID можно взять на сайтеhttps://open-demo.otcommerce.com/?q=brands (https://clip.otcommerce.com/files/193d/3bcd/brandsrus2brandsrus4.jpg- по ссылке или Id ->https://clip.otcommerce.com/files/02dc/0840/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️⃣ Далее делаем запрос, используя метод

brandsrus5.jpg)

⚠️ Если вы указываете ID бренда, его нужно копировать точно из ссылки (например, ot:34657)

2️⃣ Вызываем  список  уточняющих категорий по конкретному  бренду, чтобы сузить поиск нужных товаров.

В xmlParameters указываем провайдера и бренд:

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

В blockList указываем:HintCategories

В ответе получаем список категорий, выбираем ID категории

3️⃣ Запрашиваем товары по бренду и уточняющей категории. В xmlParameters указываем ID категории, содержащей товары этого бренда и бренд:

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

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

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

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


ℹ️ Бренд в список брендов в админке АПИ Ключа не добавляем.

1️⃣ Вызываем  список  уточняющих категорий по конкретному  бренду, чтобы сузить поиск нужных товаров.

В xmlParameters указываем провайдера и бренд в качестве ключевого слова:

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

В blockList указываем:HintCategories

В ответе получаем список категорий, выбираем ID категории

2️⃣ Запрашиваем товары по бренду и уточняющей категории.

В xmlParameters указываем ID категории, содержащей товары этого бренда и бренд:

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

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>

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

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

Имя продавца можно найти тут: 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. Нужно установить его в админке АПИ Ключа.

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

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

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

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

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

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

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

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

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

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

🔍Поиск товаров с внутренними отзывами (от покупателей ОТКоммерс)

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

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

<SearchParameters><ItemId>546425262438</ItemId><Source>Internal</Source></SearchParameters>

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

🔍Поиск товаров в категории с внутренними отзывами (от покупателей ОТКоммерс)


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

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

<SearchItemsParameters><CategoryId>otc-824</CategoryId><SearchMethod>Reviews</SearchMethod></SearchItemsParameters>

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

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

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

<SearchParameters><CategoryId>otc-824<string>CategoryId</string></CategoryId><ProviderType>Taobao</ProviderType></SearchParameters>

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

🔍Поиск товаров с внешними отзывами (от провайдера)



SearchItemReviews

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

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

<SearchParameters><ItemId>546425262438</ItemId><Source>Provider</Source></SearchParameters>

В коде ищем: <Text>

ℹ️ Модуль Отзывы покупателей не нужен

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

В blockList указываем: ProviderReviews

В коде ищем блок <ProviderReviews><Content>

ℹ️ Модуль Отзывы покупателей не нужен

🔍⭐ Поиск товаров в категории, отсортированные по количеству внутренних отзывов (от покупателей ОТКоммерс) по убыванию

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

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

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

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

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

1

824</CategoryId><SearchMethod>Reviews</SearchMethod><OrderBy>ReviewCount:Desc</OrderBy></SearchItemsParameters>

ℹ️ Только при наличии модуля

«Отзывы покупателей».

Отзывы покупателей

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

🔍⭐ Поиск

20

товаров

провайдера Таобао

в категории

otc-1

, отсортированные по

кол-ву отзывов по 

количеству внутренних отзывов (от покупателей ОТКоммерс) по возрастанию

BatchSearchItemsFrameПример в документациизапроса

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

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

1

824</CategoryId><SearchMethod>Reviews</SearchMethod><OrderBy>ReviewCount:Asc</OrderBy></SearchItemsParameters>

ℹ️ Только при наличии модуля

«Отзывы покупателей»

Отзывы покупателей

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

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

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

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

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

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

Поиск футболок по

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

BatchSearchItemsFrameПример в документациизапроса

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

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

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

🔍🛒 Поиск

футболок

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

BatchSearchItemsFrameПример в документациизапроса

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

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

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

🔍🏆 Поиск

футболок

товаров по рейтингу продавца не меньше

19 

...

BatchSearchItemsFrameПример в документациизапроса

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

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

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

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

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

🔍📏 Поиск

футболок

товаров с ограниченной стоимостью: от

10

.. до

40

.. юаней

BatchSearchItemsFrameПример в документациизапроса

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

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

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

🔍💲 Поиск

футболок

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

3

..

BatchSearchItemsFrameПример в документациизапроса

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

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

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

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

🔍📉🛒 Поиск товаров с минимальным объёмом продаж

50

.. штук

BatchSearchItemsFrameПример в документациизапроса

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

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

🔍 Поиск

футболок

товаров с минимальной партией заказа от

5

.. штук

BatchSearchItemsFrameПример в документациизапроса

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

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

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

🔍 Поиск

футболок

товаров с максимальной партией заказа

1

.. штука (аналог заказа в розницу)

BatchSearchItemsFrameПример в документациизапроса

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

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

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

🔍🆕 Поиск новых товаров



BatchSearchItemsFrame

Пример

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

запроса

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

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

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

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

Или можно отсортировать по UpdatedTime. В xmlParameters указываем:

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

🔍🏷️ Поиск по характеристике:

футболка размера XL, красного цвета

товар, размер, цвет

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

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

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

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

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

🔍🔥 Поиск

футболок

товаров со скидкой

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

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

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

🔍 Поиск TMall товаров 

BatchSearchItemsFrameПример в документациизапроса

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

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

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

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

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

BatchSearchItemsFrameПример в документациизапроса

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

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

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

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

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

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

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

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

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

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

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

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

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

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


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

...

framePosition: 400 (это начало страницы)

frameSize: 200 (например)

Сопоставление условий и возможностей поиска

Описание результатов поиска

Дополнительные блоки информации в BatchSearchItemsFrame