GetRefund

Summary

Returns all or specific refunds of the order.

Resource URL	/api/v3/orders/{orderNumber}/refunds/{refundNumber}
HTTP method	GET
Content type	application/json; text/json;

Input parameters

Parameter name	Location	Type / Model	Description
orderNumber	path		required Order number
refundNumber	path		optional Refund number

Responses

HTTP status code	Model	Comment
OK(200)	GetAllRefundsResponse	Get All Refunds Response
BadRequest (400)	array of ResponseMessage	Request failed. Check response model for list of Errors.
Unauthorized (401)		API user is unauthorized. Make sure X-Auth-Key header is sent.
InternalServerError (500)		Request failed due internal error. Retry request later.

Examples

JSON Response

{
  "refunds": [
    {
      "refundId": "82bb036f-ac1f-4394-9cd1-6c8111a8199c",
      "reservationId": "3b2b7ca1-48ac-4fd1-b9f7-097846064895",
      "customerNumber": "CUSTOMER1000",
      "refundNumber": "SHIPMENT001R00",
      "orderNumber": "ORDER00001",
      "amount": -720.0,
      "balance": -720.0,
      "currency": "NOK",
      "insertedAt": "2016-01-29T13:41:05Z",
      "captureNumber": "SHIPMENT001",
      "refundItems": [
        {
          "refundId": "82bb036f-ac1f-4394-9cd1-6c8111a8199c",
          "productId": "ITEM1111",
          "groupId": "GROUP14",
          "description": "Presents",
          "netUnitPrice": -100.0,
          "grossUnitPrice": -132.5,
          "quantity": 5.0,
          "vatCategory": "HighCategory",
          "vatPercent": 32.5,
          "vatAmount": -32.5
        },
        {
          "refundId": "82bb036f-ac1f-4394-9cd1-6c8111a8199c",
          "productId": "ITEM98556",
          "groupId": "GROUP02",
          "description": "Bag",
          "netUnitPrice": -50.0,
          "grossUnitPrice": -57.5,
          "quantity": 1.0,
          "vatCategory": "MiddleCategory",
          "vatPercent": 15.0,
          "vatAmount": -7.5,
          "lineNumber": 2
        }
      ]
    }
  ]
}