YMContent package

Submodules

YMContent.objects module

class YMContent.objects.YMAddress(data)

Bases: YMContent.objects.YMBase

block
Returns:Корпус
Return type:str or None
country
Returns:Наименование страны
Return type:str or None
distance
Returns:Расстояние
Return type:float or None
entrance
Returns:Подъезд
Return type:str or None
estate
Returns:Владение
Return type:str or None
floor
Returns:Этаж
Return type:str or None
fullAddress
Returns:Полный адрес
Return type:str
latitude
Returns:Широта
Return type:float
locality
Returns:Наименование города, поселка, деревни и тд
Return type:str
longitude
Returns:Долгота
Return type:float
note
Returns:Примечание
Return type:str or None
postcode
Returns:Почтовый индекс
Return type:str or None
premiseNumber
Returns:Номер дома, строение, участка и тд
Return type:str or None
region
Returns:Наименование региона
Return type:str or None
regionId
Returns:Идентификатор региона, к которому относится данный адрес
Return type:int
room
Returns:Комната, офис
Return type:str or None
subLocality
Returns:Наименование района
Return type:str or None
subRegion
Returns:Район внутри области
Return type:str or None
thoroughfare
Returns:Улица, проспект, км шоссе и тд
Return type:str
type
Returns:Тип региона, к которому относится данный адрес
Return type:str or None
wing
Returns:Строение
Return type:str or None
class YMContent.objects.YMBase(data)

Bases: object

json()
Returns:Объект в виде JSON
Return type:dict
class YMContent.objects.YMCategory(data)

Bases: YMContent.objects.YMBase

Категория

adult
Returns:Признак категории, имеющей возрастное ограничение (18+)
Return type:bool

False

advertisingModel
Returns:Тип размещения товарных предложений в категории
Return type:str or None
  • CPA — плата за заказы, оформленные прямо на Яндекс.Маркете
  • CPC — плата только за клики по предложению магазина
  • HYBRID — возможны оба варианта размещения товарных предложений в категории
childCount
Returns:Количество дочерних категорий
Return type:int

12

fullName
Returns:Полное наименование категории
Return type:str or None

Товары для авто- и мототехники

id
Returns:Идентификатор категории
Return type:int

90402

Returns:Ссылка на карточку категории на Яндекс.Маркете
Return type:str or None

https://market.yandex.ru/catalog/90402/list?hid=90402&onstock=1&pp=1001

modelCount
Returns:Количество моделей в категории
Return type:int or None

181170

name
Returns:Наименование категории
Return type:str

Авто

offerCount
Returns:Количество товарных предложений в категории
Return type:int or None

3531718

parent
Returns:Идентификатор родительской категории
Return type:int or None

90401

viewType
Returns:Тип отображения товаров в категории
Return type:str or None
  • LIST — список
  • GRID — сетка
warnings
Returns:Предупреждения, связанные с категорией
Return type:list[YMWarning]
class YMContent.objects.YMCriteria(data)

Bases: YMContent.objects.YMBase

id
Returns:Идентификатор фильтра
Return type:str
text
Returns:Текст поисковой фразы
Return type:str or None
value
Returns:Значение фильтра
Return type:str
class YMContent.objects.YMDatasource(data)

Bases: YMContent.objects.YMBase

criteria
Returns:Список условий фильтрации моделей и товарных предложений источника
Return type:list[YMDatasourceCriteria]
hid
Returns:Идентификатор категории
Return type:int

91491

how
Returns:Направление сортировки
Return type:str or None
  • ASC — по возрастанию;
  • DESC — по убыванию.
nid
Returns:Идентификатор узла навигационного дерева
Return type:int

54726

sort
Returns:Вариант/параметр, по которому осуществляется сортировка
Return type:str or None
  • POPULARITY — По популярности
  • PRICE — По цене
  • DATE — Сначала новые
  • RELEVANCE — По релевантности
  • RATING — По рейтингу и цене
  • DISTANCE — По удаленности
  • DISCOUNT — По скидке (сортировка работает только по убыванию)
  • QUALITY — По рейтингу
  • OPINIONS — По отзывам
  • DELIVERY_TIME — По времени доставки
type
Returns:Тип источника данных
Return type:str
class YMContent.objects.YMDatasourceCriteria(data)

Bases: YMContent.objects.YMBase

id
Returns:Идентификатор фильтра
Return type:str
text
Returns:Текст поисковой фразы
Return type:str
value
Returns:Значение фильтра
Return type:str
class YMContent.objects.YMDelivery(data)

Bases: YMContent.objects.YMBase

alternatePrice
Returns:Стоимость доставки в альтернативной или неденоминированной валюте
Return type:YMShopPrice
brief
Returns:Краткое описание условий доставки
Return type:str
carried
Returns:Признак наличия доставки
Return type:bool
deliveryIncluded
Returns:Признак, что цена доставки включена в стоимость товара
Return type:bool
description
Returns:Описание условий доставки
Return type:str or None
downloadable
Returns:Признак, что товар можно скачать
Return type:bool
free
Returns:Признак бесплатной доставки
Return type:bool
inStock
Returns:Признак наличия товара
Return type:bool
is_global
Returns:Признак трансграничной доставки
Return type:bool
localDelivery
Returns:Признак локальной доставки
Return type:bool
localStore
Returns:Признак наличия торгового зала в регионе пользователя
Return type:bool
options
Returns:Информация о службах доставки, с которыми сотрудничает магазин
Return type:list[YMDeliveryOption]
pickup
Returns:Признак возможности самовывоза заказа
Return type:bool
pickupOptions
Returns:Информация об условиях самовывоза
Return type:list[YMDeliveryPickupOption]
price
Returns:Стоимость доставки в валюте заказа
Return type:YMShopPrice
shopRegion
Returns:Свой регион магазина
Return type:YMRegion
userRegion
Returns:Регион пользователя
Return type:YMRegion
class YMContent.objects.YMDeliveryOption(data)

Bases: YMContent.objects.YMBase

brief
Returns:Краткое описание условий доставки
Return type:str
conditions
Returns:Информация об условиях доставки
Return type:YMDeliveryOptionConditions
service
Returns:Информация о службе доставки
Return type:YMDeliveryOptionService
class YMContent.objects.YMDeliveryOptionConditions(data)

Bases: YMContent.objects.YMBase

alternatePrice
Returns:Стоимость доставки в альтернативной валюте
Return type:YMShopPrice
daysFrom
Returns:Определяет начало периода (день недели), в котором возможна доставка
Return type:int
daysTo
Returns:Определяет окончание периода (день недели), в котором возможна доставка
Return type:int
deliveryIncluded
Returns:Признак, что стоимость доставки включена в стоимость товарного предложения. Отсутствие свойства в ввыдаче равнозначно значению false.
Return type:bool
orderBefore
Returns:Время, до которого нужно сделать заказ в часовом поясе пользователя. Возможные значения - от 0 до 23. Отсутствие параметра - заказ можно делать в любое время
Return type:int
price
Returns:Стоимость доставки в основной валюте
Return type:YMShopPrice
class YMContent.objects.YMDeliveryOptionService(data)

Bases: YMContent.objects.YMBase

id
Returns:Идентификатор службы доставки
Return type:int
name
Returns:Наименование службы доставки
Return type:str
class YMContent.objects.YMDeliveryPickupOption(data)

Bases: YMContent.objects.YMBase

brief
Returns:Краткое описание условий доставки
Return type:str
conditions
Returns:Информация об условиях доставки
Return type:YMDeliveryOptionConditions
outletCount
Returns:Количество пунктов выдачи и торговых залов, в которых можно забрать заказ
Return type:int
service
Returns:Информация о службе доставки
Return type:YMDeliveryOptionService
class YMContent.objects.YMFacts(data)

Bases: YMContent.objects.YMBase

contra
Returns:Недостатки
Return type:list[str]
pro
Returns:Достоинства
Return type:list[str]
class YMContent.objects.YMFilter(data)

Bases: YMContent.objects.YMBase

Фильтр

defaultUnit
Returns:Код единиц измерения значений фильтра, используемых по умолчанию
Return type:str or None
description
Returns:Описание фильтра
Return type:str or None
id
Returns:Идентификатор фильтра
Return type:str

-2

max
Returns:Максимальное значение числового фильтра
Return type:str or None
min
Returns:Минимальное значение числового фильтра
Return type:str or None
name
Returns:Наименование фильтра
Return type:str

Гарантия производителя

precision
Returns:Количество знаков поле запятой у значений фильтра
Return type:int or None
type
Returns:Тип фильтра
Return type:str
  • BOOLEAN — логический тип
  • NUMBER — числовой тип, задает диапазон допустимых значений
  • ENUM — тип перечисление, задает список допустимых значений, множественный выбор
  • COLOR — фильтр по цвету, аналогичен ENUM, значения фильтра дополнительно содержат HEX-код соответствующего цвета
  • SIZE — фильтр по размеру, аналогичен ENUM, значения фильтра дополнительно содержат код единиц измерения
  • RADIO — аналогичен ENUM, но допускает выбор только одного значения
  • TEXT — тип фильтра для фильтрации по поисковой фразе
  • PHOTO_PICKER
unit
Returns:Единицы измерения значений фильтра
Return type:str or None
value
Returns:Выбранное значение числового фильтра
Return type:str or None
values
Returns:Список значений фильтра
Return type:list[YMFilterValue]
class YMContent.objects.YMFilterValue(data)

Bases: YMContent.objects.YMBase

checked
Returns:Признак того, что значение выбрано в соответствии с текущими условиями фильтрации
Return type:bool or None
color

Note

Только для фильтров типов COLOR и Filters.FilterType#PHOTO_PICKER

Returns:Значение цвета
Return type:str or None
found
Returns:Количество моделей/офферов в выдаче, попадающих под значение фильтра, при текущих условиях фильтрации
Return type:int or None

56

id
Returns:Идентификатор значения фильтра, используется для установки значения фильтра
Return type:str

12612583

initialFound
Returns:Количество моделей/офферов в выдаче, попадающих под значение фильтра, при отсутствии других фильтров
Return type:int or None

56

name
Returns:Текстовое описание значение фильтра
Return type:str

AGV

photo

Note

Только для фильтра типа Filters.FilterType#PHOTO_PICKER

Returns:Ссылку на картинку для выбора цвета
Return type:str or None
sku
Returns:id sku на который переключимся, если проставим это значение в фильтр (карта фильтров)
Return type:str or None
unitId

Note

Только для фильтра типа SIZE

Returns:Код единицы измерения размера значения фильтра
Return type:str or None
class YMContent.objects.YMIcon(data)

Bases: YMContent.objects.YMBase

url
Returns:Ссылка на изображение
Return type:str
class YMContent.objects.YMModel(data)

Bases: YMContent.objects.YMBase

aliases
Returns:
Return type:str or None
alternatePrice
Returns:Информация о цене модели в альтернативной валюте запроса
Return type:YMPrice
barcode
Returns:Штрих-код модели
Return type:str or None
category
Returns:Информация о категории, к которой относится модель
Return type:YMCategory
description
Returns:Описание модели
Return type:str

GSM, LTE-A, смартфон, iOS 11, вес 174 г, ШхВхТ 70.9x143.6x7.7 мм, экран 5.8”, 2436x1125, Bluetooth, NFC, Wi-Fi, GPS, ГЛОНАСС, фотокамера 12 МП, память 256 Гб

facts
Returns:Факты о модели
Return type:YMFacts
filters
Returns:Список фильтров, предназначенных для фильтрации моделей/модификаций
Return type:list[YMFilter]
id
Returns:Идентификатор модели
Return type:int

1732210983

isNew
Returns:Признак “новизны” товара
Return type:bool

False

kind
Returns:Тип товара
Return type:str or None

автомагнитола

lastUpdate
Returns:Дата-время последнего обновления модели в спсике стравнения
Return type:int or None
Returns:Ссылка на карточку модели
Return type:str

https://market.yandex.ru/product/1732210983?hid=91491&pp=1001

modificationCount
Returns:Количество модификаций групповой модели. Поле отсутствует в выдаче, если модель не групповая
Return type:int or None
modifications
Returns:Список модификаций групповой модели
Return type:list[YMModification]
name
Returns:Наименование модели
Return type:str

Смартфон Apple iPhone X 256GB

navigationNode
Returns:Информация об узле навигационного дерева, к которому относится модель
Return type:YMNavigationNode
offerCount
Returns:Количество товарных предложений модели в регионе запроса
Return type:int

248

opinionCount
Returns:Количество отзывов на модель
Return type:int

33

parameters
Returns:Параметры модели
Return type:list[YMParameter]
parent
Returns:Идентификатор модели
Return type:int or None
photo
Returns:Основное изображение модели
Return type:YMModelPhoto
photos
Returns:Остальные изображения модели
Return type:list[YMModelPhoto]
price
Returns:Информация о цене модели в основной валюте запроса
Return type:YMPrice
rating
Returns:Информация о рейтинге модели
Return type:YMRating
reviewCount
Returns:Количество статей/обзоров на модель
Return type:int

6

specification
Returns:Основные характеристики модели
Return type:list[YMSpecification]
type
Returns:Тип модели
Return type:str
  • MODEL — Обычная модель
  • GROUP — Групповая модель
  • MODIFICATION — Модификация
  • BOOK — Книга
  • CLUSTER — Визуальная модель
userRelated
Returns:Информация, касающаяся текущего пользователя
Return type:list[YMUserRelated]
vendor
Returns:Информация о производителе модели
Return type:YMVendor
vendorCode
Returns:Общий идентификатор модели
Return type:str or None
Returns:Ссылка на страницу производителя
Return type:str or None

https://market.yandex.ru/brands/267101?pp=1001

