List of products in the catalog

Name

Description

Type: integer<int64>

The campaign ID.

You can find it using a query GET v2/campaigns or find it in the seller's office on the Market — click on your account icon → Settings and in the menu on the left, select APIs and modules:

• block Campaign ID;
• tab Query log → drop-down list in the block Show logs.

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

Min value: 1

Name

Description

Type: string[]

Filtering by product delivery plans:

• ACTIVE — There will be deliveries.
• INACTIVE — There will be no deliveries: the product is in stock, but you no longer plan to deliver it.
• DELISTED — Archive: The product has run out of stock, and there will be no more deliveries.

You can specify multiple values in one parameter, separated by commas, or in several identical parameters. For example:

...availability=INACTIVE,DELISTED...
...availability=INACTIVE&availability=DELISTED...

In the request, you can specify either the parameter shopSku, or any parameters for filtering products. Sharing a parameter shopSku and the filtering options will result in an error.
Delivery plans:

• ACTIVE — There will be deliveries.
• INACTIVE — There will be no deliveries: the product is in stock, but you no longer plan to deliver it. 60 days after the product runs out of stock, this status will change to DELISTED.
• DELISTED — Archive: The product has run out of stock, and there will be no more deliveries. If the product is returned to the warehouse (for example, the customer returns the order), this status will change to INACTIVE.

Enum: ACTIVE, INACTIVE, DELISTED

Type: integer[]

Filtering by the category ID on the Market.

To find out the ID of the category to which the product belongs, use the request POST v2/categories/tree.

You can specify multiple identifiers in one parameter, separated by commas, or in several identical parameters. For example:

...category_id=14727164,14382343...
...category_id=14727164&category_id=14382343...

In the request, you can specify either the parameter shopSku, or any parameters for filtering products. Sharing a parameter shopSku and the filtering options will result in an error.

Type: integer<int32>

The number of values per page.

Min value: 1
Example: 20

Type: string

The type of mapping.
Type of mapping:

• ALL — all products.
• ACTIVE — ready-to-sell products.

Enum: ACTIVE, ALL

Type: string[]

The product ID in the catalog.

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==

Type: string[]

Your SKU the product.

The parameter can be specified several times, for example:

...shop_sku=123&shop_sku=129&shop_sku=141...

In the request, you can specify either the parameter shopSku, or any parameters for filtering products. Sharing a parameter shopSku and the filtering options will result in an error.
Your SKU — the product ID in your system.

Usage rules SKU:

• For each product SKU there must be one.

• Already set SKU it cannot be released and reused for another product. Each product should receive a new identifier that has never been used in your catalog before.

SKU 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 SKU and how to assign it

Min length: 1

Max length: 255

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

Type: string[]

Filtering by product publication status:

• READY — the product has passed moderation.
• IN_WORK — the product is undergoing moderation.
• NEED_CONTENT — for a product without SKU on the Market marketSku you need to find a card yourself or create one.
• NEED_INFO — The product failed moderation due to errors or missing information in the product description.
• REJECTED — the product did not pass moderation, as the Market does not plan to post such products.
• SUSPENDED — the product has not passed moderation, as the Market does not yet place such products.
• OTHER — the product failed moderation for another reason.

You can specify multiple statuses in one parameter, separated by commas, or in several identical parameters. For example:

...status=READY,IN_WORK...
...status=READY&status=IN_WORK...

In the request, you can specify either the shopSku parameter or any parameters for filtering products. Using the shopSku parameter and the filtering parameters together will result in an error.
Product publication status:

• UNKNOWN — unknown status.
• READY — the product has passed moderation. To place it on the Market, set a price for it.
• IN_WORK — the product is undergoing moderation. It takes a few days.
• NEED_INFO — The product failed moderation due to errors or missing information in the product description. Information about the reasons for the deviation is returned in the parameter notes.
• NEED_MAPPING — You can't create a card for a product.
• NEED_CONTENT — for a product without SKU on the Market (marketSku) you need to find the card yourself (via the API or the seller's account on the Market) or create it if the product is not yet on sale on the Market.
• CONTENT_PROCESSING — the product is under moderation.
• SUSPENDED — the product has not passed moderation, as the Market does not yet place such products.
• REJECTED — the product did not pass moderation, as the Market does not plan to post such products.
• REVIEW — A decision is being made on the placement of the product.
• CREATE_ERROR — couldn't create a product profile.
• UPDATE_ERROR — the product card has unused changes.

Enum: UNKNOWN, READY, IN_WORK, NEED_INFO, NEED_MAPPING, NEED_CONTENT, CONTENT_PROCESSING, SUSPENDED, REJECTED, REVIEW, CREATE_ERROR, UPDATE_ERROR

Type: string[]

Filtering by product brand.

You can specify multiple brands in one parameter, separated by commas, or in several identical parameters. For example:

...vendor=Aqua%20Minerale,Borjomi...
...vendor=Aqua%20Minerale&vendor=Borjomi...

In order for a product to be included in the filtering results, its brand must exactly match one of the ones specified in the request. For example, if the brand is specified Schwarzkopf, then there will be no products in the results Schwarzkopf Professional.

If the brand name contains characters that are not included in the table ASCII (including Cyrillic characters), use for them URL- coding. For example, a space — %20, apostrophe "'" — %27, etc. For more information, see Coding URL Russian-language Wikipedia.

In the request, you can specify either the shopSku parameter or any parameters for filtering products. Sharing a parameter shopSku and the filtering options will result in an error.