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/v2/businesses/{businessId}/promos

Path parameters

Name

Description

businessId*

Type: integer<int64>

Cabinet ID. To find out, use the request GET v2/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: string

Type of promotion:

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

Enum: DIRECT_DISCOUNT, BLUE_FLASH, MARKET_PROMOCODE

participation

Type: string

Which promotions will return:

PARTICIPATING_NOW — current and future promotions in which the seller participates or may participate.
PARTICIPATED — completed promotions that the seller has participated in 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

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

status*

Type: string

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

result

Type: object

promos*

Type: object[]

Yandex. Market promotions.
Information about the promotion.

Information about the Market's promotions.

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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, 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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
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: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of the Market. More information about the error

Body

application/json

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

status

Type: string

The type of response. Possible values:

OK — There are no errors.
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