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

Deprecated

Метод доступен для модели DBS.

Пока недоступен для продавцов Market Yandex Go.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Возвращает информацию о первых десяти предложениях, расположенных на карточке модели.

Предложения выдаются для определенного региона и располагаются в том же порядке, в котором они показываются в выдаче Маркета на карточке модели.

Для групповых моделей метод не поддерживается. Идентификатор групповой модели игнорируется.

Для методов GET models/{modelId}/offers и POST models/offers действует групповое ресурсное ограничение. Ограничение вводится на суммарное количество моделей, информация о которых запрошена при помощи этих методов.

⚙️ Лимит: 100 000 предложений в час

Request

GET

https://api.partner.market.yandex.ru/models/{modelId}/offers

Path parameters

Name

Description

modelId*

Type: integer<int64>

Идентификатор модели товара.

Min value (exclusive): 0

Query parameters

Name

Description

regionId*

Type: integer<int64>

Идентификатор региона.

Идентификатор региона можно получить c помощью запроса GET regions.

count

Type: integer<int32>

Количество предложений на странице ответа.

Default: 10

currency

Type: CurrencyType

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

Возможные значения:

  • BYN — белорусский рубль.

  • KZT — казахстанский тенге.

  • RUR — российский рубль.

  • UAH — украинская гривна.

Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).

orderByPrice

Type: SortOrderType

Направление сортировки по цене.

Возможные значения:

  • ASC — сортировка по возрастанию.
  • DESC — сортировка по убыванию.

Значение по умолчанию: предложения выводятся в произвольном порядке.

page

Type: integer<int32>

Если в методе есть page_token

Используйте его вместо параметра page.

Подробнее о типах пагинации и их использовании

Номер страницы результатов.

Используется вместе с параметром pageSize.

page игнорируется, если задан page_token или limit.

Default: 1

Max value: 10000

CurrencyType

Коды валют:

  • RUR — российский рубль.
  • UAH — украинская гривна.
  • BYR — белорусский рубль.
  • KZT — казахстанский тенге.
  • UZS — узбекский сум.

Type

Description

CurrencyType

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

SortOrderType

Направление сортировки:

  • ASC — сортировка по возрастанию.
  • DESC — сортировка по убыванию.

Type

Description

SortOrderType

Enum: ASC, DESC

Responses

200 OK

Список предложений для модели.

Body

application/json
{
    "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

Description

models*

Type: EnrichedModelDTO[]

Список моделей товаров.
Модель товара.
Модель товара.

currency

Type: CurrencyType

Коды валют:

  • RUR — российский рубль.
  • UAH — украинская гривна.
  • BYR — белорусский рубль.
  • KZT — казахстанский тенге.
  • UZS — узбекский сум.

Enum: RUR, USD, EUR, UAH, AUD, GBP, BYR, BYN, DKK, ISK, KZT, CAD, CNY, NOK, XDR, SGD, TRY, SEK, CHF, JPY, AZN, ALL, DZD, AOA, ARS, AMD, AFN, BHD, BGN, BOB, BWP, BND, BRL, BIF, HUF, VEF, KPW, VND, GMD, GHS, GNF, HKD, GEL, AED, EGP, ZMK, ILS, INR, IDR, JOD, IQD, IRR, YER, QAR, KES, KGS, COP, CDF, CRC, KWD, CUP, LAK, LVL, SLL, LBP, LYD, SZL, LTL, MUR, MRO, MKD, MWK, MGA, MYR, MAD, MXN, MZN, MDL, MNT, NPR, NGN, NIO, NZD, OMR, PKR, PYG, PEN, PLN, KHR, SAR, RON, SCR, SYP, SKK, SOS, SDG, SRD, TJS, THB, TWD, BDT, TZS, TND, TMM, UGX, UZS, UYU, PHP, DJF, XAF, XOF, HRK, CZK, CLP, LKR, EEK, ETB, RSD, ZAR, KRW, NAD, TL, UE

regionId

Type: integer<int64>

Идентификатор региона, для которого выводится информация о предложениях модели (доставляемых в этот регион).

Информацию о регионе по идентификатору можно получить с помощью запроса GET regions/{regionId}.

EnrichedModelDTO

Модель товара.

Name

Description

id

Type: integer<int64>

Идентификатор модели товара.

name

Type: string

Название модели товара.

offers

Type: ModelOfferDTO[]

Список первых десяти предложений, расположенных на карточке модели.

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

Min items: 1

offlineOffers

Type: integer<int32>

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

onlineOffers

Type: integer<int32>

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

prices

Type: ModelPriceDTO

Информация о ценах на модель товара.

ModelOfferDTO

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

Name

Description

discount

Type: integer<int32>

Скидка на предложение в процентах.

inStock

⦸

Type: integer<int32>

Не используйте этот параметр.

name

Type: string

Наименование предложения.

pos

Type: integer<int32>

Позиция предложения в выдаче Маркета на карточке модели.

preDiscountPrice

Type: number

Цена предложения без скидки магазина.

price

Type: number

Цена предложения без скидки, которую получает покупатель при оплате через Yandex Pay.

regionId

Type: integer<int64>

Идентификатор региона предложения (регион, откуда доставляется товар).

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

shippingCost

Type: number

Стоимость доставки товара в регион:

  • 0 — платить за доставку не нужно.
  • -1 — магазин не осуществляет доставку этого товара (самовывоз).

Если стоимость доставки неизвестна, параметр не выводится.

shopName

Type: string

Название магазина (в том виде, в котором отображается на Маркете).

shopRating

Type: integer<int32>

Рейтинг магазина.

Возможные значения:

  • -1 — у магазинов, недавно появившихся на Маркете, рейтинг появляется не сразу. До момента появления рейтинга для таких магазинов возвращается значение -1.
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.

ModelPriceDTO

Информация о ценах на модель товара.

Name

Description

avg

Type: number

Средняя цена предложения для модели в регионе.

max

Type: number

Максимальная цена предложения для модели в регионе.

min

Type: number

Минимальная цена предложения для модели в регионе.

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

401 Unauthorized

В запросе не указаны данные для авторизации. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

No longer supported, please use an alternative and newer version.

Предыдущая
Несколько моделей
Следующая
Несколько моделей