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

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

POST /v1/return/fbs/list

Тело запроса

Заголовок раздела «Тело запроса»
filter object
Набор фильтров для выборки возвратов.
Показать Скрыть
return_id array
Идентификаторы возвратов для фильтра.
merchant_order_id array
Идентификаторы заказов продавца для фильтра.
status array
Статусы возврата для фильтра.
Статусы обработки возврата.
updated_since string
Нижняя граница времени обновления возврата (RFC3339).
cursor string
Курсор пагинации.
limit integer
Размер страницы.

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

200 A successful response.
application/json
object
returns array
Список возвратов на текущей странице.
Показать Скрыть
return_id string
Идентификатор возврата.
merchant_order_id string
Идентификатор заказа продавца.
client_order_id string
Идентификатор заказа клиента. Может объединять несколько заказов продавца.
status string
Текущий статус возврата.
values
FBS_RETURN_STATUS_UNSPECIFIEDNEWPENDINGAPPROVEDREJECTEDIN_TRANSITRECEIVEDREFUNDEDPARTIAL_REFUNDEDCLOSED
product_id string
Идентификатор товара на маркетплейсе.
offer_id string
Артикул товара в системе продавца.
quantity integer
Количество возвращаемых единиц товара.
reason_code string
Код причины возврата.
reason_comment string
Текстовое описание причины возврата.
created_at string
Время создания заявки на возврат (RFC3339).
updated_at string
Время последнего изменения заявки (RFC3339).
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/fbs/list 

              1
              curl https://api.omninet.ru/v1/return/fbs/list \
            
              2
                --request POST \
            
              3
                --header 'Content-Type: application/json' \
            
              4
                --data '{
            
              5
                "filter": {
            
              6
                  "return_id": [
            
              7
                    "string"
            
              8
                  ],
            
              9
                  "merchant_order_id": [
            
              10
                    "string"
            
              11
                  ],
            
              12
                  "status": [
            
              13
                    "FBS_RETURN_STATUS_UNSPECIFIED"
            
              14
                  ],
            
              15
                  "updated_since": "string"
            
              16
                },
            
              17
                "cursor": "string",
            
              18
                "limit": 0
            
              19
              }'
            
{
  "returns": [
    {
      "return_id": "string",
      "merchant_order_id": "string",
      "client_order_id": "string",
      "status": "FBS_RETURN_STATUS_UNSPECIFIED",
      "product_id": "string",
      "offer_id": "string",
      "quantity": 0,
      "reason_code": "string",
      "reason_comment": "string",
      "created_at": "string",
      "updated_at": "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": {}
}

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