warning
Returns:Дисклеймер, связанный с моделью
Return type:str or None
warnings
Returns:Строковый код дисклеймера
Return type:list[YMModelWarning]
class YMContent.objects.YMModelOpinion(data)

Bases: YMContent.objects.YMOpinion

model
Returns:Модель
Return type:YMModelOpinionModel
usageTime
Returns:Время использования модели
Return type:str
verifiedBuyer
Returns:Признак проверенного покупателя
Return type:bool
class YMContent.objects.YMModelOpinionModel(data)

Bases: YMContent.objects.YMBase

id
Returns:Идентификатор модели
Return type:int
name
Returns:Наименование модели
Return type:str or None
class YMContent.objects.YMModelOpinionShop(data)

Bases: YMContent.objects.YMBase

id
Returns:Идентификатор магазина
Return type:int
name
Returns:Наименование магазина
Return type:str
class YMContent.objects.YMModelOpinionUser(data)

Bases: YMContent.objects.YMBase

id
Returns:Идентификатор автора комментария
Return type:int
name
Returns:Имя автора комментария
Return type:str
class YMContent.objects.YMModelPhoto(data)

Bases: YMContent.objects.YMBase

colorId
Returns:Код значения фильтра по цвету
Return type:str or None
criteria
Returns:Критерий фильтрации копии изображения
Return type:list[YMCriteria]
height
Returns:Высота изображения
Return type:int

620

thumbnails
Returns:Уменьшенные копии изображения
Return type:list[YMThumbnail]
url
Returns:Ссылка на изображение
Return type:str

https://avatars.mds.yandex.net/get-mpic/397397/img_id7051974271832358544.png/orig

width
Returns:Ширина изображения
Return type:int

321

class YMContent.objects.YMModelReview(data)

Bases: YMContent.objects.YMBase

favIcon
Returns:URL значка веб-сайта с обзором на модель
Return type:str
title
Returns:Заголовок обзора на модель
Return type:str
url
Returns:URL обзорной статьи на модель
Return type:str
class YMContent.objects.YMModelWarning(data)

Bases: YMContent.objects.YMBase

code
Returns:Строковый код дисклеймера
Return type:str
message
Returns:Текст дисклеймера
Return type:str
class YMContent.objects.YMModification(data)

Bases: YMContent.objects.YMBase

alternatePrices
Returns:Информация о ценах на модификацию в альтернативной валюте запроса
Return type:YMPrice
description
Returns:Описание модели-модификации
Return type:str
id
Returns:Идентификатор модели-модификации
Return type:int
name
Returns:Наименование модели-модификации
Return type:str
offerCount
Returns:Кол-во товарных предложений для данной модификации
Return type:int
popularity
Returns:Оценка популярности модели-модификации
Return type:str
price
Returns:Информация о цене модификации
Return type:YMPrice
shopCount
Returns:Кол-во магазинов, имеющих товарные предложения данной модификации
Return type:int
class YMContent.objects.YMNavigationNode(data)

Bases: YMContent.objects.YMBase

categories
Returns:Список дочерних узлов
Return type:list[YMNavigationNode]
datasource
Returns:Информация о источнике данных для узла навигационного дерева
Return type:YMDatasource
hid
Returns:Идентификатор товарной категории (hid)
Return type:int

91491

icons
Returns:Список изображений, относящихся к данному узлу навигационного дерева
Return type:list[YMIcon]
id
Returns:Идентификатор навигационного узла (nid)
Return type:int

54726

maxDiscount
Returns:Максимальная скидка в категории
Return type:str or None
modelCount
Returns:Количество моделей в категории узла
Return type:int or None

3002

name
Returns:Полное наименование навигационного узла
Return type:str

Мобильные телефоны

offerCount
Returns:Количество товарных предложений в категории узла
Return type:int or None

55595

parents
Returns:Иерархический список всех родителей узла, начиная с корня
Return type:list[YMNavigationNode]
shortName
Returns:Краткое наименование навигационного узла
Return type:str

Мобильные телефоны

type
Returns:Тип узла навигационного дерева
Return type:str
visual
Returns:Признак визуальной категории
Return type:bool or None
class YMContent.objects.YMOffer(data)

Bases: YMContent.objects.YMBase

activeFilters
Returns:Параметры модели, по которым можно отфильтровать предложения на нее в поиске Яндекс.Маркета
Return type:list[YMFilter]
adult
Returns:Признак, что предложение относится к интим-категории (18+)
Return type:bool or None
age
Returns:Возрастные ограничения для предложения
Return type:str or None
alternatePrice
Returns:Информация о цене в альтернативной валюте
Return type:YMShopPrice
Returns:URL для добавления предложения в корзину на Яндекс.Маркете
Return type:str or None
category
Returns:Информация о категории предложения
Return type:YMCategory
cpa
Returns:Признак, что товар можно заказать на Яндекс.Маркете (в рамках программы «Заказ на Маркете»)
Return type:bool or None
cpaUrl
Returns:URL карточки модели на Яндекс.Маркете
Return type:str or None
delivery
Returns:Информация о доставке
Return type:YMDelivery
description
Returns:Описание предложения
Return type:str
id
Returns:Идентификатор предложения
Return type:str
Returns:URL предложения на Яндекс.Маркете
Return type:str or None
localStoreCount
Returns:Количество торговых залов в регионе пользователя
Return type:int
model
Returns:Идентификатор модели
Return type:int or None
name
Returns:Название предложения
Return type:str
Returns:URL предложений на модификации модели в указанном магазине
Return type:str or None
onStock
Returns:Признак наличия товара
Return type:bool or None
outletCount
Returns:Количество точек выдачи
Return type:int
outletUrl
Returns:URL карты со списком точек выдачи товара
Return type:str or None
paymentOptions
Returns:Способы оплаты товара
Return type:YMPaymentOption
phone
Returns:Номер телефона магазина
Return type:YMPhone
photo
Returns:Основное изображение товара
Return type:YMModelPhoto
photos
Returns:Изображения товара
Return type:list[YMModelPhoto]
pickupCount
Returns:Количество точек самовывоза
Return type:int
previewPhotos
Returns:Уменьшенные изображения товара
Return type:list[YMModelPhoto]
price
Returns:Информация о цене
Return type:YMShopPrice
promocode
Returns:Признак, что товар можно купить с промокодом
Return type:bool or None
recommended
Returns:Признак наличия рекомендации производителя
Return type:bool
shop
Returns:Информация о магазине, который разместил предложение
Return type:YMShop
url
Returns:URL товара на сайте магазина
Return type:str
variationCount
Returns:Количество других предложений на указанный товар в магазине
Return type:int or None
vendor
Returns:Информация о производителе
Return type:YMVendor
wareMd5
Returns:MD5 хеш-код предложения
Return type:str
warning
Returns:Предупреждение, связанное с предложением
Return type:str or None
warnings
Returns:Код предупреждения, связанного с предложением
Return type:list[YMModelWarning]
warranty
Returns:Признак наличия гарантии производителя
Return type:bool
class YMContent.objects.YMOpinion(data)

Bases: YMContent.objects.YMBase

agreeCount
Returns:Количество согласных с оценкой
Return type:int
author
Returns:Информация об авторе
Return type:YMOpinionAuthor
comments
Returns:Комментарии
Return type:list[YMOpinionComment]
cons
Returns:Описание недостатков
Return type:str or None
date
Returns:Дата написания
Return type:str
disagreeCount
Returns:Количество несоглазных с оценкой
Return type:int
grade
Returns:Оценка
Return type:int
id
Returns:Идентификатор отзыва
Return type:int
pros
Returns:Описание достоинств
Return type:str or None
region
Returns:Регион
Return type:YMRegion
rejectReason
Returns:Причина отклонения отзыва
Return type:str or None
state
Returns:Статус отзыва
Return type:str or None
text
Returns:Текст отзыва
Return type:str or None
vote
Returns:Мнение текущего пользователя об отзыве
Return type:bool or None
class YMContent.objects.YMOpinionAuthor(data)

Bases: YMContent.objects.YMBase

avatarUrl
Returns:Ссылка на аватар
Return type:str or None
grades
Returns:Количество оценок
Return type:int or None
name
Returns:Имя автора
Return type:str or None
social
Returns:Оиформация о профилях автора в социальных сетях
Return type:list[YMOpinionAuthorSocial]
visibility
Returns:Вариант отображения отзыва
Return type:str
class YMContent.objects.YMOpinionAuthorSocial(data)

Bases: YMContent.objects.YMBase

type
Returns:Тип профиля
Return type:str
url
Returns:Ссылка на профиль
Return type:str
class YMContent.objects.YMOpinionComment(data)

Bases: YMContent.objects.YMBase

blocked
Returns:Комментарий заблокирован
Return type:bool
body
Returns:Текст комментария
Return type:str
children
Returns:Список дочерних комментариев к данному в дереве комментариев
Return type:list[YMOpinionComment]
deleted
Returns:Признак удаленного комментария
Return type:bool
id
Returns:Идентификатор комментария
Return type:str
parentId
Returns:Идентификатор родительского комментария или корневого объекта в дереве комментариев
Return type:str
rootId
Returns:Идентификатор корневого объекта, к которому относится комментарий
Return type:str
sticky
Returns:Признак прикрепленного комментария
Return type:bool
title
Returns:Заголовок комментария
Return type:str
updateTimestamp
Returns:Timestamp времени последнего обновления комментария
Return type:int
user
Returns:Информация об авторе комментария
Return type:YMModelOpinionUser
valid
Returns:Комментарий действителен
Return type:bool
class YMContent.objects.YMOrganization(data)

Bases: YMContent.objects.YMBase

address
Returns:Юридический адрес
Return type:str
contactUrl
Returns:Ссылка на страницу с контактной информацией
Return type:str
name
Returns:Юридическое название
Return type:str
ogrn
Returns:Основной государственный номер регистрации
Return type:str
postalAddress
Returns:Фактический адрес
Return type:str
type
Returns:Тип организации
Return type:str
class YMContent.objects.YMOutlet(data)

Bases: YMContent.objects.YMBase

address
Returns:Адрес торговой точки / пункта выдачи товара
Return type:YMAddress
distance
Returns:Расстояние
Return type:float or None
id
Returns:Идентификатор торговой точки / пункта выдачи товара
Return type:str
latitude
Returns:Широта
Return type:float or None
longitude
Returns:Долгота
Return type:float or None
name
Returns:Наименование торговой точки / пункта выдачи товара
Return type:str
offer
Returns:Товарное предложение в контексте запроса
Return type:YMOffer
phones
Returns:Список телефонов торговой точки / пункта выдачи товара
Return type:list[YMPhone]
schedule
Returns:Расписание работы торговой точки / пункта выдачи товара
Return type:list[YMSchedule]
shop
Returns:Информация о магазине, осуществляющем выдачу товара в данной торговой точке
Return type:YMShop
type
Returns:Тип торговой точки / пункта выдачи товара
Return type:str
class YMContent.objects.YMParameter(data)

Bases: YMContent.objects.YMBase

mandatory
Returns:Является ли атрибут обязательным
Return type:bool
multivalue
Returns:Признак, что параметр имеет несколько значений
Return type:bool
name
Returns:Название параметра
Return type:str
options
Returns:Список возможных значений параметра
Return type:list[YMParameterOption]
parameterId
Returns:Идентификатор параметра
Return type:int
type
Returns:Тип параметра категории
Return type:str
unit
Returns:Единица измерения параметра
Return type:str
values
Returns:Список значений параметра
Return type:list[bool]
class YMContent.objects.YMParameterOption(data)

Bases: YMContent.objects.YMBase

id
Returns:Идентификатор значения параметра
Return type:int
name
Returns:Название значения параметра
Return type:str
class YMContent.objects.YMPaymentOption(data)

Bases: YMContent.objects.YMBase

canPayByCard
Returns:Оплата картой на Маркете
Return type:bool
class YMContent.objects.YMPhone(data)

Bases: YMContent.objects.YMBase

call
Returns:Ссылка для получения номера телефона
Return type:str or None
number
Returns:Значение номера телефона в произвольном формате
Return type:str
sanitized
Returns:Значение номера телефона в числовом формате
Return type:str
class YMContent.objects.YMPrice(data)

Bases: YMContent.objects.YMBase

avg
Returns:Среднее значение цены
Return type:str or None
base
Returns:Базовое значение цены
Return type:str or None
discount
Returns:Скидка
Return type:str or None
max
Returns:Максимальная цена
Return type:str or None
min
Returns:Минимальная цена
Return type:str or None
class YMContent.objects.YMRating(data)

Bases: YMContent.objects.YMBase

count
Returns:Количество оценок
Return type:int
distribution
Returns:Информация о распределении оценок
Return type:list[YMRatingDistribution]
status
Returns:Статус рейтинга
Return type:list[YMRatingStatus]
value
Returns:Средняя оценка рейтинга
Return type:float or int
class YMContent.objects.YMRatingDistribution(data)

Bases: YMContent.objects.YMBase

count
Returns:Количество оценок с указанным значением
Return type:int
percent
Returns:Доля оценок с указанным значением среди всех оценок
Return type:int
value
Returns:Значение оценки
Return type:float
class YMContent.objects.YMRatingStatus(data)

Bases: YMContent.objects.YMBase

id
Returns:Код статуса рейтинга
Return type:str
name
Returns:Наименование статуса рейтинга
Return type:str
class YMContent.objects.YMRedirect(data)

Bases: YMContent.objects.YMBase

Returns:Ссылка на данный редирект, направляющая на Яндекс.Маркет
Return type:str
queryText
Returns:Текст оригинального запроса на редирект
Return type:str
type
Returns:Тип редиректа
Return type:str
class YMContent.objects.YMRedirectCatalog(data)

Bases: YMContent.objects.YMRedirect

