--- title: "Get Order Refunds Available" method: GET path: "/orders/{orderId}/refunds-available" tags: ["Refund"] --- # Get Order Refunds Available `GET /orders/{orderId}/refunds-available` Get refunds available for an order by ID. Specify the ID of the order in the {orderId} uri path parameter. ## Path parameters - `orderId` string, required ## Response `200` Successful response. - RefundAvailable - `currency` string — The refund currency. - `lineItems` RefundAvailableLineItem[] - `lineItemId` string - `price` RefundAvailableDetail - `total` Total - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalTax` TotalTax - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalShipping` TotalShipping - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalShippingTax` TotalShippingTax - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalDutiesAndTariffs` TotalDutiesAndTariffs - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalDutiesAndTariffsTax` TotalDutiesAndTariffsTax - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalFee` TotalFee - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalFeeTax` TotalFeeTax - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `product` RefundAvailableProduct - `companyId` string — The company’s ID. - `id` string — The product’s ID. - `status` string - `price` RefundAvailableDetail - `total` Total - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalTax` TotalTax - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalShipping` TotalShipping - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalShippingTax` TotalShippingTax - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalDutiesAndTariffs` TotalDutiesAndTariffs - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalDutiesAndTariffsTax` TotalDutiesAndTariffsTax - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalFee` TotalFee - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `totalFeeTax` TotalFeeTax - `amount` RefundRequested - `value` number — The requested refund amount. - `formattedValue` string — The formatted value of the requested refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountAvailableForRefund` RefundAvailableAmount - `value` number — The remaining amount available for the refund. - `formattedValue` string — The formatted value of the available refund amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `amountRefunded` RefundedAmount - `value` number — The refunded amount. - `formattedValue` string — The formatted value of the refunded amount displays symbols such as the dollar sign, a decimal separator, and the number of fractional digits. Contact your Digital River team to set up the formatted value. - `status` string — The current status of the refund. ## Other responses - `403` — Invalid token - `404` — Order not found --- [API](https://skmtc.net/digitalriver/apis/commerce-api-suite-admin-apis.md) · [All operations](https://skmtc.net/digitalriver/apis/commerce-api-suite-admin-apis/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/digitalriver/commerce-api-suite-admin-apis/revisions/a6efafc1669c/schema)