Перейти к содержимому
Omninet

Получение обновлений статусов заказов

POST /v1/order/dbs/status/list

Тело запроса

Заголовок раздела «Тело запроса»
cursor string
Курсор пагинации.
filter object
Фильтры по заказам и дате обновления.
Показать Скрыть
merchant_order_id array
Идентификаторы заказов продавца (опционально).
updated_at string
Фильтр по дате обновления. Формат: date-time (RFC3339, опционально).
status array
Фильтр по статусам заказа (опционально).
Статусы доставки заказа.

- NEW: Новый.
- CONFIRMED: Подтверждён.
- PACKED: Упакован.
- DELIVERING: Доставляется.
- READY_FOR_PICKUP: Готов к выдаче на ПВЗ.
- DELIVERED: Доставлен.
- CANCELLED: Отменён.

Успешный ответ

200 A successful response.
application/json
object
order_updates array
Список обновлений заказов.
Элемент ответа: идентификатор заказа и его статус.
Показать Скрыть
merchant_order_id string
Идентификатор заказа продавца.
client_order_id string
Идентификатор заказа клиента.
status string
Статус заказа (доставки).
values
NEWCONFIRMEDPACKEDDELIVERINGREADY_FOR_PICKUPDELIVEREDCANCELLED
actions array
Разрешённые действия по заказу для установленного статуса.
Разрешённое действие по заказу для установленного статуса.
Показать Скрыть
type string required
Тип действия.
values
cancel
enabled boolean required
Доступность действия.
next_cursor string
Курсор для следующей страницы.
total integer
Общее количество записей.

Ошибки

400 Некорректный запрос
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
401 Ошибка авторизации
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
429 Превышен лимит запросов
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
500 Внутренняя ошибка сервера
application/json
object
error_type string
ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
values
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code string
код ошибки
message string
сообщение
details object
Показать Скрыть
No properties defined
POST /v1/order/dbs/status/list 

              1
              curl https://api.omninet.ru/v1/order/dbs/status/list \
            
              2
                --request POST \
            
              3
                --header 'Content-Type: application/json' \
            
              4
                --data '{
            
              5
                "cursor": "string",
            
              6
                "filter": {
            
              7
                  "merchant_order_id": [
            
              8
                    "string"
            
              9
                  ],
            
              10
                  "updated_at": "string",
            
              11
                  "status": [
            
              12
                    "NEW"
            
              13
                  ]
            
              14
                }
            
              15
              }'
            
{
  "order_updates": [
    {
      "merchant_order_id": "string",
      "client_order_id": "string",
      "status": "NEW",
      "actions": [
        {
          "type": "cancel",
          "enabled": true
        }
      ]
    }
  ],
  "next_cursor": "string",
  "total": 0
}

A successful response.

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Некорректный запрос

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Ошибка авторизации

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Превышен лимит запросов

{
  "error_type": "string",
  "code": "string",
  "message": "string",
  "details": {}
}

Внутренняя ошибка сервера