Получение сведений о возврате FBS

POST /v1/billing/fbs/return/get

POST/v1/billing/fbs/return/get

Возвращает сведения о возврате FBS, включённом в отчётный период, включая возвращённые товары, суммы возврата, начисления, удержания и связанные финансовые операции.

Тело запроса

return_ids
array
required
Элементы списка. Идентификаторы возвратов из refund fact или состава отчёта. Максимальное количество элементов в одном запросе — 1000. Если в одном запросе передано несколько одинаковых return_id, при обработке учитывается последняя запись, предыдущие игнорируются.
cursor
string
Курсор следующей страницы.
limit
integer
Размер страницы. min = 1; max = 300; default = 100.

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

200Нормализованные возвраты и return-scope money.
application/json
object
returns
array
required
Элементы списка. Возвраты с недоступными или несуществующими return_id в ответ не возвращаются.
Нормализованный возврат. amount уменьшает отчёт витрины, а fees[] дополнительно уменьшают settlement, если витрина удерживает return-scope fee.
Показать свойства
return_id
string
required
Стабильный идентификатор возврата.
merchant_order_id
string
required
Идентификатор заказа продавца.
client_order_id
string
required
Идентификатор заказа клиента.
status
string
required
Текущий статус заказа.
Допустимые значения
NEWCONFIRMEDREADY_TO_SHIPSHIPPEDACCEPTED_AT_WAREHOUSEDELIVEREDCANCELLED
status_changed_at
string
required
Переход в терминальный/refund статус, по которому возврат попадает в период. Формат RFC3339 с обязательным timezone (пример: 2026-07-02T10:25:00+02:00). Несоблюдение формата может привести к непредсказуемому поведению системы и проблемам со сверкой.
refund_type
string
required
Тип возврата. FULL_REFUND: полный возврат; сумма должна совпадать с исходным merchant_order.net_amount. PARTIAL_REFUND: частичный возврат; сумма может быть меньше, но не больше net_amount строки заказа.
Допустимые значения
FULL_REFUNDPARTIAL_REFUND
amount
object
required
Сумма возврата, уменьшающая отчёт.
Показать свойства
value
integer
required
Значение суммы, умноженное на 100.
currency_code
string
required
Код валюты в формате ISO-like, ожидаемо RUB для текущего scope.
fees
array
required
Удержания уровня возврата, например обработка возврата.
Удержание или комиссия витрины в закрытом billing fee dictionary.
Показать свойства
fee_type
string
required
Закрытый набор fee Seller API. PLATFORM_COMMISSION сюда не входит: это внутренний расчёт биллинга, а не факт витрины. SALE_COMMISSION: комиссия за продажу. ACQUIRING_FEE: комиссия эквайринга. DELIVERY_COMMISSION: комиссия за доставку. SHIPMENT_COMMISSION: комиссия за отгрузку. RETURN_COMMISSION: комиссия за возврат. REFUND_FEE: комиссия за обработку возврата.
Допустимые значения
SALE_COMMISSIONACQUIRING_FEEDELIVERY_COMMISSIONSHIPMENT_COMMISSIONRETURN_COMMISSIONREFUND_FEE
amount
object
required
Сумма удержания или комиссии.
Показать свойства
value
integer
required
Значение суммы, умноженное на 100.
currency_code
string
required
Код валюты в формате ISO-like, ожидаемо RUB для текущего scope.
next_cursor
string
Курсор следующей страницы.

Ошибки

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
код ошибки
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
код ошибки
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
код ошибки
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
код ошибки
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
код ошибки
message
string
сообщение
details
object
POST/v1/billing/fbs/return/get
1curl https://api.omninet.ru/v1/billing/fbs/return/get \2  --request POST \3  --header 'Content-Type: application/json' \4  --data '{5  "return_ids": [6    "string"7  ],8  "cursor": "string",9  "limit": 10010}'
{
  "returns": [
    {
      "return_id": "string",
      "merchant_order_id": "string",
      "client_order_id": "string",
      "status": "string",
      "status_changed_at": "string",
      "refund_type": "string",
      "amount": {
        "value": 44350,
        "currency_code": "RUB"
      },
      "fees": [
        {
          "fee_type": "string",
          "amount": {
            "value": 44350,
            "currency_code": "RUB"
          }
        }
      ]
    }
  ],
  "next_cursor": "string"
}

Нормализованные возвраты и return-scope money.