Third party coordinated returns

Learn how notify Digital River of returns when you have a third-party fulfiller

You can use the Returns API to notify Digital River that an order is partially or fully returned.

Before you submit a create return request, you must provide us basic information on the returned items.

Creating a return

Once you've supplied the necessary parameters, you can create both full and partial returns.

Setting return parameters

Every return must be associated with an order. You must also provide us the identifiers and quantities of the items that are returned.

Parameter

Required/Optional

Description

orderId

Required

Unique identifier for the order.

items

Required

Each element in this array represents a returned item. The itemId and quantity child parameters are required.

reason

Optional

String indicating the reason for the return.

location

Optional

The return address of the products.

Submitting a create return request

You use the same POST/returns method to notify Digital River of partial and full returns.

cURL
cURL
curl --location --request POST 'https://api.digitalriver.com/returns' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <API_key>' \
--data-raw '{
"orderId": "178438080336",
"reason": "The products are defective",
"items":
[
{
"itemId": "97626540336",
"quantity": 2
}
]
}'

The response returns a Return object in a state of created:

201 Created
201 Created
{
"id": "ret_6684565f-8277-4046-aea4-10b813c95f4c",
"createdTime": "2020-06-23T13:27:03Z",
"currency": "USD",
"items": [
{
"itemId": "97626540336",
"amount": 14.26,
"quantity": 2,
"quantityAccepted": 0,
"skuId": "f4f06b2b-f091-41b4-b18f-5c59a7414659",
"state": "created"
}
],
"orderId": "178438080336",
"reason": "The products are defective",
"state": "created",
"liveMode": false
}