Getting information about the fullness of store cards

Info

Console

The method is available for models: FBY, FBS, Express and DBS.

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

Returns information about the content status for the specified products:

whether a product card has been created and what is its status.
card rating — how many percent is it filled;
transmitted product characteristics;
are there any errors or warnings related to the content;
recommendations for filling out the card.

⚙️ Limit: 600 requests per minute

Request

POST

https://api.partner.market.yandex.ru/v2/businesses/{businessId}/offer-cards

Path parameters

Name

Description

businessId*

Type: integer<int64>

Cabinet ID. To find out, use the request GET v2/campaigns.

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

Min value: 1

Query parameters

Name

Description

limit

Type: integer<int32>

The number of values per page.

Min value: 1
Example: 20

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

Body

application/json

{
    "offerIds": [
        "string"
    ],
    "cardStatuses": [
        "HAS_CARD_CAN_NOT_UPDATE"
    ],
    "categoryIds": [
        0
    ],
    "withRecommendations": false
}

Name	Description
cardStatuses	Type: string[] Filter by card status. What is a product card? Product card status: `HAS_CARD_CAN_NOT_UPDATE` — The Market card. `HAS_CARD_CAN_UPDATE` — You can add it. `HAS_CARD_CAN_UPDATE_ERRORS` — The changes have not been accepted. `HAS_CARD_CAN_UPDATE_PROCESSING` — Changes are under review. `NO_CARD_NEED_CONTENT` — Create a card. `NO_CARD_MARKET_WILL_CREATE` — Creates a Marketplace. `NO_CARD_ERRORS` — It was not created due to an error. `NO_CARD_PROCESSING` — We check the data. `NO_CARD_ADD_TO_CAMPAIGN` — Place the product in the store. Enum: `HAS_CARD_CAN_NOT_UPDATE`, `HAS_CARD_CAN_UPDATE`, `HAS_CARD_CAN_UPDATE_ERRORS`, `HAS_CARD_CAN_UPDATE_PROCESSING`, `NO_CARD_NEED_CONTENT`, `NO_CARD_MARKET_WILL_CREATE`, `NO_CARD_ERRORS`, `NO_CARD_PROCESSING`, `NO_CARD_ADD_TO_CAMPAIGN` Min items: `1` Unique items
categoryIds	Type: integer[] Filter by category on the Market. The ID of the category on the Market. When changing the category, make sure that the product characteristics and their values in the parameter `parameterValues` you are submitting for a new category. You can get a list of Market categories using a request. POST v2/categories/tree. Min value (exclusive): `0` Min items: `1` Max items: `200` Unique items
offerIds	Type: string[] The IDs of the products that information is needed about. ⚠️ Do not use this field at the same time as filters based on card statuses, categories, brands, or tags. If you want to use filters, leave the field empty. 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. Warning Spaces at the beginning and end of the value are automatically deleted. For example, `" SKU123 "` and `"SKU123"` they will be treated as identical values. What is SKU and how to assign it Min length: `1` Max length: `255` Pattern: `^(?=.\S.)[^\x00-\x08\x0A-\x1f\x7f]{1,255}$` Min items: `1` Max items: `200` Unique items
withRecommendations	Type: boolean Should I return the list of recommendations for filling out the card and the average rating of the card for products of the category indicated in `marketCategoryId`. Default value: `false`. If the information is needed, pass the value `true`. Default: `false`

Responses

200 OK

Information about the cards of the specified products.

Body

application/json

{
    "status": "OK",
    "result": {
        "offerCards": [
            {
                "offerId": "string",
                "mapping": {
                    "marketSku": 0,
                    "marketSkuName": "string",
                    "marketModelId": 0,
                    "marketModelName": "string",
                    "marketCategoryId": 0,
                    "marketCategoryName": "string"
                },
                "parameterValues": [
                    {
                        "parameterId": 0,
                        "unitId": 0,
                        "valueId": 0,
                        "value": "string"
                    }
                ],
                "cardStatus": "HAS_CARD_CAN_NOT_UPDATE",
                "contentRating": 0,
                "averageContentRating": 0,
                "contentRatingStatus": "UPDATING",
                "recommendations": [
                    {
                        "type": "HAS_VIDEO",
                        "percent": 0,
                        "remainingRatingPoints": 0
                    }
                ],
                "groupId": "string",
                "errors": [
                    {
                        "message": "string",
                        "comment": "string"
                    }
                ],
                "warnings": [
                    {
                        "message": "string",
                        "comment": "string"
                    }
                ]
            }
        ],
        "paging": {
            "nextPageToken": "string"
        }
    }
}

Name

Description

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

result

Type: object

offerCards*

Type: object[]

The product list page with information about the status of the cards.
Information about the status of the product card.

If the field mapping missing in the response, the Market has not yet managed to process the product information. To determine the category of such an item, repeat the request in a few minutes.

paging

Type: object

nextPageToken

Type: string

ID of the next results page.

The ID of the next page.

A list of products with information about the status of the cards.

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: object[]

A list of errors.
The general error format.

Min items: 1

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

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: object[]

A list of errors.
The general error format.

Min items: 1

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

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: object[]

A list of errors.
The general error format.

Min items: 1

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

404 Not Found

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

Body

application/json

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

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

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: object[]

A list of errors.
The general error format.

Min items: 1

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

500 Internal Server Error

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

Body

application/json

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

Name

Description

errors

Type: object[]

A list of errors.
The general error format.

Min items: 1

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

Was the article helpful?

Getting a barcode file (FBY)

Editing product category characteristics