Returns

PreviousOrder address NextManage a subscription

Last updated 8 months ago

Retrieve all returns for a specified order

get

/v1/shoppers/me/orders/{orderId}/returns

Path parameters

orderIdstringrequired

Provide the order's identifier.

Query parameters

tokenstring

Provide the authorized token for a shopper.

expandstring

Use the expand query parameter when you want additional fields to appear in the response. The expand query parameter provides more fields in the response. Expanding resources reduces the number of API calls required to accomplish a task.

fieldsstring

Specify the fields that you want to appear in the response. Filtering the fields returned in the response can conserve bandwidth and accelerate response time.

formatstring

Override the default format of XML for the Authorize Shopper API. Valid values are XML and JSON.

Header parameters

acceptstring

Specifies the acceptable media type for the response.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.digitalriver.com/v1/shoppers/me/orders/{orderId}/returns'

200

401

404

{
  "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",
          "formattedRefundTotal": "$0.00",
          "formattedOutstandingTotal": "$107.53",
          "formattedRequestedTotal": "$107.53",
          "refundTotal": {
            "currency": "USD",
            "value": 0
          },
          "outstandingTotal": {
            "currency": "USD",
            "value": 107.53
          },
          "requestedTotal": {
            "currency": "USD",
            "value": 107.53
          },
          "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",
                "formattedReturnLITotal": "$107.53",
                "returnLITotal": {
                  "currency": "USD",
                  "value": 107.53
                },
                "lineItem": {
                  "uri": "https://api.digitalriver.com/v1/shoppers/me/orders/793374880082/line-items/793451150082"
                }
              }
            ]
          }
        }
      ]
    }
  ]
}

Successful response.

Request the return of one or more line items in an order

post