Индекс качества магазинов

Метод доступен для всех моделей.

Если вы используете API-Key-токен, для вызова метода необходим один из доступов в списке

Возвращает значение индекса качества магазинов и его составляющие.

Подробнее об индексе качества читайте в Справке Маркета для продавцов.

⚙️ Лимит: 10 000 запросов в час

Request

POST

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

Path parameters

Name

Description

businessId

Type: integer

Идентификатор кабинета. Чтобы его узнать, воспользуйтесь запросом GET v2/campaigns.

ℹ️ Что такое кабинет и магазин на Маркете

Min value: 1

Body

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

Name

Description

campaignIds

Type: CampaignId[]

Список идентификаторов кампаний магазинов.

Min items: 1

Max items: 50

Unique items: true

Example
[
  1
]

dateFrom

Type: string<date>

Начало периода.

Формат даты: ГГГГ‑ММ‑ДД.

Не может быть раньше 30 дней от текущей даты.

Example: 2025-01-01

dateTo

Type: string<date>

Конец периода.

Формат даты: ГГГГ‑ММ‑ДД.

Не может быть позже текущей даты.

Example: 2025-01-01

CampaignId

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Type: integer

Min value: 1

Responses

200 OK

Значение индекса качества магазинов и его составляющие.

Body

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

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

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

    result

    Type: CampaignsQualityRatingDTO

    Информация об индексе качества магазинов.

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

ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Type: string

Enum: OK, ERROR

ApiResponse

Стандартная обертка для ответов сервера.

Name

Description

status

Type: ApiResponseStatusType

Тип ответа. Возможные значения:

  • OK — ошибок нет.
  • ERROR — при обработке запроса произошла ошибка.

Enum: OK, ERROR
Example
{
  "status": "OK"
}

QualityRatingComponentType

Составляющие индекса качества.

Для модели DBS:

  • DBS_CANCELLATION_RATE — доля отмененных товаров.
  • DBS_LATE_DELIVERY_RATE — доля заказов, доставленных после плановой даты.

Для моделей FBS и Экспресс:

  • FBS_CANCELLATION_RATE — доля отмененных товаров.
  • FBS_LATE_SHIP_RATE — доля не вовремя отгруженных заказов.

Для модели FBY:

  • FBY_LATE_DELIVERY_RATE — доля товаров, которые приехали на склад с опозданием.
  • FBY_CANCELLATION_RATE — доля отмененных или недоставленных товаров.
  • FBY_DELIVERY_DIFF_RATE — доля товаров, которые не прибыли вместе с поставкой или которые не приняли.
  • FBY_LATE_EDITING_RATE — доля товаров, которые поздно убрали из заявки.

Type: string

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

QualityRatingComponentDTO

Составляющая индекса качества.

Name

Description

componentType

Type: QualityRatingComponentType

Тип составляющей.

Составляющие индекса качества.

Для модели DBS:

  • DBS_CANCELLATION_RATE — доля отмененных товаров.
  • DBS_LATE_DELIVERY_RATE — доля заказов, доставленных после плановой даты.

Для моделей FBS и Экспресс:

  • 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"
}

QualityRatingDTO

Информация об индексе качества.

Name

Description

calculationDate

Type: string<date>

Дата вычисления.

Формат даты: ГГГГ‑ММ‑ДД.

Example: 2025-01-01

components

Type: QualityRatingComponentDTO[]

Составляющие индекса качества.

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"
    }
  ]
}

CampaignQualityRatingDTO

Информация об индексе качества магазина.

Name

Description

campaignId

Type: CampaignId

Идентификатор кампании (магазина) — технический идентификатор, который представляет ваш магазин в системе Яндекс Маркета при работе через API. Он однозначно связывается с вашим магазином, но предназначен только для автоматизированного взаимодействия.

Его можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете. Нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули:

  • блок Идентификатор кампании;
  • вкладка Лог запросов → выпадающий список в блоке Показывать логи.

⚠️ Не путайте его с:

  • идентификатором магазина, который отображается в личном кабинете продавца;
  • рекламными кампаниями.

Min value: 1

Example: 1

ratings

Type: QualityRatingDTO[]

Список значений индекса качества.

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": [
        {
          "value": 0,
          "componentType": "DBS_CANCELLATION_RATE"
        }
      ]
    }
  ]
}

CampaignsQualityRatingDTO

Информация об индексе качества магазинов.

Name

Description

campaignRatings

Type: CampaignQualityRatingDTO[]

Список магазинов c информацией об их индексе качества.

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

400 Bad Request

Запрос содержит неправильные данные. Подробнее об ошибке

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

ApiErrorDTO

Общий формат ошибки.

Name

Description

code

Type: string

Код ошибки.

Example: example

message

Type: string

Описание ошибки.

Example: example
Example
{
  "code": "example",
  "message": "example"
}

ApiErrorResponse

Стандартная обертка для ошибок сервера.

Type: object

All of 2 types

  • Type: ApiResponse

    Стандартная обертка для ответов сервера.

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

    errors

    Type: ApiErrorDTO[] | null

    Список ошибок.

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

    Стандартная обертка для ошибок сервера.

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

    Стандартная обертка для ошибок сервера.

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

    Стандартная обертка для ошибок сервера.

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

    Стандартная обертка для ошибок сервера.

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

500 Internal Server Error

Внутренняя ошибка Маркета. Подробнее об ошибке

Body

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

Type: object

All of 1 type

  • Type: ApiErrorResponse

    Стандартная обертка для ошибок сервера.

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

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

Предыдущая
Рекомендованные ставки
Следующая
Заказы, которые повлияли на индекс качества