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

Which method should I use instead of the outdated one?

POST v2/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 that is 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: 10,000 items per minute

Request

GET

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

Path parameters

Name

Description

campaignId

Type: integer

The ID of the campaign (store) — The technical identifier that represents your store in the Yandex Market system when working through the API. It is uniquely linked to your store, but it is intended only for automated interaction.

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 confuse it with:

the store's identifier, which is displayed in the merchant's personal account.
advertising campaigns.

Min value: 1

Query parameters

Name	Description
availability	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. Unique items: `true` Example: ``
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 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. Unique items: `true` Example: ``
limit	Type: integer The number of values per page. Min value: `1`
mapping_kind	Type: string The type of mapping. Type of mapping: `ALL` — all products. `ACTIVE` — ready-to-sell products. Enum: `ACTIVE`, `ALL`
offer_id	Type: string[] Product IDs in the catalog. Unique items: `true` Example: ``
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==`
shop_sku	Type: string[] Product IDs in the catalog. Use the parameter `offer_id` instead of this parameter. Unique items: `true` Example: ``
status	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. Unique items: `true` Example: ``
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 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. Unique items: `true` Example: ``

Responses

200 OK

Information about the products in the catalog.

Body

application/json

{
  "status": "OK",
  "result": {
    "paging": {
      "nextPageToken": "example",
      "prevPageToken": "example"
    },
    "offerMappingEntries": [
      {}
    ]
  }
}

Type: object

All of 2 types

Type: object
status

Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: object

offerMappingEntries

Type: object[]

Information about the products in the catalog.

Example

[
  {
    "offer": {
      "name": "Ударная дрель Makita HP1630, 710 Вт",
      "shopSku": "example",
      "category": "example",
      "vendor": "LEVENHUK",
      "vendorCode": "VNDR-0005A",
      "description": "example",
      "id": "example",
      "feedId": 0,
      "barcodes": [
        null
      ],
      "urls": [
        null
      ],
      "pictures": [
        null
      ],
      "manufacturer": "example",
      "manufacturerCountries": [
        null
      ],
      "minShipment": 0,
      "transportUnitSize": 0,
      "quantumOfSupply": 0,
      "deliveryDurationDays": 0,
      "boxCount": 0,
      "customsCommodityCodes": [
        null
      ],
      "weightDimensions": {},
      "supplyScheduleDays": [
        null
      ],
      "shelfLifeDays": 0,
      "lifeTimeDays": 0,
      "guaranteePeriodDays": 0,
      "processingState": {},
      "availability": "ACTIVE",
      "shelfLife": {},
      "lifeTime": {},
      "guaranteePeriod": {},
      "certificate": "example",
      "price": 0.5
    },
    "mapping": {
      "marketSku": 1,
      "categoryId": 0
    },
    "awaitingModerationMapping": {
      "marketSku": 1,
      "categoryId": 0
    },
    "rejectedMapping": {
      "marketSku": 1,
      "categoryId": 0
    }
  }
]

paging

Type: object

All of 2 types

Type: object

nextPageToken

Type: string

ID of the next results page.

Example: example

The ID of the next page.
Example
```
{
  "nextPageToken": "example"
}
```
Type: object

prevPageToken

Type: string

ID of the previous results page.

Example: example
Example
```
{
  "prevPageToken": "example"
}
```

Information about the result pages.

Example

{
  "nextPageToken": "example",
  "prevPageToken": "example"
}

Information about the products in the catalog.

Example

{
  "paging": {
    "nextPageToken": "example",
    "prevPageToken": "example"
  },
  "offerMappingEntries": [
    {
      "offer": {},
      "mapping": {
        "marketSku": 1,
        "categoryId": 0
      },
      "awaitingModerationMapping": {
        "marketSku": 1,
        "categoryId": 0
      },
      "rejectedMapping": {
        "marketSku": 1,
        "categoryId": 0
      }
    }
  ]
}

Example

{
  "result": {
    "paging": {
      "nextPageToken": "example",
      "prevPageToken": "example"
    },
    "offerMappingEntries": [
      {
        "offer": {},
        "mapping": {},
        "awaitingModerationMapping": {},
        "rejectedMapping": {}
      }
    ]
  }
}

400 Bad Request

The request contains incorrect data. More information about the error

Body

application/json

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

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

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

401 Unauthorized

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

Body

application/json

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

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

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

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": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

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

404 Not Found

The requested resource was not found. More information about the error

Body

application/json

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

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

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

420 Method Failure

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

Body

application/json

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

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

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

500 Internal Server Error

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

Body

application/json

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

Type: object

All of 1 type

Type: object

All of 2 types

Type: object
status
Type: string

The type of response. Possible values:

OK — There are no errors.

ERROR — an error occurred while processing the request.

Enum: OK, ERROR
The standard wrapper for server responses.
Example
```
{
  "status": "OK"
}
```

Type: object

errors

Type: object[]

code

Type: string

The error code.

Example: example

message

Type: string

Description of the error.

Example: example

A list of errors.

Min items: 1

Example

[
  {
    "code": "example",
    "message": "example"
  }
]

Example

{
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

A standard wrapper for server errors.

Example

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

Was the article helpful?

Adding and editing products

The limit on setting the quantum and minimum quantity of goods