List of products in the catalog

Deprecated

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

This method is outdated.

Instead, use POST businesses/{businessId}/offer-mappings.

For each product that you place on the Market, information about the Market cards that this product is linked to is returned:

The ID of the current card (marketSku), the card that is undergoing moderation, and the last rejected card.
The product description shown on the Market card. For example, the size of the package and the weight of the product.

The results are returned page by page. The output data contains the ID of the next page.

How is the number of products in the store's catalog calculated?

According to the data for the last seven days (not including today).

, Limit: calculated by the formula

Request

GET

https://api.partner.market.yandex.ru/campaigns/{campaignId}/offer-mapping-entries

Path parameters

Name

Description

campaignId*

Type: integer<int64>

The store's ID in the merchant profile.

To find out the IDs of your stores, use the request GET campaigns.

ℹ️ What is a cabinet and a store on the Market?

Min value: 1

Query parameters

Name	Description
availability	Type: OfferAvailabilityStatusType[] Filtering by product delivery plans: `ACTIVE` — there will be supplies. `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.
category_id	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 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.
limit	Type: integer<int32> The number of values per page. Example: `20`
mapping_kind	Type: OfferMappingKindType The type of mapping.
offer_id	Type: string[] The product ID in the catalog.
page_token	Type: string ID of the results page. If the parameter is omitted, the first page is returned. It is recommended to pass the value of the output parameter `nextPageToken`, received during the last request. If set `page_token` and the request has parameters `page_number` and `page_size` they are ignored. Example: `eyBuZXh0SWQ6IDIzNDIgfQ==`
shop_sku	Type: string[] Your product SKU. 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 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}$`
status	Type: OfferProcessingStatusType[] Filtering by product publication status: `READY` — the product has passed moderation. `IN_WORK` — the product is undergoing moderation. `NEED_CONTENT` — for a product without a SKU on the marketSku Market, 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 has not passed 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 did not pass 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...` The request 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.
vendor	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 Schwarzkopf brand is specified, then there will be no Schwarzkopf Professional products in the results. If the brand name contains characters that are not included in the ASCII table (including Cyrillic characters), use URL encoding for them. For example, the space is %20, the apostrophe "'" is %27, and so on. For more information, see Encoding the URL of the Russian Wikipedia. The request 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.

OfferAvailabilityStatusType

Delivery plans:

ACTIVE — there will be supplies.
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.

Type	Description
OfferAvailabilityStatusType	Enum: `ACTIVE`, `INACTIVE`, `DELISTED`

OfferMappingKindType

Type of mapping:

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

Type	Description
OfferMappingKindType	Enum: `ACTIVE`, `ALL`

OfferProcessingStatusType

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 a 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 has not passed 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 — the product profile could not be created.
UPDATE_ERROR — the product card has unused changes.

Type	Description
OfferProcessingStatusType	Enum: `UNKNOWN`, `READY`, `IN_WORK`, `NEED_INFO`, `NEED_MAPPING`, `NEED_CONTENT`, `CONTENT_PROCESSING`, `SUSPENDED`, `REJECTED`, `REVIEW`, `CREATE_ERROR`, `UPDATE_ERROR`

Responses

200 OK

Information about the products in the catalog.

Body

application/json

{
    "status": "OK",
    "result": {
        "paging": {
            "nextPageToken": "string",
            "prevPageToken": "string"
        },
        "offerMappingEntries": [
            {
                "offer": {
                    "name": "Ударная дрель Makita HP1630, 710 Вт",
                    "shopSku": "string",
                    "category": "string",
                    "vendor": "LEVENHUK",
                    "vendorCode": "VNDR-0005A",
                    "description": "string",
                    "id": "string",
                    "feedId": 0,
                    "barcodes": [
                        46012300000000
                    ],
                    "urls": [
                        "string"
                    ],
                    "pictures": [
                        "string"
                    ],
                    "manufacturer": "string",
                    "manufacturerCountries": [
                        "string"
                    ],
                    "minShipment": 0,
                    "transportUnitSize": 0,
                    "quantumOfSupply": 0,
                    "deliveryDurationDays": 0,
                    "boxCount": 0,
                    "customsCommodityCodes": [
                        "string"
                    ],
                    "weightDimensions": {
                        "length": 65.55,
                        "width": 50.7,
                        "height": 20,
                        "weight": 1.001
                    },
                    "supplyScheduleDays": [
                        "MONDAY"
                    ],
                    "shelfLifeDays": 0,
                    "lifeTimeDays": 0,
                    "guaranteePeriodDays": 0,
                    "processingState": {
                        "status": "UNKNOWN",
                        "notes": [
                            {
                                "type": "ASSORTMENT",
                                "payload": "string"
                            }
                        ]
                    },
                    "availability": "ACTIVE",
                    "shelfLife": {
                        "timePeriod": 0,
                        "timeUnit": "HOUR",
                        "comment": "string"
                    },
                    "lifeTime": {
                        "timePeriod": 0,
                        "timeUnit": "HOUR",
                        "comment": "string"
                    },
                    "guaranteePeriod": {
                        "timePeriod": 0,
                        "timeUnit": "HOUR",
                        "comment": "string"
                    },
                    "certificate": "string",
                    "price": 0
                },
                "mapping": {
                    "marketSku": 0,
                    "modelId": 0,
                    "categoryId": 0
                },
                "awaitingModerationMapping": {
                    "marketSku": 0,
                    "modelId": 0,
                    "categoryId": 0
                },
                "rejectedMapping": {
                    "marketSku": 0,
                    "modelId": 0,
                    "categoryId": 0
                }
            }
        ]
    }
}

Name

Description

result

Type: OfferMappingEntriesDTO

Information about the products in the catalog.

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

OfferMappingEntriesDTO

Information about the products in the catalog.

Name

Description

offerMappingEntries*

Type: OfferMappingEntryDTO[]

Information about the products in the catalog.
The list of products.
Information about the product card.

paging

Type: ScrollingPagerDTO

Information about the result pages.
Link to 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`

