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

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

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

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

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

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

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

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

  • прямая скидка;
  • флеш-акция;
  • скидка по промокоду.
⚙️ Лимит: 1 000 запросов в час

Request

POST

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

Path parameters

Name

Description

businessId

Type: integer

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

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

Min value: 1

Body

application/json
{
  "participation": "PARTICIPATING_NOW",
  "mechanics": "DIRECT_DISCOUNT"
}

Name

Description

mechanics

Type: MechanicsType

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

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

Тип акции:

  • DIRECT_DISCOUNT — прямая скидка.

  • BLUE_FLASH — флеш-акция.

  • MARKET_PROMOCODE — скидка по промокоду.

Enum: DIRECT_DISCOUNT, BLUE_FLASH, MARKET_PROMOCODE

participation

Type: PromoParticipationType

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

Какие акции вернутся при указании фильтра:

  • PARTICIPATING_NOW — текущие акции, в которых участвует продавец.

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

Enum: PARTICIPATING_NOW, PARTICIPATED

PromoParticipationType

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

Какие акции вернутся при указании фильтра:

  • PARTICIPATING_NOW — текущие акции, в которых участвует продавец.

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

Type: string

Enum: PARTICIPATING_NOW, PARTICIPATED

MechanicsType

Тип акции:

  • DIRECT_DISCOUNT — прямая скидка.

  • BLUE_FLASH — флеш-акция.

  • MARKET_PROMOCODE — скидка по промокоду.

Type: string

Enum: DIRECT_DISCOUNT, BLUE_FLASH, MARKET_PROMOCODE

Responses

200 OK

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

Body

application/json
{
  "status": "OK"
}

Type: object

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR
Example
{
  "status": "OK"
}

PromoPeriodDTO

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

Name

Description

dateTimeFrom

Type: string<date-time>

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

Example: 2025-01-01T00:00:00Z

dateTimeTo

Type: string<date-time>

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

Example: 2025-01-01T00:00:00Z
Example
{
  "dateTimeFrom": "2025-01-01T00:00:00Z",
  "dateTimeTo": "2025-01-01T00:00:00Z"
}

GetPromoAssortmentInfoDTO

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

Name

Description

activeOffers

Type: integer

Количество товаров, которые участвуют или участвовали в акции.

Не учитываются товары, которые были добавлены автоматически.

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

potentialOffers

Type: integer

Количество доступных товаров в акции.

Параметр возвращается только для текущих и будущих акций.

processing

Type: boolean

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

Параметр возвращается только для текущих и будущих акций.
Example
{
  "activeOffers": 0,
  "potentialOffers": 0,
  "processing": true
}

GetPromoPromocodeInfoDTO

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

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

Name

Description

discount

Type: integer

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

promocode

Type: string

Промокод.

Example: example
Example
{
  "promocode": "example",
  "discount": 0
}

GetPromoMechanicsInfoDTO

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

Name

Description

type

Type: MechanicsType

Тип акции:

  • DIRECT_DISCOUNT — прямая скидка.

  • BLUE_FLASH — флеш-акция.

  • MARKET_PROMOCODE — скидка по промокоду.

Enum: DIRECT_DISCOUNT, BLUE_FLASH, MARKET_PROMOCODE

promocodeInfo

Type: GetPromoPromocodeInfoDTO

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

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

Example
{
  "promocode": "example",
  "discount": 0
}
Example
{
  "type": "DIRECT_DISCOUNT",
  "promocodeInfo": {
    "promocode": "example",
    "discount": 0
  }
}

GetPromoBestsellerInfoDTO

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

Name

Description

bestseller

Type: boolean

Является ли акция «Бестселлером Маркета». Подробнее об этой акции читайте в Справке Маркета для продавцов.

entryDeadline

Type: string<date-time>

До какой даты можно добавить товар в акцию «Бестселлеры Маркета».

Параметр возвращается только для текущих и будущих акций «Бестселлеры Маркета».

Example: 2025-01-01T00:00:00Z

renewalEnabled

Type: boolean

Включен ли автоматический перенос ассортимента между акциями «Бестселлеры Маркета». О том, как это работает, читайте в Справке Маркета для продавцов.

Параметр возвращается только для текущих и будущих акций «Бестселлеры Маркета».
Example
{
  "bestseller": true,
  "entryDeadline": "2025-01-01T00:00:00Z",
  "renewalEnabled": true
}

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: string

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[] | null

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

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

Min items: 1

Unique items: true

Example
[
  0
]
Example
{
  "warehouseIds": [
    0
  ]
}

GetPromoDTO

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

Name

Description

assortmentInfo

Type: GetPromoAssortmentInfoDTO

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

Example
{
  "activeOffers": 0,
  "potentialOffers": 0,
  "processing": true
}

bestsellerInfo

Type: GetPromoBestsellerInfoDTO

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

Example
{
  "bestseller": true,
  "entryDeadline": "2025-01-01T00:00:00Z",
  "renewalEnabled": true
}

id

Type: string

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

Example: example

mechanicsInfo

Type: GetPromoMechanicsInfoDTO

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

Example
{
  "type": "DIRECT_DISCOUNT",
  "promocodeInfo": {
    "promocode": "example",
    "discount": 0
  }
}

name

Type: string

Название акции.

Example: example

participating

Type: boolean

Участвует или участвовал ли продавец в этой акции.

Для текущих и будущих акций возвращается со значением true, если в акции есть товары, которые были добавлены вручную. Если товары не участвуют в акции или добавлены в нее автоматически, параметр возвращается со значением false.

Для прошедших акций всегда возвращается со значением true.

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

period

Type: PromoPeriodDTO

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

