Детальная карточка возврата

POST /v1/return/fbo/get

POST/v1/return/fbo/get

Тело запроса

return_id

string

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

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

200A successful response.

application/json

object

return_details

object

Полная карточка возврата.

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

returns

object

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

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

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).

shipment

object

Данные логистики по возврату.

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

provider_code

string

Код службы доставки возврата.

tracking_number

string

Трек-номер возвратной отправки.

tracking_url

string

URL для отслеживания возвратной отправки.

status_history

array

История изменения статусов возврата.

returnsFboReturnStatusHistory

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

returnsFboReturnStatusHistory

status

string

Статус, установленный на шаге истории.

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

NEWPENDINGAPPROVEDREJECTEDIN_TRANSITRECEIVEDREFUNDEDPARTIAL_REFUNDEDCLOSED

changed_by

string

Инициатор изменения статуса.

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

MERCHANTCLIENTMARKET

changed_at

string

Время изменения статуса (RFC3339).

comment

string

Комментарий к событию в истории.

available_actions

array

Доступные действия на текущем шаге.

returnsFboReturnAvailableAction

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

returnsFboReturnAvailableAction

action

string

Допустимое действие на текущем этапе.

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

REFUNDPARTIAL_REFUNDREPLACEREJECT

title

string

Краткое название действия.

hint

string

Подсказка по применению действия.

compensation

object

Информация о выплате/компенсации.

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

amount

integer

Сумма компенсации, умноженная на 100.

currency

string

Валюта компенсации.

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

RUBBYNKZTEURUSDCNY

paid_at

string

Время фактической выплаты (RFC3339).

Ошибки

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/get

1curl https://api.omninet.ru/v1/return/fbo/get \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "return_id": "string"6}'

{
  "return_details": {
    "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"
    },
    "shipment": {
      "provider_code": "string",
      "tracking_number": "string",
      "tracking_url": "string"
    },
    "status_history": [
      {
        "status": "string",
        "changed_by": "string",
        "changed_at": "string",
        "comment": "string"
      }
    ],
    "available_actions": [
      {
        "action": "string",
        "title": "string",
        "hint": "string"
      }
    ],
    "compensation": {
      "amount": 0,
      "currency": "RUB",
      "paid_at": "string"
    }
  }
}

A successful response.