OfferMappingEntryDTO

The list of products.

Name	Description
awaitingModerationMapping	Type: OfferMappingDTO Information about the product profile on the Market that is undergoing moderation for this product
mapping	Type: OfferMappingDTO Information about the product card on the Market. If the parameter is not specified, the Market staff will select or create a suitable product card themselves, or it will have the status `NEED_CONTENT` (you need to find the card or create it yourself) in the request output POST businesses/{businessId}/offer-mappings.
offer	Type: MappingsOfferDTO Product information from the catalog. Basic information about the products in the catalog.
rejectedMapping	Type: OfferMappingDTO Information about the last product card on the Market that was rejected during moderation for this product

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.

OfferMappingDTO

Information about the current product profile on the Market.

Name	Description
categoryId	Type: integer<int64> The category ID for the current product profile on the Market.
marketSku	Type: integer<int64> SKU on the Market is the identifier of the product card on the Market. At the first request, marketSku links the product to the Market card. In the future, you cannot change the SKU by sending a request. To do this, contact customer support. Min value: `1`
modelId	Type: integer<int64> The model ID for the current product profile on the Market. For example, two blades of different colors have different SKUs on the Market (parameter `marketSku`), but the same product model identifier.

MappingsOfferDTO

Information about the products in the catalog.

Name

Description

availability

Type: OfferAvailabilityStatusType

Delivery plans:

ACTIVE — there will be supplies.
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

barcodes

Type: string[]

Specify it as a sequence of numbers. Suitable codes are EAN-13, EAN-8, UPC-A, UPC-E or Code 128.

For books, specify the ISBN.

For products certain categories and brands The barcode must be a valid GTIN code. Please note: Internal barcodes starting with 2 or 02 and Code 128 format codes are not GTINs.

What is GTIN?

Example: 46012300000000

Min items: 1

boxCount

Type: integer<int32>

How many seats (if more than one) the product occupies.

The parameter is specified only if the product occupies more than one place (for example, the air conditioner occupies two places: an external and an internal unit in two boxes). If the product occupies one place, do not specify this parameter.

TimePeriodDTO

A time period with a comment. The requirements for the comment content depend on the context of the parameter usage and are specified in the description of the field that contains it.

Name	Description
timePeriod*	Type: integer Duration in the specified units.
timeUnit*	Type: TimeUnitType Unit of measurement. Enum: `HOUR`, `DAY`, `WEEK`, `MONTH`, `YEAR`
comment	Type: string Comment.

OfferProcessingStateDTO

Information about the publication status of the product on the Market.

Name

Description

notes

Type: OfferProcessingNoteDTO[]

The reasons why the product failed moderation.
The reasons why the product failed moderation.

Min items: 1

status

Type: OfferProcessingStatusType

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 a 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 has not passed 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 — the product profile could not be created.
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

DayOfWeekType

Day of the week:

MONDAY — Monday.
TUESDAY "Tuesday."
WEDNESDAY — Wednesday.
THURSDAY — Thursday.
FRIDAY — It's Friday.
SATURDAY "Saturday."
SUNDAY — Sunday.

Type	Description
DayOfWeekType	Enum: `MONDAY`, `TUESDAY`, `WEDNESDAY`, `THURSDAY`, `FRIDAY`, `SATURDAY`, `SUNDAY`

