Information about the goods you have hidden

Info

Console

The method is available for all models.

If you are using an API Key token, one of the accesses in the list is required to call the method

offers-and-cards-management — Manage products and cards
offers-and-cards-management:read-only — View products and cards
all-methods — Full account management
all-methods:read-only — View all data

Retrieves the list of hidden items for the specified store.

The list will contain products that are hidden in any way — through the API, using the YML feed, in the cabinet, and so on.

, Limit: 10,000 products per minute, no more than 500 products per request

Request

GET

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

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The campaign ID.

You can find it using a query GET campaigns or find it in the seller's office on the Market — click on the name of your business and go to the page:

Modules and APIs → block Sending data to Yandex.Market.
Query log → drop-down list in the block Show logs.

, Do not send the store's ID instead, which is indicated in the seller's account on the Market next to the store's name and in some reports.

Min value: 1

Query parameters

Name	Description
limit	Type: integer<int32> The number of values per page. Example: `20`
offer_id	Type: string[] The ID of the hidden offer. Your SKU is the product identifier in your system. SKU Usage Rules: Each product must have its own SKU. An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before. The SKU of the product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers. What is a SKU and how to assign it Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$`
page_token	Type: string ID of the results page. If the parameter is omitted, the first page is returned. We recommend transmitting the value of the output parameter `nextPageToken`, received during the last request. If set `page_token` and the request has parameters `page` and `pageSize` they are ignored. Example: `eyBuZXh0SWQ6IDIzNDIgfQ==`

Responses

200 OK

Information about the goods you have hidden.

Body

application/json

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

Name

Description

result

Type: GetHiddenOffersResultDTO

A list of hidden items.

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

GetHiddenOffersResultDTO

A list of hidden items.

Name

Description

hiddenOffers*

Type: HiddenOfferDTO[]

A list of hidden goods.
Information about hiding.

paging

Type: ScrollingPagerDTO

Information about the result pages.
The ID of the next page.

ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

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

HiddenOfferDTO

Information about hiding.

Name

Description

offerId*

Type: string

Your SKU is the product identifier in your system.

SKU Usage Rules:

Each product must have its own SKU.
An already set SKU cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

The SKU of the product can be changed in the seller's account on the Market. Read about how to do this. in the Help of the Market for sellers.

What is a SKU and how to assign it

Min length: 1

Max length: 255

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

ScrollingPagerDTO

Information about the result pages.

Name

Description

nextPageToken

Type: string

ID of the next results page.

prevPageToken

Type: string

ID of the previous results page.

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

ApiErrorDTO

The general error format.

Name

Description

code*

Type: string

The error code.

message

Type: string

Description of the error.

401 Unauthorized

The authorization data is not specified in the request. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

403 Forbidden

The authorization data is incorrect or access to the resource is prohibited. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

420 Method Failure

The resource access limit has been exceeded. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

500 Internal Server Error

Internal error of Yandex. Market. More information about the error

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

A list of errors.
The general error format.

Min items: 1

status

Type: ApiResponseStatusType

The type of response. Possible values:

OK — there are no mistakes.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

In the shop

Hiding goods