Orders that affected the quality index

Info

Console

The method is available for models: 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

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 a list of orders that affected the store's quality index. To find out the value of the quality index, make a request POST v2/businesses/{businessId}/ratings/quality.

⚙️ Limit: 100,000 requests per hour

Request

POST

https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/ratings/quality/details

Path parameters

Name

Description

campaignId*

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

Responses

200 OK

Information about orders that affected the quality index.

Body

application/json

{
    "status": "OK",
    "result": {
        "affectedOrders": [
            {
                "orderId": 0,
                "description": "string",
                "componentType": "DBS_CANCELLATION_RATE"
            }
        ]
    }
}

Name

Description

status*

Type: ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

result

Type: QualityRatingDetailsDTO

Information about orders that affected the quality index.

ApiResponseStatusType

The type of response. Possible values:

OK — There are no errors.
ERROR — an error occurred while processing the request.

Type	Description
ApiResponseStatusType	Enum: `OK`, `ERROR`

QualityRatingDetailsDTO

Information about orders that affected the quality index.

Name

Description

affectedOrders*

Type: QualityRatingAffectedOrderDTO[]

A list of orders that affected the quality index.
Information about the order that affected the quality index.

QualityRatingAffectedOrderDTO

Information about the order that affected the quality index.

Name	Description
componentType*	Type: AffectedOrderQualityRatingComponentType Тип составляющей индекса качества. Enum: `DBS_CANCELLATION_RATE`, `DBS_LATE_DELIVERY_RATE`, `FBS_CANCELLATION_RATE`, `FBS_LATE_SHIP_RATE`
description*	Type: string Description of the problem.
orderId*	Type: integer<int64> The order ID. Min value: `0`

AffectedOrderQualityRatingComponentType

The components of the quality index.

For the model DBS:

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

For models FBS and Express:

FBS_CANCELLATION_RATE — the percentage of cancelled items.
FBS_LATE_SHIP_RATE — the percentage of orders shipped late.

Type	Description
AffectedOrderQualityRatingComponentType	Enum: `DBS_CANCELLATION_RATE`, `DBS_LATE_DELIVERY_RATE`, `FBS_CANCELLATION_RATE`, `FBS_LATE_SHIP_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 errors.
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 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: 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 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: 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 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: 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 errors.
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 errors.
ERROR — an error occurred while processing the request.

Enum: OK, ERROR

Was the article helpful?

Store Quality Index

Message history