影响质量指数的订单
如果您使用API-Key令牌,调用该方法时需要具备列表中可用权限之一
返回影响商店质量指数的订单列表。 要找出质量指标的值,请提出请求 POST v2/businesses/{businessId}/ratings/quality.
| ⚙️ 限制: 每小时100,000次请求 |
|---|
Request
POST
https://api.partner.market.yandex.ru/v2/campaigns/{campaignId}/ratings/quality/details
Path parameters
|
Name |
Description |
|
campaignId* |
Type: integer<int64> 活动ID。 您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置 在左边的菜单中,选择 Api和模块:
⚠️ 不要发送商店ID,这是在市场上的卖家帐户旁边的商店名称和一些报告。
Min value: |
Responses
200 OK
有关影响质量指数的订单的信息。
Body
application/json
{
"status": "OK",
"result": {
"affectedOrders": [
{
"orderId": 0,
"description": "string",
"componentType": "DBS_CANCELLATION_RATE"
}
]
}
}
|
Name |
Description |
|
status* |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
|
result |
Type: QualityRatingDetailsDTO 有关影响质量指数的订单的信息。 |
ApiResponseStatusType
响应的类型。 可能的值:
OK— 没有错误。ERROR— 处理请求时出错。
|
Type |
Description |
|
Enum: |
QualityRatingDetailsDTO
有关影响质量指数的订单的信息。
|
Name |
Description |
|
affectedOrders* |
Type: QualityRatingAffectedOrderDTO[] 影响质量指数的订单列表。 |
QualityRatingAffectedOrderDTO
影响质量指标的订单的信息。
|
Name |
Description |
|
componentType* |
Type: AffectedOrderQualityRatingComponentType Тип составляющей индекса качества. Enum: |
|
description* |
Type: string 问题的描述。 |
|
orderId* |
Type: integer<int64> 的订单ID。 Min value: |
AffectedOrderQualityRatingComponentType
质量指标的组成部分。
对于模型 DBS:
DBS_CANCELLATION_RATE— 取消项目的百分比。DBS_LATE_DELIVERY_RATE— 在预定日期之后交付的订单的百分比。
模型 FBS 和 Express:
FBS_CANCELLATION_RATE— 取消项目的百分比。FBS_LATE_SHIP_RATE— 延迟发货的订单的百分比。
|
Type |
Description |
|
Enum: |
400 Bad Request
请求包含不正确的数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
ApiErrorDTO
一般错误格式。
|
Name |
Description |
|
code* |
Type: string 的错误代码。 |
|
message |
Type: string 错误的描述。 |
401 Unauthorized
请求中未指定授权数据。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
403 Forbidden
授权数据不正确或禁止访问资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
404 Not Found
找不到请求的资源。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
420 Method Failure
已超出资源访问限制。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
500 Internal Server Error
市场的内部错误。 有关错误的更多信息
Body
application/json
{
"status": "OK",
"errors": [
{
"code": "string",
"message": "string"
}
]
}
|
Name |
Description |
|
errors |
Type: ApiErrorDTO[] 错误列表。 Min items: |
|
status |
Type: ApiResponseStatusType 响应的类型。 可能的值:
Enum: |
No longer supported, please use an alternative and newer version.