Getting the available refunds for a specific order

Learn how to get the available refunds for a specific order.

Use the GET /orders/{orderId}/refunds-available request to get the amount available for a refund (amountAvailableForRefund) for the specified order identifier (orderId).

cURL

curl --location --globoff 'api.digitalriver.com/order-api/orders/{orderID}/refunds-available' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Basic <<full access token>>'

200 OK response

{
  "currency": "string",
  "lineItems": [
    {
      "lineItemId": "string",
      "price": {
        "total": {
          "amount": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "string"
          }
        },
        "totalTax": {
          "amount": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "string"
          }
        },
        "totalShipping": {
          "amount": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "string"
          }
        },
        "totalShippingTax": {
          "amount": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "string"
          }
        },
        "totalDutiesAndTariffs": {
          "amount": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "string"
          }
        },
        "totalDutiesAndTariffsTax": {
          "amount": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "string"
          }
        },
        "totalFee": {
          "amount": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "string"
          }
        },
        "totalFeeTax": {
          "amount": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountAvailableForRefund": {
            "value": 0,
            "formattedValue": "string"
          },
          "amountRefunded": {
            "value": 0,
            "formattedValue": "string"
          }
        }
      },
      "product": {
        "companyId": "string",
        "id": "string"
      },
      "status": "string"
    }
  ],
  "price": {
    "total": {
      "amount": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "string"
      }
    },
    "totalTax": {
      "amount": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "string"
      }
    },
    "totalShipping": {
      "amount": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "string"
      }
    },
    "totalShippingTax": {
      "amount": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "string"
      }
    },
    "totalDutiesAndTariffs": {
      "amount": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "string"
      }
    },
    "totalDutiesAndTariffsTax": {
      "amount": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "string"
      }
    },
    "totalFee": {
      "amount": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "string"
      }
    },
    "totalFeeTax": {
      "amount": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountAvailableForRefund": {
        "value": 0,
        "formattedValue": "string"
      },
      "amountRefunded": {
        "value": 0,
        "formattedValue": "string"
      }
    }
  },
  "status": "string"
}