Creating a return

Learn how to create a return for a specified order.

Use the reate a return a specified order.

cURL

curl --location --globoff 'api.digitalriver.com/v1/shoppers/me/orders/{orderId}/returns' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer <<full access token>>' \
--data '{
    "return": {
        "reason": "DUPLICATE_ORDER",
        "comments": "Duplicate Order",
        "acceptELOD": "true",
        "returnLineItems": {
            "returnLineItem": [
                {
                    "lineItemQuantityIDs": [
                        1
                    ],
                    "lineItem": {
                        "id": "123",
                        "quantity": 1
                    }
                }
            ]
        }
    }
}  

200 OK response

A successful request returns a 200 response code:

{
  "returns": [
    {
      "return": [
        {
          "id": 6654727889,
          "reason": "DUPLICATE_ORDER",
          "comments": "Shopper initiated self service return-",
          "type": "LineItemLevelReturnProduct",
          "status": "RefundedWithoutReturn",
          "generationDate": "2020-01-30T17:37:09.000Z",
          "generatedBy": "56066c6b-139b-47ff-9b07-1c799c10ea75",
          "origin": "SHOPPER",
          "policy": "LOD",
          "dateRefunded": "In Process",
          "refundTotal": {
            "currency": "USD",
            "value": 0
          },
          "formattedRefundTotal": "0.00USD",
          "outstandingTotal": {
            "currency": "USD",
            "value": 107.53
          },
          "formattedOutstandingTotal": "107.53USD",
          "requestedTotal": {
            "currency": "USD",
            "value": 107.53
          },
          "formattedRequestedTotal": "107.53USD",
          "returnLineItems": {
            "returnLineItem": [
              {
                "dueDate": "2020-02-07T05:59:59.000Z",
                "expectedQty": 1,
                "returnedQty": 1,
                "type": 100409,
                "notes": "LOD_REFUNDED-2020-02-07T05:59:59.000Z",
                "date": "2020-01-30T17:37:09.000Z",
                "status": "RefundedWithoutReturn",
                "returnLITotal": {
                  "currency": "USD",
                  "value": 107.53
                },
                "formattedReturnLITotal": "107.53USD",
                "lineItem": {
                  "uri": "https://api.digitalriver.com/v1/shoppers/me/orders/793374880082/line-items/793451150082"
                }
              }
            ]
          }
        }
      ]
    }
  ]
}