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

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

POST /v1/return/fbs/get

Тело запроса

Заголовок раздела «Тело запроса»
return_id string
Идентификатор возврата.

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

200 A successful response.
application/json
object
return_details object
Полная карточка возврата.
Показать Скрыть
returns object
Основные поля заявки на возврат.
Показать Скрыть
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).
shipment object
Данные логистики по возврату.
Показать Скрыть
provider_code string
Код службы доставки возврата.
tracking_number string
Трек-номер возвратной отправки.
tracking_url string
URL для отслеживания возвратной отправки.
exemplar object
Данные экземпляра возвращаемого товара.
Показать Скрыть
exemplar_id string
Идентификатор экземпляра товара.
gtd string
Номер грузовой таможенной декларации.
rnpt string
Регистрационный номер партии товара.
weight number
Фактический вес экземпляра.
marks array
Маркировки экземпляра товара.
Показать Скрыть
mark string
Значение кода маркировки.
mark_type string
Тип кода маркировки.
status_history array
История изменения статусов возврата.
Показать Скрыть
status string
Статус, установленный на шаге истории.
values
FBS_RETURN_STATUS_UNSPECIFIEDNEWPENDINGAPPROVEDREJECTEDIN_TRANSITRECEIVEDREFUNDEDPARTIAL_REFUNDEDCLOSED
changed_by string
Инициатор изменения статуса.
values
FBS_RETURN_ACTOR_UNSPECIFIEDMERCHANTCLIENTMARKET
changed_at string
Время изменения статуса (RFC3339).
comment string
Комментарий к событию в истории.
available_actions array
Доступные действия на текущем шаге.
Показать Скрыть
action string
Допустимое действие на текущем этапе.
values
FBS_RETURN_ACTION_UNSPECIFIEDREFUNDPARTIAL_REFUNDREPLACEREJECT
title string
Краткое название действия.
hint string
Подсказка по применению действия.
compensation object
Информация о выплате/компенсации.
Показать Скрыть
amount integer
Сумма компенсации, умноженная на 100.
currency string
Валюта компенсации.
values
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
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/get 

              1
              curl https://api.omninet.ru/v1/return/fbs/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": "FBS_RETURN_STATUS_UNSPECIFIED",
      "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"
    },
    "exemplar": {
      "exemplar_id": "string",
      "gtd": "string",
      "rnpt": "string",
      "weight": 0,
      "marks": [
        {
          "mark": "string",
          "mark_type": "string"
        }
      ]
    },
    "status_history": [
      {
        "status": "FBS_RETURN_STATUS_UNSPECIFIED",
        "changed_by": "FBS_RETURN_ACTOR_UNSPECIFIED",
        "changed_at": "string",
        "comment": "string"
      }
    ],
    "available_actions": [
      {
        "action": "FBS_RETURN_ACTION_UNSPECIFIED",
        "title": "string",
        "hint": "string"
      }
    ],
    "compensation": {
      "amount": 0,
      "currency": "RUB",
      "paid_at": "string"
    }
  }
}

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": {}
}

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