categories
Returns:Список категорий
Return type:list[YMSearchCategory]
criteria
Returns:Список условий фильтрации, уточняющих поиск
Return type:list[YMDatasourceCriteria]
filters
Returns:Фильтры
Return type:list[YMFilter]
items
Returns:Список моделей и/или товарных предложений
Return type:list[YMModel or YMOffer]
navigationNode
Returns:Краткая информация об узле навигационного дерева
Return type:YMNavigationNode
sorts
Returns:Сортировки
Return type:list[YMSort]
class YMContent.objects.YMRedirectModel(data)

Bases: YMContent.objects.YMRedirect

model
Returns:Информация о модели
Return type:YMModel
model_id
Returns:Идентификатор модели
Return type:int
class YMContent.objects.YMRedirectSearch(data)

Bases: YMContent.objects.YMRedirect

criteria
Returns:Список условий фильтрации, уточняющих поиск
Return type:list[YMDatasourceCriteria]
filters
Returns:Фильтры
Return type:list[YMFilter]
sorts
Returns:Сортировки
Return type:list[YMSort]
class YMContent.objects.YMRedirectVendor(data)

Bases: YMContent.objects.YMRedirect

vendor
Returns:Производитель
Return type:YMVendor
vendor_id
Returns:Идентификатор производителя
Return type:int
class YMContent.objects.YMRegion(data)

Bases: YMContent.objects.YMBase

Регион

childCount
Returns:Количество дочерних регионов
Return type:int

14

country
Returns:Страна, к которой относится регион
Return type:YMRegion or None
id
Returns:Идентификатор региона
Return type:int

225

name
Returns:Наименование региона
Return type:str

Россия

nameAccusative
Returns:Наименование региона в винительном падеже
Return type:str or None
nameGenitive
Returns:Наименование региона в родительном падеже
Return type:str or None
parent
Returns:Родительский регион
Return type:YMRegion or None
type
Returns:Тип региона
Return type:str
  • CONTINENT — континент
  • REGION — регион
  • COUNTRY — страна
  • COUNTRY_DISTRICT — федеральный округ
  • SUBJECT_FEDERATION — субъект федерации
  • CITY — город
  • VILLAGE — село
  • CITY_DISTRICT — район города
  • METRO_STATION — станиция метро
  • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации
  • AIRPORT — аэропорт
  • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.)
  • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.)
  • MONORAIL_STATION — станция монорельса
  • RURAL_SETTLEMENT — сельское поселение
  • OTHER — другой тип населенного пункта
  • HIDDEN
class YMContent.objects.YMSchedule(data)

Bases: YMContent.objects.YMBase

daysFrom
Returns:День недели, определяет начало периода работы в рамках недели
Return type:str
daysTill
Returns:День недели, определяет окончание периода работы в рамках недели
Return type:str
timeFrom
Returns:Время суток, определяет начало периода работы в рамках дня
Return type:str
timeTill
Returns:Время суток, определяет окончание периода работы в рамках дня
Return type:str
class YMContent.objects.YMSearchCategory(data)

Bases: YMContent.objects.YMCategory

findCount
Returns:Количество категорий в результатах поиска
Return type:int

12

class YMContent.objects.YMShop(data)

Bases: YMContent.objects.YMBase

domain
Returns:URL, содержащий контактную информацию магазина
Return type:str
id
Returns:Идентификатор магазина
Return type:int
name
Returns:Наименование магазина
Return type:str
opinionUrl
Returns:Ссылка на отзывы о магазине
Return type:str
organizations
Returns:Информация об организации
Return type:list[YMOrganization]
rating
Returns:Информация о рейтинге магазина
Return type:YMRating
region
Returns:Домашний регион
Return type:YMRegion
registered
Returns:Дата регистрации на Маркете
Return type:str
class YMContent.objects.YMShopOpinion(data)

Bases: YMContent.objects.YMOpinion

delivery
Returns:Способ покупки
Return type:str
problem
Returns:Статус решения проблемы пользователя
Return type:str or None
shop
Returns:Магазин
Return type:YMModelOpinionShop
shopOrderId
Returns:Идентификатор заказа, относящегося к отзыву
Return type:str or None
class YMContent.objects.YMShopPrice(data)

Bases: YMContent.objects.YMBase

base
Returns:Базовая цена
Return type:str or None
discount
Returns:Скидка
Return type:str or None
shopMax
Returns:Максимальная цена из всех склеенных офферов в данном магазине
Return type:str or None
shopMin
Returns:Минимальная цена из всех склеенных офферов в данном магазине
Return type:str or None
value
Returns:Значение цены
Return type:str
class YMContent.objects.YMSort(data)

Bases: YMContent.objects.YMBase

field
Returns:Тип сортировки
Return type:str or None
  • RELEVANCY — сортировка по релевантности.
  • PRICE — сортировка по цене.
  • RATING — сортировка по рейтингу.
  • DISTANCE — сортировка по расстоянию до ближайшей точки продаж (значение доступно только при указании местоположения пользователя).
  • POPULARITY — сортировка по популярности.
  • DISCOUNT — сортировка по размеру скидки.

Note

Для sort=DISCOUNT возможна только сортировка по убыванию (how=DESC).

  • QUALITY — сортировка по рейтингу.
  • OPINIONS — сортировка по количеству отзывов.
  • DATE — сортировка по дате.
  • DELIVERY_TIME — сортировка по времени доставки.
  • NOFFERS — сортировка по количеству предложений
options
Returns:Доступные варианты для данного типа сортировки
Return type:list[YMSortOption]
text
Returns:Наименование типа сортировки
Return type:str

по цене

class YMContent.objects.YMSortOption(data)

Bases: YMContent.objects.YMBase

Опции сортировки

how
Returns:Направление сортировки
Return type:str
  • ASC — по возрастанию
  • DESC — по убыванию
id
Returns:Идентификатор варианта сортировки
Return type:str

aprice

text
Returns:Наименование данного варианта сортировки
Return type:str

Сначала дешёвые

class YMContent.objects.YMSpecification(data)

Bases: YMContent.objects.YMBase

features
Returns:
Return type:list[YMSpecificationFeature]
name
Returns:Название группы характеристик
Return type:str
class YMContent.objects.YMSpecificationFeature(data)

Bases: YMContent.objects.YMBase

name
Returns:Наименование характеристики
Return type:str
value
Returns:Значение характеристики
Return type:str
class YMContent.objects.YMStatistics(data)

Bases: YMContent.objects.YMBase

regions
Returns:Список статистик по регионам
Return type:list[YMStatisticsRegion]
class YMContent.objects.YMStatisticsRegion(data)

Bases: YMContent.objects.YMBase

id
Returns:Идентификатор региона
Return type:int
offerCount
Returns:Количество товарных предложений модели в регионе
Return type:int
price_max
Returns:Максимальная цена
Return type:str
price_median
Returns:Медиана по ценам
Return type:str
price_min
Returns:Минимальная цена
Return type:str
class YMContent.objects.YMSuggestion(data)

Bases: YMContent.objects.YMBase

url
Returns:Ссылка на страницу соответствующую поисковой посдказке
Return type:str or None
value
Returns:Значение поисковой подсказки
Return type:str
class YMContent.objects.YMSuggestionCompletion(data)

Bases: YMContent.objects.YMBase

completion
Returns:Завершение фразы
Return type:str
value
Returns:Фраза целиком после завершения
Return type:str
class YMContent.objects.YMThumbnail(data)

Bases: YMContent.objects.YMBase

container
Returns:container
Return type:str
  • W50xH50 — 50x50
  • W100xH100 — 100x100
  • W150xH150 — 150x150
  • W200xH200 — 200x200
  • W300xH300 — 300x300
height
Returns:Высота изображения
Return type:int

620

url
Returns:Ссылка на изображение
Return type:str

https://avatars.mds.yandex.net/get-mpic/397397/img_id7051974271832358544.png/orig

width
Returns:Ширина изображения
Return type:int

321

class YMContent.objects.YMUserRelated(data)

Bases: YMContent.objects.YMBase

inComparisonList
Returns:Модель находится в списках сравнений
Return type:bool
inWishlist
Returns:Модель находится в отложеннных
Return type:bool
class YMContent.objects.YMVendor(data)

Bases: YMContent.objects.YMBase

categories
Returns:Список категорий, в которых представлен данный производитель
Return type:list[YMVendorCategory]
id
Returns:Идентификатор производителя
Return type:int
Returns:Ссылка на карточку производителя на большом маркете
Return type:str or None
name
Returns:Наименование производителя
Return type:str or None
picture
Returns:Ссылка на изображение логотипа производителя
Return type:str or None
recommendedShops
Returns:Ссылка на страницу производителя с рекомендованными магазинами
Return type:str or None
site
Returns:Ссылка на веб-сайт производителя
Return type:str or None
topCategories
Returns:Список наиболее популярных категорий товаров производителя
Return type:list[YMVendorCategory]
class YMContent.objects.YMVendorCategory(data)

Bases: YMContent.objects.YMCategory

children
Returns:Список дочерних категорий
Return type:list[YMVendorCategory]
popularity
Returns:Оценка популярности
Return type:float
class YMContent.objects.YMWarning(data)

Bases: YMContent.objects.YMBase

Предупреждение

age
Returns:Возрастное ограничение для категории
Return type:int
shortText
Returns:Краткий текст предупреждения
Return type:str
text
Returns:Текст предупреждения
Return type:str

YMContent.response module

class YMContent.response.Base(data)

Bases: object

alt_currency_id
Returns:Код валюты
Return type:str or None
alt_currency_name
Returns:Название валюты
Return type:str or None
curl()
Returns:Эквивалент команды curl
Return type:str
currency_id
Returns:Код валюты
Return type:str
currency_name
Returns:Название валюты
Return type:str
daily_limit
Returns:возможное количество запросов в сутки
Return type:int
daily_remaining
Returns:оставшееся количество запросов до превышения суточного ограничения
Return type:int
daily_until
Returns:время обновления суточного ограничения
Return type:str
date
Returns:время выполнения запроса
Return type:str
fields_all_limit
Returns:возможное количество запросов с получением всех полей
Return type:int or None
fields_all_remaining
Returns:оставшееся количество запросов с получением всех полей
Return type:int or None
fields_all_until
Returns:время обновления ресурсного посекундного ограничения с получением всех полей
Return type:str or None
global_limit
Returns:возможное количество запросов в определенный промежуток времени
Return type:int
global_remaining
Returns:оставшееся количество запросов в определенный промежуток времени до превышения глобального ограничения
Return type:int
global_until
Returns:время обновления глобального посекундного ограничения
Return type:str
http_status_code
Returns:HTTP статус обработки запроса
Return type:int
id
Returns:Уникальный идентификатор запроса
Return type:str
is_ok()
Returns:Статус корректности запроса
Return type:bool
json()
Returns:ответ в формате JSON
Return type:dict
Returns:Ссылка на текущий запрос
Return type:str or None
marketUrl
Returns:Ссылка на Яндекс.Маркет
Return type:str
method_limit
Returns:возможное количество запросов к вызываемому ресурсу
Return type:int
method_remaining
Returns:оставшееся количество запросов к вызываемому ресурсу
Return type:int
method_until
Returns:время обновления ресурсного посекундного ограничения
Return type:str
next_request
Returns:ближайшее возможное время выполнения следующего запроса
Return type:datetime.datetime
region
Returns:Информация о регионе запроса
Return type:YMRegion
status
Returns:Статус обработки запроса
Return type:str
time
Returns:Дата и время выполнения запроса в формате ISO 8601
Return type:str
class YMContent.response.Categories(data)

Bases: YMContent.response.Page

categories
Returns:Список категорий
Return type:list[YMCategory]
class YMContent.response.Category(data)

Bases: YMContent.response.Base

Категория

category
Returns:Категория
Return type:YMCategory
class YMContent.response.Filters(data)

Bases: YMContent.response.Base

Фильтры

filters
Returns:Список фильтров
Return type:list[YMFilter]
sorts
Returns:Список сортировок
Return type:list[YMSort]
class YMContent.response.Model(data)

Bases: YMContent.response.Base

Модель

model
Returns:Модель
Return type:YMModel
class YMContent.response.ModelOffers(data)

Bases: YMContent.response.Page

filters
Returns:Список фильтров, доступных для фильтрации товарных предложений модели
Return type:list[YMFilter]
offers
Returns:Список товарных предложений модели
Return type:list[YMOffer]
sorts
Returns:Список доступных сортировок товарных предложений модели
Return type:list[YMSort]
class YMContent.response.ModelOffersDefault(data)

Bases: YMContent.response.Base

offer
Returns:Товарное предложение
Return type:YMOffer
class YMContent.response.ModelOffersStat(data)

Bases: YMContent.response.Base

statistics
Returns:Информация о количестве и ценах товарных предложений модели по регионам
Return type:YMStatistics
class YMContent.response.ModelOpinions(data)

Bases: YMContent.response.Page

opinions
Returns:Отзывы
Return type:list[YMModelOpinion]
class YMContent.response.ModelReview(data)

Bases: YMContent.response.Page

reviews
Returns:Список отзывов на модель
Return type:list[YMModelReview]
class YMContent.response.Models(data)

Bases: YMContent.response.Base

models
Returns:Список моделей
Return type:list[YMModel]
class YMContent.response.Offer(data)

Bases: YMContent.response.Base

offer
Returns:Товарное предложение
Return type:YMOffer
class YMContent.response.Outlets(data)

Bases: YMContent.response.Page

outlets
Returns:Список торговых точек / пунктов выдачи товара
Return type:list[YMOutlet]
class YMContent.response.Page(data)

Bases: YMContent.response.Base

page_count
Returns:Размер страницы
Return type:int
page_last
Returns:Признак последней страницы
Return type:bool
page_number
Returns:Номер страницы
Return type:int
page_total
Returns:Количество страниц в результате
Return type:int
class YMContent.response.Redirect(data)

