Store Quality Index

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

inventory-and-order-processing — Order processing and inventory
inventory-and-order-processing:read-only — View order information
settings-management — Store settings
all-methods — Full account management
all-methods:read-only — View all data

Returns the value of the store quality index and its components.

Read more about the quality index. in the Help of the Market for sellers.

, Limit: 10,000 requests per hour

Request

POST

https://api.partner.market.yandex.ru/businesses/{businessId}/ratings/quality

Path parameters

Name

Description

businessId*

Type: integer<int64>

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

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

Min value: 1

Body

application/json

{
    "dateFrom": "string",
    "dateTo": "string",
    "campaignIds": [
        0
    ]
}

Name	Description
campaignIds*	Type: integer<int64>[] A list of campaign IDs. You can find them 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 use store IDs instead, which are listed in the seller's account on the Market next to the store name and in some reports. The campaign list of those stores for which you need to get information. Min items: `1` Max items: `50` Unique items
dateFrom	Type: string<date> The beginning of the period. Date format: `YYYY‑MM‑DD`. It cannot be earlier than 30 days from the current date.
dateTo	Type: string<date> End of the period. Date format: `YYYY‑MM‑DD`. It cannot be later than the current date.

Responses

200 OK

The value of the store quality index and its components.

Body

application/json

{
    "status": "OK",
    "result": {
        "campaignRatings": [
            {
                "campaignId": 0,
                "ratings": [
                    {
                        "rating": 0,
                        "calculationDate": "string",
                        "components": [
                            {
                                "value": 0,
                                "componentType": "DBS_CANCELLATION_RATE"
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

Name

Description

result

Type: CampaignsQualityRatingDTO

Information about the quality index of stores.

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

CampaignsQualityRatingDTO

Information about the quality index of stores.

Name

Description

campaignRatings*

Type: CampaignQualityRatingDTO[]

A list of stores with information about their quality index.
Information about the store's quality index.

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`

CampaignQualityRatingDTO

Information about the store's quality index.

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 ID instead, which is indicated in the seller's account on the Market next to the store name and in some reports.

ratings*

Type: QualityRatingDTO[]

A list of quality index values.
Information about the quality index.

QualityRatingDTO

Information about the quality index.

Name	Description
calculationDate*	Type: string<date> Date of calculation. Date format: `YYYY‑MM‑DD`.
components*	Type: QualityRatingComponentDTO[] The components of the quality index. A component of the quality index.
rating*	Type: integer<int64> The value of the quality index. Min value: `0` Max value: `100`

QualityRatingComponentDTO

A component of the quality index.

Name

Description

componentType*

Type: QualityRatingComponentType

The type of component.

Enum: DBS_CANCELLATION_RATE, DBS_LATE_DELIVERY_RATE, FBS_CANCELLATION_RATE, FBS_LATE_SHIP_RATE, FBY_LATE_DELIVERY_RATE, FBY_CANCELLATION_RATE, FBY_DELIVERY_DIFF_RATE, FBY_LATE_EDITING_RATE

value*

Type: number<double>

The value of the component as a percentage.

Min value: 0

Max value: 100

QualityRatingComponentType

The components of the quality index.

For the DBS model:

DBS_CANCELLATION_RATE — the proportion of cancelled items.
DBS_LATE_DELIVERY_RATE — the percentage of orders delivered after the scheduled date.

For the FBS and Express models:

FBS_CANCELLATION_RATE — the proportion of cancelled items.
FBS_LATE_SHIP_RATE — the proportion of orders shipped on time.

For the FBY model:

FBY_LATE_DELIVERY_RATE — the percentage of goods that arrived at the warehouse late.
FBY_CANCELLATION_RATE — the percentage of cancelled or undelivered items.
FBY_DELIVERY_DIFF_RATE — the proportion of goods that did not arrive with the delivery or that were not accepted.
FBY_LATE_EDITING_RATE — the percentage of products that were removed from the application late.

Type	Description
QualityRatingComponentType	Enum: `DBS_CANCELLATION_RATE`, `DBS_LATE_DELIVERY_RATE`, `FBS_CANCELLATION_RATE`, `FBS_LATE_SHIP_RATE`, `FBY_LATE_DELIVERY_RATE`, `FBY_CANCELLATION_RATE`, `FBY_DELIVERY_DIFF_RATE`, `FBY_LATE_EDITING_RATE`

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

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

Recommended rates

Orders that affected the quality index