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

Список заявок на отмену заказа

POST /v1/cancellation/list

Тело запроса

Заголовок раздела «Тело запроса»
filter object
Фильтр.
Показать Скрыть
cancellation_id array
Фильтр по идентификаторам заявок на отмену (опционально).
status array
Фильтр по статусам (опционально).
Статус заявки на отмену.

- NEW: Ожидает обновления со стороны продавца.
- APPROVED_CANCEL: Одобрено.
- DECLINED: Отклонено.
cursor string
Курсор начала отсчёта.
limit integer
Лимит записей.

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

200 A successful response.
application/json
object
cancellations array
Элементы списка.
Показать Скрыть
cancellation_id string
Идентификатор заявки на отмену.
merchant_order_id string
Идентификатор заказа продавца.
client_order_id string
Идентификатор заказа клиента.
status string
Статус.
values
NEWAPPROVED_CANCELDECLINED
description string
Описание (опционально).
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/cancellation/list 

              1
              curl https://api.omninet.ru/v1/cancellation/list \
            
              2
                --request POST \
            
              3
                --header 'Content-Type: application/json' \
            
              4
                --data '{
            
              5
                "filter": {
            
              6
                  "cancellation_id": [
            
              7
                    "string"
            
              8
                  ],
            
              9
                  "status": [
            
              10
                    "NEW"
            
              11
                  ]
            
              12
                },
            
              13
                "cursor": "string",
            
              14
                "limit": 0
            
              15
              }'
            
{
  "cancellations": [
    {
      "cancellation_id": "string",
      "merchant_order_id": "string",
      "client_order_id": "string",
      "status": "NEW",
      "description": "string"
    }
  ],
  "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": {}
}

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