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

Info

Console

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

В списке будут товары, скрытые любым способом — по API, с помощью YML-фида, в кабинете и так далее.

⚙️ Лимит: 5000 товаров в минуту, не более 500 товаров в одном запросе

Request

GET

https://api.partner.market.yandex.ru/campaigns/{campaignId}/hidden-offers

Path parameters

Name

Description

campaignId*

Type: integer<int64>

Идентификатор кампании в API и магазина в кабинете. Каждая кампания в API соответствует магазину в кабинете.

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

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

Min value: 1

Query parameters

Name

Description

limit

⦸

Type: integer<int32>

Этот параметр устарел. Не используйте его.

Количество скрытых товаров в выходных данных.

Минимальное значение: 1.

Максимальное значение: 500.

Значение по умолчанию: 500.

Используется вместе с параметром page_token или offset.

Если задан limit, параметры page_number и page_size игнорируются.
Example: 20

offer_id

Type: string[]

Идентификатор скрытого предложения.
Ваш SKU — идентификатор товара в вашей системе.

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

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

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

Min length: 1

Max length: 255

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

offset

⦸

Type: integer<int32>

Этот параметр устарел. Не используйте его.

Позиция в списке, начиная с которой возвращаются результаты ответа.

Используется вместе с параметром limit.

Если задан offset, параметры page_number и page_size игнорируются.

offset игнорируется, если задан page_token.

page

⦸

Type: integer<int32>

Этот параметр устарел. Не используйте его.

Номер страницы результатов.

Значение по умолчанию: 1.

Используется вместе с параметром page_size.

page_number игнорируется, если задан page_token, limit или offset.

Default: 1

Max value: 10000

pageSize

⦸

Type: integer<int32>

Этот параметр устарел. Не используйте его.

Размер страницы.

Используется вместе с параметром page_number.

page_size игнорируется, если задан page_token, limit или offset.

page_token

Type: string

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

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

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

Если задан page_token и в запросе есть параметры offset, page_number и page_size, они игнорируются.
Example: eyBuZXh0SWQ6IDIzNDIgfQ==

Responses

200 OK

Информация о скрытых вами товарах.

Body

application/json

{
    "status": "OK",
    "result": {
        "paging": {
            "nextPageToken": "string",
            "prevPageToken": "string"
        },
        "hiddenOffers": [
            {
                "offerId": "string"
            }
        ]
    }
}

Name

Description

result

Type: GetHiddenOffersResultDTO

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

status

Type: ApiResponseStatusType

Тип ответа.

Enum: OK, ERROR

GetHiddenOffersResultDTO

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

Name

Description

hiddenOffers*

Type: HiddenOfferDTO[]

Список скрытых товаров.
Информация о скрытии.

paging

Type: ScrollingPagerDTO

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

ApiResponseStatusType

Тип ответа.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

HiddenOfferDTO

Информация о скрытии.

Name

Description

offerId*

Type: string

Идентификатор предложения из прайс-листа.

Min length: 1

Max length: 255

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

ScrollingPagerDTO

Информация о страницах результатов.

Name

Description

nextPageToken

Type: string

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

prevPageToken

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

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

Была ли статья полезна?

В магазине

Скрытие товаров