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

hasMorebooleanOptional

Whether or not there are more elements available after this set. If false this set represents the end of the list.

Example: true

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

get

/returns

HTTPcURLJavaScriptPython

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

{
  "hasMore": true,
  "data": [
    {
      "id": "ret_5823594809",
      "createdTime": "2026-03-10T04:06:54.775Z",
      "updatedTime": "2026-03-10T04:06:54.775Z",
      "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

application/json

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

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

409

409 Conflict

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

post

/returns

HTTPcURLJavaScriptPython

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": "2026-03-10T04:06:54.775Z",
  "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

idstringRead-onlyOptional

Unique identifier for the return

Example: ret_5823594809

createdTimestring · date-timeRead-onlyOptional

Time at which the return was created

updatedTimestring · date-timeRead-onlyOptional

Time at which the return was updated

orderIdstringRead-onlyOptional

Unique identifier for the order

Example: ord_6645940010

currencystringOptional

Three-letter ISO currency code.

Example: USD

reasonstringOptional

String indicating the reason for the return.

Example: requested_by_customer

failureReasonstringOptional

Enumeration indicating the reason for the return failure, if known.

statestring · enumOptional

Enumeration indicating the state of the return.

Example: createdPossible values:

liveModebooleanOptional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example: false

metadataany ofOptional

or

or

refundIdsstring[]Read-onlyOptional

The ID of a refund issued for this return.

Example: 0848750667

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

404

404 Not Found

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

get

/returns/{id}

HTTPcURLJavaScriptPython

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

{
  "id": "ret_5823594809",
  "createdTime": "2026-03-10T04:06:54.775Z",
  "updatedTime": "2026-03-10T04:06:54.775Z",
  "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

application/json

or

Responses

200

200 OK

application/json

idstringRead-onlyOptional

Unique identifier for the return

Example: ret_5823594809

createdTimestring · date-timeRead-onlyOptional

Time at which the return was created

updatedTimestring · date-timeRead-onlyOptional

Time at which the return was updated

orderIdstringRead-onlyOptional

Unique identifier for the order

Example: ord_6645940010

currencystringOptional

Three-letter ISO currency code.

Example: USD

reasonstringOptional

String indicating the reason for the return.

Example: requested_by_customer

failureReasonstringOptional

Enumeration indicating the reason for the return failure, if known.

statestring · enumOptional

Enumeration indicating the state of the return.

Example: createdPossible values:

liveModebooleanOptional

Has the value true if the object exists in live mode or the value false if the object exists in test mode.

Example: false

metadataany ofOptional

or

or

refundIdsstring[]Read-onlyOptional

The ID of a refund issued for this return.

Example: 0848750667

400

400 Bad Request

application/json

401

401 Unauthorized

application/json

403

403 Forbidden

application/json

404

401 Not Found

application/json

405

405 Method Not Allowed

application/json

406

406 Not Acceptable

application/json

408

408 Request Timeout

application/json

409

409 Conflict

application/json

429

429 Too Many Requests

application/json

500

500 Internal Server Error

application/json

502

502 Bad Gateway Error

application/json

503

503 Service Unavailable Error

application/json

504

504 Gateway Timeout Error

application/json

post

/returns/{id}

HTTPcURLJavaScriptPython

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": "2026-03-10T04:06:54.775Z",
  "updatedTime": "2026-03-10T04:06:54.775Z",
  "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"
  ]
}