Получение списка акций

Info

Console

Метод доступен для всех моделей.

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

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

pricing — Управление ценами
pricing:read-only — Просмотр цен
promotion — Продвижение товаров
promotion:read-only — Просмотр информации о продвижении товаров
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Возвращает информацию об акциях Маркета.

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

Чтобы получить текущие или завершенные акции, передайте параметр participation.

Типы акций, которые возвращаются в ответе:

прямая скидка;
флеш-акция;
скидка по промокоду.

⚙️ Лимит: 1 000 запросов в час

Request

POST

https://api.partner.market.yandex.ru/businesses/{businessId}/promos

Path parameters

Name

Description

businessId*

Type: integer<int64>

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

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

Min value: 1

Body

application/json

{
    "participation": "PARTICIPATING_NOW",
    "mechanics": "DIRECT_DISCOUNT"
}

Name

Description

mechanics

Type: MechanicsType

Фильтр по типу акции.

По умолчанию возвращаются все типы акций.

Enum: DIRECT_DISCOUNT, BLUE_FLASH, MARKET_PROMOCODE

participation

Type: PromoParticipationType

Какие акции вернутся:

PARTICIPATING_NOW — текущие и будущие акции продавца.
PARTICIPATED — завершенные акции продавца за последний год. Если за год их было меньше 15, в ответе придут 15 последних акций за все время.

Enum: PARTICIPATING_NOW, PARTICIPATED

MechanicsType

Тип акции:

DIRECT_DISCOUNT — прямая скидка.
BLUE_FLASH — флеш-акция.
MARKET_PROMOCODE — скидка по промокоду.

Type	Description
MechanicsType	Enum: `DIRECT_DISCOUNT`, `BLUE_FLASH`, `MARKET_PROMOCODE`

PromoParticipationType

Какие акции вернутся:

PARTICIPATING_NOW — текущие и будущие акции продавца.
PARTICIPATED — завершенные акции продавца за последний год. Если за год их было меньше 15, в ответе придут 15 последних акций за все время.

Type	Description
PromoParticipationType	Enum: `PARTICIPATING_NOW`, `PARTICIPATED`

Responses

200 OK

Список акций Маркета.

Body

application/json

{
    "status": "OK",
    "result": {
        "promos": [
            {
                "id": "string",
                "name": "string",
                "period": {
                    "dateTimeFrom": "2022-12-29T18:02:01Z",
                    "dateTimeTo": "2022-12-29T18:02:01Z"
                },
                "participating": false,
                "assortmentInfo": {
                    "activeOffers": 0,
                    "potentialOffers": 0,
                    "processing": false
                },
                "mechanicsInfo": {
                    "type": "DIRECT_DISCOUNT",
                    "promocodeInfo": {
                        "promocode": "string",
                        "discount": 0
                    }
                },
                "bestsellerInfo": {
                    "bestseller": false,
                    "entryDeadline": "2022-12-29T18:02:01Z",
                    "renewalEnabled": false
                },
                "channels": [
                    "PUSH"
                ],
                "constraints": {
                    "warehouseIds": [
                        0
                    ]
                }
            }
        ]
    }
}

Name

Description

result

Type: GetPromosResultDTO

Информация об акциях Маркета.

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

GetPromosResultDTO

Информация об акциях Маркета.

Name

Description

promos*

Type: GetPromoDTO[]

Акции Маркета.
Информация об акции.

ApiResponseStatusType

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

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

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

GetPromoDTO

Информация об акции.

