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

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>

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

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

Min value: 1

Body

application/json

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

Name	Description
campaignIds*	Type: integer<int64>[] Список идентификаторов кампании. Их можно узнать с помощью запроса GET v2/campaigns или найти в кабинете продавца на Маркете — нажмите на иконку вашего аккаунта → Настройки и в меню слева выберите API и модули: блок Идентификатор кампании; вкладка Лог запросов → выпадающий список в блоке Показывать логи. ⚠️ Не используйте вместо них идентификаторы магазинов, которые указаны в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах. Список кампании тех магазинов, для которых необходимо получить информацию. Min items: `1` Max items: `50` Unique items
dateFrom	Type: string<date> Начало периода. Формат даты: `ГГГГ‑ММ‑ДД`. Не может быть раньше 30 дней от текущей даты.
dateTo	Type: string<date> Конец периода. Формат даты: `ГГГГ‑ММ‑ДД`. Не может быть позже текущей даты.

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[]

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

CampaignQualityRatingDTO

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

Name

Description

campaignId*

Type: integer<int64>

Идентификатор кампании.

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

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

⚠️ Не передавайте вместо него идентификатор магазина, который указан в кабинете продавца на Маркете рядом с названием магазина и в некоторых отчетах.

ratings*

Type: QualityRatingDTO[]

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

QualityRatingDTO

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

Name	Description
calculationDate*	Type: string<date> Дата вычисления. Формат даты: `ГГГГ‑ММ‑ДД`.
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 и Экспресс:

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

Была ли статья полезна?

Рекомендованные ставки

Заказы, которые повлияли на индекс качества