Request
- Query parameters
- CurrencyType
Responses
200 OK
400 Bad Request
401 Unauthorized
- Body
403 Forbidden
- Body
404 Not Found
- Body
420 Method Failure
- Body
500 Internal Server Error
- Body

Поиск модели товара

Info

Console

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

В одном запросе можно получить информацию не более чем о 100 моделях.

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

⚙️ Лимит: рассчитывается индивидуально

Request

GET

https://api.partner.market.yandex.ru/models

Query parameters

Name	Type	Description
query*	string	Поисковый запрос по названию модели товара.
regionId*	integer<int64>	Идентификатор региона. Идентификатор региона можно получить c помощью запроса GET regions.
currency	CurrencyType	Валюта, в которой отображаются цены предложений на страницах с результатами поиска. Возможные значения: `BYN` — белорусский рубль. `KZT` — казахстанский тенге. `RUR` — российский рубль. `UAH` — украинская гривна. Значение по умолчанию: используется национальная валюта магазина (национальная валюта страны происхождения магазина).
page	integer<int32>	Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром `page_size`. `page_number` игнорируется, если задан `page_token`, `limit` или `offset`.
pageSize	integer<int32>	Размер страницы. Используется вместе с параметром `page_number`. `page_size` игнорируется, если задан `page_token`, `limit` или `offset`.

CurrencyType

Коды валют. Возможные значения:

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

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

{
    "models": [
        {
            "id": 0,
            "name": "string",
            "prices": {
                "avg": 0,
                "max": 0,
                "min": 0
            }
        }
    ],
    "currency": "RUR",
    "regionId": 0,
    "pager": {
        "total": 0,
        "from": 0,
        "to": 0,
        "currentPage": 0,
        "pagesCount": 0,
        "pageSize": 0
    }
}

Name	Type	Description
models	ModelDTO[]	Список моделей товаров. Модель товара.
currency	CurrencyType	Коды валют. Возможные значения: `BYR` — белорусский рубль. `KZT` — казахстанский тенге. `RUR` — российский рубль. `UAH` — украинская гривна. 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	integer<int64>	Идентификатор региона, для которого выводится информация о предложениях модели (доставляемых в этот регион). Информацию о регионе по идентификатору можно получить с помощью запроса GET regions/{regionId}.
pager	FlippingPagerDTO	Модель для пагинации.

ModelDTO

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

Name	Type	Description
id	integer<int64>	Идентификатор модели товара.
name	string	Название модели товара.
prices	ModelPriceDTO	Информация о ценах на модель товара.

FlippingPagerDTO

Модель для пагинации.

Name	Type	Description
total	integer<int32>	Сколько всего найдено элементов.
from	integer<int32>	Начальный номер найденного элемента на странице.
to	integer<int32>	Конечный номер найденного элемента на странице.
currentPage	integer<int32>	Текущая страница.
pagesCount	integer<int32>	Общее количество страниц.
pageSize	integer<int32>	Размер страницы.

ModelPriceDTO

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

Name	Type	Description
avg	number	Средняя цена предложения для модели в регионе.
max	number	Максимальная цена предложения для модели в регионе.
min	number	Минимальная цена предложения для модели в регионе.

400 Bad Request

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

ApiResponseStatusType

Тип ответа.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

ApiErrorDTO

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

Name	Type	Description
code*	string	Код ошибки.
message	string	Описание ошибки.

401 Unauthorized

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

403 Forbidden

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

404 Not Found

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

420 Method Failure

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

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

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

Name	Type	Description
status	ApiResponseStatusType	Тип ответа. Enum: `OK`, `ERROR`
errors	ApiErrorDTO[]	Список ошибок. Общий формат ошибки.

Поиск модели товара

RequestRequest

Query parametersQuery parameters

CurrencyTypeCurrencyType

ResponsesResponses

200 OK200 OK

BodyBody

ModelDTOModelDTO

FlippingPagerDTOFlippingPagerDTO

ModelPriceDTOModelPriceDTO

400 Bad Request400 Bad Request

BodyBody

ApiResponseStatusTypeApiResponseStatusType

ApiErrorDTOApiErrorDTO

401 Unauthorized401 Unauthorized

BodyBody

403 Forbidden403 Forbidden

BodyBody

404 Not Found404 Not Found

BodyBody

420 Method Failure420 Method Failure

BodyBody

500 Internal Server Error500 Internal Server Error

BodyBody

Была ли статья полезна?

Request

Query parameters

CurrencyType

Responses

200 OK

Body

ModelDTO

FlippingPagerDTO

ModelPriceDTO

400 Bad Request

Body

ApiResponseStatusType

ApiErrorDTO

401 Unauthorized

Body

403 Forbidden

Body

404 Not Found

Body

420 Method Failure

Body

500 Internal Server Error

Body