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

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

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

Query parameters

Name

Description

limit

Type: integer<int32>

The number of values per page.

Min value: 1
Example: 20

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": "string",
    "statusType": "MANUALLY_ADDED",
    "statuses": [
        "MANUALLY_ADDED"
    ]
}

Name	Description
promoId*	Type: string The ID of the promotion.
statusType ⦸	Type: PromoOfferParticipationStatusFilterType Instead, use `statuses`. Filter for products that are added to the promotion manually. If you don't pass the parameter `statusType`, all items will be returned. Enum: `MANUALLY_ADDED`, `NOT_MANUALLY_ADDED`
statuses	Type: PromoOfferParticipationStatusMultiFilterType[] Filter for products that can participate in the promotion. You can set multiple values. Filter for products that can participate in the promotion: `MANUALLY_ADDED` — products that were added manually. `RENEWED` — products that were added automatically from the previous "Best Sellers of the Market" promotion. Only for "Bestsellers of the Market" promotions. `RENEW_FAILED` — products that could not be transferred from the previous "Best Sellers of the Market" promotion. Only for "Bestsellers of the Market" promotions. `NOT_MANUALLY_ADDED` — products that do not participate in the promotion and those that are added automatically. `MINIMUM_FOR_PROMOS` — products with the established minimum price for shares, which corresponds to the threshold `maxPromoPrice`. Such products participate in the promotion with a price `maxPromoPrice`. Only for "Bestsellers of the Market" promotions. If you don't pass the parameter `statuses`, all items will be returned. Read about the automatic and manual addition of products to the promotion in the Help of the Market for sellers. Enum: `MANUALLY_ADDED`, `RENEWED`, `RENEW_FAILED`, `NOT_MANUALLY_ADDED`, `MINIMUM_FOR_PROMOS` Min items: `1` Unique items

PromoOfferParticipationStatusFilterType

Filter for products that are added to the promotion manually:

MANUALLY_ADDED — products that were added manually.
NOT_MANUALLY_ADDED— products that do not participate 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.

Type	Description
PromoOfferParticipationStatusFilterType	Enum: `MANUALLY_ADDED`, `NOT_MANUALLY_ADDED`

PromoOfferParticipationStatusMultiFilterType

Filter for products that can participate in the promotion:

MANUALLY_ADDED — products that were added manually.
RENEWED — products that were added automatically from the previous "Best Sellers of the Market" promotion. Only for "Bestsellers of the Market" promotions.
RENEW_FAILED — products that could not be transferred from the previous "Best Sellers of the Market" promotion. Only for "Bestsellers of the Market" promotions.
NOT_MANUALLY_ADDED — products that do not participate in the promotion and those that are added automatically.
MINIMUM_FOR_PROMOS — products with the established minimum price for shares, which corresponds to the threshold maxPromoPrice. Such products participate in the promotion with a price maxPromoPrice. Only for "Bestsellers of the Market" promotions.

If you don't pass the parameter statuses, all items will be returned.

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

Type	Description
PromoOfferParticipationStatusMultiFilterType	Enum: `MANUALLY_ADDED`, `RENEWED`, `RENEW_FAILED`, `NOT_MANUALLY_ADDED`, `MINIMUM_FOR_PROMOS`

Responses

200 OK

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

Body

application/json

{
    "status": "OK",
    "result": {
        "offers": [
            {
                "offerId": "string",
                "status": "AUTO",
                "params": {
                    "discountParams": {
                        "price": 0,
                        "promoPrice": 0,
                        "maxPromoPrice": 0
                    }
                },
                "autoParticipatingDetails": {
                    "campaignIds": [
                        0
                    ]
                }
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

result

Type: GetPromoOffersResultDTO

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

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

GetPromoOffersResultDTO

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

Name

Description

offers*

Type: GetPromoOfferDTO[]

Products that participate or may participate in the promotion.
A product that participates or may participate in the promotion.

paging

Type: ForwardScrollingPagerDTO

The ID of the next page.

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`

GetPromoOfferDTO

A product that participates or may participate in the promotion.

Name	Description
offerId*	Type: string Your SKU is the product identifier in your system. SKU Usage Rules: Each product must have its own SKU. An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before. The SKU of 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. What is a SKU and how to assign it Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$`
params*	Type: PromoOfferParamsDTO Product parameters in the promotion. The parameter that corresponds to the type of the promotion is returned.
status*	Type: PromoOfferParticipationStatusType Product status in the promotion: `AUTO` — added automatically in all cabinet stores where the product is available for purchase. `PARTIALLY_AUTO` — added automatically to 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 a promotion with a price `maxPromoPrice` (A minimum price has been 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: PromoOfferAutoParticipatingDetailsDTO 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.

ForwardScrollingPagerDTO

The ID of the next page.

Name

Description

nextPageToken

Type: string

ID of the next results page.

PromoOfferParamsDTO

Product parameters in the promotion.

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

Name

Description

discountParams

Type: PromoOfferDiscountParamsDTO

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

PromoOfferParticipationStatusType

Product status in the promotion:

AUTO — added automatically in all cabinet stores where the product is available for purchase.
PARTIALLY_AUTO — added automatically to 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 a promotion with a price maxPromoPrice (A minimum price has been 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.

Type	Description
PromoOfferParticipationStatusType	Enum: `AUTO`, `PARTIALLY_AUTO`, `MANUAL`, `NOT_PARTICIPATING`, `RENEWED`, `RENEW_FAILED`, `MINIMUM_FOR_PROMOS`

PromoOfferAutoParticipatingDetailsDTO

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.

Name

Description

campaignIds

Type: integer<int64>[]

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.
The campaign ID.

Min items: 1

Unique items

PromoOfferDiscountParamsDTO

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

Name	Description
maxPromoPrice*	Type: integer<int64> The maximum possible price to participate in the promotion. Indicated in rubles. It is refunded for all products.
price	Type: integer<int64> The crossed—out price is the one 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<int64> The share price is the one at which you want to sell the product. Indicated in rubles. It is refunded only if the product participates in the promotion.

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?

List of shares

Adding products to a promotion/changing their prices