riverty logo

Docs

Get Refunds

Returns all or specific refunds of the order.

Path

GET /api/v3/orders/{orderNumber}/refunds/{refundNumber}

Request Parameters

orderNumber required
string
Order number
refundNumber required
string
Refund number

Responses

Successful RequestUnsuccessful Request, Incorrect Refund Number

Response Example

    
        {
 "refunds": [
  {
   "refundId": "78d0f5d5-dc7e-4462-9d2b-9a32d8fe684e",
   "reservationId": "fb583567-c5a1-45de-a341-289c75e3f3dd",
   "customerNumber": "AP000100919",
   "refundNumber": "800090090",
   "orderNumber": "riverty1",
   "amount": -185,
   "balance": -185,
   "currency": "EUR",
   "insertedAt": "2023-09-27T12:24:53Z",
   "captureNumber": "800090089",
   "refundItems": [
    {
     "refundId": "78d0f5d5-dc7e-4462-9d2b-9a32d8fe684e",
     "productId": "4534-BLK-M",
     "groupId": "",
     "description": "Leather jacket, Black, size M",
     "netUnitPrice": -84,
     "grossUnitPrice": -100,
     "quantity": 1,
     "vatPercent": 19,
     "vatAmount": -16,
     "imageUrl": "https://developer-sandbox.riverty.com/images/black_leather_jacket.jpg"
    },
    {
     "refundId": "78d0f5d5-dc7e-4462-9d2b-9a32d8fe684e",
     "productId": "5745-GRY-M",
     "groupId": "",
     "description": "Socks, Grey, Size M",
     "netUnitPrice": -8.4,
     "grossUnitPrice": -10,
     "quantity": 5,
     "vatPercent": 19,
     "vatAmount": -1.6,
     "imageUrl": "https://developer-sandbox.riverty.com/images/grey_socks.jpg"
    },
    {
     "refundId": "78d0f5d5-dc7e-4462-9d2b-9a32d8fe684e",
     "productId": "3323-BRN-M",
     "groupId": "",
     "description": "Woolen hat, brown, Size M",
     "netUnitPrice": -25.21,
     "grossUnitPrice": -30,
     "quantity": 1,
     "vatPercent": 19,
     "vatAmount": -4.79,
     "imageUrl": "https://developer-sandbox.riverty.com/images/brown_wool_hat.jpg"
    },
    {
     "refundId": "78d0f5d5-dc7e-4462-9d2b-9a32d8fe684e",
     "productId": "SHIP",
     "groupId": "",
     "description": "Shipping",
     "type": "ShippingFee",
     "netUnitPrice": -4.2,
     "grossUnitPrice": -5,
     "quantity": 1,
     "vatPercent": 19,
     "vatAmount": -0.8
    }
   ]
  }
 ]
}
    

Request Example

    
        null