Refunds
Last updated
Admin APIs reference
Last updated
Get refunds available for an order by ID. Specify the ID of the order in the {orderId} uri path parameter.
The order's ID.
GET /orders/{orderId}/refunds-available HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
"currency": "text",
"lineItems": [
{
"lineItemId": "text",
"price": {
"total": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalTax": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalShipping": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalShippingTax": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalDutiesAndTariffs": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalDutiesAndTariffsTax": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalFee": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalFeeTax": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
}
},
"product": {
"companyId": "text",
"id": "text"
},
"status": "text"
}
],
"price": {
"total": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalTax": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalShipping": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalShippingTax": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalDutiesAndTariffs": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalDutiesAndTariffsTax": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalFee": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
},
"totalFeeTax": {
"amount": {
"value": 1,
"formattedValue": "text"
},
"amountAvailableForRefund": {
"value": 1,
"formattedValue": "text"
},
"amountRefunded": {
"value": 1,
"formattedValue": "text"
}
}
},
"status": "text"
}Get refunds for an order by ID. Specify the ID of the order in the {orderId} URI path parameter.
The order's ID.
GET /orders/{orderId}/refunds HTTP/1.1
Host: api.digitalriver.com
Accept: */*
{
"refunds": []
}Gets JSON schema for order refund
The order's ID.
GET /orders/{orderId}/refunds/schema HTTP/1.1
Host: api.digitalriver.com
Accept: */*
Successful response.
{
"status": "text",
"reason": "CUSTOMER_SATISFACTION_ISSUE",
"comments": "text",
"type": "PRODUCT_SHOULD_NOT_HAVE_FEE",
"category": "PRODUCT_LEVEL_FEE",
"generationDate": "text",
"origin": "text",
"overrides": "text",
"policy": "text",
"currency": "text",
"totalRefunded": {},
"outstanding": {},
"totalRequested": {},
"refundAmount": {
"value": 1,
"formattedValue": "text"
},
"lineItems": [
{
"status": "text",
"expectedQuantity": 1,
"returnedQuantity": 1,
"type": "text",
"notes": "text",
"date": "text",
"Product": {
"companyId": "text",
"id": "text",
"externalId": "text"
},
"lineItemId": "text",
"refundAmount": {
"value": 1,
"formattedValue": "text"
},
"lineItemFees": [
{
"feeType": "text",
"refundAmount": {
"value": 1,
"currency": "text"
}
}
]
}
],
"id": "text",
"companyId": "text",
"siteId": "text",
"generatedBy": "text"
}Use this method to create a refund.
The order's ID.
POST /orders/{orderId}/refunds HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 197
{
"type": "text",
"category": "PRODUCT_LEVEL_PRODUCT",
"reason": "CUSTOMER_SATISFACTION_ISSUE",
"comments": "text",
"refundAmount": {
"value": 1
},
"lineItems": [
{
"lineItemId": "text",
"refundAmount": {
"value": 1
}
}
]
}{
"refunds": []
}