Информация об установленных ставках

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

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

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

Возвращает значения ставок для заданных товаров.

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

В ответе возвращаются значения только тех ставок, которые вы установили через запрос PUT v2/businesses/{businessId}/bids.

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

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

Request

POST

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

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
{
  "skus": [
    "example"
  ]
}

Name

Description

skus

Type: ShopSku[] | null

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

Если список не задан, постранично возвращаются все товары со ставками.

Если список задан, результаты возвращаются одной страницей, а параметры page_token и limit игнорируются.

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"
}

Type: object

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

SkuBidItemDTO

Список товаров и ставок на них.

Name

Description

bid

Type: Bid

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

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

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

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

Example
{
  "sku": "example",
  "bid": 570
}

ForwardScrollingPagerDTO

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

Name

Description

nextPageToken

Type: string

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

Example: example

Example
{
  "nextPageToken": "example"
}

GetBidsInfoResponseDTO

Список товаров с указанными ставками.

Name

Description

bids

Type: SkuBidItemDTO[]

Страница списка товаров.

Example
[
  {
    "sku": "example",
    "bid": 570
  }
]

paging

Type: ForwardScrollingPagerDTO

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

Example
{
  "nextPageToken": "example"
}
Example
{
  "bids": [
    {
      "sku": "example",
      "bid": 570
    }
  ],
  "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: |-
  {
    "skus": [
      "example"
    ]
  }
schema:
  description: description.
  type: object
  properties:
    skus:
      description: >
        Список товаров, для которых нужно получить значения ставок.


        Если список не задан, постранично возвращаются все товары со ставками.


        Если список задан, результаты возвращаются одной страницей, а параметры
        `page_token` и `limit` игнорируются.
      type: array
      minItems: 1
      maxItems: 1500
      nullable: true
      uniqueItems: true
      items:
        description: "Ваш SKU —\_идентификатор товара в вашей системе.\n\nПравила использования SKU:\n\n* У каждого товара SKU должен быть свой.\n\n* Уже заданный SKU нельзя освободить и использовать заново для другого товара. Каждый товар должен получать новый идентификатор, до того никогда не использовавшийся в вашем каталоге.\n\nSKU товара можно изменить в кабинете продавца на Маркете. О том, как это сделать, читайте [в Справке Маркета для продавцов](https://yandex.ru/support2/marketplace/ru/assortment/operations/edit-sku).\n\n{% note warning %}\n\nПробельные символы в начале и конце значения автоматически удаляются. Например, `\"  SKU123  \"` и `\"SKU123\"` будут обработаны как одинаковые значения.\n\n{% endnote %}\n\n[Что такое SKU и как его назначать](https://yandex.ru/support/marketplace/assortment/add/index.html#fields)\n"
        type: string
        pattern: ^(?=.*\S.*)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$
        x-transform: trim
        minLength: 1
        maxLength: 255
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}/bids/info
host: https://api.partner.market.yandex.ru

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