Refunds
Last updated
Last updated
Refunds are essential to order management, allowing businesses to maintain customer satisfaction. Through the Digital River API, you can process full or partial refunds covering product costs, shipping, taxes, duties, and other fees. Understanding the nuances between standard and charge refunds helps ensure precise adjustments and effective financial management. For an in-depth guide on implementing refunds, explore and .
Retrieves the details of a refund. Supply the unique identifier of the refund.
/refunds/{id}
Refund ID
Updates the specified refund by setting the values of the parameters passed. Any parameters not provided will be left unchanged. This request only accepts metadata as an argument.
/refunds/{id}
Refund ID
Key-value pairs used to store additional data. Value can be string, boolean or integer types.
{"coupon":"iOS"}Get all refunds.
/refunds
A filter on the list based on the createdTime field. The value can be a string with an ISO-8601 UTC format datetime or it can be a dictionary with the following options:
createdTime[gt]=2020-09-22T12:09:44ZA cursor for use in pagination. The endingBefore parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with xyz your subsequent calls can include endingBefore=xyz in order to fetch the previous page of the list.
A cursor for use in pagination. The startingAfter parameter is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with xyz, your subsequent calls can include startingAfter=xyz in order to fetch the next page of the list.
A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.
Only return objects in the given state
Only return refunds with the given IDs
The order to retrieve refunds for.
The sku to retrieve refunds for.
Retrieve refunds with this reason.
Retrieve refunds that failed for this reason.
A filter on the list based on the amount field. The value can be a string or it can be a dictionary with the following options:
20.99A filter on the list based on the amount field. The value can be a string or it can be a dictionary with the following options:
20.99Refunds all all or part of an order charge.
/refunds
The unique identifier of the order. You are required to provide this parameter or <code>invoiceId</code>.
ord_5823594809The unique identifier of the invoice. You are required to provide this parameter or <code>orderId</code>.
5823594809Three-letter ISO currency code.
USDThe amount to refund. You are required to provide this value, <code>percent</code>, or <code>items</code>.
9.99The percent to refund. You are required to provide this value, <code>amount</code>, or <code>items</code>.
100The reason for the refund.
requested_by_customerKey-value pairs used to store additional data. Value can be string, boolean or integer types.
{"coupon":"iOS"}The type of the refund.
shippingshipping, duty, tax, importer_taxThe items to refund.