Orders that affected the quality index
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 businesses/{businessId}/ratings/quality.
, Limit: 100,000 requests per hour |
---|
Request
POST
https://api.partner.market.yandex.ru/campaigns/{campaignId}/ratings/quality/details
Path parameters
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:
, Do not send the store's ID instead, which is indicated in the seller's account on the Market next to the store's name and in some reports.
Min value: |
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 |
result |
Type: QualityRatingDetailsDTO Information about orders that affected the quality index. |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
QualityRatingDetailsDTO
Information about orders that affected the quality index.
Name |
Description |
affectedOrders* |
Type: QualityRatingAffectedOrderDTO[] A list of orders that affected the quality index. |
ApiResponseStatusType
The type of response. Possible values:
OK
— there are no mistakes.ERROR
— an error occurred while processing the request.
Type |
Description |
Enum: |
QualityRatingAffectedOrderDTO
Information about the order that affected the quality index.
Name |
Description |
componentType* |
Type: AffectedOrderQualityRatingComponentType The type of component of the quality index. Enum: |
description* |
Type: string Description of the problem. |
orderId* |
Type: integer<int64> The order ID. Min value: |
AffectedOrderQualityRatingComponentType
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.
Type |
Description |
Enum: |
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. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
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: ApiErrorDTO[] A list of errors. Min items: |
status |
Type: ApiResponseStatusType The type of response. Possible values:
Enum: |
No longer supported, please use an alternative and newer version.