商店质量指数

方法适用于所有模式.

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

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

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

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

Request

POST

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

Path parameters

Name

Description

businessId

Type: integer

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

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

Min value: 1

Body

application/json
{
  "dateFrom": "2025-01-01",
  "dateTo": "2025-01-01",
  "campaignIds": [
    1
  ]
}

Name

Description

campaignIds

Type: integer[]

商店广告系列Id的列表。

Min items: 1

Max items: 50

Unique items: true

Example
[
  1
]

dateFrom

Type: string<date>

期的开始。

日期格式: YYYY-MM-DD.

它不能早于当前日期的30天。

Example: 2025-01-01

dateTo

Type: string<date>

期结束。

日期格式: YYYY-MM-DD.

它不能晚于当前日期。

Example: 2025-01-01

Responses

200 OK

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

Body

application/json
{
  "status": "OK",
  "result": {
    "campaignRatings": [
      {
        "campaignId": 1,
        "ratings": [
          null
        ]
      }
    ]
  }
}

Type: object

All of 2 types
  • Type: object

    status

    Type: string

    响应的类型。 可能的值:

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

    Enum: OK, ERROR

    服务器响应的标准包装器。

    Example
    {
      "status": "OK"
    }
    
  • Type: object

    result

    Type: object

    campaignRatings

    Type: object[]

    campaignId

    Type: integer

    广告系列(商店)的ID — 通过API工作时,代表您在Yandex市场系统中的商店的技术标识符。 它与您的商店唯一链接,但仅用于自动交互。

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

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

    ⚠️ 不要把它与:

    • 商店的标识符,显示在商家的个人帐户中。
    • 广告活动。

    Min value: 1

    ratings

    Type: object[]

    calculationDate

    Type: string<date>

    计算日期。

    日期格式: YYYY-MM-DD.

    Example: 2025-01-01

    components

    Type: object[]

    componentType

    Type: string

    质量指标的组成部分。

    对于模型 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 — 晚从应用程序中删除的产品的百分比。

    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

    成分的百分比的值。

    Min value: 0

    Max value: 100

    质量指标的组成部分。

    Example
    [
      {
        "value": 0,
        "componentType": "DBS_CANCELLATION_RATE"
      }
    ]
    

    rating

    Type: integer

    质量指标的值。

    Min value: 0

    Max value: 100

    质量指标值的列表。

    Example
    [
      {
        "rating": 0,
        "calculationDate": "2025-01-01",
        "components": [
          {
            "value": 0,
            "componentType": "DBS_CANCELLATION_RATE"
          }
        ]
      }
    ]
    

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

    Example
    [
      {
        "campaignId": 1,
        "ratings": [
          {
            "rating": 0,
            "calculationDate": "2025-01-01",
            "components": [
              {}
            ]
          }
        ]
      }
    ]
    

    店的质量指标的信息。

    Example
    {
      "campaignRatings": [
        {
          "campaignId": 1,
          "ratings": [
            {
              "rating": 0,
              "calculationDate": "2025-01-01",
              "components": [
                null
              ]
            }
          ]
        }
      ]
    }
    
    Example
    {
      "result": {
        "campaignRatings": [
          {
            "campaignId": 1,
            "ratings": [
              {}
            ]
          }
        ]
      }
    }
    

400 Bad Request

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

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

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

401 Unauthorized

请求中未指定授权数据。 有关错误的更多信息

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

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

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

403 Forbidden

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

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

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

404 Not Found

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

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

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

420 Method Failure

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

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

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

500 Internal Server Error

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

Body

application/json
{
  "status": "OK",
  "errors": [
    {
      "code": "example",
      "message": "example"
    }
  ]
}

Type: object

All of 1 type
  • Type: object

    All of 2 types
    • Type: object

      status

      Type: string

      响应的类型。 可能的值:

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

      Enum: OK, ERROR

      服务器响应的标准包装器。

      Example
      {
        "status": "OK"
      }
      
    • Type: object

      errors

      Type: object[]

      code

      Type: string

      的错误代码。

      Example: example

      message

      Type: string

      错误的描述。

      Example: example

      错误列表。

      Min items: 1

      Example
      [
        {
          "code": "example",
          "message": "example"
        }
      ]
      
      Example
      {
        "errors": [
          {
            "code": "example",
            "message": "example"
          }
        ]
      }
      

    服务器错误的标准包装器。

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

No longer supported, please use an alternative and newer version.