К содержимому
Инвойсбокс
get/v3/filter/api/order/refund-order

Получение списка возвратов

Возвраты читаются одним запросом:

В запросе можно применять фильтры и сортировку.

Пример запроса с фильтром по идентификатору возврата

GET /v3/filter/api/order/refund-order?id=01771534-196a-1105-839a-82422289d6d9

Пример запроса с фильтром по идентификатору заказа (по которому оформлялся возврат)

GET /v3/filter/api/order/refund-order?parentId=d6f1ccb2-2e32-43c2-8a42-5a835dd88607

Пример запроса возвратов с фильтром по статусу

GET /v3/filter/api/order/refund-order?status=completed

Пример запроса возвратов с фильтром по идентификатору магазина

GET /v3/filter/api/order/refund-order?merchantId=2ce417f1-8702-4517-bb56-11cd305d2594

Пример запроса возвратов с фильтром по идентификатору заказа в учётной системе магазина

GET /v3/filter/api/order/refund-order?merchantOrderId=ORD123456
Пример запроса и ответа 
GET /v3/filter/api/order/refund-order?status=completed
Authorization: Bearer b37c4c689295904ed21eee5d9a48d42e
User-Agent: MyApp 1.0
Accept: application/json

Ответ (по схеме):

{
  "data": [
    {
      "id": "01771534-1a57-f184-dee3-ebeb91dded75",
      "description": "string",
      "currencyId": "RUB",
      "amount": 100.5,
      "vatAmount": 100.5,
      "basketItems": [
        {
          "sku": "string",
          "name": "string",
          "groupName": "string",
          "measure": "string",
          "measureCode": "string",
          "originCountry": "string",
          "originCountryCode": "string",
          "grossWeight": 100.5,
          "netWeight": 100.5,
          "quantity": 100.5,
          "amount": 100.5,
          "amountWoVat": 100.5,
          "totalAmount": 100.5,
          "totalVatAmount": 100.5,
          "vatCode": "RUS_VAT22",
          "type": "string",
          "gtdNumber": "string",
          "paymentType": "string",
          "excise": 100.5,
          "metaData": {},
          "tnved": "string",
          "rnpt": "string",
          "gtin": "string",
          "category": "string",
          "categoryType": "string",
          "serviceDate": "2026-08-03T12:00:00+03:00"
        }
      ],
      "merchantId": "01771534-1a57-f184-dee3-ebeb91dded75",
      "status": "string",
      "shipmentStatus": "string",
      "subtype": "string",
      "processingStatus": "string",
      "createdAt": "2026-08-03T12:00:00+03:00",
      "merchantOrderId": "01771534-1a57-f184-dee3-ebeb91dded75",
      "merchantOrderIdVisible": "string",
      "expirationDate": "2026-08-03T12:00:00+03:00",
      "metaData": {},
      "customerData": {},
      "notificationUrl": "string",
      "orderSetting": {
        "roundPolicy": "string",
        "disableValidate": false
      },
      "internalProperty": {
        "guarantee": false,
        "hold": false,
        "rtp": false,
        "agent": false,
        "rtpExternal": false
      },
      "tags": {},
      "shopId": 1,
      "sourceId": "l3",
      "paidAt": "2026-08-03T12:00:00+03:00",
      "orderContainerId": "01771534-1a57-f184-dee3-ebeb91dded75",
      "parentId": "01771534-1a57-f184-dee3-ebeb91dded75",
      "processable": false,
      "userAccountId": "01771534-1a57-f184-dee3-ebeb91dded75"
    }
  ],
  "metaData": {
    "totalCount": 1,
    "pageSize": 1,
    "page": 1
  },
  "extendedData": [
    {
      "type": "string",
      "data": {}
    }
  ]
}

Параметры запроса — PUT

9 обязательных из 31
ПолеТипОписание
description#string≤ 1000 символов
amount#numberот 0Денежное значение: ровно два знака после точки. В коде считайте Decimal/BigDecimal, не двоичным float
vatAmount#numberот 0Денежное значение: ровно два знака после точки. В коде считайте Decimal/BigDecimal, не двоичным float
basketItems#BillingProviderDomainOrderEntityBasketItemApiUpdateCollection
expirationDate#string | nulldate-time
metaData#ArrayMap | null
Страница помогла?
Нужна помощь?Написать в поддержкуТелеграм-канал
← НазадОформление возвратаДальше →Отмена возврата
getЗапрашивает список возвратов заказов через SDK бэк-офисаДемо
curl -X GET 'https://api.invoicebox.ru/v3/filter/api/order/refund-order' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0'
putРедактирование возвратного заказаДемо
curl -X PUT 'https://api.invoicebox.ru/v3/billing/api/order/refund-order/<id>' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0' \
  -d '{
  "description": "Оплата бронирования",
  "amount": 12200,
  "vatAmount": 2200
}'
Возвраты демо-магазина общие — править их значит менять чужой возврат.
deleteОтмена возвратного заказаДемо
curl -X DELETE 'https://api.invoicebox.ru/v3/billing/api/order/refund-order/<id>' \
  -H 'Authorization: Bearer <ВАШ_ТОКЕН>' \
  -H 'Content-Type: application/json' \
  -H 'User-Agent: MyApp 1.0'
Возвраты демо-магазина общие — удалять их значит удалять чужой возврат.