Bases: YMContent.response.Page

redirect
Returns:Информация по редиректу
Return type:YMRedirectModel or YMRedirectCatalog or YMRedirectVendor or YMRedirectSearch
class YMContent.response.Region(data)

Bases: YMContent.response.Base

region
Returns:Регион
Return type:YMRegion
class YMContent.response.Regions(data)

Bases: YMContent.response.Page

regions
Returns:Список регионов
Return type:list[YMRegion]
class YMContent.response.Search(data)

Bases: YMContent.response.Page

categories
Returns:Список категорий
Return type:list[YMSearchCategory]
items
Returns:Список моделей и/или товарных предложений
Return type:list[YMModel or YMOffer]
sorts
Returns:Список доступных сортировок
Return type:list[YMSort]
class YMContent.response.Shop(data)

Bases: YMContent.response.Base

shop
Returns:Информация о магазине
Return type:YMShop
class YMContent.response.ShopOpinions(data)

Bases: YMContent.response.Page

opinions
Returns:Отзывы
Return type:list[YMShopOpinion]
class YMContent.response.Shops(data)

Bases: YMContent.response.Base

shops
Returns:Информация о магазинах
Return type:list[YMShop]
class YMContent.response.ShopsSummary(data)

Bases: YMContent.response.Base

deliveryCount
Returns:Количество магазинов, которые осуществляют доставку в указанный регион
Return type:int
homeCount
Returns:Количество магазинов, которые находятся в указанном регионе
Return type:int
totalCount
Returns:Общее количество магазинов, которые работают в указанном регионе: находятся в указанном регионе и осуществляют в него доставку
Return type:int
class YMContent.response.Suggestions(data)

Bases: YMContent.response.Base

completions
Returns:Поисковые подсказки для завершения фразы
Return type:list[YMSuggestionCompletion]
input
Returns:Поисковая подсказка соответствующая введенному тексту
Return type:YMSuggestion
pages
Returns:Поисковые подсказки ведущие на конкретные страницы
Return type:list[YMSuggestion]
class YMContent.response.Suggests(data)

Bases: YMContent.response.Page

suggests
Returns:Список регионов в результате поиска по частичному или полному наименованию
Return type:list[YMRegion]
class YMContent.response.Vendor(data)

Bases: YMContent.response.Base

vendor
Returns:Производитель
Return type:YMVendor
class YMContent.response.Vendors(data)

Bases: YMContent.response.Page

vendors
Returns:Список производителей
Return type:list[YMVendor]

Module contents

class YMContent.YMAPI(authorization_key=None)

Bases: object

Parameters:authorization_key (str) – Авторизационный ключ
categories(fields=None, sort='NONE', geo_id=None, remote_ip=None, count=30, page=1)

Список категорий

Parameters:
  • fields (str or list[str]) –

    Параметры категории, которые необходимо показать в выходных данных:

    • PARENT — информация о родительской категории
    • STATISTICS — статистика по категории. Например, количество моделей и товарных предложений в категории
    • WARNINGS — предупреждения, связанные с показом категории
    • ALL - Все значения

    Note

    Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS

  • sort (str) –

    Тип сортировки категорий:

    • BY_NAME — сортировка категорий в алфавитном порядке
    • BY_OFFERS_NUM — сортировка по количеству товарных предложений в каждой категории
    • NONE — сортировка по умолчанию
  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – IP-адрес пользователя
  • count (int) – Количество выводимых результатов на странице ответа
  • page (int) – Номер страницы
Returns:

Список категорий первого уровня (корневых) товарного дерева

Return type:

Categories

Raises:
  • FieldsParamError – неверное значение параметра fields
  • SortParamError – неверное значение параметра sort
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
categories_bestdeals(category_id, fields='CATEGORY, PHOTO', count=30, page=1, geo_id=None, remote_ip=None)

Лучшие предложения (скидки дня)

Parameters:
  • category_id (int or str) – Идентификатор категории
  • count (int) – Количество элементов на странице
  • page (int) – Номер страницы
  • fields (str or list[str]) –

    Параметры моделей, которые необходимо показать в выходных данных

    • CATEGORY — Информация о категории, к которой относится модель
    • DEFAULT_OFFER — информация о товарном предложении по умолчанию для модели в указанном регионе.
    • DISCOUNTS — информация о скидках на модель.
    • FACTS — Список достоинств и недостатков модели
    • FILTERS — список фильтров, доступных для отбора модификаций модели.
    • FILTER_ALLVENDORS — группа параметров для фильтра «Производитель».
    • FILTER_COLOR — список фильтров по цвету, доступных для отбора модификаций модели.
    • FILTER_DESCRIPTION — описания фильтров.
    • FILTER_FOUND — количество моделей или товарных предложений:
    • FILTER_SORTS — включение в выдачу доступных фильтров.
    • MEDIA — информация об отзывах и обзорах на модель.
    • MODIFICATIONS — краткая информация о модификациях (для групповой модели).
    • NAVIGATION_NODE — информация о навигационном узле дерева категорий Маркета, к которому относится модель.
    • NAVIGATION_NODE_DATASOURCE — источник данных узла навигационного дерева.
    • NAVIGATION_NODE_ICONS — иконки навигационного дерева.
    • NAVIGATION_NODE_STATISTICS — статистика узла навигационного дерева.
    • OFFERS — информация о товарных предложениях, соотнесенных с моделью, в указанном регионе.
    • OFFER_ACTIVE_FILTERS — активные фильтры.
    • OFFER_CATEGORY — информация о категории предложения.
    • OFFER_DELIVERY — информация о доставке.
    • OFFER_DISCOUNT — скидка.
    • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
    • OFFER_OUTLET — информация о точке выдачи производетеля.
    • OFFER_PHOTO — фото предложения.
    • OFFER_SHOP — магазин от которого поступило предложенение.
    • OFFER_VENDOR — информация о поставщике.
    • PHOTO — Изображение модели, используемое как основное изображение на карточке модели
    • PHOTOS — все доступные изображения модели.
    • PRICE — информация о ценах на модель.
    • RATING — иформация о рейтинге и оценках модели.
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
    • SHOP_RATING — рейтинг магазина.
    • SPECIFICATION — характеристики модели.
    • VENDOR — информация о производителе.
    • ALL = Все значения
    • FILTER_ALL = FILTER_ALLVENDORS, FILTER_DESCRIPTION, FILTER_FOUND, FILTER_SORTS
    • NAVIGATION_NODE_ALL = NAVIGATION_NODE_DATASOURCE, NAVIGATION_NODE_ICONS, NAVIGATION_NODE_STATISTICS
    • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_PHOTO, OFFER_SHOP, OFFER_VENDOR
    • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
    • STANDARD = CATEGORY, OFFERS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_PHOTO, OFFER_SHOP, PHOTO, PRICE, RATING, SHOP_RATING, VENDOR
    • VENDOR_ALL = VENDOR_LINK

    Note

    Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS

  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – IP-адрес пользователя
Returns:

Return type:

Models

Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
  • FieldsParamError – недопустимое значение параметра fields
categories_children(category_id, fields=None, sort='NONE', geo_id=None, remote_ip=None, count=30, page=1)

Список подкатегорий

Parameters:
  • category_id (int or str) – Идентификатор категории
  • fields (str or list[str]) –

    Параметры категории, которые необходимо показать в выходных данных:

    • PARENT — информация о родительской категории
    • STATISTICS — статистика по категории. Например, количество моделей и товарных предложений в категории
    • WARNINGS — предупреждения, связанные с показом категории
    • ALL - Все значения

    Note

    Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS

  • sort (str) –

    Тип сортировки категорий:

    • BY_NAME — сортировка категорий в алфавитном порядке
    • BY_OFFERS_NUM — сортировка по количеству товарных предложений в каждой категории
    • NONE — сортировка по умолчанию
  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – IP-адрес пользователя
  • count (int) – Количество выводимых результатов на странице ответа
  • page (int) – Номер страницы
Returns:

Список категорий товарного дерева, вложенных в категорию с указанным в запросе идентификатором

Return type:

Categories

Raises:
  • FieldsParamError – неверное значение параметра fields
  • SortParamError – неверное значение параметра sort
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
categories_filters(category_id, geo_id=None, remote_ip=None, fields=None, filter_set='POPULAR', rs=None, sort='NONE', filters=None)

Список фильтров категории

Parameters:
  • category_id (int or str) – Идентификатор категории
  • fields (str or list[str]) –

    Параметры категории, которые необходимо показать в выходных данных:

    • ALLVENDORS — группа параметров для фильтра «Производитель
    • DESCRIPTION — описания фильтров
    • FOUND — количество моделей или товарных предложений
    • SORTS — включение в выдачу доступных фильтров
    • STANDARD = ALLVENDORS, DESCRIPTION, FOUND, SORTS
    • ALL - Все значения

    Note

    Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS

  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – IP-адрес пользователя
  • filter_set (str) –

    Набор фильтров в выходных данных:

    • ALL — все фильтры
    • BASIC — базовый набор фильтров
    • POPULAR — только популярные фильтры

    Note

    Значение BASIC равнозначно POPULAR

  • rs (str) – Поле содержащее закодированную информацию о текстовом запросе после редиректа, на которую будет ориентироваться поиск
  • sort (str) –

    Тип сортировки категорий:

    • NAME — сортировка по имени
    • NONE — сортировка отсутствует
  • filters (dict) – Условия фильтрации моделей и предложений на модель
Returns:

Cписок фильтров для фильтрации моделей и товарных предложений в указанной категории

Return type:

Filters

Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • FieldsParamError – неверное значение параметра fields
  • FilterSetParamError – неверное значение параметра filter_set
  • SortParamError – неверное значение параметра sort
categories_match(name, category_name=None, description=None, locale='RU_ru', price=None, shop_name=None)

Подбор категорий по параметрам

Parameters:
  • name (str) – Имя
  • category_name (str) – Наименование категории
  • description (str) – Описание модели
  • locale (str) – Локаль поиска
  • price (str or int) – Цена модели
  • shop_name (str) – Наименование магазина
Returns:

Подобранные категории

Return type:

Categories

Список популярных моделей

Parameters:
  • category_id (int or str) – Идентификатор категории
  • count (int) – Количество элементов на странице
  • page (int) – Номер страницы
  • fields (str or list[str]) –

    Параметры моделей, которые необходимо показать в выходных данных

    • CATEGORY — Информация о категории, к которой относится модель
    • DEFAULT_OFFER — информация о товарном предложении по умолчанию для модели в указанном регионе.
    • DISCOUNTS — информация о скидках на модель.
    • FACTS — Список достоинств и недостатков модели
    • FILTERS — список фильтров, доступных для отбора модификаций модели.
    • FILTER_ALLVENDORS — группа параметров для фильтра «Производитель».
    • FILTER_COLOR — список фильтров по цвету, доступных для отбора модификаций модели.
    • FILTER_DESCRIPTION — описания фильтров.
    • FILTER_FOUND — количество моделей или товарных предложений:
    • FILTER_SORTS — включение в выдачу доступных фильтров.
    • MEDIA — информация об отзывах и обзорах на модель.
    • MODIFICATIONS — краткая информация о модификациях (для групповой модели).
    • NAVIGATION_NODE — информация о навигационном узле дерева категорий Маркета, к которому относится модель.
    • NAVIGATION_NODE_DATASOURCE — источник данных узла навигационного дерева.
    • NAVIGATION_NODE_ICONS — иконки навигационного дерева.
    • NAVIGATION_NODE_STATISTICS — статистика узла навигационного дерева.
    • OFFERS — информация о товарных предложениях, соотнесенных с моделью, в указанном регионе.
    • OFFER_ACTIVE_FILTERS — активные фильтры.
    • OFFER_CATEGORY — информация о категории предложения.
    • OFFER_DELIVERY — информация о доставке.
    • OFFER_DISCOUNT — скидка.
    • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
    • OFFER_OUTLET — информация о точке выдачи производетеля.
    • OFFER_PHOTO — фото предложения.
    • OFFER_SHOP — магазин от которого поступило предложенение.
    • OFFER_VENDOR — информация о поставщике.
    • PHOTO — Изображение модели, используемое как основное изображение на карточке модели
    • PHOTOS — все доступные изображения модели.
    • PRICE — информация о ценах на модель.
    • RATING — иформация о рейтинге и оценках модели.
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
    • SHOP_RATING — рейтинг магазина.
    • SPECIFICATION — характеристики модели.
    • VENDOR — информация о производителе.
    • ALL = Все значения
    • FILTER_ALL = FILTER_ALLVENDORS, FILTER_DESCRIPTION, FILTER_FOUND, FILTER_SORTS
    • NAVIGATION_NODE_ALL = NAVIGATION_NODE_DATASOURCE, NAVIGATION_NODE_ICONS, NAVIGATION_NODE_STATISTICS
    • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_PHOTO, OFFER_SHOP, OFFER_VENDOR
    • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
    • STANDARD = CATEGORY, OFFERS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_PHOTO, OFFER_SHOP, PHOTO, PRICE, RATING, SHOP_RATING, VENDOR
    • VENDOR_ALL = VENDOR_LINK

    Note

    Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS

  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – Идентификатор региона пользователя
Returns:

популярные на Яндекс.Маркете модели

Return type:

Models

Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
  • FieldsParamError – недопустимое значение параметра fields

Подбор по параметрам в категории

