Getting a list of products that participate or may participate in the promotion

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

Returns a list of products that participate or may participate in the promotion.

The terms of participation in the promotions may change

For example, maxPromoPrice.

The set prices will not change. — price and promoPrice.

⚙️ Limit: 10,000 requests per hour, no more than 500 items per request

Request

POST

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

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

Query parameters

Name

Description

limit

Type: integer

The number of values per page.

Min value: 1

page_token

Type: string

ID of the results page.

If the parameter is omitted, the first page is returned.

We recommend transmitting the value of the output parameter nextPageToken, received during the last request.

If set page_token and the request has parameters page and pageSize they are ignored.

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

application/json
{
  "promoId": "example",
  "statusType": "MANUALLY_ADDED",
  "statuses": [
    "MANUALLY_ADDED"
  ]
}

Name

Description

promoId

Type: string

The ID of the promotion.

Example: example

statuses

Type: string[] | null

Filter for products that can participate in the promotion. You can set multiple values.

Min items: 1

Unique items: true

Example
[
  "MANUALLY_ADDED"
]

statusType

Type: string

Filter for products that are added to the promotion manually:

  • MANUALLY_ADDED — products that were added manually.

  • NOT_MANUALLY_ADDED— products that are not included in the promotion and those that are added automatically.

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

Enum: MANUALLY_ADDED, NOT_MANUALLY_ADDED

Responses

200 OK

A list of products that participate or may participate in the promotion.

Body

application/json
{
  "status": "OK",
  "result": {
    "offers": [
      {
        "offerId": "example",
        "status": "AUTO",
        "params": {},
        "autoParticipatingDetails": {}
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

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

    offers
    Type: object[]

    offerId

    Type: string

    Your SKU — the product ID in your system.

    Usage rules SKU:

    • For each product SKU there must be one.

    • Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

    SKU The product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.

    Warning

    Spaces at the beginning and end of the value are automatically deleted. For example, " SKU123 " and "SKU123" they will be treated as identical values.

    What is SKU and how to assign it

    Min length: 1

    Max length: 255

    Pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$

    Example: example

    params
    Type: object

    discountParams
    Type: object

    maxPromoPrice

    Type: integer

    The maximum possible price to participate in the promotion.

    Indicated in rubles.

    It is refunded for all products.

    price

    Type: integer

    Crossed out price — the price at which the product was sold before the promotion.

    Indicated in rubles.

    It is refunded only if the product participates in the promotion.

    promoPrice

    Type: integer

    Share price — the one you want to sell the product at.

    Indicated in rubles.

    It is refunded only if the product participates in the promotion.

    Product parameters in the promotion with the type DIRECT_DISCOUNT or BLUE_FLASH.

    Example
    {
  "price": 0,
  "promoPrice": 0,
  "maxPromoPrice": 0
}

    Product parameters in the promotion.

    The parameter that corresponds to the type of the promotion is returned.

    Example
    {
  "discountParams": {
    "price": 0,
    "promoPrice": 0,
    "maxPromoPrice": 0
  }
}

    status

    Type: string

    Product status in the promotion:

    • AUTO — added automatically in all cabinet stores where the product is available for purchase.

    • PARTIALLY_AUTO — added automatically for some stores.

    • MANUAL — added manually.

    • NOT_PARTICIPATING — does not participate in the promotion.

    • RENEWED — successfully transferred from the previous "Bestsellers of the Market" promotion. Only for "Bestsellers of the Market" promotions.

    • RENEW_FAILED — it was not possible to transfer from the previous "Bestsellers of the Market" promotion. Only for "Bestsellers of the Market" promotions.

    • MINIMUM_FOR_PROMOS — participates in an action with a price maxPromoPrice (minimum price set for shares, which corresponds to the threshold maxPromoPrice). Only for "Bestsellers of the Market" promotions.

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

    Enum: AUTO, PARTIALLY_AUTO, MANUAL, NOT_PARTICIPATING, RENEWED, RENEW_FAILED, MINIMUM_FOR_PROMOS

    autoParticipatingDetails
    Type: object

    campaignIds

    Type: integer[] | null

    The campaign IDs of those stores where the product is added to the promotion automatically.

    Refunded if the product's status is in the promotion — PARTIALLY_AUTO.

    Min items: 1

    Unique items: true

    Example
    [
  1
]

    Information about the automatic product addition to the promotion.

    The reasons why the product was not added automatically in other stores can be found in the seller's account on the Market on the promotion page.

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

    Example
    {
  "campaignIds": [
    1
  ]
}

    Products that participate or may participate in the promotion.

    Example
    [
  {
    "offerId": "example",
    "status": "AUTO",
    "params": {
      "discountParams": {
        "price": 0,
        "promoPrice": 0,
        "maxPromoPrice": 0
      }
    },
    "autoParticipatingDetails": {
      "campaignIds": [
        1
      ]
    }
  }
]

    paging
    Type: object

    nextPageToken

    Type: string

    ID of the next results page.

    Example: example

    The ID of the next page.

    Example
    {
  "nextPageToken": "example"
}

    A list of products that participate or may participate in the promotion.

    Example
    {
  "offers": [
    {
      "offerId": "example",
      "status": "AUTO",
      "params": {
        "discountParams": {
          "price": 0,
          "promoPrice": 0,
          "maxPromoPrice": 0
        }
      },
      "autoParticipatingDetails": {
        "campaignIds": [
          1
        ]
      }
    }
  ],
  "paging": {
    "nextPageToken": "example"
  }
}
    Example
    {
  "result": {
    "offers": [
      {
        "offerId": "example",
        "status": "AUTO",
        "params": {
          "discountParams": {}
        },
        "autoParticipatingDetails": {
          "campaignIds": [
            null
          ]
        }
      }
    ],
    "paging": {
      "nextPageToken": "example"
    }
  }
}

400 Bad Request

The request contains incorrect data. Learn more about errors when working with stocks

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

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

In the method POST v2/businesses/{businessId}/offer-prices/updates.

Previous
List of shares
Next
Adding products to a promotion/changing their prices