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

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

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

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

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

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

Например, maxPromoPrice.

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

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

Request

POST

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

Path parameters

Name

Description

businessId

Type: integer

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

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer

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

Min value: 1

page_token

Type: string

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

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

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

Если задан page_token и в запросе есть параметры page и pageSize, они игнорируются.

Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

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

Name

Description

promoId

Type: string

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

Example: example

statuses

Type: PromoOfferParticipationStatusMultiFilterType[] | null

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

Min items: 1

Unique items: true

Example
[
  "MANUALLY_ADDED"
]

statusType

Type: PromoOfferParticipationStatusFilterType

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

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

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

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

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

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

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

Enum: MANUALLY_ADDED, NOT_MANUALLY_ADDED

PromoOfferParticipationStatusMultiFilterType

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

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

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

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

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

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

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

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

Type: string

Enum: MANUALLY_ADDED, RENEWED, RENEW_FAILED, NOT_MANUALLY_ADDED, MINIMUM_FOR_PROMOS

PromoOfferParticipationStatusFilterType

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

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

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

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

Type: string

Enum: MANUALLY_ADDED, NOT_MANUALLY_ADDED

Responses

200 OK

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

Body

application/json
{
  "status": "OK"
}

Type: object

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR
Example
{
  "status": "OK"
}

ShopSku

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

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

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

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

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

Важно

Пробельные символы в начале и конце значения автоматически удаляются. Например, " SKU123 " и "SKU123" будут обработаны как одинаковые значения.

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

Type: string

Min length: 1

Max length: 255

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

Example: example

PromoOfferParticipationStatusType

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

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

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

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

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

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

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

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

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

Type: string

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

PromoOfferDiscountParamsDTO

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

Name

Description

maxPromoPrice

Type: integer

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

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

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

price

Type: integer

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

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

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

promoPrice

Type: integer

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

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

Возвращается, только если товар участвует в акции.
Example
{
  "price": 0,
  "promoPrice": 0,
  "maxPromoPrice": 0
}

PromoOfferParamsDTO

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

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

Name

Description

discountParams

Type: PromoOfferDiscountParamsDTO

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

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

CampaignId

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Type: integer

Min value: 1

PromoOfferAutoParticipatingDetailsDTO

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

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

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

Name

Description

campaignIds

Type: CampaignId[] | null

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

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

Min items: 1

Unique items: true

Example
[
  1
]
Example
{
  "campaignIds": [
    1
  ]
}

GetPromoOfferDTO

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

Name

Description

offerId

Type: ShopSku

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

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

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

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

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

Важно

Пробельные символы в начале и конце значения автоматически удаляются. Например, " SKU123 " и "SKU123" будут обработаны как одинаковые значения.

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

Min length: 1

Max length: 255

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

Example: example

params

Type: PromoOfferParamsDTO

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

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

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

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

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

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

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

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

ForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

Example: example
Example
{
  "nextPageToken": "example"
}

GetPromoOffersResultDTO

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

Name

Description

offers

Type: GetPromoOfferDTO[]

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

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

paging

Type: ForwardScrollingPagerDTO

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

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

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибках при работе с акциями

Body

application/json
{
  "status": "OK"
}

Type: object

ApiErrorDTO

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

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

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

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

    Example
    {
  "status": "OK"
}
  • Type: object

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

    Min items: 1

    Example
    [
  {
    "code": "example",
    "message": "example"
  }
]
    Example
    {
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}
Example
{
  "status": "OK"
}

401 Unauthorized

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

Body

application/json
{
  "status": "OK"
}

Type: object

403 Forbidden

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

Body

application/json
{
  "status": "OK"
}

Type: object

404 Not Found

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

Body

application/json
{
  "status": "OK"
}

Type: object

420 Method Failure

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

Body

application/json
{
  "status": "OK"
}

Type: object

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

application/json
{
  "status": "OK"
}

Type: object

pathParams:
  - description: "Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом [GET\_v2/campaigns](../../reference/campaigns/getCampaigns.md).\n\nℹ️ [Что такое кабинет и магазин на Маркете](https://yandex.ru/support/marketplace/account/introduction.html)\n"
    name: businessId
    in: path
    required: true
    schema:
      type: integer
      format: int64
      minimum: 1
searchParams:
  - name: page_token
    description: >
      Идентификатор страницы c результатами.


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


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


      Если задан `page_token` и в запросе есть параметры `page` и `pageSize`,
      они игнорируются.
    in: query
    required: false
    example: eyBuZXh0SWQ6IDIzNDIgfQ==
    schema:
      type: string
  - name: limit
    description: |
      Количество значений на одной странице.
    in: query
    required: false
    example: 20
    schema:
      type: integer
      format: int32
      minimum: 1
headers: []
body: |-
  {
    "promoId": "example",
    "statusType": "MANUALLY_ADDED",
    "statuses": [
      "MANUALLY_ADDED"
    ]
  }
schema:
  description: Получение списка товаров, которые участвуют или могут участвовать в акции.
  type: object
  required:
    - promoId
  properties:
    promoId:
      description: Идентификатор акции.
      type: string
    statusType:
      description: "{% note warning \"Вместо него используйте `statuses`.\" %}\n\n\_\n\n{% endnote %}\n\nФильтр для товаров, которые добавлены в акцию вручную.\n\nЕсли не передать параметр `statusType`, вернутся все товары.\n"
      deprecated: true
      $ref: '#/$defs/PromoOfferParticipationStatusFilterType'
    statuses:
      description: >-
        Фильтр для товаров, которые могут участвовать в акции. Можно задать
        несколько значений.
      type: array
      nullable: true
      uniqueItems: true
      minItems: 1
      items:
        description: >
          Фильтр для товаров, которые могут участвовать в акции:


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


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


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


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


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


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


          Об автоматическом и ручном добавлении товаров в акцию читайте [в
          Справке Маркета для
          продавцов](https://yandex.ru/support2/marketplace/ru/marketing/promos/market/index).
        type: string
        enum:
          - MANUALLY_ADDED
          - RENEWED
          - RENEW_FAILED
          - NOT_MANUALLY_ADDED
          - MINIMUM_FOR_PROMOS
  $defs:
    /home/sandbox/.ya/build/build_root/4217/00000b/market/mbi/docs/partner-api/docfiles/__docsbuild/.tmp_input/ru/openapi/partner-api-spec/promos/api/getPromoOffers.yaml#/PromoOfferParticipationStatusFilterType:
      description: >
        Фильтр для товаров, которые добавлены в акцию вручную:


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


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


        Об автоматическом и ручном добавлении товаров в акцию читайте [в Справке
        Маркета для
        продавцов](https://yandex.ru/support2/marketplace/ru/marketing/promos/market/index).
      type: string
      enum:
        - MANUALLY_ADDED
        - NOT_MANUALLY_ADDED
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/offers
host: https://api.partner.market.yandex.ru

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

В методе POST v2/businesses/{businessId}/offer-prices/updates.

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