riverty logo

Docs

Get Order

Path

GET /api/v3/orders/{orderNumber}

Request Parameters

orderNumber required
string
Order number

Responses

Successful RequestUnsuccessful Request, Incorrect Order Number

Response Example

    
        {
 "orderDetails": {
  "orderId": "29dab5d5-9a9f-4b4e-8aec-6914eebe54e8",
  "orderNumber": "riverty1",
  "totalNetAmount": 155.41,
  "totalGrossAmount": 185,
  "currency": "EUR",
  "hasSeparateDeliveryAddress": false,
  "customer": {
   "address": {
    "street": "Normalized Str.",
    "streetNumber": "1",
    "postalCode": "01234",
    "postalPlace": "normalized city",
    "countryCode": "DE"
   },
   "customerNumber": "AP000100919",
   "salutation": "Mr",
   "firstName": "Astrid",
   "lastName": "Svensson",
   "companyName": "",
   "email": "astrid.svensson@example.com",
   "phone": "",
   "mobilePhone": "00491234567",
   "birthDate": "1999-01-02T00:00:00Z",
   "customerCategory": "Person"
  },
  "insertedAt": "2023-09-27T10:49:11Z",
  "updatedAt": "2023-09-27T10:49:11Z",
  "orderItems": [
   {
    "orderId": "29dab5d5-9a9f-4b4e-8aec-6914eebe54e8",
    "insertedAt": "2023-09-27T10:49:11Z",
    "updatedAt": "2023-09-27T10:49:11Z",
    "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",
    "lineNumber": 0
   },
   {
    "orderId": "29dab5d5-9a9f-4b4e-8aec-6914eebe54e8",
    "insertedAt": "2023-09-27T10:49:11Z",
    "updatedAt": "2023-09-27T10:49:11Z",
    "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",
    "lineNumber": 0
   },
   {
    "orderId": "29dab5d5-9a9f-4b4e-8aec-6914eebe54e8",
    "insertedAt": "2023-09-27T10:49:11Z",
    "updatedAt": "2023-09-27T10:49:11Z",
    "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",
    "lineNumber": 0
   },
   {
    "orderId": "29dab5d5-9a9f-4b4e-8aec-6914eebe54e8",
    "insertedAt": "2023-09-27T10:49:11Z",
    "updatedAt": "2023-09-27T10:49:11Z",
    "productId": "SHIP",
    "groupId": "",
    "description": "Shipping",
    "type": "ShippingFee",
    "netUnitPrice": 4.2,
    "grossUnitPrice": 5,
    "quantity": 1,
    "vatPercent": 19,
    "vatAmount": 0.8,
    "lineNumber": 0
   }
  ],
  "expirationDate": "2023-10-27",
  "status": "Accepted",
  "displayStatus": "FullyRefunded"
 },
 "captures": [
  {
   "reservationId": "fb583567-c5a1-45de-a341-289c75e3f3dd",
   "customerNumber": "AP000100919",
   "captureNumber": "800090089",
   "orderNumber": "riverty1",
   "amount": 185,
   "balance": 0,
   "totalRefundedAmount": 185,
   "currency": "EUR",
   "insertedAt": "2023-09-27T10:50:32Z",
   "updatedAt": "2023-09-27T12:24:53Z",
   "orderDate": "2023-09-27T10:49:11Z",
   "captureItems": [
    {
     "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"
    },
    {
     "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"
    },
    {
     "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"
    },
    {
     "productId": "SHIP",
     "groupId": "",
     "description": "Shipping",
     "type": "ShippingFee",
     "netUnitPrice": 4.2,
     "grossUnitPrice": 5,
     "quantity": 1,
     "vatPercent": 19,
     "vatAmount": 0.8
    }
   ]
  }
 ],
 "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
    }
   ]
  }
 ],
 "cancellations": [],
 "payment": {
  "type": "Invoice"
 }
}
    

Request Example

    
        null