Name	Description
assortmentInfo*	Type: GetPromoAssortmentInfoDTO Информация о товарах в акции.
bestsellerInfo*	Type: GetPromoBestsellerInfoDTO Информация об акции «Бестселлеры Маркета».
id*	Type: string Идентификатор акции.
mechanicsInfo*	Type: GetPromoMechanicsInfoDTO Информация о типе акции.
name*	Type: string Название акции.
participating*	Type: boolean Участвует или участвовал ли продавец в этой акции. Для текущих и будущих акций возвращается со значением `true`, если в акции есть товары, которые были добавлены вручную. Если товары не участвуют в акции или добавлены в нее автоматически, параметр возвращается со значением `false`. Для прошедших акций всегда возвращается со значением `true`. Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.
period*	Type: PromoPeriodDTO Время проведения акции.
channels	Type: ChannelType[] Список каналов продвижения товаров. Каналы продвижения товаров: `PUSH` — пуш-уведомление из приложения Яндекс Маркет. `STRETCH_MAIN` — верхний баннер-растяжка на главной странице Яндекс Маркета. `MAIN_PAGE_CAROUSEL` — карусель акций на главной странице Яндекс Маркета. `PRODUCT_RETAIL_PAGE` — товар на странице ритейл-повода. `MAIN_PAGE_CAROUSEL_WEB` — карусель акций на главной странице веб версии Яндекс Маркета. `PRODUCT_SEPARATE_LANDING` — товар на лендинге акции. `SUPER_SHELF_CATEGORY` — полка в категориях. `CAROUSEL_RETAIL_PAGE` — карусель на лендинге ритейл-повода. `POPUP_APPLICATION` — всплывающее окно в приложении Яндекс Маркет. `POST_TELEGRAM` — пост в Телеграм-канале Яндекс Маркета. `CPA` — реклама в партнерской сети Яндекс Маркета. `WEB_PERFORMANCE_DIRECT` — реклама в Яндекс Директе. `APP_PERFORMANCE` — реклама в AppStore и Google Play. `BANNER_PICKUP_POINT` — баннер в ПВЗ Маркета. `BLOGGER_PERFORMANCE` — рекламная интеграция у блогеров. `DIGITAL_CHANNEL_BANNER` — баннер в digital-каналах и социальных сетях VK, Одноклассники. `YANDEX_ECOSYSTEM_CHANNELS` — реклама в других сервисах Яндекса: GO, Delivery, Еда. `PARTNERS_MAIN_BANNER` — баннер на главной странице mail.ru, auto.ru, ya.ru. `OTHER` — прочее. Enum: `PUSH`, `STRETCH_MAIN`, `MAIN_PAGE_CAROUSEL`, `PRODUCT_RETAIL_PAGE`, `MAIN_PAGE_CAROUSEL_WEB`, `PRODUCT_SEPARATE_LANDING`, `SUPER_SHELF_CATEGORY`, `CAROUSEL_RETAIL_PAGE`, `POPUP_APPLICATION`, `POST_TELEGRAM`, `CPA`, `WEB_PERFORMANCE_DIRECT`, `APP_PERFORMANCE`, `BANNER_PICKUP_POINT`, `BLOGGER_PERFORMANCE`, `DIGITAL_CHANNEL_BANNER`, `YANDEX_ECOSYSTEM_CHANNELS`, `PARTNERS_MAIN_BANNER`, `OTHER` Min items: `1`
constraints	Type: GetPromoConstraintsDTO Ограничения в акции.

GetPromoAssortmentInfoDTO

Информация о товарах в акции.

Name	Description
activeOffers*	Type: integer<int32> Количество товаров, которые участвуют или участвовали в акции. Учитываются только товары, которые были добавлены вручную. Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.
potentialOffers	Type: integer<int32> Количество доступных товаров в акции. Параметр возвращается только для текущих и будущих акций.
processing	Type: boolean Есть ли изменения в ассортименте, которые еще не применились. Сохранение изменений занимает некоторое время. Параметр возвращается только для текущих и будущих акций.

GetPromoBestsellerInfoDTO

Информация об акции «Бестселлеры Маркета».

Name	Description
bestseller*	Type: boolean Является ли акция «Бестселлером Маркета». Подробнее об этой акции читайте в Справке Маркета для продавцов.
entryDeadline	Type: string<date-time> До какой даты можно добавить товар в акцию «Бестселлеры Маркета». Параметр возвращается только для текущих и будущих акций «Бестселлеры Маркета».
renewalEnabled	Type: boolean Включен ли автоматический перенос ассортимента между акциями «Бестселлеры Маркета». Параметр возвращается только для текущих и будущих акций «Бестселлеры Маркета».