Parameters:
  • category_id (int or str) – Идентификатор категории
  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – Идентификатор региона пользователя
  • fields (str or list[str]) –

    Поля, которые необходимо показать в выходных данных

    • MODEL_CATEGORY — Информация о категории, к которой относится модель
    • MODEL_DEFAULT_OFFER — информация о товарном предложении по умолчанию для модели в указанном регионе.
    • MODEL_DISCOUNTS — информация о скидках на модель.
    • MODEL_FACTS — Список достоинств и недостатков модели
    • MODEL_FILTER_COLOR — список фильтров по цвету, доступных для отбора модификаций модели.
    • MODEL_MEDIA — информация об отзывах и обзорах на модель.
    • MODEL_NAVIGATION_NODE — информация о навигационном узле дерева категорий Маркета, к которому относится модель.
    • MODEL_OFFERS — информация о товарных предложениях, соотнесенных с моделью, в указанном регионе.
    • MODEL_PHOTO — Изображение модели, используемое как основное изображение на карточке модели
    • MODEL_PHOTOS — все доступные изображения модели.
    • MODEL_PRICE — информация о ценах на модель.
    • MODEL_RATING — иформация о рейтинге и оценках модели.
    • MODEL_SPECIFICATION — характеристики модели.
    • MODEL_VENDOR — информация о производителе.
    • OFFER_ACTIVE_FILTERS — активные фильтры.
    • OFFER_CATEGORY — информация о категории предложения.
    • OFFER_DELIVERY — информация о доставке.
    • OFFER_DISCOUNT — скидка.
    • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
    • OFFER_OUTLET — информация о точке выдачи производетеля.
    • OFFER_OUTLET_COUNT — Количество точек выдачи предложения
    • OFFER_PHOTO — фото предложения.
    • OFFER_SHOP — магазин от которого поступило предложенение.
    • OFFER_VENDOR — информация о поставщике.
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
    • SHOP_RATING — рейтинг магазина.
    • ALL = Все значения
    • MODEL_ALL = MODEL_ACTIVE_FILTERS, MODEL_CATEGORY, MODEL_DEFAULT_OFFER, MODEL_DISCOUNTS, MODEL_FACTS, MODEL_FILTER_COLOR, MODEL_LINK, MODEL_MEDIA, MODEL_NAVIGATION_NODE, MODEL_OFFERS, MODEL_PHOTO, MODEL_PHOTOS, MODEL_PRICE, MODEL_RATING, MODEL_SPECIFICATION, MODEL_VENDOR
    • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, OFFER_VENDOR
    • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
    • STANDARD = MODEL_CATEGORY, MODEL_OFFERS, MODEL_PHOTO, MODEL_PRICE, MODEL_RATING, MODEL_VENDOR, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, SHOP_RATING
  • result_type (str) – Тип возвращаемых данных
  • rs (str) – Поле содержащее закодированную информацию о текстовом запросе после редиректа, на которую будет ориентироватся поиск
  • shop_regions (str or list[str]) – Идентификаторы регионов магазинов
  • filters (dict) – Параметры задают условия фильтрации моделей и предложений на модель
  • count (int) – Размер страницы (количество элементов на странице)
  • page (int) – Номер страницы
  • how (str) – Направление сортировки
  • sort (str) – Тип сортировки товарных предложений
Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • FieldsParamError – недопустимое значение параметра fields
  • ResultTypeParamError – недопустимое значение параметра result_type
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
  • HowParamError – недопустимое значение параметра how
  • SortParamError – недопустимое значение параметра sort
Returns:

Список моделей категории и предложений на модели, удовлетворяющих заданным в запросе параметрам

Return type:

Search

category(category_id, fields=None, geo_id=None, remote_ip=None)

Информация о категории

Parameters:
  • category_id (int or str) – Идентификатор категории
  • fields (str or list[str]) –

    Параметры категории, которые необходимо показать в выходных данных:

    • PARENT — информация о родительской категории
    • STATISTICS — статистика по категории. Например, количество моделей и товарных предложений в категории
    • WARNINGS — предупреждения, связанные с показом категории
    • ALL - Все значения

    Note

    Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS

  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – IP-адрес пользователя
Returns:

Информация о категории

Return type:

Category

Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • FieldsParamError – неверное значение параметра fields
geo_region(region_id, fields=None)

Информация о регионе

Parameters:
  • region_id (int) – Идентификатор региона
  • fields (str or list[str]) –

    Параметры региона, которые необходимо включить в выдачу

    • DECLENSIONS — Название региона в разных падежах
    • PARENT — Родительский регион
    • ALL = Все значения
Raises:

FieldsParamError – недопустимое значение параметра fields

Returns:

Информация о регионе

Return type:

Region

geo_regions(fields=None, count=30, page=1)

Список регионов

Parameters:
  • fields (str or list[str]) –

    Параметры региона, которые необходимо включить в выдачу

    • DECLENSIONS — Название региона в разных падежах
    • PARENT — Родительский регион
    • ALL = Все значения
  • count (int) – Размер страницы (количество элементов на странице)
  • page (int) – Номер страницы
Raises:
  • FieldsParamError – недопустимое значение параметра fields
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
Returns:

Список регионов

Return type:

Regions

geo_regions_children(region_id, fields=None, count=30, page=1)

Список дочерних регионов

Parameters:
  • region_id (int) – Идентификатор региона
  • fields (str or list[str]) –

    Параметры региона, которые необходимо включить в выдачу

    • DECLENSIONS — Название региона в разных падежах
    • PARENT — Родительский регион
    • ALL = Все значения
  • count (int) – Размер страницы (количество элементов на странице)
  • page (int) – Номер страницы
Raises:
  • FieldsParamError – недопустимое значение параметра fields
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
Returns:

Список регионов

Return type:

Regions

geo_regions_shops_summary(region_id, fields='DELIVERY_COUNT, HOME_COUNT')

Количество магазинов, работающих в регионе

Parameters:
  • region_id (int) – Идентификатор региона
  • fields (str or list[str]) –

    Параметры, которые необходимо показать в выдаче

    • DELIVERY_COUNT — Магазины осуществляющие доставку в регион
    • HOME_COUNT — Магазины находящиеся в регионе физически
    • TOTAL_COUNT — Общее количество магазинов в регионе
    • ALL
Raises:

FieldsParamError – недопустимое значение параметра fields

Returns:

Информация о количестве магазинов и типах их работы в указанном регионе

Return type:

ShopsSummary

geo_suggest(name_part, fields=None, types='CITY, CITY_DISTRICT, REGION, RURAL_SETTLEMENT, SECONDARY_DISTRICT, VILLAGE', count=30, page=1)

Текстовый поиск региона

Parameters:
  • name_part (str) – Полное или частичное название региона
  • fields (str or list[str]) –

    Параметры региона, которые необходимо включить в выдачу

    • DECLENSIONS — Название региона в разных падежах
    • PARENT — Родительский регион
    • ALL = Все значения
  • types (str or list[str]) –

    Тип региона

    • AIRPORT — аэропорт.
    • CITY — город.
    • CITY_DISTRICT — район города.
    • CONTINENT — континент.
    • COUNTRY — страна.
    • COUNTRY_DISTRICT — федеральный округ.
    • METRO_STATION — станиция метро.
    • MONORAIL_STATION — станция монорельса.
    • OVERSEAS_TERRITORY — отдельная территория какого-либо государства, расположенная в другой части света (например, Ангилья, Гренландия, Бермудские острова и т. д.).
    • REGION — регион.
    • RURAL_SETTLEMENT — сельское поселение.
    • SECONDARY_DISTRICT — район города второго уровня (например, для ВАО Москвы районами второго уровня являются Измайлово, Новокосино, Перово и т. д.).
    • SUBJECT_FEDERATION — субъект федерации.
    • SUBJECT_FEDERATION_DISTRICT — район субъекта федерации.
    • VILLAGE — село.
    • ALL = Все значения
  • count (int) – Размер страницы (количество элементов на странице)
  • page (int) – Номер страницы
Raises:
  • FieldsParamError – недопустимое значение параметра fields
  • TypeParamError – недопустимое значение параметра type
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
Returns:

Список регионов, подходящих под заданные условия поиска

Return type:

Suggests

model(model_id, fields='CATEGORY, PHOTO', filters=None, geo_id=None, remote_ip=None)

Информация о модели

Parameters:
  • model_id (int or str) – Идентификатор модели
  • fields (str or list[str]) –

    Свойства модели, которые необходимо показать в выходных данных:

    • CATEGORY — Информация о категории, к которой относится модель
    • DEFAULT_OFFER — информация о товарном предложении по умолчанию для модели в указанном регионе.
    • DISCOUNTS — информация о скидках на модель.
    • FACTS — Список достоинств и недостатков модели
    • FILTERS — список фильтров, доступных для отбора модификаций модели.
    • FILTER_ALLVENDORS — группа параметров для фильтра «Производитель».
    • FILTER_COLOR — список фильтров по цвету, доступных для отбора модификаций модели.
    • FILTER_DESCRIPTION — описания фильтров.
    • FILTER_FOUND — количество моделей или товарных предложений:
    • FILTER_SORTS — включение в выдачу доступных фильтров.
    • MEDIA — информация об отзывах и обзорах на модель.
    • MODIFICATIONS — краткая информация о модификациях (для групповой модели).
    • NAVIGATION_NODE — информация о навигационном узле дерева категорий Маркета, к которому относится модель.
    • NAVIGATION_NODE_DATASOURCE — источник данных узла навигационного дерева.
    • NAVIGATION_NODE_ICONS — иконки навигационного дерева.
    • NAVIGATION_NODE_STATISTICS — статистика узла навигационного дерева.
    • OFFERS — информация о товарных предложениях, соотнесенных с моделью, в указанном регионе.
    • OFFER_ACTIVE_FILTERS — активные фильтры.
    • OFFER_CATEGORY — информация о категории предложения.
    • OFFER_DELIVERY — информация о доставке.
    • OFFER_DISCOUNT — скидка.
    • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
    • OFFER_OUTLET — информация о точке выдачи производетеля.
    • OFFER_PHOTO — фото предложения.
    • OFFER_SHOP — магазин от которого поступило предложенение.
    • OFFER_VENDOR — информация о поставщике.
    • PHOTO — Изображение модели, используемое как основное изображение на карточке модели
    • PHOTOS — все доступные изображения модели.
    • PRICE — информация о ценах на модель.
    • RATING — иформация о рейтинге и оценках модели.
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
    • SHOP_RATING — рейтинг магазина.
    • SPECIFICATION — характеристики модели.
    • VENDOR — информация о производителе.
    • ALL = Все значения
    • FILTER_ALL = FILTER_ALLVENDORS, FILTER_DESCRIPTION, FILTER_FOUND, FILTER_SORTS
    • NAVIGATION_NODE_ALL = NAVIGATION_NODE_DATASOURCE, NAVIGATION_NODE_ICONS, NAVIGATION_NODE_STATISTICS
    • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_PHOTO, OFFER_SHOP, OFFER_VENDOR
    • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
    • STANDARD = CATEGORY, OFFERS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_PHOTO, OFFER_SHOP, PHOTO, PRICE, RATING, SHOP_RATING, VENDOR
    • VENDOR_ALL = VENDOR_LINK

    Note

    Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS

  • filters (dict) – Условия фильтрации моделей и предложений на модель
  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – IP-адрес пользователя
Returns:

Информация о модели

Return type:

Model

Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • FieldsParamError – неверное значение параметра fields
model_offers(model_id, delivery_included=False, fields=None, group_by=None, shop_regions=None, filters=None, count=30, page=1, how=None, sort=None, latitude=None, longitude=None)

Список предложений на модель

Parameters:
  • model_id (int or str) – Идентификатор модели
  • delivery_included (bool or int or str) – Признак включения цены доставки в цену товарного предложения
  • fields (str or list[str]) –

    Параметры товарных предложений, которые необходимо показать в выходных данных

    • FILTERS — Список фильтров в результатах запроса офферов
    • FILTER_ALLVENDORS — группа параметров для фильтра «Производитель».
    • FILTER_DESCRIPTION — описания фильтров.
    • FILTER_FOUND — количество моделей или товарных предложений:
    • FILTER_SORTS — включение в выдачу доступных фильтров.
    • FILTER_STATISTICS — Обогащение информацией статистикой по фильтрам
    • OFFER_ACTIVE_FILTERS — активные фильтры.
    • OFFER_CATEGORY — информация о категории предложения.
    • OFFER_DELIVERY — информация о доставке.
    • OFFER_DISCOUNT — скидка.
    • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
    • OFFER_OUTLET — информация о точке выдачи производетеля.
    • OFFER_OUTLET_COUNT — Количество точек выдачи предложения
    • OFFER_PHOTO — фото предложения.
    • OFFER_SHOP — магазин от которого поступило предложенение.
    • OFFER_VENDOR — информация о поставщике.
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
    • SHOP_RATING — рейтинг магазина.
    • SORTS — Доступные варианты сортировок для запроса
    • ALL = Все значения
    • FILTER_ALL = FILTER_ALLVENDORS, FILTER_DESCRIPTION, FILTER_FOUND, FILTER_PHOTO_PICKER, FILTER_SORTS, FILTER_STATISTICS
    • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, OFFER_VENDOR
    • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
    • STANDARD = OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, SHOP_RATING
    • VENDOR_ALL = VENDOR_LINK
  • group_by (str) – Вариант группировки товарных предложений
  • shop_regions (str or list[int]) – Идентификаторы регионов магазинов
  • filters (dict) – Параметры задают условия фильтрации моделей и предложений на модель
  • count (int) – Количество элементов на странице
  • page (int) – Номер страницы
  • how (str) – Направление сортировки
  • sort (str) –

    Тип сортировки товарных предложений:

    • DATE — сортировка по дате
    • DELIVERY_TIME — сортировка по времени доставки
    • DISCOUNT — сортировка по размеру скидки
    • DISTANCE — сортировка по расстоянию до ближайшей точки продаж (значение доступно только при указании местоположения пользователя)
    • NOFFERS — сортировка по количеству предложений
    • OPINIONS — сортировка по количеству отзывов
    • POPULARITY — сортировка по популярности
    • PRICE — сортировка по цене
    • QUALITY — сортировка по рейтингу
    • RATING — сортировка по рейтингу
    • RELEVANCY — сортировка по релевантности
  • latitude (int or str or float) – Широта
  • longitude (int or str or float) – Долгота
