Список предложений для модели
Возвращает информацию о первых десяти предложениях, расположенных на карточке модели.
Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели.
Для групповых моделей метод не поддерживается. Идентификатор групповой модели игнорируется.
Для методов GET models/{modelId}/offers
и POST models/offers
действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.
⚙️ Лимит: рассчитывается индивидуально |
---|
Request
GET
https://api.partner.market.yandex.ru/models/{modelId}/offers
Path parameters
Name |
Type |
Description |
modelId* |
integer<int64> |
Идентификатор модели товара. |
Query parameters
Name |
Type |
Description |
regionId* |
integer<int64> |
Идентификатор региона. Идентификатор региона можно получить c помощью запроса GET regions. |
currency |
Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения:
Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина). |
|
orderByPrice |
Направление сортировки по цене. Возможные значения:
Значение по умолчанию: предложения выводятся в произвольном порядке. |
|
count |
integer<int32> |
Количество предложений на странице ответа. |
page |
integer<int32> |
Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром
|
CurrencyType
Коды валют. Возможные значения:
BYR
— белорусский рубль.KZT
— казахстанский тенге.RUR
— российский рубль.UAH
— украинская гривна.
Type |
Description |
Enum: |
SortOrderType
Направление сортировки.
Возможные значения:
ASC
— сортировка по возрастанию.DESC
— сортировка по убыванию.
Type |
Description |
Enum: |
Responses
200 OK
Список предложений для модели.
Body
{
"models": [
{
"id": 0,
"name": "string",
"prices": {
"avg": 0,
"max": 0,
"min": 0
},
"offers": [
{
"discount": 0,
"name": "string",
"pos": 0,
"preDiscountPrice": 0,
"price": 0,
"regionId": 0,
"shippingCost": 0,
"shopName": "string",
"shopRating": 0,
"inStock": 0
}
],
"offlineOffers": 0,
"onlineOffers": 0
}
],
"currency": "RUR",
"regionId": 0
}
Name |
Type |
Description |
models |
Список моделей товаров. |
|
currency |
Коды валют. Возможные значения:
|
|
regionId |
integer<int64> |
Идентификатор региона, для которого выводится информация о предложениях модели (доставляемых в этот регион). Информацию о регионе по идентификатору можно получить с помощью запроса GET regions/{regionId}. |
EnrichedModelDTO
Модель товара.
Name |
Type |
Description |
id |
integer<int64> |
Идентификатор модели товара. |
name |
string |
Название модели товара. |
prices |
Информация о ценах на модель товара. |
|
offers |
Список первых десяти предложений, расположенных на карточке модели. В ответе на запрос возвращаются предложения различных магазинов. Если есть несколько предложений от одного магазина, в ответе отображается только одно, наиболее релевантное из них.
|
|
offlineOffers |
integer<int32> |
Суммарное количество предложений в розничных магазинах в регионе. Учитываются все предложения от каждого магазина. |
onlineOffers |
integer<int32> |
Суммарное количество предложений в интернет-магазинах в регионе. Учитываются все предложения от каждого магазина. |
ModelPriceDTO
Информация о ценах на модель товара.
Name |
Type |
Description |
avg |
number |
Средняя цена предложения для модели в регионе. |
max |
number |
Максимальная цена предложения для модели в регионе. |
min |
number |
Минимальная цена предложения для модели в регионе. |
ModelOfferDTO
Информация о предложении.
Name |
Type |
Description |
discount |
integer<int32> |
Скидка на предложение, в %. |
name |
string |
Наименование предложения. |
pos |
integer<int32> |
Позиция предложения в выдаче Маркета на карточке модели. |
preDiscountPrice |
number |
Цена предложения без скидки магазина. |
price |
number |
Цена предложения без скидки, которую получает покупатель при оплате через Yandex Pay. |
regionId |
integer<int64> |
Идентификатор региона предложения (регион, откуда доставляется товар). Сначала показываются предложения, доставляемые из региона, указанного в запросе в параметре |
shippingCost |
number |
Стоимость доставки товара в регион. Если значение параметра — |
shopName |
string |
Название магазина (в том виде, в котором отображается на Маркете). |
shopRating |
integer<int32> |
Рейтинг магазина. Возможные значения:
|
inStock |
integer<int32> |
Внимание Параметр устарел и не рекомендуется к использованию. |
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
Name |
Type |
Description |
code* |
string |
Код ошибки. |
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
404 Not Found
Запрашиваемый ресурс не найден.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
Name |
Type |
Description |
status |
Тип ответа.
|
|
errors |
Список ошибок. |
Суточный лимит зависит от количества:
- предложений на карточках моделей;
- активных магазинов клиента.
Количество предложений считается по данным за последние семь дней (не включая сегодня). Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.
Для клиентов с несколькими магазинами ограничение рассчитывается с учетом количества предложений, являющегося максимальным среди всех магазинов клиента. Для агентств ограничение суммируется по всем субклиентам агентства.