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

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

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

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

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

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

Request

POST

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

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 и в запросе есть параметры offset, page_number и page_size, они игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Body

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

Name

Description

skus

Type: string[]

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

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

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

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

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

  • SKU товара нельзя менять — можно только удалить товар и добавить заново с новым SKU.

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

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

Min length: 1

Max length: 255

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

Max items: 1500

Min items: 1

Unique items: true

Responses

200 OK

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

Body

application/json
{
    "status": "OK",
    "result": {
        "bids": [
            {
                "sku": "string",
                "bid": 570
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

result

Type: GetBidsInfoResponseDTO

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

GetBidsInfoResponseDTO

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

Name

Description

bids*

Type: SkuBidItemDTO[]

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

paging

Type: ForwardScrollingPagerDTO

Ссылка на следующую страницу.

ApiResponseStatusType

Тип ответа.

Type

Description

ApiResponseStatusType

Enum: OK, ERROR

SkuBidItemDTO

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

Name

Description

bid*

Type: integer<int32>

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

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

Example: 570

Min value: 0

Max value: 9999

sku*

Type: string

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

Min length: 1

Max length: 255

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

ForwardScrollingPagerDTO

Ссылка на следующую страницу.

Name

Description

nextPageToken

Type: string

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

400 Bad Request

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

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[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

403 Forbidden

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

404 Not Found

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

420 Method Failure

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

500 Internal Server Error

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

Body

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

Name

Description

errors

Type: ApiErrorDTO[]

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR