Рекомендованные ставки для заданных товаров

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

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

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

Возвращает рекомендованные ставки для заданных товаров, что обеспечивает вашим предложениям определенную долю показов, и дополнительные инструменты продвижения.

Для одного товара может возвращаться одна рекомендованная ставка или несколько. Во втором случае разные ставки предназначены для достижения разной доли показов и получения дополнительных инструментов продвижения.

Если товар только добавлен в каталог, но пока не продается, рекомендованной ставки для него не будет.

В одном запросе может быть максимум 1500 товаров.

⚙️ Лимит: 1 000 запросов в минуту

Request

POST

https://api.partner.market.yandex.ru/v2/businesses/{businessId}/bids/recommendations

Path parameters

Name

Description

businessId

Type: integer

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

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

Min value: 1

Body

application/json
{
  "skus": [
    "example"
  ]
}

Name

Description

skus

Type: ShopSku[]

Список товаров, для которых нужно получить рекомендации по ставкам.

Min items: 1

Max items: 1500

Unique items: true

Example
[
  "example"
]

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

Responses

200 OK

Рекомендованные ставки для заданных товаров.

Body

application/json
{
  "status": "OK",
  "result": {
    "recommendations": [
      {
        "sku": "example",
        "bid": 570,
        "bidRecommendations": [
          null
        ],
        "priceRecommendations": [
          null
        ]
      }
    ]
  }
}

Type: object

All of 2 types

  • Type: ApiResponse

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

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

    result

    Type: GetBidsRecommendationsResponseDTO

    Список товаров с рекомендованными ставками.

    Example
    {
  "recommendations": [
    {
      "sku": "example",
      "bid": 570,
      "bidRecommendations": [
        {
          "bid": null,
          "showPercent": 0,
          "benefits": [
            null
          ]
        }
      ],
      "priceRecommendations": [
        {
          "campaignId": 1,
          "price": 1
        }
      ]
    }
  ]
}
    Example
    {
  "result": {
    "recommendations": [
      {
        "sku": "example",
        "bid": 570,
        "bidRecommendations": [
          {}
        ],
        "priceRecommendations": [
          {}
        ]
      }
    ]
  }
}

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

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

Name

Description

status

Type: ApiResponseStatusType

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

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

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

Bid

Значение ставки.

Type: integer

Min value: 0

Max value: 9999

BenefitType

Типы дополнительных инструментов продвижения:

  • BESTS — участие в акции «Бестселлеры Маркета».
  • SPLIT_0_0_4 — возможность оплаты со Сплитом сроком на 4 месяца.
  • SPLIT_0_0_6 — возможность оплаты со Сплитом сроком на 6 месяцев.
  • SPLIT_0_0_12 — возможность оплаты со Сплитом сроком на 12 месяцев.
  • MARKET_SUBSIDY_1_4 — скидка от Маркета от 1 до 4%.
  • MARKET_SUBSIDY_5_9 — скидка от Маркета от 5 до 9%.
  • MARKET_SUBSIDY_10 — скидка от Маркета от 10%.

Type: string

Enum: BESTS, SPLIT_0_0_4, SPLIT_0_0_6, SPLIT_0_0_12, MARKET_SUBSIDY_1_4, MARKET_SUBSIDY_5_9, MARKET_SUBSIDY_10

BidRecommendationItemDTO

Рекомендованная ставка, возможная доля показов и доступные дополнительные инструменты продвижения.

Name

Description

bid

Type: Bid

Значение рекомендованной ставки для товара из параметра sku, от 50 до 9999.

Указывается в процентах от стоимости товара и умножается на 100. Например, ставка 5% обозначается как 500.

Значение ставки.

Min value: 0

Max value: 9999

Example: 570

showPercent

Type: integer

Доля показов.

Min value: 0

Max value: 100

benefits

Type: BenefitType[] | null

Список доступных субсидий.

Чтобы получить необходимый инструмент продвижения, установите ставку, которая будет рекомендована для этого инструмента или выше.

Min items: 1

Unique items: true

Example
[
  "BESTS"
]
Example
{
  "bid": 570,
  "showPercent": 0,
  "benefits": [
    "BESTS"
  ]
}

CampaignId

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

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

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

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

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

Type: integer

Min value: 1

PriceRecommendationItemDTO

Рекомендованная цена.

Name

Description

campaignId

Type: CampaignId

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

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

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

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

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

Min value: 1

Example: 1

price

Type: number

Рекомендованная цена товара. Чтобы продвижение хорошо работало, цена товара должна быть не выше этого значения. Подробно о рекомендованных ценах

Min value: 1
Example
{
  "campaignId": 1,
  "price": 1
}

SkuBidRecommendationItemDTO

Список товаров с рекомендованными ставками.

Name

Description

bid

Type: Bid

Значение рекомендованной ставки для товара из параметра sku, от 50 до 9999.

Указывается в процентах от стоимости товара и умножается на 100. Например, ставка 5% обозначается как 500.

В ответе присутствует не пустой bidRecommendations

Не обращайте внимания на это поле.

Значение ставки.

Min value: 0

Max value: 9999

Example: 570

sku

Type: ShopSku

SKU товара, которому соответствует ставка из параметра bid.

Ваш 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

bidRecommendations

Type: BidRecommendationItemDTO[] | null

Список рекомендованных ставок с соответствующими долями показов и доступными дополнительными инструментами продвижения.

Чем больше ставка, тем большую долю показов она помогает получить и тем больше дополнительных инструментов продвижения доступно.

Min items: 1

Example
[
  {
    "bid": 570,
    "showPercent": 0,
    "benefits": [
      "BESTS"
    ]
  }
]

priceRecommendations

Type: PriceRecommendationItemDTO[] | null

Рекомендованные цены.

Min items: 1

Example
[
  {
    "campaignId": 1,
    "price": 1
  }
]
Example
{
  "sku": "example",
  "bid": 570,
  "bidRecommendations": [
    {
      "bid": null,
      "showPercent": 0,
      "benefits": [
        "BESTS"
      ]
    }
  ],
  "priceRecommendations": [
    {
      "campaignId": 1,
      "price": 1
    }
  ]
}

GetBidsRecommendationsResponseDTO

Список товаров с рекомендованными ставками.

Name

Description

recommendations

Type: SkuBidRecommendationItemDTO[]

Список товаров с рекомендованными ставками.

Example
[
  {
    "sku": "example",
    "bid": 570,
    "bidRecommendations": [
      {
        "bid": null,
        "showPercent": 0,
        "benefits": [
          "BESTS"
        ]
      }
    ],
    "priceRecommendations": [
      {
        "campaignId": 1,
        "price": 1
      }
    ]
  }
]
Example
{
  "recommendations": [
    {
      "sku": "example",
      "bid": 570,
      "bidRecommendations": [
        {
          "bid": null,
          "showPercent": 0,
          "benefits": [
            null
          ]
        }
      ],
      "priceRecommendations": [
        {
          "campaignId": 1,
          "price": 1
        }
      ]
    }
  ]
}

400 Bad Request

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

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

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

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",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

401 Unauthorized

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

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

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

403 Forbidden

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

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

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

404 Not Found

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

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

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

420 Method Failure

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

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

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

500 Internal Server Error

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

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

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

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

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

Предыдущая
Установленные ставки
Следующая
Индекс качества магазинов