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

Info

Console

Метод доступен для моделей: FBS, Экспресс и DBS.

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

inventory-and-order-processing — Обработка заказов и учёт товаров
inventory-and-order-processing:read-only — Просмотр информации о заказах
settings-management — Настройка магазинов
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Возвращает список заказов, которые повлияли на индекс качества магазина. Чтобы узнать значение индекса качества, выполните запрос 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

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

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

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

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

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

Min value: 1

Responses

200 OK

Информация о заказах, которые повлияли на индекс качества.

Body

application/json

{
  "status": "OK",
  "result": {
    "affectedOrders": [
      {
        "orderId": 0,
        "description": "example",
        "componentType": "DBS_CANCELLATION_RATE"
      }
    ]
  }
}

Type: object

All of 2 types

Type: ApiResponse

Стандартная обертка для ответов сервера.
Example
```
{
  "status": "OK"
}
```

Type: object

result

Type: QualityRatingDetailsDTO

Информация о заказах, которые повлияли на индекс качества.

Example

{
  "affectedOrders": [
    {
      "orderId": 0,
      "description": "example",
      "componentType": "DBS_CANCELLATION_RATE"
    }
  ]
}

Example

{
  "result": {
    "affectedOrders": [
      {
        "orderId": 0,
        "description": "example",
        "componentType": "DBS_CANCELLATION_RATE"
      }
    ]
  }
}

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

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

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

Example

{
  "status": "OK"
}

AffectedOrderQualityRatingComponentType

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

Для модели DBS:

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

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

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

Type: string

Enum: DBS_CANCELLATION_RATE, DBS_LATE_DELIVERY_RATE, FBS_CANCELLATION_RATE, FBS_LATE_SHIP_RATE

QualityRatingAffectedOrderDTO

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

Name	Description
componentType	Type: AffectedOrderQualityRatingComponentType Тип составляющей индекса качества. Составляющие индекса качества. Для модели DBS: `DBS_CANCELLATION_RATE` — доля отмененных товаров. `DBS_LATE_DELIVERY_RATE` — доля заказов, доставленных после плановой даты. Для моделей FBS и Экспресс: `FBS_CANCELLATION_RATE` — доля отмененных товаров. `FBS_LATE_SHIP_RATE` — доля не вовремя отгруженных заказов. Enum: `DBS_CANCELLATION_RATE`, `DBS_LATE_DELIVERY_RATE`, `FBS_CANCELLATION_RATE`, `FBS_LATE_SHIP_RATE`
description	Type: string Описание проблемы. Example: `example`
orderId	Type: integer Идентификатор заказа. Min value: `0`

Example

{
  "orderId": 0,
  "description": "example",
  "componentType": "DBS_CANCELLATION_RATE"
}

QualityRatingDetailsDTO

Информация о заказах, которые повлияли на индекс качества.

Name

Description

affectedOrders

Type: QualityRatingAffectedOrderDTO[]

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

Example

[
  {
    "orderId": 0,
    "description": "example",
    "componentType": "DBS_CANCELLATION_RATE"
  }
]

Example

{
  "affectedOrders": [
    {
      "orderId": 0,
      "description": "example",
      "componentType": "DBS_CANCELLATION_RATE"
    }
  ]
}

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

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

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

История сообщений