riverty logo

Docs
Get Started Login

Get Voids

Returns all or specific voided (cancelled) authorizations of the order.

Path

GET /api/v3/orders/{orderNumber}/voids/{voidNumber}

Request Parameters

orderNumber
required
string
Order number
voidNumber
required
string
Void number

Responses

Successful RequestUnsuccessful Request, Incorrect Void Number

Request Example

    
        null

Response Example

    
        {
 "cancellations": [
  {
   "cancellationNo": "C0000033476",
   "cancellationAmount": 300,
   "cancellationItems": [
    {
     "productId": "4534-BLK-M",
     "description": "Leather jacket, Black, size M",
     "grossUnitPrice": 100,
     "netUnitPrice": 84,
     "quantity": 1,
     "vatPercent": 19,
     "vatAmount": 16,
     "imageUrl": "https://developer-sandbox.riverty.com/images/black_leather_jacket.jpg"
    },
    {
     "productId": "5745-GRY-M",
     "description": "Socks, Grey, Size M",
     "grossUnitPrice": 10,
     "netUnitPrice": 8.4,
     "quantity": 5,
     "vatPercent": 19,
     "vatAmount": 1.6,
     "imageUrl": "https://developer-sandbox.riverty.com/images/grey_socks.jpg"
    },
    {
     "productId": "3323-BRN-M",
     "description": "Woolen hat, brown, Size M",
     "grossUnitPrice": 30,
     "netUnitPrice": 25.21,
     "quantity": 1,
     "vatPercent": 19,
     "vatAmount": 4.79,
     "imageUrl": "https://developer-sandbox.riverty.com/images/brown_wool_hat.jpg"
    },
    {
     "productId": "SHIP",
     "description": "Shipping",
     "type": "ShippingFee",
     "grossUnitPrice": 5,
     "netUnitPrice": 4.2,
     "quantity": 1,
     "vatPercent": 19,
     "vatAmount": 0.8
    }
   ]
  }
 ]
}