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

POST /v1/return/fbo/list

POST/v1/return/fbo/list

Тело запроса

filter
object

Набор фильтров для выборки возвратов.

Показать свойства
return_id
array

Идентификаторы возвратов для фильтра.

merchant_order_id
array

Идентификаторы заказов продавца для фильтра.

status
array

Статусы возврата для фильтра.

Допустимые значения
NEWPENDINGAPPROVEDREJECTEDIN_TRANSITRECEIVEDREFUNDEDPARTIAL_REFUNDEDCLOSED
updated_since
string

Нижняя граница времени обновления возврата (RFC3339).

cursor
string

Курсор пагинации.

limit
integer

Размер страницы. min = 1; max = 300; default = 100.

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

200A successful response.
application/json
object
returns
array

Список возвратов на текущей странице.

returnsFboReturnListItem

Показать свойства

returnsFboReturnListItem

return_id
string

Идентификатор возврата.

merchant_order_id
string

Идентификатор заказа продавца.

client_order_id
string

Идентификатор заказа клиента. Может объединять несколько заказов продавца.

status
string

Текущий статус возврата.

Допустимые значения
NEWPENDINGAPPROVEDREJECTEDIN_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
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
401Ошибка авторизации
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
429Превышен лимит запросов
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
500Внутренняя ошибка сервера
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
defaultОшибка (неожиданная или прочие)
application/json
object
error_type
string
  • ERROR_TYPE_UNAUTHORIZED — 401, ERROR_TYPE_RATE_LIMIT — 429, ERROR_TYPE_INTERNAL — 500
Допустимые значения
ERROR_TYPE_UNSPECIFIEDERROR_TYPE_UNAUTHORIZEDERROR_TYPE_RATE_LIMITERROR_TYPE_INTERNAL
code
string

Код ошибки.

  • OPERATION_NOT_SUPPORTED: операция недоступна для текущей конфигурации.
Допустимые значения
OPERATION_NOT_SUPPORTED
message
string

сообщение

details
object
POST/v1/return/fbo/list
1curl https://api.omninet.ru/v1/return/fbo/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      "string"14    ],15    "updated_since": "string"16  },17  "cursor": "string",18  "limit": 019}'
{
  "returns": [
    {
      "return_id": "string",
      "merchant_order_id": "string",
      "client_order_id": "string",
      "status": "string",
      "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.