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

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

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: 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`
statuses	Type: string[] 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 are not included in the promotion and those that are added automatically. `MINIMUM_FOR_PROMOS` — products with a set minimum price for stocks, 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

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

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

offers*

Type: object[]

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

paging

Type: object

nextPageToken

Type: string

ID of the next results page.

The ID of the next page.

A list of products that participate or may participate 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: 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?

List of shares

Adding products to a promotion/changing their prices