Получение статусов операций

Info

Console

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

Пока недоступен для продавцов Market Yandex Go.

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

inventory-and-order-processing — Обработка заказов и учёт товаров
inventory-and-order-processing:read-only — Просмотр информации о заказах
pricing — Управление ценами
pricing:read-only — Просмотр цен
offers-and-cards-management — Управление товарами и карточками
offers-and-cards-management:read-only — Просмотр товаров и карточек
promotion — Продвижение товаров
promotion:read-only — Просмотр информации о продвижении товаров
finance-and-accounting — Просмотр финансовой информации и отчётности
communication — Общение с покупателями
settings-management — Настройка магазинов
supplies-management:read-only — Получение информации по FBY-заявкам
all-methods — Полное управление кабинетом
all-methods:read-only — Просмотр всех данных

Возвращает статусы запущенных операций по их идентификаторам.

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

Request

POST

https://api.partner.market.yandex.ru/v1/businesses/{businessId}/operations

Path parameters

Name

Description

businessId

Type: integer

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

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

Min value: 1

Body

application/json

{
  "operationType": "ORDER_RECIPIENT_UPDATE",
  "operationIds": [
    "example"
  ]
}

Name

Description

operationIds

Type: OperationId[]

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

Min items: 1

Max items: 100

Unique items: true

Example

[
  "example"
]

operationType

Type: OperationType

Тип операции:

ORDER_RECIPIENT_UPDATE — изменение данных получателя.
ORDER_DELIVERY_INTERVAL_UPDATE — изменение интервала дат доставки.
ORDER_STATUS_UPDATE — обновление статуса заказа для его отмены.
RETURN_CANCELLATION — отмена возврата.

Enum: ORDER_RECIPIENT_UPDATE, ORDER_DELIVERY_INTERVAL_UPDATE, ORDER_STATUS_UPDATE, RETURN_CANCELLATION

OperationType

Тип операции:

ORDER_RECIPIENT_UPDATE — изменение данных получателя.
ORDER_DELIVERY_INTERVAL_UPDATE — изменение интервала дат доставки.
ORDER_STATUS_UPDATE — обновление статуса заказа для его отмены.
RETURN_CANCELLATION — отмена возврата.

Type: string

Enum: ORDER_RECIPIENT_UPDATE, ORDER_DELIVERY_INTERVAL_UPDATE, ORDER_STATUS_UPDATE, RETURN_CANCELLATION

OperationId

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

Type: string

Min length: 1

Max length: 1000

Example: example

Responses

200 OK

Информация об операциях.

Body

application/json

{
  "status": "OK",
  "result": {
    "operations": [
      {
        "id": "example",
        "type": "ORDER_RECIPIENT_UPDATE",
        "status": "IN_PROGRESS"
      }
    ]
  }
}

Type: object

All of 2 types

Type: ApiResponse

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

Type: object

result

Type: GetOperationsResultDTO

Информация об операциях.

Example

{
  "operations": [
    {
      "id": "example",
      "type": "ORDER_RECIPIENT_UPDATE",
      "status": "IN_PROGRESS"
    }
  ]
}

Example

{
  "result": {
    "operations": [
      {
        "id": "example",
        "type": "ORDER_RECIPIENT_UPDATE",
        "status": "IN_PROGRESS"
      }
    ]
  }
}

ApiResponseStatusType

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

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

Type: string

Enum: OK, ERROR

ApiResponse

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

Name

Description

status

Type: ApiResponseStatusType

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

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

Enum: OK, ERROR

Example

{
  "status": "OK"
}

OperationStatusType

Статус выполнения операции:

IN_PROGRESS — выполняется.
DONE — успешно завершена.
FAILED — завершена с ошибкой.

Type: string

Enum: IN_PROGRESS, DONE, FAILED

OperationResultDTO

Результат выполнения.

Name	Description
id	Type: OperationId Идентификатор операции. Min length: `1` Max length: `1000` Example: `example`
status	Type: OperationStatusType Статус выполнения операции: `IN_PROGRESS` — выполняется. `DONE` — успешно завершена. `FAILED` — завершена с ошибкой. Enum: `IN_PROGRESS`, `DONE`, `FAILED`
type	Type: OperationType Тип операции: `ORDER_RECIPIENT_UPDATE` — изменение данных получателя. `ORDER_DELIVERY_INTERVAL_UPDATE` — изменение интервала дат доставки. `ORDER_STATUS_UPDATE` — обновление статуса заказа для его отмены. `RETURN_CANCELLATION` — отмена возврата. Enum: `ORDER_RECIPIENT_UPDATE`, `ORDER_DELIVERY_INTERVAL_UPDATE`, `ORDER_STATUS_UPDATE`, `RETURN_CANCELLATION`

Example

{
  "id": "example",
  "type": "ORDER_RECIPIENT_UPDATE",
  "status": "IN_PROGRESS"
}

GetOperationsResultDTO

Информация об операциях.

Name

Description

operations

Type: OperationResultDTO[]

Список операций.

Example

[
  {
    "id": "example",
    "type": "ORDER_RECIPIENT_UPDATE",
    "status": "IN_PROGRESS"
  }
]

Example

{
  "operations": [
    {
      "id": "example",
      "type": "ORDER_RECIPIENT_UPDATE",
      "status": "IN_PROGRESS"
    }
  ]
}

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

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

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

Получение временных интервалов для изменения заказа

Информация об одной отгрузке