Raises:
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
  • DeliveryIncludedParamError – недопустимое значение параметра delivery_included
  • FieldsParamError – недопустимое значение параметра fields
  • GroupByParamError – недопустимое значение параметра group_by
  • HowParamError – недопустимое значение параметра how
  • SortParamError – недопустимое значение параметра sort
  • GeoParamError – недопустимое значение параметра latitude
  • GeoParamError – недопустимое значение параметра longitude
Returns:

Список товарных предложений, соотнесенных с указанной моделью

Return type:

ModelOffers

model_offers_default(model_id, fields='STANDARD', filters=None, geo_id=None, remote_ip=None)

Товарное предложение по умолчанию

Parameters:
  • model_id (int or str) – Идентификатор модели
  • fields (str or list[str]) –

    Параметры предложений, которые необходимо показать в выходных данных

    • ACTIVE_FILTERS — активные фильтры
    • CATEGORY — информация о категории предложения
    • DELIVERY — информация о доставке
    • DISCOUNT — скидка
    • OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине
    • OUTLET — информация о точке выдачи производетеля
    • OUTLET_COUNT — Количество точек выдачи предложени
    • PHOTO — фото предложения
    • SHOP — магазин от которого поступило предложенение
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты
    • SHOP_RATING — рейтинг магазина
    • VENDOR — информация о поставщике
    • ALL = Все значения
    • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
    • STANDARD = CATEGORY, DELIVERY, OUTLET, OUTLET_COUNT, PHOTO, SHOP, SHOP_RATING
  • filters (dict) – Параметры задают условия фильтрации моделей и предложений на модель
  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – IP-адрес пользователя
Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • FieldsParamError – недопустимое значение параметра fields
Returns:

Товарное предложение по умолчанию

Return type:

ModelOffersDefault

model_offers_filters(model_id, fields=None, filter_set=None, sort='NONE')

Список фильтров для предложений на модель

Parameters:
  • model_id (int or str) – Идентификатор модели
  • fields (str or list[str]) –

    Группы параметров, которые необходимо отобразить в выходных данных

    • ALLVENDORS — группа параметров для фильтра «Производитель
    • DESCRIPTION — описания фильтров
    • FOUND — количество моделей или товарных предложений
    • SORTS — включение в выдачу доступных фильтров
    • STANDARD = ALLVENDORS, DESCRIPTION, FOUND, SORTS
    • ALL - Все значения

    Note

    Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS

  • filter_set (str) –

    Набор фильтров в выходных данных:

    • ALL — все фильтры
    • BASIC — базовый набор фильтров
    • POPULAR — только популярные фильтры

    Note

    Значение BASIC равнозначно POPULAR

  • sort (str) – Задает тип сортировки значений в фильтрах
Raises:
  • FieldsParamError – недопустимое значение параметра fields
  • FilterSetParamError – недопустимое значение параметра filter_set
  • SortParamError – недопустимое значение параметра sort
Returns:

Cписок фильтров и сортировок, доступных для фильтрации и сортировки товарных предложений указанной модели

Return type:

Filters

model_offers_stat(model_id, geo_id=None, remote_ip=None)

Количество товарных предложений на модель по регионам :param model_id: Идентификатор модели :type model_id: int or str

Parameters:
  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – IP-адрес пользователя
Raises:

NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip

Returns:

Информация о количестве товарных предложений на указанную модель по регионам, а также минимальную, максимальную и среднюю стоимость этой модели

Return type:

ModelOffersStat

model_opinions(model_id, grade=None, max_comments=0, count=30, page=1, how=None, sort='DATE')

Отзывы о модели

Parameters:
  • model_id (int or str) – Идентификатор модели
  • grade (int) – Оценка, выставленная автором отзыва
  • max_comments (int) – Максимальное количество комментариев, возвращаемых для каждого отзыва
  • count (int) – IP-адрес пользователя
  • page (int) – Номер страницы
  • how (str) – Направление сортировки
  • sort (str) – Тип сортировки отзывов
Raises:
  • GradeParamError – недопустимое значение параметра grade
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
  • HowParamError – недопустимое значение параметра how
  • SortParamError – недопустимое значение параметра sort
Returns:

Отзывы пользователей о модели

Return type:

ModelOpinions

model_outlets(model_id, boundary=None, fields='STANDARD', outlet_type='PICKUP, STORE', filters=None, count=30, page=1, how=None, sort='RELEVANCY', latitude=None, longitude=None, geo_id=None, remote_ip=None)

Список пунктов выдачи модели

Parameters:
  • model_id (int or str) – Идентификатор модели
  • boundary (str) – Координаты квадрата на местности для выдачи точек продаж на карте.
  • fields (str or list[str]) –

    Поля точек продажи, которые попадут в выдачу

    • OFFER — Информация о товарнном предложении, соответствующем точке продажи
    • OFFER_ACTIVE_FILTERS — активные фильтры.
    • OFFER_CATEGORY — информация о категории предложения.
    • OFFER_DELIVERY — информация о доставке.
    • OFFER_DISCOUNT — скидка.
    • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
    • OFFER_OUTLET — информация о точке выдачи производетеля.
    • OFFER_OUTLET_COUNT — Количество точек выдачи предложения
    • OFFER_PHOTO — фото предложения.
    • OFFER_SHOP — магазин от которого поступило предложенение.
    • OFFER_VENDOR — информация о поставщике.
    • SHOP — Информация о магазине, сортировка по полезности отзыва
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
    • SHOP_RATING — рейтинг магазина.
    • ALL = Все значения
    • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, OFFER_VENDOR
    • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
    • STANDARD = OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, SHOP_RATING
  • outlet_type (str or list[str]) –

    Типы пунктов выдачи товара

    • PICKUP — Самовывоз
    • STORE — Магазин
    • ALL = Все значения
  • filters (dict) – Параметры задают условия фильтрации моделей и предложений на модель
  • count (int) – Размер страницы (количество элементов на странице)
  • page (int) – Номер страницы
  • how (str) – Направление сортировки
  • sort (str) –

    Тип сортировки товарных предложений

    • DATE — сортировка по дате
    • DELIVERY_TIME — сортировка по времени доставки
    • DISCOUNT — сортировка по размеру скидки
    • DISTANCE — сортировка по расстоянию до ближайшей точки продаж (значение доступно только при указании местоположения пользователя)
    • NOFFERS — сортировка по количеству предложений
    • OPINIONS — сортировка по количеству отзывов
    • POPULARITY — сортировка по популярности
    • PRICE — сортировка по цене
    • QUALITY — сортировка по рейтингу
    • RATING — сортировка по рейтингу
    • RELEVANCY — сортировка по релевантности
  • latitude (float) – Широта
  • longitude (float) – Долгота
  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – Идентификатор региона пользователя
Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • FieldsParamError – недопустимое значение параметра fields
  • TypeParamError – недопустимое значение параметра type
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
  • HowParamError – недопустимое значение параметра how
  • SortParamError – недопустимое значение параметра sort
  • GeoParamError – недопустимое значение параметра latitude
  • GeoParamError – недопустимое значение параметра longitude
Returns:

Список пунктов выдачи/точек продаж, в которых представлена указанная модель

Return type:

Outlets

models_lookas(model_id, count=30, page=1, fields='CATEGORY, PHOTO', geo_id=None, remote_ip=None)

Список похожих моделей

Parameters:
  • model_id (int or str) – Идентификатор модели
  • count (int) – Количество элементов на странице
  • page (int) – Номер страницы
  • fields (str or list[str]) –

    Параметры моделей, которые необходимо показать в выходных данных

    • CATEGORY — Информация о категории, к которой относится модель
    • DEFAULT_OFFER — информация о товарном предложении по умолчанию для модели в указанном регионе.
    • DISCOUNTS — информация о скидках на модель.
    • FACTS — Список достоинств и недостатков модели
    • FILTERS — список фильтров, доступных для отбора модификаций модели.
    • FILTER_ALLVENDORS — группа параметров для фильтра «Производитель».
    • FILTER_COLOR — список фильтров по цвету, доступных для отбора модификаций модели.
    • FILTER_DESCRIPTION — описания фильтров.
    • FILTER_FOUND — количество моделей или товарных предложений:
    • FILTER_SORTS — включение в выдачу доступных фильтров.
    • MEDIA — информация об отзывах и обзорах на модель.
    • MODIFICATIONS — краткая информация о модификациях (для групповой модели).
    • NAVIGATION_NODE — информация о навигационном узле дерева категорий Маркета, к которому относится модель.
    • NAVIGATION_NODE_DATASOURCE — источник данных узла навигационного дерева.
    • NAVIGATION_NODE_ICONS — иконки навигационного дерева.
    • NAVIGATION_NODE_STATISTICS — статистика узла навигационного дерева.
    • OFFERS — информация о товарных предложениях, соотнесенных с моделью, в указанном регионе.
    • OFFER_ACTIVE_FILTERS — активные фильтры.
    • OFFER_CATEGORY — информация о категории предложения.
    • OFFER_DELIVERY — информация о доставке.
    • OFFER_DISCOUNT — скидка.
    • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
    • OFFER_OUTLET — информация о точке выдачи производетеля.
    • OFFER_PHOTO — фото предложения.
    • OFFER_SHOP — магазин от которого поступило предложенение.
    • OFFER_VENDOR — информация о поставщике.
    • PHOTO — Изображение модели, используемое как основное изображение на карточке модели
    • PHOTOS — все доступные изображения модели.
    • PRICE — информация о ценах на модель.
    • RATING — иформация о рейтинге и оценках модели.
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
    • SHOP_RATING — рейтинг магазина.
    • SPECIFICATION — характеристики модели.
    • VENDOR — информация о производителе.
    • ALL = Все значения
    • FILTER_ALL = FILTER_ALLVENDORS, FILTER_DESCRIPTION, FILTER_FOUND, FILTER_SORTS
    • NAVIGATION_NODE_ALL = NAVIGATION_NODE_DATASOURCE, NAVIGATION_NODE_ICONS, NAVIGATION_NODE_STATISTICS
    • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_PHOTO, OFFER_SHOP, OFFER_VENDOR
    • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
    • STANDARD = CATEGORY, OFFERS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_PHOTO, OFFER_SHOP, PHOTO, PRICE, RATING, SHOP_RATING, VENDOR
    • VENDOR_ALL = VENDOR_LINK

    Note

    Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS

  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – IP-адрес пользователя
Returns:

Cписок моделей, которые похожи на указанную в запросе

Return type:

Models

Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
  • FieldsParamError – недопустимое значение параметра fields
models_match(name, category_count=1, fields='CATEGORY, PHOTO', match_types='MULTI, REPORT', category_name=None, description=None, locale='RU_ru', price=None, shop_name=None, category_id=None, hid=None)

Поиск модели по названию и параметрам

Parameters:
  • name (str) – Имя
  • category_count (int) – Количество категорий
  • fields (str or list[str]) –

    Параметры моделей, которые необходимо показать в выходных данных

    • CATEGORY — Информация о категории, к которой относится модель
    • DEFAULT_OFFER — информация о товарном предложении по умолчанию для модели в указанном регионе.
    • DISCOUNTS — информация о скидках на модель.
    • FACTS — Список достоинств и недостатков модели
    • FILTERS — список фильтров, доступных для отбора модификаций модели.
    • FILTER_ALLVENDORS — группа параметров для фильтра «Производитель».
    • FILTER_COLOR — список фильтров по цвету, доступных для отбора модификаций модели.
    • FILTER_DESCRIPTION — описания фильтров.
    • FILTER_FOUND — количество моделей или товарных предложений:
    • FILTER_SORTS — включение в выдачу доступных фильтров.
    • MEDIA — информация об отзывах и обзорах на модель.
    • MODIFICATIONS — краткая информация о модификациях (для групповой модели).
    • NAVIGATION_NODE — информация о навигационном узле дерева категорий Маркета, к которому относится модель.
    • NAVIGATION_NODE_DATASOURCE — источник данных узла навигационного дерева.
    • NAVIGATION_NODE_ICONS — иконки навигационного дерева.
    • NAVIGATION_NODE_STATISTICS — статистика узла навигационного дерева.
    • OFFERS — информация о товарных предложениях, соотнесенных с моделью, в указанном регионе.
    • OFFER_ACTIVE_FILTERS — активные фильтры.
    • OFFER_CATEGORY — информация о категории предложения.
    • OFFER_DELIVERY — информация о доставке.
    • OFFER_DISCOUNT — скидка.
    • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
    • OFFER_OUTLET — информация о точке выдачи производетеля.
    • OFFER_PHOTO — фото предложения.
    • OFFER_SHOP — магазин от которого поступило предложенение.
    • OFFER_VENDOR — информация о поставщике.
    • PHOTO — Изображение модели, используемое как основное изображение на карточке модели
    • PHOTOS — все доступные изображения модели.
    • PRICE — информация о ценах на модель.
    • RATING — иформация о рейтинге и оценках модели.
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
    • SHOP_RATING — рейтинг магазина.
    • SPECIFICATION — характеристики модели.
    • VENDOR — информация о производителе.
    • ALL = Все значения
    • FILTER_ALL = FILTER_ALLVENDORS, FILTER_DESCRIPTION, FILTER_FOUND, FILTER_SORTS
    • NAVIGATION_NODE_ALL = NAVIGATION_NODE_DATASOURCE, NAVIGATION_NODE_ICONS, NAVIGATION_NODE_STATISTICS
    • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_PHOTO, OFFER_SHOP, OFFER_VENDOR
    • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
    • STANDARD = CATEGORY, OFFERS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_PHOTO, OFFER_SHOP, PHOTO, PRICE, RATING, SHOP_RATING, VENDOR
    • VENDOR_ALL = VENDOR_LINK

    Note

    Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS

  • match_types (str or list[str]) –

    Типы поиска

    • BATCH — Матчинг пачки офферов. Возвращает в ответ пачку результатов аналогичной длины - по одному результату на оффер
    • MULTI — Мультиматчинг одного оффера. Возвращает в ответ все найденные результаты по одному офферу.
    • MULTI_STRING — Мультиматчинг строки текста. Возвращает в ответ все найденные результаты по исследуемой строке.
    • REPORT — Логика репорта
    • STRING — Матчинг строки текста. Возвращает в ответ ровно один наилучший найденный результат.
  • category_name (str) – Наименование категории
  • description (str) – Описание модели
  • locale (str) – Локаль поиска
  • price (str or int) – Цена модели
  • shop_name (str) – Наименование магазина
  • category_id (list[int]) – Идентификаторы категорий
  • hid (list[int]) – Идентификаторы категорий
