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

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

Without specifying a filter, the promotions in which the seller participates or may participate are returned.

Which shares will be returned when the filter is specified:

PARTICIPATING_NOW — current promotions in which the seller participates.
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": "example",
        "name": "example",
        "period": {},
        "participating": true,
        "assortmentInfo": {},
        "mechanicsInfo": {},
        "bestsellerInfo": {},
        "channels": [
          null
        ],
        "constraints": {}
      }
    ]
  }
}

Type: object

All of 2 types

Type: object
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
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: object

promos

Type: object[]

assortmentInfo

Type: object

activeOffers

Type: integer

The number of products that participate or participated in the promotion.

Products that were added automatically are not counted.

Read about the automatic and manual addition of products to the promotion in the Help of the Market for sellers.

potentialOffers

Type: integer

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.

Information about the products in the promotion.

Example

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

bestsellerInfo

Type: object

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.

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

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.

Information about the "Bestsellers of the Market" promotion.

Example

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

Type: string

The ID of the promotion.

Example: example

mechanicsInfo

Type: object

type

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

promocodeInfo

Type: object

discount

Type: integer

The discount percentage for the promo code.

promocode

Type: string

The promo code.

Example: example

Information for the type MARKET_PROMOCODE.

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

Example

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

Information about the type of promotion.

Example

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

name

Type: string

The name of the promotion.

Example: example

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

dateTimeFrom

Type: string<date-time>

The date and time of the start of the promotion.

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

dateTimeTo

Type: string<date-time>

The date and time of the end of the promotion.

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

The time of the promotion.

Example

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

channels

Type: string[] | null

A list of product promotion channels.

Min items: 1

Unique items: true

Example

[
  "PUSH"
]

constraints

Type: object

warehouseIds

Type: integer[] | null

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

Example

[
  0
]

Restrictions on promotions.

Example

{
  "warehouseIds": [
    0
  ]
}

Yandex. Market promotions.

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
      ]
    }
  }
]

Information about the Market's promotions.

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
        ]
      }
    }
  ]
}

Example

{
  "result": {
    "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": {}
        },
        "bestsellerInfo": {
          "bestseller": true,
          "entryDeadline": "2025-01-01T00:00:00Z",
          "renewalEnabled": true
        },
        "channels": [
          "PUSH"
        ],
        "constraints": {
          "warehouseIds": [
            null
          ]
        }
      }
    ]
  }
}

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

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

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
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
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

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

401 Unauthorized

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

Body

application/json

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

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
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
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

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

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": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
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
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

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

404 Not Found

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

Body

application/json

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

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
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
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

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

420 Method Failure

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

Body

application/json

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

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
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
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

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

500 Internal Server Error

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

Body

application/json

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

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
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
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

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

Was the article helpful?

Removal from quarantine for the price in the store

List of products in the promotion