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

POST /v1/cancellation/list

POST/v1/cancellation/list

Тело запроса

filter
object
Фильтр. Если поле фильтра не передано, равно null или передан пустой массив [], фильтрация по этому полю не применяется. При одновременном указании нескольких фильтров условия объединяются по AND.
Показать свойства
cancellation_id
array
Фильтр по идентификаторам заявок на отмену (опционально).
status
array
Фильтр по статусам (опционально).
Статус заявки на отмену. - NEW: Ожидает обновления со стороны продавца. - APPROVED_CANCEL: Одобрено. - DECLINED: Отклонено.
cursor
string
Курсор начала отсчёта.
limit
integer
Размер страницы. min = 1; max = 300; default = 100.

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

200A successful response.
application/json
object
cancellations
array
Элементы списка. Заявки на отмену с недоступными или несуществующими cancellation_id в ответ не возвращаются.
CancellationListItem
Показать свойства
CancellationListItem
cancellation_id
integer
Идентификатор заявки на отмену.
merchant_order_id
string
Идентификатор заказа продавца.
client_order_id
string
Идентификатор заказа клиента.
status
string
Статус.
Допустимые значения
NEWAPPROVED_CANCELDECLINED
description
string
Описание (опционально).
next_cursor
string
Курсор начала отсчёта.
total
integer
Общее количество записей.

Ошибки

400Некорректный запрос
application/json
object
error_type
string
ERROR_TYPE_BAD_REQUEST — HTTP 400 (request-level); ERROR_TYPE_UNAUTHORIZED — 401; ERROR_TYPE_RATE_LIMIT — 429; ERROR_TYPE_INTERNAL — 500. Поэлементные/бизнес-ошибки сущности — в HTTP 200 errors/failed, не здесь.
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string
код ошибки
message
string
сообщение
details
object
401Ошибка авторизации
application/json
object
error_type
string
ERROR_TYPE_BAD_REQUEST — HTTP 400 (request-level); ERROR_TYPE_UNAUTHORIZED — 401; ERROR_TYPE_RATE_LIMIT — 429; ERROR_TYPE_INTERNAL — 500. Поэлементные/бизнес-ошибки сущности — в HTTP 200 errors/failed, не здесь.
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string
код ошибки
message
string
сообщение
details
object
429Превышен лимит запросов
application/json
object
error_type
string
ERROR_TYPE_BAD_REQUEST — HTTP 400 (request-level); ERROR_TYPE_UNAUTHORIZED — 401; ERROR_TYPE_RATE_LIMIT — 429; ERROR_TYPE_INTERNAL — 500. Поэлементные/бизнес-ошибки сущности — в HTTP 200 errors/failed, не здесь.
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string
код ошибки
message
string
сообщение
details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string
ERROR_TYPE_BAD_REQUEST — HTTP 400 (request-level); ERROR_TYPE_UNAUTHORIZED — 401; ERROR_TYPE_RATE_LIMIT — 429; ERROR_TYPE_INTERNAL — 500. Поэлементные/бизнес-ошибки сущности — в HTTP 200 errors/failed, не здесь.
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string
код ошибки
message
string
сообщение
details
object
defaultОшибка (неожиданная или прочие)
application/json
object
error_type
string
ERROR_TYPE_BAD_REQUEST — HTTP 400 (request-level); ERROR_TYPE_UNAUTHORIZED — 401; ERROR_TYPE_RATE_LIMIT — 429; ERROR_TYPE_INTERNAL — 500. Поэлементные/бизнес-ошибки сущности — в HTTP 200 errors/failed, не здесь.
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNALERROR_TYPE_BAD_REQUEST
code
string
код ошибки
message
string
сообщение
details
object
POST/v1/cancellation/list
1curl https://api.omninet.ru/v1/cancellation/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "filter": {6    "cancellation_id": [7      08    ],9    "status": [10      "NEW"11    ]12  },13  "cursor": "string",14  "limit": 015}'
{
  "cancellations": [
    {
      "cancellation_id": 0,
      "merchant_order_id": "string",
      "client_order_id": "string",
      "status": "NEW",
      "description": "string"
    }
  ],
  "next_cursor": "string",
  "total": 0
}

A successful response.