Example
{
  "dateTimeFrom": "2025-01-01T00:00:00Z",
  "dateTimeTo": "2025-01-01T00:00:00Z"
}

channels

Type: ChannelType[] | null

Список каналов продвижения товаров.

Min items: 1

Unique items: true

Example
[
  "PUSH"
]

constraints

Type: GetPromoConstraintsDTO

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

Example
{
  "warehouseIds": [
    0
  ]
}
Example
{
  "id": "example",
  "name": "example",
  "period": {
    "dateTimeFrom": "2025-01-01T00:00:00Z",
    "dateTimeTo": "2025-01-01T00:00:00Z"
  },
  "participating": true,
  "assortmentInfo": {
    "activeOffers": 0,
    "potentialOffers": 0,
    "processing": true
  },
  "mechanicsInfo": {
    "type": "DIRECT_DISCOUNT",
    "promocodeInfo": {
      "promocode": "example",
      "discount": 0
    }
  },
  "bestsellerInfo": {
    "bestseller": true,
    "entryDeadline": "2025-01-01T00:00:00Z",
    "renewalEnabled": true
  },
  "channels": [
    "PUSH"
  ],
  "constraints": {
    "warehouseIds": [
      0
    ]
  }
}

GetPromosResultDTO

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

Name

Description

promos

Type: GetPromoDTO[]

Акции Маркета.

Example
[
  {
    "id": "example",
    "name": "example",
    "period": {
      "dateTimeFrom": "2025-01-01T00:00:00Z",
      "dateTimeTo": "2025-01-01T00:00:00Z"
    },
    "participating": true,
    "assortmentInfo": {
      "activeOffers": 0,
      "potentialOffers": 0,
      "processing": true
    },
    "mechanicsInfo": {
      "type": "DIRECT_DISCOUNT",
      "promocodeInfo": {
        "promocode": "example",
        "discount": 0
      }
    },
    "bestsellerInfo": {
      "bestseller": true,
      "entryDeadline": "2025-01-01T00:00:00Z",
      "renewalEnabled": true
    },
    "channels": [
      "PUSH"
    ],
    "constraints": {
      "warehouseIds": [
        0
      ]
    }
  }
]
Example
{
  "promos": [
    {
      "id": "example",
      "name": "example",
      "period": {
        "dateTimeFrom": "2025-01-01T00:00:00Z",
        "dateTimeTo": "2025-01-01T00:00:00Z"
      },
      "participating": true,
      "assortmentInfo": {
        "activeOffers": 0,
        "potentialOffers": 0,
        "processing": true
      },
      "mechanicsInfo": {
        "type": "DIRECT_DISCOUNT",
        "promocodeInfo": {
          "promocode": "example",
          "discount": 0
        }
      },
      "bestsellerInfo": {
        "bestseller": true,
        "entryDeadline": "2025-01-01T00:00:00Z",
        "renewalEnabled": true
      },
      "channels": [
        "PUSH"
      ],
      "constraints": {
        "warehouseIds": [
          0
        ]
      }
    }
  ]
}

400 Bad Request

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

Body

application/json
{
  "status": "OK"
}

Type: object

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

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

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

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

401 Unauthorized

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

Body

application/json
{
  "status": "OK"
}

Type: object

403 Forbidden

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

Body

application/json
{
  "status": "OK"
}

Type: object

404 Not Found

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

Body

application/json
{
  "status": "OK"
}

Type: object

420 Method Failure

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

Body

application/json
{
  "status": "OK"
}

Type: object

500 Internal Server Error

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

Body

application/json
{
  "status": "OK"
}

Type: object

pathParams:
  - description: "Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)\n"
    name: businessId
    in: path
    required: true
    schema:
      type: integer
      format: int64
      minimum: 1
searchParams: []
headers: []
body: |-
  {
    "participation": "PARTICIPATING_NOW",
    "mechanics": "DIRECT_DISCOUNT"
  }
schema:
  description: Фильтры для получения списка акций.
  type: object
  properties:
    participation:
      description: >
        Без указания фильтра возвращаются акции, в которых продавец участвует
        или может принять участие.


        Какие акции вернутся при указании фильтра:


        * `PARTICIPATING_NOW` — текущие акции, в которых участвует продавец.


        * `PARTICIPATED` — завершенные акции, в которых продавец участвовал за
        последний год. Если за год их было меньше 15, в ответе придут 15
        последних акций за все время.
      type: string
      enum:
        - PARTICIPATING_NOW
        - PARTICIPATED
    mechanics:
      description: |
        Фильтр по типу акции.

        По умолчанию возвращаются все типы акций.
      $ref: '#/$defs/MechanicsType'
  $defs:
    /home/sandbox/.ya/build/build_root/4217/00000b/market/mbi/docs/partner-api/docfiles/__docsbuild/.tmp_input/ru/openapi/partner-api-spec/promos/schemas.yaml#/MechanicsType:
      description: |
        Тип акции:

        * `DIRECT_DISCOUNT` — прямая скидка.

        * `BLUE_FLASH` — флеш-акция.

        * `MARKET_PROMOCODE` — скидка по промокоду.
      type: string
      enum:
        - DIRECT_DISCOUNT
        - BLUE_FLASH
        - MARKET_PROMOCODE
bodyType: application/json
method: post
security:
  - type: apiKey
    name: Api-Key
    in: header
  - type: oauth2
    x-inline: true
    flows:
      implicit:
        authorizationUrl: https://oauth.yandex.ru/authorize
        scopes:
          market:partner-api: API Яндекс.Маркета / Поиска по товарам для партнеров
path: v2/businesses/{businessId}/promos
host: https://api.partner.market.yandex.ru

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

Предыдущая
Удаление из карантина по цене в магазине
Следующая
Список товаров в акции