Getting the JSON schema for an order refund

Learn how to retrieve the JSON schema for an order refund.

Use the GET /orders/{orderId}/refunds/schema to retrieve the JSON schema for a refund associated with an order.

cURL

curl --location --request GET 'https://api.digitalriver.com/orders/{orderid}/refunds/schema' \
--header 'authorization: bearer {auth_token}' \
...

200 OK response

A successful request returns a 200 OK response.

{
  "status": "string",
  "reason": "CUSTOMER_SATISFACTION_ISSUE",
  "comments": "string",
  "type": "PRODUCT_SHOULD_NOT_HAVE_FEE",
  "category": "PRODUCT_LEVEL_FEE",
  "generationDate": "string",
  "origin": "string",
  "overrides": "string",
  "policy": "string",
  "currency": "string",
  "totalRefunded": {},
  "outstanding": {},
  "totalRequested": {},
  "refundAmount": {
    "value": 0,
    "formattedValue": "string"
  },
  "lineItems": [
    {
      "status": "string",
      "expectedQuantity": 0,
      "returnedQuantity": 0,
      "type": "string",
      "notes": "string",
      "date": "string",
      "Product": {
        "companyId": "string",
        "id": "string",
        "externalId": "string"
      },
      "lineItemId": "string",
      "refundAmount": {
        "value": 0,
        "formattedValue": "string"
      },
      "lineItemFees": [
        {
          "feeType": "string",
          "refundAmount": {
            "value": 0,
            "currency": "string"
          }
        }
      ]
    }
  ],
  "id": "string",
  "companyId": "string",
  "siteId": "string",
  "generatedBy": "string"
}