Получение списка товаров, которые участвуют или могут участвовать в акции

Метод доступен для всех моделей.

Пока недоступен для продавцов Market Yandex Go.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Возвращает список товаров, которые участвуют или могут участвовать в акции.

Условия участия в акциях могут меняться

Например, maxPromoPrice.

Установленные цены меняться не будут — price и promoPrice.

⚙️ Лимит: 10 000 запросов в час, не более 500 товаров в запросе

Request

POST

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

Path parameters

Name

Description

businessId*

Type: integer<int64>

Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

Количество значений на одной странице.
Example: 20

page_token

Type: string

Идентификатор страницы c результатами.

Если параметр не указан, возвращается первая страница.

Рекомендуем передавать значение выходного параметра nextPageToken, полученное при последнем запросе.

Если задан page_token и в запросе есть параметры page_number и page_size, они игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

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

Name

Description

promoId*

Type: string

Идентификатор акции.

statusType

⦸

Type: PromoOfferParticipationStatusFilterType

Вместо него используйте statuses.

Фильтр для товаров, которые добавлены в акцию вручную.

Если не передать параметр statusType, вернутся все товары.

Enum: MANUALLY_ADDED, NOT_MANUALLY_ADDED

statuses

Type: PromoOfferParticipationStatusMultiFilterType[]

Фильтр для товаров, которые могут участвовать в акции. Можно задать несколько значений.
Фильтр для товаров, которые могут участвовать в акции:

  • MANUALLY_ADDED — товары, которые добавлены вручную.

  • RENEWED — товары, которые добавлены автоматически из предыдущей акции «Бестселлеры Маркета». Только для акций «Бестселлеры Маркета».

  • RENEW_FAILED — товары, которые не получилось перенести из предыдущей акции «Бестселлеры Маркета». Только для акций «Бестселлеры Маркета».

  • NOT_MANUALLY_ADDED — товары, которые не участвуют в акции и те, которые добавлены автоматически.

  • MINIMUM_FOR_PROMOS — товары с установленным минимумом по цене для акций, который соответствует порогу maxPromoPrice. Такие товары участвуют в акции с ценой maxPromoPrice. Только для акций «Бестселлеры Маркета».

Если не передать параметр statuses, вернутся все товары.

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

Enum: MANUALLY_ADDED, RENEWED, RENEW_FAILED, NOT_MANUALLY_ADDED, MINIMUM_FOR_PROMOS

Min items: 1

Unique items  

PromoOfferParticipationStatusFilterType

Фильтр для товаров, которые добавлены в акцию вручную:

  • MANUALLY_ADDED — товары, которые добавлены вручную.

  • NOT_MANUALLY_ADDED— товары, которые не участвуют в акции и те, которые добавлены автоматически.

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

Type

Description

PromoOfferParticipationStatusFilterType

Enum: MANUALLY_ADDED, NOT_MANUALLY_ADDED

PromoOfferParticipationStatusMultiFilterType

Фильтр для товаров, которые могут участвовать в акции:

  • MANUALLY_ADDED — товары, которые добавлены вручную.

  • RENEWED — товары, которые добавлены автоматически из предыдущей акции «Бестселлеры Маркета». Только для акций «Бестселлеры Маркета».

  • RENEW_FAILED — товары, которые не получилось перенести из предыдущей акции «Бестселлеры Маркета». Только для акций «Бестселлеры Маркета».

  • NOT_MANUALLY_ADDED — товары, которые не участвуют в акции и те, которые добавлены автоматически.

  • MINIMUM_FOR_PROMOS — товары с установленным минимумом по цене для акций, который соответствует порогу maxPromoPrice. Такие товары участвуют в акции с ценой maxPromoPrice. Только для акций «Бестселлеры Маркета».

Если не передать параметр statuses, вернутся все товары.

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

Type

Description

PromoOfferParticipationStatusMultiFilterType

Enum: MANUALLY_ADDED, RENEWED, RENEW_FAILED, NOT_MANUALLY_ADDED, MINIMUM_FOR_PROMOS

Responses

200 OK

Список товаров, которые участвуют или могут участвовать в акции.

Body

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

Name

Description

result

Type: GetPromoOffersResultDTO

Список товаров, которые участвуют или могут участвовать в акции.

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

GetPromoOffersResultDTO

Список товаров, которые участвуют или могут участвовать в акции.

Name

Description

offers*

Type: GetPromoOfferDTO[]

Товары, которые участвуют или могут участвовать в акции.
Товар, который участвует или может участвовать в акции.

paging

Type: ForwardScrollingPagerDTO

Идентификатор следующей страницы.

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

GetPromoOfferDTO

Товар, который участвует или может участвовать в акции.

Name

Description

offerId*

Type: string

Ваш SKU — идентификатор товара в вашей системе.

Правила использования SKU:

  • У каждого товара SKU должен быть свой.

  • Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.

SKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте в Справке Маркета для продавцов.

Что такое SKU и как его назначать

Min length: 1

Max length: 255

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

params*

Type: PromoOfferParamsDTO

Параметры товара в акции.