OfferWeightDimensionsDTO

The dimensions of the package and the weight of the product.

If the product takes up several boxes, fold them compactly before measuring the dimensions.

Multi-seat cargo measurement scheme

Name	Description
height*	Type: number Package height in cm. Example: `20`
length*	Type: number Package length in cm. Example: `65.55`
weight*	Type: number The weight of the product in kg, including packaging (gross). Example: `1.001`
width*	Type: number Package width in cm. Example: `50.7`

TimeUnitType

Time measurement unit:

HOUR "An hour."
DAY — a day.
WEEK — a week.
MONTH — a month.
YEAR — a year.

Type	Description
TimeUnitType	Enum: `HOUR`, `DAY`, `WEEK`, `MONTH`, `YEAR`

OfferProcessingNoteDTO

The reasons why the product failed moderation.

Name

Description

payload

Type: string

Additional information about the reason for the product rejection.

type

Type: OfferProcessingNoteType

The type of reason why the product failed moderation.

Enum: ASSORTMENT, CANCELLED, CONFLICTING_INFORMATION, OTHER, DEPARTMENT_FROZEN, INCORRECT_INFORMATION, LEGAL_CONFLICT, NEED_CLASSIFICATION_INFORMATION, NEED_INFORMATION, NEED_PICTURES, NEED_VENDOR, NO_CATEGORY, NO_KNOWLEDGE, NO_PARAMETERS_IN_SHOP_TITLE, NO_SIZE_MEASURE, SAMPLE_LINE

OfferProcessingNoteType

The type of reason why the product failed moderation:

ASSORTMENT — the product is produced in different versions. Each of them should be described as a separate product (parameter offerMappings in the request POST businesses/{businessId}/offer-mappings/update or a line in the catalog if you upload products through the seller's account on the Market).
CANCELLED — the product was withdrawn from moderation on your initiative.
CONFLICTING_INFORMATION (previously wrongly CONFLICTING) — you provided conflicting information about the product. The parameters that need to be fixed are specified in the parameter payload.
OTHER — the product did not pass moderation for another reason. Contact customer support or your manager.
DEPARTMENT_FROZEN — the rules for placing products in this category are being processed, so the product cannot pass moderation yet.
INCORRECT_INFORMATION — the product information you provided contradicts the description from the manufacturer. The parameters that need to be fixed are specified in the parameter payload.
LEGAL_CONFLICT — the product did not pass moderation for legal reasons. For example, it is not officially sold in Russia or you do not have a permit to sell it.
NEED_CLASSIFICATION_INFORMATION — the information about the product that you provided is not enough to classify it. Make sure that you have correctly specified the name, category, manufacturer, and country of manufacture of the product, as well as the URLs of images or description pages that can be used to identify the product.
NEED_INFORMATION — the product has not been sold in Russia before and is not yet available on the Market. You can create a card for it. For more information, see the section Working with the product card Yandex. Market help for sellers.
NEED_PICTURES — to identify a product, you need its images. Send the URL of the product images in the request POST businesses/{businessId}/offer-mappings/update or download the updated catalog through the seller's account on the Market.
NEED_VENDOR — the manufacturer of the product is incorrectly specified.
NO_CATEGORY, NO_KNOWLEDGE — products from the specified category are not yet placed on the Market. If the category appears, the product will be sent for moderation again.
NO_PARAMETERS_IN_SHOP_TITLE — the product is produced in different versions, and it is not clear from the name indicated which one it is about. The parameters to be added to the product name are specified in the parameter payload.
NO_SIZE_MEASURE — this product requires a size grid. Send it to the support service or your manager. The size grid requirements are specified in the parameter payload.
SAMPLE_LINE — the product did not pass moderation because of an extra line.

Type	Description
OfferProcessingNoteType	Enum: `ASSORTMENT`, `CANCELLED`, `CONFLICTING_INFORMATION`, `OTHER`, `DEPARTMENT_FROZEN`, `INCORRECT_INFORMATION`, `LEGAL_CONFLICT`, `NEED_CLASSIFICATION_INFORMATION`, `NEED_INFORMATION`, `NEED_PICTURES`, `NEED_VENDOR`, `NO_CATEGORY`, `NO_KNOWLEDGE`, `NO_PARAMETERS_IN_SHOP_TITLE`, `NO_SIZE_MEASURE`, `SAMPLE_LINE`

400 Bad Request

The request contains incorrect data.

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.

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.

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

404 Not Found

The requested resource was not found.

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.

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 server 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?

Adding and editing products

Recommended cards