Getting a list of shares

Info

Console

The method is available for all models.

Not yet available for Market Yandex Go sellers.

If you are using an API Key token, one of the accesses in the list is required to call the method

pricing — Manage prices
pricing:read-only — View prices
promotion — Product promotion
promotion:read-only — View promotion information
all-methods — Full account management
all-methods:read-only — View all data

Returns information about the Market's promotions. It does not return data about the shares that the seller created.

By default, promotions in which the seller participates or may participate are returned.

To get current or completed promotions, pass the parameter participation.

Types of shares that are returned in the response:

direct discount;
flash promotion;
discount by promo code.

, Limit: 1,000 requests per hour

Request

POST

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

Path parameters

Name

Description

businessId*

Type: integer<int64>

Cabinet ID. To find out, use the request GET campaigns.

ℹ️ What is a cabinet and a store on the Market?

Min value: 1

Body

application/json

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

Name

Description

mechanics

Type: MechanicsType

Filter by promotion type.

All stock types are returned by default.

Enum: DIRECT_DISCOUNT, BLUE_FLASH, MARKET_PROMOCODE

participation

Type: PromoParticipationType

Which promotions will return:

PARTICIPATING_NOW — current and future promotions in which the seller participates or may participate.
PARTICIPATED — completed promotions in which the seller participated over the past year. If there were less than 15 of them in a year, the response will show the last 15 shares for all time.

Enum: PARTICIPATING_NOW, PARTICIPATED

MechanicsType

Type of promotion:

DIRECT_DISCOUNT — direct discount.
BLUE_FLASH — flash promotion.
MARKET_PROMOCODE — discount by promo code.

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

PromoParticipationType

Which promotions will return:

PARTICIPATING_NOW — current and future promotions in which the seller participates or may participate.
PARTICIPATED — completed promotions in which the seller participated over the past year. If there were less than 15 of them in a year, the response will show the last 15 shares for all time.

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

Responses

200 OK

The list of Market shares.

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

Information about the Market's promotions.

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

GetPromosResultDTO

Information about the Market's promotions.

Name

Description

promos*

Type: GetPromoDTO[]

Yandex. Market promotions.
Information about the promotion.

ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

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

GetPromoDTO

Information about the promotion.