Возвращается параметр, который соответствует типу акции.

status*

Type: PromoOfferParticipationStatusType

Статус товара в акции:

  • AUTO — добавлен автоматически во всех магазинах кабинета, в которых товар доступен для покупки.

  • PARTIALLY_AUTO — добавлен автоматически у части магазинов.

  • MANUAL — добавлен вручную.

  • NOT_PARTICIPATING — не участвует в акции.

  • RENEWED — успешно перенесен из предыдущей акции «Бестселлеры Маркета». Только для акций «Бестселлеры Маркета».

  • RENEW_FAILED — не получилось перенести из предыдущей акции «Бестселлеры Маркета». Только для акций «Бестселлеры Маркета».

  • MINIMUM_FOR_PROMOS — участвует в акции с ценой maxPromoPrice (установлен минимум по цене для акций, который соответствует порогу maxPromoPrice). Только для акций «Бестселлеры Маркета».

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

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

autoParticipatingDetails

Type: PromoOfferAutoParticipatingDetailsDTO

Информация об автоматическом добавлении товара в акцию.

Причины, по которым товар не был добавлен автоматически в других магазинах, можно узнать в кабинете продавца на Маркете на странице акции.

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

ForwardScrollingPagerDTO

Идентификатор следующей страницы.

Name

Description

nextPageToken

Type: string

Идентификатор следующей страницы результатов.

PromoOfferParamsDTO

Параметры товара в акции.

Возвращается параметр, который соответствует типу акции.

Name

Description

discountParams

Type: PromoOfferDiscountParamsDTO

Параметры товара в акции с типом DIRECT_DISCOUNT или BLUE_FLASH.

promocodeParams

Type: PromoOfferPromocodeParamsDTO

Параметры товара в акции с типом MARKET_PROMOCODE.

PromoOfferParticipationStatusType

Статус товара в акции:

  • AUTO — добавлен автоматически во всех магазинах кабинета, в которых товар доступен для покупки.

  • PARTIALLY_AUTO — добавлен автоматически у части магазинов.

  • MANUAL — добавлен вручную.

  • NOT_PARTICIPATING — не участвует в акции.

  • RENEWED — успешно перенесен из предыдущей акции «Бестселлеры Маркета». Только для акций «Бестселлеры Маркета».

  • RENEW_FAILED — не получилось перенести из предыдущей акции «Бестселлеры Маркета». Только для акций «Бестселлеры Маркета».

  • MINIMUM_FOR_PROMOS — участвует в акции с ценой maxPromoPrice (установлен минимум по цене для акций, который соответствует порогу maxPromoPrice). Только для акций «Бестселлеры Маркета».

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

Type

Description

PromoOfferParticipationStatusType

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

PromoOfferAutoParticipatingDetailsDTO

Информация об автоматическом добавлении товара в акцию.

Причины, по которым товар не был добавлен автоматически в других магазинах, можно узнать в кабинете продавца на Маркете на странице акции.

Об автоматическом и ручном добавлении товаров в акцию читайте в Справке Маркета для продавцов.

Name

Description

campaignIds

Type: integer<int64>[]

Идентификаторы кампаний тех магазинов, в которых товар добавлен в акцию автоматически.

Возвращается, если статус товара в акции — PARTIALLY_AUTO.
Идентификатор кампании.

Min items: 1

Unique items  

PromoOfferDiscountParamsDTO

Параметры товара в акции с типом DIRECT_DISCOUNT или BLUE_FLASH.

Name

Description

maxPromoPrice*

Type: integer<int64>

Максимально возможная цена для участия в акции.

Указывается в рублях.

Возвращается для всех товаров.

price

Type: integer<int64>

Зачеркнутая цена — та, по которой товар продавался до акции.

Указывается в рублях.

Возвращается, только если товар участвует в акции.

promoPrice

Type: integer<int64>

Цена по акции — та, по которой вы хотите продавать товар.

Указывается в рублях.

Возвращается, только если товар участвует в акции.

PromoOfferPromocodeParamsDTO

Параметры товара в акции с типом MARKET_PROMOCODE.

Name

Description

maxPrice*

Type: integer<int64>

Максимально возможная цена для участия в акции до применения промокода.

Указывается в рублях.

Возвращается для всех товаров.

400 Bad Request

Запрос содержит неправильные данные.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

ApiErrorDTO

Общий формат ошибки.

Name

Description

code*

Type: string

Код ошибки.

message

Type: string

Описание ошибки.

401 Unauthorized

В запросе не указаны данные для авторизации.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

403 Forbidden

Данные для авторизации неверны или доступ к ресурсу запрещен.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

404 Not Found

Запрашиваемый ресурс не найден.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

420 Method Failure

Превышено ограничение на доступ к ресурсу.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json
{
    "status": "OK",
    "errors": [
        {
            "code": "string",
            "message": "string"
        }
    ]
}

Name

Description

errors

Type: ApiErrorDTO[]

Список ошибок.
Общий формат ошибки.

Min items: 1

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR

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

Предыдущая
Список акций
Следующая
Добавление товаров в акцию/изменение их цен