Returns:

Модель из гуризованной категории по названию и параметрам, удовлетворяющим заданным во входных данных условиям поиска

Return type:

Models

Raises:
  • FieldsParamError – недопустимое значение параметра fields
  • MatchTypeParamError – недопустимое значение параметра match_types
models_reviews(model_id, count=30, page=1)

Список обзоров на модель

Parameters:
  • model_id (int or str) – Идентификатор модели
  • count (int) – Количество элементов на странице
  • page (int) – Номер страницы
Returns:

Обзоры на модель

Return type:

ModelReview

Raises:
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
offer(offer_id, delivery_included=0, fields='STANDARD', geo_id=None, remote_ip=None)

Информация о товарном предложении

Parameters:
  • offer_id (str) – Идентификатор товарного предложения
  • delivery_included (bool) – Признак включения цены доставки в цену товарного предложения
  • fields (str or list[str]) –

    Параметры предложений, которые необходимо показать в выходных данных

    • ACTIVE_FILTERS — активные фильтры
    • CATEGORY — информация о категории предложения
    • DELIVERY — информация о доставке
    • DISCOUNT — скидка
    • OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине
    • OUTLET — информация о точке выдачи производетеля
    • OUTLET_COUNT — Количество точек выдачи предложени
    • PHOTO — фото предложения
    • SHOP — магазин от которого поступило предложенение
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты
    • SHOP_RATING — рейтинг магазина
    • VENDOR — информация о поставщике
    • ALL = Все значения
    • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
    • STANDARD = CATEGORY, DELIVERY, OUTLET, OUTLET_COUNT, PHOTO, SHOP, SHOP_RATING
  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – IP-адрес пользователя
Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • DeliveryIncludedParamError – недопустимое значение параметра delivery_included
  • FieldsParamError – недопустимое значение параметра fields
Returns:

Информация об указанном товарном предложении

Return type:

Offer

offer_outlets(offer_id, boundary=None, fields='STANDARD', outlet_type='PICKUP, STORE', filters=None, count=30, page=1, how=None, sort='RELEVANCY', latitude=None, longitude=None, geo_id=None, remote_ip=None)

Список пунктов выдачи товарного предложения

Parameters:
  • offer_id (int) – Идентификатор товарного предложения
  • boundary (str) – Координаты квадрата на местности для выдачи точек продаж на карте.
  • fields (str or list[str]) –

    Поля точек продажи, которые попадут в выдачу

    • OFFER — Информация о товарнном предложении, соответствующем точке продажи
    • OFFER_ACTIVE_FILTERS — активные фильтры.
    • OFFER_CATEGORY — информация о категории предложения.
    • OFFER_DELIVERY — информация о доставке.
    • OFFER_DISCOUNT — скидка.
    • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
    • OFFER_OUTLET — информация о точке выдачи производетеля.
    • OFFER_OUTLET_COUNT — Количество точек выдачи предложения
    • OFFER_PHOTO — фото предложения.
    • OFFER_SHOP — магазин от которого поступило предложенение.
    • OFFER_VENDOR — информация о поставщике.
    • SHOP — Информация о магазине, сортировка по полезности отзыва
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
    • SHOP_RATING — рейтинг магазина.
    • ALL = Все значения
    • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, OFFER_VENDOR
    • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
    • STANDARD = OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, SHOP_RATING
  • outlet_type (str or list[str]) –

    Типы пунктов выдачи товара

    • PICKUP — Самовывоз
    • STORE — Магазин
    • ALL = Все значения
  • filters (dict) – Параметры задают условия фильтрации моделей и предложений на модель
  • count (int) – Размер страницы (количество элементов на странице)
  • page (int) – Номер страницы
  • how (str) – Направление сортировки
  • sort (str) –

    Тип сортировки товарных предложений

    • DATE — сортировка по дате
    • DELIVERY_TIME — сортировка по времени доставки
    • DISCOUNT — сортировка по размеру скидки
    • DISTANCE — сортировка по расстоянию до ближайшей точки продаж (значение доступно только при указании местоположения пользователя)
    • NOFFERS — сортировка по количеству предложений
    • OPINIONS — сортировка по количеству отзывов
    • POPULARITY — сортировка по популярности
    • PRICE — сортировка по цене
    • QUALITY — сортировка по рейтингу
    • RATING — сортировка по рейтингу
    • RELEVANCY — сортировка по релевантности
  • latitude (float) – Широта
  • longitude (float) – Долгота
  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – Идентификатор региона пользователя
Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • FieldsParamError – недопустимое значение параметра fields
  • TypeParamError – недопустимое значение параметра type
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
  • HowParamError – недопустимое значение параметра how
  • SortParamError – недопустимое значение параметра sort
  • GeoParamError – недопустимое значение параметра latitude
  • GeoParamError – недопустимое значение параметра longitude
Returns:

Список пунктов выдачи/точек продаж указанного товарного предложения

Return type:

Outlets

redirect(text, redirect_types='SEARCH', barcode=False, search_type=None, category_id=None, hid=None, fields=None, user_agent=None, count=30, page=1, how=None, sort=None, geo_id=None, remote_ip=None)

Редирект (перенаправление)

Parameters:
  • text (str) – Текст запроса
  • redirect_types (str or list[str]) –

    Типы редиректов

    • CATALOG — Страница категории
    • MODEL — Страница модели
    • SEARCH — Страница поиска (он же тип по умолчанию, если страница неизвестного типа, и есть текст по которому можно искать)
    • VENDOR — Страница производителя
    • ALL = Все значения
  • barcode (bool) – Признак поиска по штрихкоду
  • search_type (str) – Тип поискового запроса
  • category_id (int) – Идентификаторы категорий
  • hid (int) – Идентификаторы категорий
  • fields (str or list[str]) –

    Праметры модели/товарного предложения, которые необходимо показать в выходных данных.

    • CATEGORY_PARENT — информация о родительской категории.
    • CATEGORY_STATISTICS — статистика по категории. Например, количество моделей и товарных предложений в категории.
    • CATEGORY_WARNINGS — предупреждения, связанные с показом категории.
    • FILTERS — Список фильтров в результатах запроса офферов
    • FOUND_CATEGORIES — категории, в которых нашлись результаты по этому запросу
    • MODEL_CATEGORY — Информация о категории, к которой относится модель
    • MODEL_DEFAULT_OFFER — информация о товарном предложении по умолчанию для модели в указанном регионе.
    • MODEL_DISCOUNTS — информация о скидках на модель.
    • MODEL_FACTS — Список достоинств и недостатков модели
    • MODEL_FILTER_COLOR — список фильтров по цвету, доступных для отбора модификаций модели.
    • MODEL_MEDIA — информация об отзывах и обзорах на модель.
    • MODEL_NAVIGATION_NODE — информация о навигационном узле дерева категорий Маркета, к которому относится модель.
    • MODEL_OFFERS — информация о товарных предложениях, соотнесенных с моделью, в указанном регионе.
    • MODEL_PHOTO — Изображение модели, используемое как основное изображение на карточке модели
    • MODEL_PHOTOS — все доступные изображения модели.
    • MODEL_PRICE — информация о ценах на модель.
    • MODEL_RATING — иформация о рейтинге и оценках модели.
    • MODEL_SPECIFICATION — характеристики модели.
    • MODEL_VENDOR — информация о производителе.
    • OFFER_ACTIVE_FILTERS — активные фильтры.
    • OFFER_CATEGORY — информация о категории предложения.
    • OFFER_DELIVERY — информация о доставке.
    • OFFER_DISCOUNT — скидка.
    • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
    • OFFER_OUTLET — информация о точке выдачи производетеля.
    • OFFER_OUTLET_COUNT — Количество точек выдачи предложения
    • OFFER_PHOTO — фото предложения.
    • OFFER_SHOP — магазин от которого поступило предложенение.
    • OFFER_VENDOR — информация о поставщике.
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
    • SHOP_RATING — рейтинг магазина.
    • SORTS — Доступные варианты сортировок для запроса
    • VENDOR_CATEGORIES — Описание категорий, в которых представлен данный производитель
    • VENDOR_TOP_CATEGORIES — Список наиболее популярных категорий товаров производителя
    • ALL = Все значения
    • CATEGORY_ALL = LINK, PARENT, STATISTICS, WARNINGS
    • MODEL_ALL = FACTS, MEDIA, DEFAULT_OFFER, PRICE, PHOTOS, DISCOUNTS, NAVIGATION_NODE, RATING, LINK, VENDOR, ACTIVE_FILTERS, OFFERS, FILTER_COLOR, SPECIFICATION, CATEGORY, PHOTO
    • OFFER_ALL = DISCOUNT, SHOP, PHOTO, DELIVERY, CATEGORY, VENDOR, OUTLET_COUNT, OUTLET, ACTIVE_FILTERS, LINK, BUNDLE_SETTINGS, OFFERS_LINK
    • SHOP_ALL = ORGANIZATION, RATING
    • VENDOR_ALL = LINK, CATEGORIES, TOP_CATEGORIES
  • user_agent (str) – Признак включения цены доставки в цену товарного предложения
  • count (int) – Размер страницы (количество элементов на странице)
  • page (int) – Номер страницы
  • how (str) – Направление сортировки
  • sort (str) – Тип сортировки товарных предложений
  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – Идентификатор региона пользователя
Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • RedirectTypesParamError – недопустимое значение параметра redirect_types
  • SearchTypeParamError – недопустимое значение параметра search_type
  • FieldsParamError – недопустимое значение параметра fields
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
  • HowParamError – недопустимое значение параметра how
  • SortParamError – недопустимое значение параметра sort
Returns:

Список параметров редиректа (перенаправления), подходящих под заданные в запросе условия.

Return type:

Redirect

search(text, delivery_included=False, fields=None, onstock=0, outlet_types=None, price_max=None, price_min=None, result_type='ALL', shop_id=None, warranty=0, filters=None, barcode=False, search_type=None, category_id=None, hid=None, count=30, page=1, how=None, sort=None, latitude=None, longitude=None, geo_id=None, remote_ip=None)

Текстовый поиск

Parameters:
  • text (str) – Текст запроса
  • delivery_included (str or int or bool) – Признак включения цены доставки в цену товарного предложения
  • fields (str or list[str]) –

    Праметры модели/товарного предложения, которые необходимо показать в выходных данных.

    • FILTERS — Список фильтров в результатах запроса офферов
    • FOUND_CATEGORIES — категории, в которых нашлись результаты по этому запросу
    • MODEL_CATEGORY — Информация о категории, к которой относится модель
    • MODEL_DEFAULT_OFFER — информация о товарном предложении по умолчанию для модели в указанном регионе.
    • MODEL_DISCOUNTS — информация о скидках на модель.
    • MODEL_FACTS — Список достоинств и недостатков модели
    • MODEL_FILTER_COLOR — список фильтров по цвету, доступных для отбора модификаций модели.
    • MODEL_MEDIA — информация об отзывах и обзорах на модель.
    • MODEL_NAVIGATION_NODE — информация о навигационном узле дерева категорий Маркета, к которому относится модель.
    • MODEL_OFFERS — информация о товарных предложениях, соотнесенных с моделью, в указанном регионе.
    • MODEL_PHOTO — Изображение модели, используемое как основное изображение на карточке модели
    • MODEL_PHOTOS — все доступные изображения модели.
    • MODEL_PRICE — информация о ценах на модель.
    • MODEL_RATING — иформация о рейтинге и оценках модели.
    • MODEL_SPECIFICATION — характеристики модели.
    • MODEL_VENDOR — информация о производителе.
    • OFFER_ACTIVE_FILTERS — активные фильтры.
    • OFFER_CATEGORY — информация о категории предложения.
    • OFFER_DELIVERY — информация о доставке.
    • OFFER_DISCOUNT — скидка.
    • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
    • OFFER_OUTLET — информация о точке выдачи производетеля.
    • OFFER_OUTLET_COUNT — Количество точек выдачи предложения
    • OFFER_PHOTO — фото предложения.
    • OFFER_SHOP — магазин от которого поступило предложенение.
    • OFFER_VENDOR — информация о поставщике.
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
    • SHOP_RATING — рейтинг магазина.
    • SORTS — Доступные варианты сортировок для запроса
    • ALL = Все значения
    • MODEL_ALL = MODEL_ACTIVE_FILTERS, MODEL_CATEGORY, MODEL_DEFAULT_OFFER, MODEL_DISCOUNTS, MODEL_FACTS, MODEL_FILTER_COLOR, MODEL_LINK, MODEL_MEDIA, MODEL_NAVIGATION_NODE, MODEL_OFFERS, MODEL_PHOTO, MODEL_PHOTOS, MODEL_PRICE, MODEL_RATING, MODEL_SPECIFICATION, MODEL_VENDOR
    • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, OFFER_VENDOR
    • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
    • STANDARD = MODEL_CATEGORY, MODEL_OFFERS, MODEL_PHOTO, MODEL_PRICE, MODEL_RATING, MODEL_VENDOR, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, SHOP_RATING
  • onstock (str or int or bool) – Признак в наличии
  • outlet_types (str or list[str]) –

    Типы точек продажи

    • DELIVERY — Доставка курьером/почтой
    • PICKUP — Самовывоз
    • STORE — Магазин
    • ALL = Все значения
  • price_max (int) – Максимальная цена
  • price_min (int) – Минимальная цена
  • result_type (str) – Возможные значения
  • shop_id (str or list[str]) – Идентификаторы магазинов
  • warranty (str or int or bool) – Признак “Гарантия производителя”
  • filters (dict) – Параметры задают условия фильтрации моделей и предложений на модель
  • barcode (bool) – Признак поиска по штрихкоду
  • search_type (str) – Тип поискового запроса
  • category_id (int or str) – Идентификаторы категорий
  • hid (int) – Идентификаторы категорий
  • count (int) – Размер страницы (количество элементов на странице)
  • page (int) – Номер страницы
  • how (str) – Направление сортировки
  • sort (str) –

    Тип сортировки товарных предложений

    • DATE — сортировка по дате
    • DELIVERY_TIME — сортировка по времени доставки
    • DISCOUNT — сортировка по размеру скидки
    • DISTANCE — сортировка по расстоянию до ближайшей точки продаж (значение доступно только при указании местоположения пользователя)
    • NOFFERS — сортировка по количеству предложений
    • OPINIONS — сортировка по количеству отзывов
    • POPULARITY — сортировка по популярности
    • PRICE — сортировка по цене
    • QUALITY — сортировка по рейтингу
    • RATING — сортировка по рейтингу
    • RELEVANCY — сортировка по релевантности
  • latitude (float) – Широта
  • longitude (float) – Долгота
  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – Идентификатор региона пользователя
Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • DeliveryIncludedParamError – недопустимое значение параметра delivery_included
  • FieldsParamError – недопустимое значение параметра fields
  • OnstockParamError – недопустимое значение параметра onstock
  • OutletTypesParamError – недопустимое значение параметра outlet_types
  • ResultTypeParamError – недопустимое значение параметра result_type
  • WarrantyParamError – недопустимое значение параметра warranty
  • SearchTypeParamError – недопустимое значение параметра search_type
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
  • HowParamError – недопустимое значение параметра how
  • SortParamError – недопустимое значение параметра sort
  • GeoParamError – недопустимое значение параметра latitude
  • GeoParamError – недопустимое значение параметра longitude
