Request
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

Deprecated

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

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

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

В ответе на запрос для каждого найденного предложения указывается URL и наименование этого предложения, его цена и валюта, в которой она указана, карточка модели Маркета, с которой соотнесено предложение, и аукционные ставки на него.

Примечание

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

В связи с этим настоятельно рекомендуется анализировать содержимое параметра pager для каждой полученной страницы.

Примечание

Количество предложений считается по данным за последние семь дней (не включая сегодня).

Для новых магазинов, еще не разместивших предложения, ограничение равно 0 и пересчитывается на следующий день после размещения первых предложений.

⚙️ Лимит: рассчитывается по формуле

Request

GET

https://api.partner.market.yandex.ru/campaigns/{campaignId}/offers

Path parameters

Name

Type

Description

campaignId*

integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Query parameters

Name	Type	Description
query	string	Поисковый запрос. Поддерживается язык запросов. Значение по умолчанию: все предложения магазина, размещенные на Маркете.
feedId	integer<int64>	Идентификатор прайс-листа.
shopCategoryId	string	Идентификатор категории предложения, указанный магазином в прайс-листе. Параметр выводится только для предложений, у которых указана категория в прайс-листе. Параметр доступен начиная с версии 2.0 партнерского API.
currency	CurrencyType	Валюта, в которой указана цена предложения. Возможные значения: `BYN` — белорусский рубль. `KZT` — казахстанский тенге. `RUR` — российский рубль. `UAH` — украинская гривна.
matched	boolean	Фильтр по признаку соотнесения предложения и карточки модели. Возможные значения: `0 / FALSE / NO` — поиск выполняется среди предложений, не соотнесенных ни с какой карточкой модели. `1 / TRUE / YES` — поиск выполняется среди предложений, соотнесенных с карточками моделей).
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

{
    "offers": [
        {
            "price": 0,
            "feedId": 0,
            "id": "string",
            "shopCategoryId": "string",
            "marketCategoryId": 0,
            "preDiscountPrice": 0,
            "discount": 0,
            "cutPrice": false,
            "url": "string",
            "modelId": 0,
            "name": "string",
            "currency": "RUR",
            "bid": 0,
            "cbid": 0,
            "fee": 0,
            "blocked": false
        }
    ],
    "pager": {
        "total": 0,
        "from": 0,
        "to": 0,
        "currentPage": 0,
        "pagesCount": 0,
        "pageSize": 0
    }
}

Name	Type	Description
offers	OfferDTO[]	Список предложений магазина. Предложение.
pager	FlippingPagerDTO	Модель для пагинации.

OfferDTO

Предложение.

Name	Type	Description
price	number	Цена предложения. До версии 2.0 партнерского API у параметра был тип String.
feedId	integer<int64>	Идентификатор прайс-листа, содержащего предложение. Параметр доступен начиная с версии 2.0 партнерского API.
id	string	Идентификатор предложения из прайс-листа. Параметр выводится, если в прайс-листе задан уникальный идентификатор. Если в прайс-листе содержится несколько предложений с одинаковыми идентификаторами, параметр `id` указывается только для первого из них, для остальных параметры `id` и `feedId` не выводятся. Параметр доступен начиная с версии 2.0 партнерского API.
shopCategoryId	string	Идентификатор категории предложения, указанный магазином в прайс-листе. Параметр выводится только для предложений, у которых указана категория в прайс-листе. Параметр доступен начиная с версии 2.0 партнерского API.
marketCategoryId	integer<int32>	Идентификатор категории предложения в дереве категорий Маркета. Параметр доступен начиная с версии 2.0 партнерского API.
preDiscountPrice	number	Цена предложения без скидки.
discount	integer<int32>	Скидка на предложение, в %.
cutPrice	boolean	Является ли предложение уцененным: `true` — да. `false` — нет. Параметр доступен начиная с версии 2.58 партнерского API.
url	string	URL-адрес предложения на сайте магазина.
modelId*	integer<int64>	Идентификатор модели Маркета, с которой соотнесено предложение. Если предложение не соотнесено ни с какой карточкой модели, то параметр `modelid` содержит значение `0`. Примечание Идентификатор модели присутствует в URL карточки модели в виде значения параметра `product`. Например: `https://market.yandex.ru/product/13584121`.
name	string	Наименование предложения.
currency	CurrencyType	Валюта, в которой указана цена предложения. Возможные значения: `BYN` — белорусский рубль. `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`
bid	number	Ставка на клик. deprecated.
cbid	number	Ставка на клик. deprecated.
fee	number	Процент комиссии на товар при продаже по CPA. deprecated.
blocked	boolean	Признак блокировки предложения. Возможные значения: `false` — предложение активно, параметр не выводится. `true` — предложение заблокировано. Параметр выводится, если предложение заблокировано и не попадает в выдачу Маркета. Это может произойти из-за отключения магазина.

FlippingPagerDTO

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

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

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

Path parametersPath parameters

Query parametersQuery parameters

CurrencyTypeCurrencyType

ResponsesResponses

200 OK200 OK

BodyBody

OfferDTOOfferDTO

FlippingPagerDTOFlippingPagerDTO

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

Path parameters

Query parameters

CurrencyType

Responses

200 OK

Body

OfferDTO

FlippingPagerDTO

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