Skip to main content

Get repayment request details

note

The id in this example is a placeholder — use a real one from repaymentRequests.

Use repaymentRequest query to retrieve a single repayment request by ID. This example returns its scalar fields together with the order, the return reason (causal), the lines being returned, the returned lines as evaluated by the warehouse and the return shipping.

The lifecycle of the return (status) and the return reasons are described in Repayment request statuses and return reasons; the fields are documented on the RepaymentRequest and RepaymentReturnedLine object references. In returnedLines, quantityReceived and quantityCompliant are null until the warehouse records the reception, and line is null for items the warehouse received without them being part of the return. The refund payment transactions linked to the request are listed in refundTransactions (see From transactions and disputes to the order).

Response
{
  "data": {
    "repaymentRequest": {
      "id": "567",
      "number": "RR-2026-0001",
      "createdAt": "2026-02-14T09:00:00.000Z",
      "updatedAt": "2026-02-14T10:00:00.000Z",
      "status": "waiting_warehouse_reception",
      "order": {
        "id": "12345",
        "number": "56089"
      },
      "causal": {
        "id": "5",
        "description": "Defective/Damaged product",
        "refundKind": "total"
      },
      "lines": [
        {
          "id": "701",
          "quantity": 2,
          "sku": "SKU-1",
          "skuDescription": "Demo product",
          "number": "1",
          "originalUnitaryPrice": 100.0,
          "discountedUnitaryPrice": 90.0,
          "vatPercentage": 22.0,
          "unitaryVatAmount": 19.8
        }
      ],
      "returnedLines": [
        {
          "id": "98765",
          "quantityExpected": 2,
          "quantityReceived": null,
          "quantityCompliant": null,
          "sku": "SKU-1",
          "skuDescription": "Demo product",
          "line": {
            "id": "701",
            "sku": "SKU-1",
            "number": "1"
          }
        }
      ],
      "shipping": {
        "id": "790",
        "createdAt": "2026-02-14T09:05:00.000Z",
        "updatedAt": "2026-02-14T09:10:00.000Z",
        "status": "delivered",
        "bookingStatus": "confirmed"
      }
    }
  },
  "extensions": {
    "queryComplexity": 40,
    "bucketBalance": 9960,
    "bucketRestoreRate": 100
  }
}

Relevant permissions

The operations in this page require the following permissions on the API credentials — they are configured for you by Calicantus.

  • repayment_request:query:repayment_request
  • repayment_request:read
  • repayment_line:read
  • repayment_returned_line:read
  • repayment_causal:read
  • repayment_shipping:read