Returns:

Список моделей и товарных предложений, удовлетворяющих заданным в запросе условиям поиска

Return type:

Search

search_filters(text, fields=None, geo_id=None, remote_ip=None)

Фильтры для поискового запроса

Parameters:
  • text (str) – Текст запроса
  • fields (str or list[str]) –

    Поля, которые необходимо показать в выходных данных

    • ALLVENDORS — группа параметров для фильтра «Производитель
    • DESCRIPTION — описания фильтров
    • FOUND — количество моделей или товарных предложений
    • SORTS — включение в выдачу доступных фильтров
    • STANDARD = ALLVENDORS, DESCRIPTION, FOUND, SORTS
    • ALL - Все значения

    Note

    Значение ALL доступно только для отладки и имеет ограничение по нагрузке – один RPS

  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – Идентификатор региона пользователя
Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • FieldsParamError – недопустимое значение параметра fields
Returns:

Список доступных фильтров и сортировок для укзанного поискового запроса

Return type:

Filters

shop(shop_id, fields=None)

Информация о магазине

Parameters:
  • shop_id (int) – Идентификатор магазина
  • fields (str or list[str]) –

    Свойства магазинов, которые необходимо показать в выходных данных

    • DATE — сортировка по дате написания отзыва
    • GRADE — сортировка по оценке пользователем модели
    • RANK — сортировка по полезности отзыва
Raises:

FieldsParamError – недопустимое значение параметра fields

Returns:

Информация об указанном магазине

Return type:

Shop

shop_opinions(shop_id, grade=None, max_comments=0, count=30, page=1, how=None, sort='DATE')

Отзывы о магазине

Parameters:
  • shop_id (int) – Идентификатор магазина
  • grade (int) – Оценка, выставленная автором отзыва
  • max_comments (int) – Максимальное количество комментариев, возвращаемых для каждого отзыва
  • count (int) – IP-адрес пользователя
  • page (int) – Номер страницы
  • how (str) – Направление сортировки
  • sort (str) – Тип сортировки отзывов
Raises:
  • GradeParamError – недопустимое значение параметра grade
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
  • HowParamError – недопустимое значение параметра how
  • SortParamError – недопустимое значение параметра sort
Returns:

Отзывы пользователей о магазине

Return type:

ShopOpinions

shop_opinions_chronological(shop_id, grade=None, max_comments=0, count=20, page=1)

Отзывы о магазине в хронологическом порядке

Parameters:
  • shop_id (int) – Идентификатор магазина
  • grade (int) – Оценка, выставленная автором отзыва
  • max_comments (int) – Максимальное количество комментариев, возвращаемых для каждого отзыва
  • count (int) – IP-адрес пользователя
  • page (int) – Номер страницы
Raises:
  • GradeParamError – недопустимое значение параметра grade
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
Returns:

Отзывы пользователей о магазине

Return type:

ShopOpinions

shop_outlets(shop_id, boundary=None, fields='STANDARD', outlet_type='PICKUP, STORE', filters=None, count=30, page=1, how=None, sort='RELEVANCY', latitude=None, longitude=None)

Пункты выдачи товаров магазина

Parameters:
  • shop_id (int) – Идентификатор магазина
  • boundary (str) – Координаты квадрата на местности для выдачи точек продаж на карте.
  • fields (str or list[str]) –

    Поля точек продажи, которые попадут в выдачу

    • OFFER — Информация о товарнном предложении, соответствующем точке продажи
    • OFFER_ACTIVE_FILTERS — активные фильтры.
    • OFFER_CATEGORY — информация о категории предложения.
    • OFFER_DELIVERY — информация о доставке.
    • OFFER_DISCOUNT — скидка.
    • OFFER_OFFERS_LINK — Ссылка на страницу с офферами для той же модели в том же магазине.
    • OFFER_OUTLET — информация о точке выдачи производетеля.
    • OFFER_OUTLET_COUNT — Количество точек выдачи предложения
    • OFFER_PHOTO — фото предложения.
    • OFFER_SHOP — магазин от которого поступило предложенение.
    • OFFER_VENDOR — информация о поставщике.
    • SHOP — Информация о магазине, сортировка по полезности отзыва
    • SHOP_ORGANIZATION — юридическая информация: юридический и фактический адрес, ОГРН, тип организации, ссылка на реквизиты.
    • SHOP_RATING — рейтинг магазина.
    • ALL = Все значения
    • OFFER_ALL = OFFER_ACTIVE_FILTERS, OFFER_BUNDLE_SETTINGS, OFFER_CATEGORY, OFFER_DELIVERY, OFFER_DISCOUNT, OFFER_LINK, OFFER_OFFERS_LINK, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, OFFER_VENDOR
    • SHOP_ALL = SHOP_ORGANIZATION, SHOP_RATING
    • STANDARD = OFFER_CATEGORY, OFFER_DELIVERY, OFFER_OUTLET, OFFER_OUTLET_COUNT, OFFER_PHOTO, OFFER_SHOP, SHOP_RATING
  • outlet_type (str or list[str]) –

    Типы пунктов выдачи товара

    • PICKUP — Самовывоз
    • STORE — Магазин
    • ALL = Все значения
  • filters (dict) – Параметры задают условия фильтрации моделей и предложений на модель
  • count (int) – Размер страницы (количество элементов на странице)
  • page (int) – Номер страницы
  • how (str) – Направление сортировки
  • sort (str) –

    Тип сортировки товарных предложений

    • DATE — сортировка по дате
    • DELIVERY_TIME — сортировка по времени доставки
    • DISCOUNT — сортировка по размеру скидки
    • DISTANCE — сортировка по расстоянию до ближайшей точки продаж (значение доступно только при указании местоположения пользователя)
    • NOFFERS — сортировка по количеству предложений
    • OPINIONS — сортировка по количеству отзывов
    • POPULARITY — сортировка по популярности
    • PRICE — сортировка по цене
    • QUALITY — сортировка по рейтингу
    • RATING — сортировка по рейтингу
    • RELEVANCY — сортировка по релевантности
  • latitude (float) – Широта
  • longitude (float) – Долгота
Raises:
  • FieldsParamError – недопустимое значение параметра fields
  • TypeParamError – недопустимое значение параметра type
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
  • HowParamError – недопустимое значение параметра how
  • SortParamError – недопустимое значение параметра sort
  • GeoParamError – недопустимое значение параметра latitude
  • GeoParamError – недопустимое значение параметра longitude
Returns:

Cписок пунктов выдачи/точек продаж магазина

Return type:

Outlets

shops(host, fields=None, geo_id=None)

Поиск магазина по хосту или URL

Parameters:
  • host (str) – Хост или URL магазина, который требуется найти
  • fields (str or list[str]) –

    Свойства магазинов, которые необходимо показать в выходных данных

    • DATE — сортировка по дате написания отзыва
    • GRADE — сортировка по оценке пользователем модели
    • RANK — сортировка по полезности отзыва
  • geo_id (int or str) – Идентификатор региона
Raises:
  • NoGeoIdOrIP – недопустимое значение параметра geo_id
  • FieldsParamError – недопустимое значение параметра fields
Returns:

Информация о найденном магазине по указанному в запросе хосту или URL

Return type:

Shops

suggestions(text, count=30, page=1, pos=None, suggest_types='DEFAULT', geo_id=None, remote_ip=None)

Поисковые подсказки

Parameters:
  • text (str) – Текст запроса
  • count (int) – Размер страницы (количество элементов на странице)
  • page (int) – Номер страницы
  • pos (int) – Позиция курсора в поисковой подсказке
  • suggest_types (str or list[str]) –

    Типы поисковых подсказок

    • CATALOG — Страница категории
    • MODEL — Страница модели
    • SEARCH — Страница поиска (он же тип по умолчанию, если страница неизвестного типа, и есть текст по которому можно искать)
    • VENDOR — Страница производителя
    • ALL = Все значения
    • DEFAULT = CATALOG, MODEL, SEARCH, VENDOR
  • geo_id (int or str) – Идентификатор региона
  • remote_ip (str) – IP-адрес пользователя
Raises:
  • NoGeoIdOrIP – не передан обязательный параметр geo_id или remote_ip
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
  • PosParamError – недопустимое значение параметра pos
  • SuggestTypesParamError – недопустимое значение параметра suggest_types
Returns:

Список поисковых подсказок, подходящих под заданные условия поиска

Return type:

Suggestions

vendor(vendor_id, fields=None)

Информация о производителе

Parameters:
  • vendor_id (int) – Идентификатор производителя
  • fields (str or list[str]) –

    Свойства производителя, которые необходимо показать в выходных данных

    • CATEGORIES — Описание категорий, в которых представлен данный производитель
    • CATEGORY_PARENT — информация о родительской категории.
    • CATEGORY_STATISTICS — статистика по категории. Например, количество моделей и товарных предложений в категории.
    • CATEGORY_WARNINGS — предупреждения, связанные с показом категории.
    • TOP_CATEGORIES — Список наиболее популярных категорий товаров производителя
    • ALL = Все значения
    • CATEGORY_ALL = CATEGORY_LINK, CATEGORY_PARENT, CATEGORY_STATISTICS, CATEGORY_WARNINGS
Raises:

FieldsParamError – недопустимое значение параметра fields

Returns:

Информация об указанном производителе

Return type:

Vendor

vendors(fields=None, count=30, page=1)

Список производителей

Parameters:
  • fields (str or list[str]) –

    Параметры региона, которые необходимо включить в выдачу

    • CATEGORIES — Описание категорий, в которых представлен данный производитель
    • CATEGORY_PARENT — информация о родительской категории.
    • CATEGORY_STATISTICS — статистика по категории. Например, количество моделей и товарных предложений в категории.
    • CATEGORY_WARNINGS — предупреждения, связанные с показом категории.
    • TOP_CATEGORIES — Список наиболее популярных категорий товаров производителя
    • ALL = Все значения
    • CATEGORY_ALL = CATEGORY_LINK, CATEGORY_PARENT, CATEGORY_STATISTICS, CATEGORY_WARNINGS
  • count (int) – Размер страницы (количество элементов на странице)
  • page (int) – Номер страницы
Raises:
  • FieldsParamError – недопустимое значение параметра fields
  • CountParamError – недопустимое значение параметра count
  • PageParamError – недопустимое значение параметра page
Returns:

Cписок производителей, товары которых размещаются на Яндекс.Маркете

Return type:

Vendors

vendors_match(name, fields=None)

Подбор производителя по названию

Parameters:
  • name (str) – Название производителя
  • fields (str or list[str]) –

    Свойства производителя, которые необходимо показать в выходных данных

    • CATEGORIES — Описание категорий, в которых представлен данный производитель
    • CATEGORY_PARENT — информация о родительской категории.
    • CATEGORY_STATISTICS — статистика по категории. Например, количество моделей и товарных предложений в категории.
    • CATEGORY_WARNINGS — предупреждения, связанные с показом категории.
    • TOP_CATEGORIES — Список наиболее популярных категорий товаров производителя
    • ALL = Все значения
    • CATEGORY_ALL = CATEGORY_LINK, CATEGORY_PARENT, CATEGORY_STATISTICS, CATEGORY_WARNINGS
Raises:

FieldsParamError – недопустимое значение параметра fields

Returns:

Производитель, наиболее подходящего под заданное во входных данных название

Return type:

Vendor