Информация о скрытых вами товарах
Возвращает для заданного магазина список скрытых вами товаров.
В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее.
| ⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе |
|---|
Request
GET
https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers
Path parameters
|
Name |
Type |
Description |
|
campaignId* |
integer<int64> |
Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете. Чтобы узнать идентификаторы своих магазинов, воспользуйтесь запросом GET campaigns. |
Query parameters
|
Name |
Type |
Description |
|
offer_id |
string[] |
Идентификатор скрытого предложения. |
|
page_token |
string |
Идентификатор страницы c результатами. Если параметр не указан, возвращается самая старая страница. Рекомендуется передавать значение выходного параметра Если задан |
|
limit |
integer<int32> |
Это поле устарело Не используйте его — это может привести к ошибкам. Количество скрытых товаров в выходных данных. Минимальное значение: 1. Максимальное значение: 500. Значение по умолчанию: 500. Используется вместе с параметром Если задан |
|
offset |
integer<int32> |
Это поле устарело Не используйте его — это может привести к ошибкам. Позиция в списке, начиная с которой возвращаются результаты ответа. Используется вместе с параметром Если задан
|
|
page |
integer<int32> |
Это поле устарело Не используйте его — это может привести к ошибкам. Номер страницы результатов. Значение по умолчанию: 1. Используется вместе с параметром
|
|
pageSize |
integer<int32> |
Это поле устарело Не используйте его — это может привести к ошибкам. Размер страницы. Используется вместе с параметром
|
Responses
200 OK
Информация о скрытых вами товарах.
Body
{
"status": "OK",
"result": {
"paging": {
"nextPageToken": "string",
"prevPageToken": "string"
},
"hiddenOffers": [
{
"offerId": "string"
}
]
}
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
result |
Список скрытых вами товаров. |
GetHiddenOffersResultDTO
Список скрытых вами товаров.
|
Name |
Type |
Description |
|
paging |
Информация о страницах результатов. |
|
|
hiddenOffers |
Список скрытых товаров. |
ScrollingPagerDTO
Информация о страницах результатов.
|
Name |
Type |
Description |
|
nextPageToken |
string |
Идентификатор следующей страницы результатов. |
|
prevPageToken |
string |
Идентификатор предыдущей страницы результатов. |
HiddenOfferDTO
Информация о скрытии.
|
Name |
Type |
Description |
|
offerId |
string |
Идентификатор предложения из прайс-листа.
|
400 Bad Request
Запрос содержит неправильные данные.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
ApiErrorDTO
Общий формат ошибки.
|
Name |
Type |
Description |
|
code* |
string |
Код ошибки. |
|
message |
string |
Описание ошибки. |
401 Unauthorized
В запросе не указаны данные для авторизации.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
403 Forbidden
Данные для авторизации неверны или доступ к ресурсу запрещен.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
420 Method Failure
Превышено ограничение на доступ к ресурсу.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |
500 Internal Server Error
Внутренняя ошибка сервера.
Body
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Type |
Description |
|
status |
Тип ответа.
|
|
|
errors |
Список ошибок. |