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

Type: object

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

{
  "status": "OK"
}

Type: object

401 Unauthorized

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

Body

application/json

{
  "status": "OK"
}

Type: object

403 Forbidden

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

Body

application/json

{
  "status": "OK"
}

Type: object

404 Not Found

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

Body

application/json

{
  "status": "OK"
}

Type: object

420 Method Failure

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

Body

application/json

{
  "status": "OK"
}

Type: object

500 Internal Server Error

Internal error of the Market. More information about the error

Body

application/json

{
  "status": "OK"
}

Type: object

pathParams:
  - description: "Cabinet ID. To find out, use the request [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [What is a cabinet and a store on the Market?](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: Filters for getting a list of stocks.
  type: object
  properties:
    participation:
      description: >
        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.
      type: string
      enum:
        - PARTICIPATING_NOW
        - PARTICIPATED
    mechanics:
      description: >
        Type of promotion:


        * `DIRECT_DISCOUNT` — direct discount.


        * `BLUE_FLASH` — a flash promotion.


        * `MARKET_PROMOCODE` — discount by promo
        code.
      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

Was the article helpful?

Removal from quarantine for the price in the store

List of products in the promotion