Name	Description
assortmentInfo*	Type: GetPromoAssortmentInfoDTO Information about the products in the promotion.
bestsellerInfo*	Type: GetPromoBestsellerInfoDTO Information about the "Bestsellers of the Market" promotion.
id*	Type: string The ID of the promotion.
mechanicsInfo*	Type: GetPromoMechanicsInfoDTO Information about the type of promotion.
name*	Type: string The name of the promotion.
participating*	Type: boolean Whether or not the seller participates in this promotion. For current and future promotions, it is returned with the value `true` if there are products in the promotion that were added manually. If the products are not included in the promotion or are added to it automatically, the parameter is returned with the value `false`. For past promotions, it is always returned with the value `true`. Read about the automatic and manual addition of products to the promotion in the Help of the Market for sellers.
period*	Type: PromoPeriodDTO The time of the promotion.
channels	Type: ChannelType[] A list of product promotion channels. Product promotion channels: `PUSH` — push notification from the Yandex Market app. `STRETCH_MAIN` — the top banner is a banner on the main page of Yandex Market. `MAIN_PAGE_CAROUSEL` — a carousel of promotions on the main page of Yandex Market. `PRODUCT_RETAIL_PAGE` — the product is on the retail occasion page. `MAIN_PAGE_CAROUSEL_WEB` — a carousel of promotions on the main page of the web version of Yandex. Market. `PRODUCT_SEPARATE_LANDING` — the product is on the landing page of the promotion. `SUPER_SHELF_CATEGORY` — shelf in categories. `CAROUSEL_RETAIL_PAGE` — a carousel on the retail outlet's landing page. `POPUP_APPLICATION` — a pop-up window in the Yandex Market application. `POST_TELEGRAM` — a post in the Telegram channel of Yandex Market. `CPA` — advertising in the Yandex Market partner network. `WEB_PERFORMANCE_DIRECT` — advertising in Yandex. Direct. `APP_PERFORMANCE` — advertising on the AppStore and Google Play. `BANNER_PICKUP_POINT` — a banner in the Market's PVZ. `BLOGGER_PERFORMANCE` — advertising integration for bloggers. `DIGITAL_CHANNEL_BANNER` — banner in digital channels and social networks VK, Odnoklassniki. `YANDEX_ECOSYSTEM_CHANNELS` — advertising in other Yandex services: GO, Delivery, Food. `PARTNERS_MAIN_BANNER` — banner on the main page mail.ru , auto.ru , ya.ru . `OTHER` — other stuff. 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` Unique items
constraints	Type: GetPromoConstraintsDTO Restrictions on promotions.

GetPromoAssortmentInfoDTO

Information about the products in the promotion.

Name	Description
activeOffers*	Type: integer<int32> The number of products that participate or participated in the promotion. Only products that were added manually are counted. Read about the automatic and manual addition of products to the promotion in the Help of the Market for sellers.
potentialOffers	Type: integer<int32> The number of available products in the promotion. The parameter is returned only for current and future promotions.
processing	Type: boolean Are there any changes in the product range that have not yet been applied? Saving changes takes some time. The parameter is returned only for current and future promotions.

GetPromoBestsellerInfoDTO

Information about the "Bestsellers of the Market" promotion.

Name	Description
bestseller*	Type: boolean Is the promotion a "Market Bestseller"? Read more about this promotion in the Help of the Market for sellers.
entryDeadline	Type: string<date-time> By what date can I add an item to the "Bestsellers of the Market" promotion? The parameter is returned only for current and future Bestsellers Market promotions.
renewalEnabled	Type: boolean Whether the automatic transfer of the assortment between the "Bestsellers of the Market" promotions is enabled. Read about how it works. in the Help of the Market for sellers. The parameter is returned only for current and future Bestsellers Market promotions.

GetPromoMechanicsInfoDTO

Information about the type of promotion.

Name

Description

type*

Type: MechanicsType

Type of promotion:

DIRECT_DISCOUNT — direct discount.
BLUE_FLASH — flash promotion.
MARKET_PROMOCODE — discount by promo code.

Enum: DIRECT_DISCOUNT, BLUE_FLASH, MARKET_PROMOCODE

promocodeInfo

Type: GetPromoPromocodeInfoDTO

Information for the type MARKET_PROMOCODE.

The parameter is filled in only for this type of promotion.

PromoPeriodDTO

The time of the promotion.

Name

Description

dateTimeFrom*

Type: string<date-time>

The date and time of the start of the promotion.

dateTimeTo*

Type: string<date-time>

The date and time of the end of the promotion.

ChannelType

Product promotion channels:

PUSH — push notification from the Yandex Market app.
STRETCH_MAIN — the top banner is a banner on the main page of Yandex Market.
MAIN_PAGE_CAROUSEL — a carousel of promotions on the main page of Yandex Market.
PRODUCT_RETAIL_PAGE — the product is on the retail occasion page.
MAIN_PAGE_CAROUSEL_WEB — a carousel of promotions on the main page of the web version of Yandex. Market.
PRODUCT_SEPARATE_LANDING — the product is on the landing page of the promotion.
SUPER_SHELF_CATEGORY — shelf in categories.
CAROUSEL_RETAIL_PAGE — a carousel on the retail outlet's landing page.
POPUP_APPLICATION — a pop-up window in the Yandex Market application.
POST_TELEGRAM — a post in the Telegram channel of Yandex Market.
CPA — advertising in the Yandex Market partner network.
WEB_PERFORMANCE_DIRECT — advertising in Yandex. Direct.
APP_PERFORMANCE — advertising on the AppStore and Google Play.
BANNER_PICKUP_POINT — a banner in the Market's PVZ.
BLOGGER_PERFORMANCE — advertising integration for bloggers.
DIGITAL_CHANNEL_BANNER — banner in digital channels and social networks VK, Odnoklassniki.
YANDEX_ECOSYSTEM_CHANNELS — advertising in other Yandex services: GO, Delivery, Food.
PARTNERS_MAIN_BANNER — banner on the main page mail.ru , auto.ru , ya.ru .
OTHER — other stuff.

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

Restrictions on promotions.

Name

Description

warehouseIds

Type: integer<int64>[]

Ids of warehouses for which the promotion is valid. Goods stored in other warehouses will not be sold under the promotion.

The parameter is returned only if there is a stock restriction in the terms of the promotion.

Min items: 1

Unique items

GetPromoPromocodeInfoDTO

Information for the type MARKET_PROMOCODE.

The parameter is filled in only for this type of promotion.

Name

Description

discount*

Type: integer<int32>

The discount percentage for the promo code.

promocode*

Type: string

The promo code.

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

404 Not Found

The requested resource was not found. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Removal from quarantine for the price in the store

List of products in the promotion