System Status

Fulfillment returns

When Digital River coordinates an order's physical fulfillment, you can use the Fulfillment Returns API to manage the return process.

Gets a fulfillment return by its unique identifier

get

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

Path parameters
idstringRequired

Return ID

Responses
200
OK.
application/json
get
GET /fulfillment-returns/{id} HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "id": "ret_5823594809",
  "createdTime": "2025-07-01T02:30:42.639Z",
  "fulfillmentOrderId": "ord_6645940010",
  "upstreamId": "ord_6645940010",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "inventoryItemId": "5823594809",
      "quantity": 1,
      "quantityAccepted": 1,
      "state": "accepted",
      "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]"
      },
      "unitAttributes": [
        {
          "serialNumber": ".",
          "imeiNumber": ".",
          "simCardNumber": "."
        }
      ],
      "unitAttributesAccepted": [
        {
          "serialNumber": ".",
          "imeiNumber": ".",
          "simCardNumber": "."
        }
      ]
    }
  ],
  "reason": "requested_by_customer",
  "state": "pending",
  "type": "client",
  "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
}

Returns a list of fulfillment returns

get

Get all returns.

Query parameters
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.

upstreamIdsstring[]Optional

Only return objects with these upstreamIds.

statestringOptional

Only return objects in the given state

fulfillmentOrderIdstringOptional

The fulfillment order to retrieve returns for.

inventoryItemIdstringOptional

The inventory item id to retrieve returns for.

Responses
200
200 OK
application/json
get
GET /fulfillment-returns HTTP/1.1
Host: api.digitalriver.com
Accept: */*

{
  "hasMore": true,
  "data": [
    {
      "id": "ret_5823594809",
      "createdTime": "2025-07-01T02:30:42.639Z",
      "fulfillmentOrderId": "ord_6645940010",
      "upstreamId": "ord_6645940010",
      "items": [
        {
          "fulfillmentOrderItemId": "99341140336",
          "inventoryItemId": "5823594809",
          "quantity": 1,
          "quantityAccepted": 1,
          "state": "accepted",
          "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]"
          },
          "unitAttributes": [
            {
              "serialNumber": ".",
              "imeiNumber": ".",
              "simCardNumber": "."
            }
          ],
          "unitAttributesAccepted": [
            {
              "serialNumber": ".",
              "imeiNumber": ".",
              "simCardNumber": "."
            }
          ]
        }
      ],
      "reason": "requested_by_customer",
      "state": "pending",
      "type": "client",
      "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
    }
  ]
}

Creates a return

post

Returns all or part of a previously created fulfillment order.

Body
fulfillmentOrderIdstringRequired

The unique identifier of the fulfillment order associated with the fulfillment return.

Example: 6645940010
upstreamIdstringOptional

The unique identifier of the upstream order.

Example: 6645940010
reasonstringOptional

The reason for the return.

Example: requested_by_customer
Responses
201
201 Created
application/json
post
POST /fulfillment-returns HTTP/1.1
Host: api.digitalriver.com
Content-Type: application/json
Accept: */*
Content-Length: 235

{
  "fulfillmentOrderId": "6645940010",
  "upstreamId": "6645940010",
  "reason": "requested_by_customer",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "quantity": 1,
      "unitAttributes": [
        {
          "serialNumber": ".",
          "imeiNumber": ".",
          "simCardNumber": "."
        }
      ]
    }
  ]
}
{
  "id": "ret_5823594809",
  "createdTime": "2025-07-01T02:30:42.639Z",
  "fulfillmentOrderId": "ord_6645940010",
  "upstreamId": "ord_6645940010",
  "items": [
    {
      "fulfillmentOrderItemId": "99341140336",
      "inventoryItemId": "5823594809",
      "quantity": 1,
      "quantityAccepted": 1,
      "state": "accepted",
      "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]"
      },
      "unitAttributes": [
        {
          "serialNumber": ".",
          "imeiNumber": ".",
          "simCardNumber": "."
        }
      ],
      "unitAttributesAccepted": [
        {
          "serialNumber": ".",
          "imeiNumber": ".",
          "simCardNumber": "."
        }
      ]
    }
  ],
  "reason": "requested_by_customer",
  "state": "pending",
  "type": "client",
  "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
}
PreviousFulfillment ordersNextFulfillments

Last updated