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

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

POST /v1/return/list

Тело запроса

Заголовок раздела «Тело запроса»
filter object
Фильтр.
Показать Скрыть
status array
Фильтр по статусам возврата (опционально).
return_id array
Фильтр по идентификаторам возврата (опционально).
cursor string
Курсор начала отсчёта.
limit integer
Лимит записей.

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

200 A successful response.
application/json
object
returns array
Элементы списка.
Показать Скрыть
return_id string
Идентификатор возврата.
merchant_order_id string
Идентификатор заказа продавца.
client_order_id string
Идентификатор заказа клиента.
product_id string
Идентификатор товара в системе маркетплейса.
offer_id string
Идентификатор товара в системе продавца — артикул.
status string
Статус возврата.
values
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).
values
COURIERPICKUP_POINTCLICK_AND_COLLECT
address_tail string
Адрес в текстовом формате. Обязателен при delivery_type = COURIER.
comment string
Комментарий к доставке или адресу.
location_id string
Идентификатор локации.
tracking_number string
Трек-номер отправления (опционально).
delivery_date object
Слот доставки: дата и время начала и окончания.
Показать Скрыть
delivery_date_begin string
Дата и время начала доставки (date-time, RFC3339).
delivery_date_end string
Ожидаемая дата доставки (date-time, RFC3339).
return_request_reviewed_at string
Дата и время до которого нужно рассмотреть заявку, иначе она будет принята автоматически (date-time, RFC3339).
description string
Описание ситуации.
created_at string
Дата создания заявки (date-time, RFC3339).
money_returned object
Сумма возвращённых денег.
Показать Скрыть
value number required
Сумма.
currency_code string required
Валюта.
values
RUBBYNKZTEURUSDCNY
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/return/list 

              1
              curl 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": 0
            
              15
              }'
            
{
  "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": "string",
        "delivery_date_end": "string"
      },
      "return_request_reviewed_at": "string",
      "description": "string",
      "created_at": "string",
      "money_returned": {
        "value": 0,
        "currency_code": "RUB"
      }
    }
  ],
  "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": {}
}

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