Все АПИ методы и основные методы
➡️ Все АПИ методы доступны здесь
Основные методы для получения почти всей информации о товарах:
GetRootCategoryInfoList - получение информации о корневых категориях
BatchSearchItemsFrame - поиск по ID категории, продавцу, товару, бренду, слову, фразе, ссылке, фото и другим параметрам (конфигураторам)
BatchGetItemFullInfo - получение информации о продукте с характеристиками
XML и JSON
Для получения ответа в формате XML делаем запрос на http://otapi.net/service/
Для получения ответа в формате JSON делаем запрос на http://otapi.net/service-json/
Примеры запросов
Запрос | Метод | Пример | Комментарии |
Получить инфо о подключенных провайдерах к АПИ Ключу | Товарный провайдер — это сервис (или площадка) для торговли. Именно от товарного провайдера поступает информация о товарах (названия, настройки, конфигурации и тд) и товарных категориях в АПИ и потом, с помощью ключа, транслируется на сайт владельца АПИ Ключа. Метод позволяет получить список доступных провайдеров для вашего АПИ Ключа и информацию о них. | ||
Получить все категории | ℹ️ Наше АПИ не позволяет получить все продукты во всех категориях сразу. Сначала запрашиваем главные (корневые) категории, затем по-отдельности запрашиваем подкатегории второго, третьего, … уровня | ||
Получить подкатегории в категории | |||
Получить товары в категории (поиск товаров по категории) | 1 провайдер: | ||
Несколько провайдеров: | |||
Получить список родительских категорий для категории (путь к корню) | |||
Получить список родительских категорий для товара (путь к корню) | |||
Получить количество товаров в категории | В коде находим: <TotalCount>...</TotalCount> | ||
Через сайт https://open-demo.otcommerce.com. | В адресной строке указываем номер категории и в результатах выдачи получаем количество найденных товаров: https://clip.otcommerce.com/files/27/2e/totalcountrus.jpg | ||
Получить полную информацию о товаре с характеристиками | ID товара для Таобао указываем без префикса. Для других провайдеров указываем префикс. Добавляем Description в blockList, если нужно фото, видео и описание товара. | ||
Получить краткую информацию о товаре | ID товара для Таобао указываем без префикса. Для других провайдеров указываем префикс. | ||
Получить номер категории товара | Номер категории также можно найти через адресную строку сайта (https://clip.otcommerce.com/files/40/48/category.jpg). В адресной строке последние цифры - это номер категории | ||
Получить до 10 000 товаров за 1 запрос | Можно получить до 10 000 товаров по критериям поиска или списку идентификаторов, с полной информацией (описанием, характеристиками, конфигурациями) за 1 запрос с использованием методов BulkOperations (GetBulkItemsResult, GetBulkSearchItemsResult, RunBulkItems, RunBulkSearchItems). Платные вызовы считаются только за успешное получение товаров. Например, загрузили 9000 товаров, заплатили за 9000 вызовов. ⚠️ Методы BulkOperations доступны только после покупки АПИ Ключа. Для подключения обратитесь к менеджеру в группе Telegram. ⚒️ Документация | ||
Получить SKU товара и конфигурации | Если у товара нет конфигураций, то в ответе будет один раздел <OtapiConfiguredItem>... </OtapiConfiguredItem>. Если у товара есть конфигурации, то в ответе будет несколько разделов <OtapiConfiguredItem>... </OtapiConfiguredItem>. <Id>...</Id> товара - это его конфигурации (SKU), а ниже все параметры товара (количество в наличии, цена и др.) Pid - идентификатор свойства товара, а Vid - значение этого свойства (например, Pid="цвет" Vid="черный"). Например, товар – туфли чёрного и белого цвета, чёрные туфли есть 35, 38 и 40 размера, а белые - 36 и 42 размера. В ответе будет 5 разделов <OtapiConfiguredItem>... </OtapiConfiguredItem>, внутри каждого - информация о цене и количестве в наличии, а также <Id>... </Id> В разделе <Attributes> можно найти все атрибуты товара (это может быть назначение товара, сезон применения, стиль и другие) и также все конфигурации товара с переводом на выбранный вами язык. | ||
Получить подборки товаров: популярные, рекомендуемые, последние открытые | В 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 дней или всего | В коде находим значения: SalesInLast30Days TotalSales | ||
Получить стоимость товара со скидкой | В коде ищем: <Promotions> | ||
Получить внутренние отзывы о товаре (от покупателей ОТКоммерс) | SearchItemReviews | Пример запроса | ⚠️ Только при наличии модуля Отзывы покупателей |
Получить товары в категории с внутренними отзывами (от покупателей ОТКоммерс) | BatchSearchItemsFrame | Пример запроса | ⚠️ Только при наличии модуля Отзывы покупателей |
| SearchReviewedItems | Пример запроса | ⚠️ Только при наличии модуля Отзывы покупателей | |
Получить внешние отзывы о товаре (от провайдера) | В коде ищем блок: <Text> ℹ️ Модуль Отзывы покупателей не нужен | ||
В коде ищем блок <ProviderReviews><Content> ℹ️ Модуль Отзывы покупателей не нужен | |||
Получить информацию о продавце (местоположение, рейтинг и т.п.) | Имя продавца можно найти тут: https://clip.otcommerce.com/files/21/99/seller.jpg Рейтинг продавца в нашем АПИ - Level | ||
Имя продавца можно найти тут: https://clip.otcommerce.com/files/21/99/seller.jpg Рейтинг продавца в нашем АПИ - Level | |||
Получить стоимость внутренней доставки | В коде ищем: Internaldelivery (без пробела) ⚠️ Невозможно получить стоимость внутренней доставки продукта по определенному адресу через АПИ. Нужно установить его в админке АПИ Ключа | ||
Сортировка товаров провайдера по убыванию цены | BatchSearchItemsFrame | Пример запроса | |
Сортировка товаров провайдера по возрастанию цены | BatchSearchItemsFrame | Пример запроса | |
Получить подключенные языки для АПИ Ключа | ⚠️ В стоимость АПИ Ключей K0 Basic, K1 Standard и K2 Advanced входит только 1 язык. Чтобы подключить дополнительный язык, необходимо подключение модуля Мультиязычность. Для Ключа K3 Enterprise доступно неограниченное количество языков. Стоимость модуля Мультиязычность ⚒️ Документация | ||
Поиск | |||
Поиск товара по номеру категории (ID) | 1 провайдер: | ||
Несколько провайдеров: | |||
Поиск товара по названию категории (ID) | Прямого поиска товаров по названию категории нет, но если вы укажете название категории или часть названия в xmlParameters и HintCategories в blockList, то помимо прочего поиск отобразит подходящие категории | ||
Поиск товара по артикулу (ID) | Добавляем Description в blockList, если нужно фото, видео и описание товара | ||
Поиск товара по слову | ℹ️ Все параметры поиска в документации | 1 провайдер: Пример запроса | ⚠️ Поисковый запрос может быть на любом нужном языке. В стоимость АПИ Ключей K0 Basic, K1 Standard и K2 Advanced входит только 1 язык. Чтобы подключить дополнительный язык, необходимо подключение модуля Мультиязычность. Для Ключа K3 Enterprise доступно неограниченное количество языков. Стоимость модуля Мультиязычность |
Несколько провайдеров: | ⚠️ Поисковый запрос может быть на любом нужном языке. В стоимость АПИ Ключей K0 Basic, K1 Standard и K2 Advanced входит только 1 язык. Чтобы подключить дополнительный язык, необходимо подключение модуля Мультиязычность. Для Ключа K3 Enterprise доступно неограниченное количество языков. Стоимость модуля Мультиязычность ⚒️ Документация | ||
Поиск товара по фразе или ключевым словам | 1 провайдер: Пример запроса | ⚠️ Поисковый запрос может быть на любом нужном языке. В стоимость АПИ Ключей K0 Basic, K1 Standard и K2 Advanced входит только 1 язык. Чтобы подключить дополнительный язык, необходимо подключение модуля Мультиязычность. Для Ключа K3 Enterprise доступно неограниченное количество языков. Стоимость модуля Мультиязычность ⚒️ Документация | |
Несколько провайдеров: | ⚠️ Поисковый запрос может быть на любом нужном языке. В стоимость АПИ Ключей K0 Basic, K1 Standard и K2 Advanced входит только 1 язык. Чтобы подключить дополнительный язык, необходимо подключение модуля Мультиязычность. Для Ключа K3 Enterprise доступно неограниченное количество языков. Стоимость модуля Мультиязычность ⚒️ Документация | ||
Поиск товара по ссылке | Нельзя скопировать и вставить в запрос ссылку на товар в таком виде 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 | ||
Поиск товара по фото | 1 провайдер:
| ℹ️ Ссылка на фото может быть любая, но она должна быть доступна к просмотру в любом браузере ⚠️ Поиск по фото - это дополнительный платный модуль. Стоимость - 170$ (разовый платеж) для каждого провайдера. ⚒️ Документация | |
Несколько провайдеров: | ℹ️ Ссылка на фото может быть любая, но она должна быть доступна к просмотру в любом браузере ⚠️ Поиск по фото - это дополнительный платный модуль. Стоимость - 170$ (разовый платеж) для каждого провайдера. ⚒️ Документация | ||
Поиск товара по бренду | Для Таобао:
| 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. | |
Для других провайдеров: | ℹ️ Бренд в список брендов в админке АПИ Ключа не добавляем. Делаем запрос как при поиске по слову, фразе, продавцу и другим фильтрам, используя метод BatchSearchItemsFrame. | ||
Поиск товара по бренду в категории | Для Таобао: | 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️⃣ Вызываем список уточняющих категорий по конкретному бренду, чтобы сузить поиск нужных товаров. В 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️⃣ Вызываем список уточняющих категорий по конкретному бренду, чтобы сузить поиск нужных товаров. В xmlParameters указываем провайдера и бренд в качестве ключевого слова: <SearchItemsParameters><Provider>Alibaba1688</Provider><ItemTitle>Adidas</ItemTitle></SearchItemsParameters> В blockList указываем: HintCategories В ответе получаем список категорий, выбираем ID категории 2️⃣ Запрашиваем товары по бренду и уточняющей категории. В xmlParameters указываем ID категории, содержащей товары этого бренда и бренд: <SearchItemsParameters><CategoryId>abb-10282</CategoryId><ItemTitle>Adidas</ItemTitle></SearchItemsParameters> | ||
Поиск товара по продавцу | Имя продавца можно найти тут: https://clip.otcommerce.com/files/21/99/seller.jpg | ||
Поиск товара с внутренними отзывами (от покупателей ОТКоммерс) | SearchItemReviews | Пример запроса | ⚠️ Только при наличии модуля Отзывы покупателей |
Поиск товара в категории с внутренними отзывами (от покупателей ОТКоммерс) | BatchSearchItemsFrame | Пример запроса | ⚠️ Только при наличии модуля Отзывы покупателей |
| SearchReviewedItems | Пример запроса | ⚠️ Только при наличии модуля Отзывы покупателей | |
Поиск товара с внешними отзывами (от провайдера) | В коде ищем блок: <Text> ℹ️ Модуль Отзывы покупателей не нужен | ||
| BatchGetItemFullInfo | Пример запроса | В коде ищем блок <ProviderReviews><Content> ℹ️ Модуль Отзывы покупателей не нужен | |
Поиск товара в категории, отсортированные по количеству внутренних отзывов (от покупателей ОТКоммерс) по убыванию | BatchSearchItemsFrame | Пример запроса | ℹ️ Только при наличии модуля Отзывы покупателей |
Поиск товара в категории, отсортированные по количеству внутренних отзывов (от покупателей ОТКоммерс) по возрастанию | BatchSearchItemsFrame | Пример запроса | ℹ️ Только при наличии модуля Отзывы покупателей |
Поиск товара по убыванию количества продаж | BatchSearchItemsFrame | Пример запроса | |
Поиск товара по возрастанию количества продаж | BatchSearchItemsFrame | Пример запроса | |
Поиск товара по рейтингу продавца не меньше ... | BatchSearchItemsFrame | Пример запроса | ℹ️ Максимальное значение рейтинга продавца у разных провайдеров разное. Его можно найти в доступных поисковых методах провайдера. В данном конкретном примере единственный провайдер Таобао и максимальный рейтинг продавца у этого провайдера 20 |
Поиск товара с ограниченной стоимостью: от .. до .. юаней | BatchSearchItemsFrame | Пример запроса | В выборку попадают товары со скидочной ценой (PromotionPrice). Валюта (если не передана в явном виде) берётся из витрины (первая валюта) и конвертируется. |
Поиск товара с ценой в долларах (эквивалент) не выше .. | BatchSearchItemsFrame | Пример запроса | Код валюты (CurrencyCode) берём в GetCurrencyInstanceList или в GetInstanceCurrencyInfoList |
Поиск товара с минимальным объёмом продаж .. штук | BatchSearchItemsFrame | Пример запроса | |
Поиск товара с минимальной партией заказа от .. штук | BatchSearchItemsFrame | Пример запроса | ℹ️ Метод доступен только для провайдера 1688 |
Поиск товара с максимальной партией заказа .. штука (аналог заказа в розницу) | BatchSearchItemsFrame | Пример запроса | |
Поиск новых товаров | BatchSearchItemsFrame | ℹ️ На данный момент работает 2 состояния: новый (new) и б/у (Second) | |
Или можно отсортировать по UpdatedTime | |||
Поиск по характеристике: товар, размер, цвет | BatchSearchItemsFrame | Пример запроса |
<ItemAttribute Pid="20509" Vid="28317"> (для размера XL) <ItemAttribute Pid="1627207" Vid="13535612018"> (для цвета “красный”)
|
Поиск товаров со скидкой | BatchSearchItemsFrame | Пример запроса | |
Поиск TMall товаров | BatchSearchItemsFrame | Пример запроса | ℹ️ Список возможных особенностей (фич) в документации |
Отсортировать товары в наличии | BatchSearchItemsFrame | Пример запроса | |
Максимально можно запросить 200 товаров за 1 запрос:
framePosition - 0 (это начало страницы)
frameSize - 200 (например). это количество товаров на странице. можно запросить максимально 200 товаров за один запрос
Чтобы запросить далее, указываем:
framePosition: 200 (это начало страницы)
frameSize: 200 (например)
Чтобы запросить далее, указываем:
framePosition: 400 (это начало страницы)
frameSize: 200 (например)