System Status

Returns

The Returns resource in the Digital River API allows businesses to handle returning items from an order. It supports full and partial returns, offering flexibility in managing customer requests to return goods. This resource allows businesses to process returns, initiate refunds, and update inventory and order statuses accordingly.

Returns a list of returns

get

Get all returns.

Query parameters
createdTimestring · date-timeOptional

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:

  • gt–return values where the createdTime field is after this timestamp
  • gte–return values where the createdTime field is after or equal to this timestamp
  • lt–return values where the createdTime field is before this timestamp
  • lte–return values where the createdTime field is before or equal to this timestamp
endingBeforestringOptional

A 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.

startingAfterstringOptional

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.

limitinteger · min: 1 · max: 100Optional

A limit on the number of objects returned. Limit can range between 1 and 100, and the default is 10.

idsstring[]Optional

Only return objects with these IDs.

statestringOptional

Only return objects in the given state

orderIdstringOptional

The order to retrieve returns for.

skuIdstringOptional

The sku to retrieve returns for.

Responses
200

200 OK

application/json
get
GET /returns HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "ret_5823594809",
      "createdTime": "2025-09-15T21:27:22.823Z",
      "updatedTime": "2025-09-15T21:27:22.823Z",
      "orderId": "ord_6645940010",
      "currency": "USD",
      "items": [
        [
          {
            "skuId": "sku_9234276173",
            "amount": 899,
            "quantity": 1,
            "state": "created"
          }
        ]
      ],
      "reason": "requested_by_customer",
      "failureReason": "text",
      "state": "created",
      "location": {
        "address": {
          "line1": "10380 Bren Rd W",
          "line2": "text",
          "city": "Minnetonka",
          "postalCode": "55129",
          "state": "MN",
          "country": "US"
        },
        "name": "John Smith",
        "phone": "952-111-1111",
        "email": "[email protected]"
      },
      "liveMode": false,
      "metadata": {
        "coupon": "iOS"
      },
      "refundIds": [
        "0848750667"
      ]
    }
  ]
}

Creates a Return

post

Returns all or part of a previously created order.

Body
orderIdstringRequired

The unique identifier of the Order associated with the Return.

Example: ord_6645940010
reasonstring · max: 64Optional

The reason for the return.

Example: requested_by_customer
metadataany ofOptional
or
or
Responses
201

201 Created

application/json
post
POST /returns HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 353

{
  "orderId": "ord_6645940010",
  "reason": "requested_by_customer",
  "items": [
    [
      {
        "skuId": "sku_9234276173",
        "quantity": 1
      }
    ]
  ],
  "location": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]"
  },
  "metadata": {
    "coupon": "iOS"
  }
}
{
  "id": "ret_5823594809",
  "createdTime": "2025-09-15T21:27:22.823Z",
  "orderId": "ord_6645940010",
  "currency": "USD",
  "items": [
    [
      {
        "skuId": "sku_9234276173",
        "amount": 899,
        "quantity": 1,
        "state": "created"
      }
    ]
  ],
  "reason": "requested_by_customer",
  "state": "created",
  "location": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]"
  },
  "livemode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "refundIds": [
    "ref_0848750667"
  ]
}

Gets a return by ID

get

Retrieves the details of a return. Supply the unique identifier of the return.

Path parameters
idstringRequired

Return ID

Responses
200

OK.

application/json
get
GET /returns/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "id": "ret_5823594809",
  "createdTime": "2025-09-15T21:27:22.823Z",
  "updatedTime": "2025-09-15T21:27:22.823Z",
  "orderId": "ord_6645940010",
  "currency": "USD",
  "items": [
    [
      {
        "skuId": "sku_9234276173",
        "amount": 899,
        "quantity": 1,
        "state": "created"
      }
    ]
  ],
  "reason": "requested_by_customer",
  "failureReason": "text",
  "state": "created",
  "location": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]"
  },
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "refundIds": [
    "0848750667"
  ]
}

Updates an existing return

post

Updates an existing return.

Path parameters
idstringRequired

Return ID

Body
one ofOptional
or
Responses
200

200 OK

application/json
post
POST /returns/{id} HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 260

{
  "location": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]"
  },
  "state": "accepted",
  "metadata": {
    "coupon": "iOS"
  }
}
{
  "id": "ret_5823594809",
  "createdTime": "2025-09-15T21:27:22.823Z",
  "updatedTime": "2025-09-15T21:27:22.823Z",
  "orderId": "ord_6645940010",
  "currency": "USD",
  "items": [
    [
      {
        "skuId": "sku_9234276173",
        "amount": 899,
        "quantity": 1,
        "state": "created"
      }
    ]
  ],
  "reason": "requested_by_customer",
  "failureReason": "text",
  "state": "created",
  "location": {
    "address": {
      "line1": "10380 Bren Rd W",
      "line2": "text",
      "city": "Minnetonka",
      "postalCode": "55129",
      "state": "MN",
      "country": "US"
    },
    "name": "John Smith",
    "phone": "952-111-1111",
    "email": "[email protected]"
  },
  "liveMode": false,
  "metadata": {
    "coupon": "iOS"
  },
  "refundIds": [
    "0848750667"
  ]
}
PreviousRefundsNextSKUs

Last updated