商店质量指数

Info

Console

方法适用于所有模式.

如果您使用API-Key令牌，调用该方法时需要具备列表中可用权限之一

inventory-and-order-processing — 订单处理和商品核算
inventory-and-order-processing:read-only — 查看订单信息
settings-management — 店铺设置
all-methods — 全面管理账户
all-methods:read-only — 查看所有数据

返回存储质量索引及其组件的值。

阅读更多关于质量指数的信息。在市场对卖家的帮助.

⚙️ 限制: 每小时10,000次请求

Request

POST

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

Path parameters

Name

Description

businessId*

Type: integer<int64>

内阁ID。要找到答案，请使用请求 GET v2/campaigns.

ℹ️ 什么是市场上的橱柜和商店？

Min value: 1

Body

application/json

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

Name	Description
campaignIds*	Type: integer<int64>[] 广告系列Id列表。您可以使用查询找到它们。 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置在左边的菜单中，选择 Api和模块: 座运动ID; 标签查询日志 →块中的下拉列表显示日志. ⚠️ 请勿使用商店Id，这些Id列在商店名称旁边的市场上的卖家帐户和某些报告中。您需要获取信息的商店的广告系列列表。 Min items: `1` Max items: `50` Unique items
dateFrom	Type: string<date> 期的开始。日期格式: `YYYY-MM-DD`. 它不能早于当前日期的30天。
dateTo	Type: string<date> 期结束。日期格式: `YYYY-MM-DD`. 它不能晚于当前日期。

Responses

200 OK

店质量指数及其分量的值。

Body

application/json

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

Name

Description

status*

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

result

Type: CampaignsQualityRatingDTO

店的质量指标的信息。

ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

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

CampaignsQualityRatingDTO

店的质量指标的信息。

Name

Description

campaignRatings*

Type: CampaignQualityRatingDTO[]

有关其质量指数信息的商店列表。
店的质量指数的信息。

CampaignQualityRatingDTO

店的质量指数的信息。

Name

Description

campaignId*

Type: integer<int64>

活动ID。

您可以使用查询找到它 GET v2/campaigns 或者在市场上的卖家办公室找到 — 点击您的帐户图标→ 设置在左边的菜单中，选择 Api和模块:

座 运动ID;
标签 查询日志 →块中的下拉列表 显示日志.

⚠️ 不要发送商店ID，这是在市场上的卖家帐户旁边的商店名称和一些报告。

ratings*

Type: QualityRatingDTO[]

质量指标值的列表。
质量指标的信息。

QualityRatingDTO

质量指标的信息。

Name	Description
calculationDate*	Type: string<date> 计算日期。日期格式: `YYYY-MM-DD`.
components*	Type: QualityRatingComponentDTO[] 质量指标的组成部分。质量指标的一个组成部分。
rating*	Type: integer<int64> 质量指标的值。 Min value: `0` Max value: `100`

QualityRatingComponentDTO

质量指标的一个组成部分。

Name

Description

componentType*

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

value*

Type: number<double>

成分的百分比的值。

Min value: 0

Max value: 100

QualityRatingComponentType

质量指标的组成部分。

对于模型 DBS:

DBS_CANCELLATION_RATE — 取消项目的百分比。
DBS_LATE_DELIVERY_RATE — 在预定日期之后交付的订单的百分比。

模型 FBS 和 Express:

FBS_CANCELLATION_RATE — 取消项目的百分比。
FBS_LATE_SHIP_RATE — 延迟发货的订单的百分比。

对于模型 FBY:

FBY_LATE_DELIVERY_RATE — 迟到达仓库的货物的百分比。
FBY_CANCELLATION_RATE — 已取消或未交付项目的百分比。
FBY_DELIVERY_DIFF_RATE — 未随交货到达或未被接受的货物的比例。
FBY_LATE_EDITING_RATE — 晚从应用程序中删除的产品的百分比。

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

请求包含不正确的数据。有关错误的更多信息

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

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

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

403 Forbidden

授权数据不正确或禁止访问资源。有关错误的更多信息

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

404 Not Found

找不到请求的资源。有关错误的更多信息

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

420 Method Failure

已超出资源访问限制。有关错误的更多信息

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

500 Internal Server Error

市场的内部错误。有关错误的更多信息

Body

application/json

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

Name

Description

errors

Type: ApiErrorDTO[]

错误列表。
一般错误格式。

Min items: 1

status

Type: ApiResponseStatusType

响应的类型。可能的值:

OK — 没有错误。
ERROR — 处理请求时出错。

Enum: OK, ERROR

这篇文章是否有用？

建议收费

影响质量指数的订单