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

POST /v1/return/list

POST/v1/return/list

Тело запроса

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

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

200A successful response.
application/json
object
returns
array
Элементы списка. Возвраты с недоступными или несуществующими return_id в ответ не возвращаются.
ReturnListItem
Показать свойства
ReturnListItem
return_id
string
Идентификатор возврата.
merchant_order_id
string
Идентификатор заказа продавца.
client_order_id
string
Идентификатор заказа клиента.
product_id
string
Идентификатор товара в системе маркетплейса.
offer_id
string
Идентификатор товара в системе продавца — артикул.
status
string
Статус возврата.
Допустимые значения
NEWPENDINGNEEDS_INFOREJECT_PENDINGPARTIAL_REFUNDDELIVERY_APPROVEDDELIVERINGDELIVEREDAPPROVEDREJECT_REFUNDDELIVERY_TO_CLIENTCANCELEDCLOSED
product_name
string
Название товара.
client_photo
array
Ссылки на фотографии товара.
delivery
object
Параметры доставки или выдачи.
Показать свойства
delivery_type
string
required
Тип доставки или выдачи. - COURIER: доставка курьером — обязателен address_tail. - PICKUP_POINT: доставка в пункт выдачи. - CLICK_AND_COLLECT: самовывоз (Click & Collect).
Допустимые значения
COURIERPICKUP_POINTCLICK_AND_COLLECT
address_tail
string
Адрес в текстовом формате. Обязателен при delivery_type = COURIER. Формат: «196653, Россия, г. Санкт-Петербург, г. Колпино, ул. Октябрьская, д. 77/27, подъезд 1, этаж 3, кв. 12».
comment
string
Комментарий к доставке или адресу.
location_id
string
Идентификатор локации.
tracking_number
string
Трек-номер отправления (опционально).
delivery_date
object
Слот доставки: дата и время начала и окончания.
Показать свойства
delivery_date_begin
string
Дата и время начала доставки (date-time, RFC3339). Формат RFC3339 с обязательным timezone (пример: 2026-07-02T10:25:00+02:00). Несоблюдение формата может привести к непредсказуемому поведению системы и проблемам с заказами.
delivery_date_end
string
Ожидаемая дата доставки (date-time, RFC3339). Формат RFC3339 с обязательным timezone (пример: 2026-07-02T10:25:00+02:00). Несоблюдение формата может привести к непредсказуемому поведению системы и проблемам с заказами.
return_request_reviewed_at
string
Дата и время до которого нужно рассмотреть заявку, иначе она будет принята автоматически (date-time, RFC3339). Формат RFC3339 с обязательным timezone (пример: 2026-07-02T10:25:00+02:00). Несоблюдение формата может привести к непредсказуемому поведению системы и проблемам с заказами.
description
string
Описание ситуации.
created_at
string
Дата создания заявки (date-time, RFC3339). Формат RFC3339 с обязательным timezone (пример: 2026-07-02T10:25:00+02:00). Несоблюдение формата может привести к непредсказуемому поведению системы и проблемам с заказами.
money_returned
object
Сумма возвращённых денег.
Показать свойства
value
number
required
Сумма.
currency_code
string
required
Валюта.
Допустимые значения
RUBBYNKZTEURUSDCNY
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/return/list
1curl https://api.omninet.ru/v1/return/list \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "filter": {6    "status": [7      "string"8    ],9    "return_id": [10      "string"11    ]12  },13  "cursor": "string",14  "limit": 015}'
{
  "returns": [
    {
      "return_id": "string",
      "merchant_order_id": "string",
      "client_order_id": "string",
      "product_id": "string",
      "offer_id": "string",
      "status": "NEW",
      "product_name": "string",
      "client_photo": [
        "string"
      ],
      "delivery": {
        "delivery_type": "string",
        "address_tail": "string",
        "comment": "string",
        "location_id": "string",
        "tracking_number": "string"
      },
      "delivery_date": {
        "delivery_date_begin": "2026-07-02T10:25:00+02:00",
        "delivery_date_end": "2026-07-02T10:25:00+02:00"
      },
      "return_request_reviewed_at": "2026-07-02T10:25:00+02:00",
      "description": "string",
      "created_at": "2026-07-02T10:25:00+02:00",
      "money_returned": {
        "value": 0,
        "currency_code": "RUB"
      }
    }
  ],
  "next_cursor": "string",
  "total": 0
}

A successful response.