GetPromoMechanicsInfoDTO

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

Name

Description

type*

Type: MechanicsType

Тип акции:

DIRECT_DISCOUNT — прямая скидка.
BLUE_FLASH — флеш-акция.
MARKET_PROMOCODE — скидка по промокоду.

Enum: DIRECT_DISCOUNT, BLUE_FLASH, MARKET_PROMOCODE

promocodeInfo

Type: GetPromoPromocodeInfoDTO

Информация для типа MARKET_PROMOCODE.

Параметр заполняется только для этого типа акции.

PromoPeriodDTO

Время проведения акции.

Name

Description

dateTimeFrom*

Type: string<date-time>

Дата и время начала акции.

dateTimeTo*

Type: string<date-time>

Дата и время окончания акции.

ChannelType

Каналы продвижения товаров:

PUSH — пуш-уведомление из приложения Яндекс Маркет.
STRETCH_MAIN — верхний баннер-растяжка на главной странице Яндекс Маркета.
MAIN_PAGE_CAROUSEL — карусель акций на главной странице Яндекс Маркета.
PRODUCT_RETAIL_PAGE — товар на странице ритейл-повода.
MAIN_PAGE_CAROUSEL_WEB — карусель акций на главной странице веб версии Яндекс Маркета.
PRODUCT_SEPARATE_LANDING — товар на лендинге акции.
SUPER_SHELF_CATEGORY — полка в категориях.
CAROUSEL_RETAIL_PAGE — карусель на лендинге ритейл-повода.
POPUP_APPLICATION — всплывающее окно в приложении Яндекс Маркет.
POST_TELEGRAM — пост в Телеграм-канале Яндекс Маркета.
CPA — реклама в партнерской сети Яндекс Маркета.
WEB_PERFORMANCE_DIRECT — реклама в Яндекс Директе.
APP_PERFORMANCE — реклама в AppStore и Google Play.
BANNER_PICKUP_POINT — баннер в ПВЗ Маркета.
BLOGGER_PERFORMANCE — рекламная интеграция у блогеров.
DIGITAL_CHANNEL_BANNER — баннер в digital-каналах и социальных сетях VK, Одноклассники.
YANDEX_ECOSYSTEM_CHANNELS — реклама в других сервисах Яндекса: GO, Delivery, Еда.
PARTNERS_MAIN_BANNER — баннер на главной странице mail.ru, auto.ru, ya.ru.
OTHER — прочее.

Type

Description

ChannelType

Enum: PUSH, STRETCH_MAIN, MAIN_PAGE_CAROUSEL, PRODUCT_RETAIL_PAGE, MAIN_PAGE_CAROUSEL_WEB, PRODUCT_SEPARATE_LANDING, SUPER_SHELF_CATEGORY, CAROUSEL_RETAIL_PAGE, POPUP_APPLICATION, POST_TELEGRAM, CPA, WEB_PERFORMANCE_DIRECT, APP_PERFORMANCE, BANNER_PICKUP_POINT, BLOGGER_PERFORMANCE, DIGITAL_CHANNEL_BANNER, YANDEX_ECOSYSTEM_CHANNELS, PARTNERS_MAIN_BANNER, OTHER

GetPromoConstraintsDTO

Ограничения в акции.

Name

Description

warehouseIds

Type: integer<int64>[]

Идентификаторы складов, для которых действует акция. Товары, которые лежат на других складах, не будут продаваться по акции.

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

Min items: 1

GetPromoPromocodeInfoDTO

Информация для типа MARKET_PROMOCODE.

Параметр заполняется только для этого типа акции.

Name

Description

discount*

Type: integer<int32>

Процент скидки по промокоду.

promocode*

Type: string

Промокод.

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

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

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

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

Удаление из карантина по цене в магазине

Список товаров в акции