List Returns

List returns, sorted by most recent to least recent.

GET /stores/{storeId}/returns

List Returns

cURL

curl --request GET \
  --url https://api.getredo.com/v2.2/stores/{storeId}/returns \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.getredo.com/v2.2/stores/{storeId}/returns"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.getredo.com/v2.2/stores/{storeId}/returns', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.getredo.com/v2.2/stores/{storeId}/returns",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.getredo.com/v2.2/stores/{storeId}/returns"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.getredo.com/v2.2/stores/{storeId}/returns")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.getredo.com/v2.2/stores/{storeId}/returns")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "orders": [
    {
      "customer": {
        "name": {
          "given": "<string>",
          "surname": "<string>"
        },
        "emailAddress": "[e-mail]",
        "phoneNumber": "<string>"
      },
      "discounts": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "id": "64e4da943dd822979a70bd12",
      "items": [
        {
          "fulfillmentLocationId": "123",
          "id": "<string>",
          "price": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "product": {
            "name": "<string>",
            "externalId": "<string>"
          },
          "quantity": 1,
          "variant": {
            "name": "<string>",
            "externalId": "<string>",
            "sku": "<string>",
            "weight": {
              "kg": 1
            }
          },
          "externalId": "123"
        }
      ],
      "lineItemsTotal": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "name": "<string>",
      "shippingCost": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "taxes": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "total": {
        "amount": "<string>",
        "currency": "<string>"
      },
      "externalId": "<string>"
    }
  ],
  "returns": [
    {
      "createdAt": "2023-11-07T05:31:56Z",
      "destination": {
        "mailingAddress": {
          "city": "<string>",
          "country": "<string>",
          "line1": "<string>",
          "postalCode": "<string>",
          "state": "<string>",
          "line2": ""
        },
        "phoneNumber": "<string>"
      },
      "giftCards": [
        {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          },
          "code": "<string>",
          "externalId": "<string>"
        }
      ],
      "id": "<string>",
      "items": [
        {
          "id": "<string>",
          "orderItem": {
            "id": "<string>",
            "line_item_id": "<string>"
          },
          "quantity": 123,
          "reason": "<string>",
          "customerComment": "<string>",
          "exchangeItem": {
            "product": {
              "externalId": "<string>",
              "name": "<string>"
            },
            "quantity": 123,
            "variant": {
              "externalId": "<string>",
              "name": "<string>"
            }
          },
          "grade": "<string>",
          "greenReturn": true,
          "outcome": "<string>",
          "shipmentGroupIds": [
            "<string>"
          ],
          "externalIdentifier": "<string>",
          "externalReturnLineItemId": "<string>",
          "productId": "<string>",
          "reasonCode": "<string>",
          "reasons": [
            "<string>"
          ],
          "reasonCodes": [
            "<string>"
          ],
          "productAdjustment": "<string>",
          "multipleChoiceQuestions": [
            {
              "question": "<string>",
              "answer": "<string>"
            }
          ],
          "assessments": [
            {
              "assignedUser": {
                "id": "<string>",
                "name": "<string>",
                "firstName": "<string>",
                "lastName": "<string>",
                "email": "<string>"
              },
              "responses": [
                {
                  "type": "<string>",
                  "value": "<string>"
                }
              ]
            }
          ],
          "refund": {
            "amount": {
              "amount": "<string>",
              "currency": "<string>"
            },
            "type": "<string>"
          },
          "productValueNoTaxNoAdjustment": {
            "amount": {
              "amount": "<string>",
              "currency": "<string>"
            }
          },
          "sku": "<string>",
          "upc": "<string>",
          "status": "<string>",
          "variantId": "<string>"
        }
      ],
      "order": {
        "id": "64e4da943dd822979a70bd12",
        "name": "<string>"
      },
      "source": {
        "emailAddress": "[e-mail]",
        "mailingAddress": {
          "city": "<string>",
          "country": "<string>",
          "line1": "<string>",
          "postalCode": "<string>",
          "state": "<string>",
          "line2": ""
        },
        "name": {
          "given": "<string>",
          "surname": "<string>"
        },
        "phoneNumber": "<string>"
      },
      "status": "open",
      "updatedAt": "2023-11-07T05:31:56Z",
      "compensationMethods": [],
      "completeWithNoAction": true,
      "exchange": {
        "items": [
          {
            "id": "<string>",
            "quantity": 1,
            "variant": {
              "name": "<string>",
              "externalId": "<string>",
              "sku": "<string>",
              "weight": {
                "kg": 1
              }
            },
            "originalPrice": {
              "amount": "<string>",
              "currency": "<string>"
            },
            "price": {
              "amount": "<string>",
              "currency": "<string>",
              "tax": "<string>"
            },
            "product": {
              "name": "<string>",
              "externalId": "<string>"
            }
          }
        ],
        "provision": "deferred",
        "itemCount": 123,
        "order": {
          "externalId": "<string>"
        },
        "totalTax": {
          "amount": "<string>",
          "currency": "<string>"
        }
      },
      "externalOrderIds": [
        "<string>"
      ],
      "internalCreatedByName": "<string>",
      "notes": [
        {
          "message": "<string>",
          "image": "<string>"
        }
      ],
      "shipment": {
        "carrier": "<string>",
        "tracker": "<string>",
        "trackingUrl": "<string>",
        "postageLabel": "<string>",
        "formLabel": "<string>",
        "shipmentGroupId": "<string>",
        "itemIds": [
          "<string>"
        ],
        "externalLocationId": "<string>",
        "estimatedDeliveryDate": "<string>",
        "deliveredAt": "<string>"
      },
      "shipments": [
        {
          "carrier": "<string>",
          "tracker": "<string>",
          "trackingUrl": "<string>",
          "postageLabel": "<string>",
          "formLabel": "<string>",
          "shipmentGroupId": "<string>",
          "itemIds": [
            "<string>"
          ],
          "externalLocationId": "<string>",
          "estimatedDeliveryDate": "<string>",
          "deliveredAt": "<string>"
        }
      ],
      "dropoffs": [
        {
          "shipmentGroupId": "<string>",
          "provider": "<string>",
          "qrCode": "<string>",
          "qrCodeUrl": "<string>"
        }
      ],
      "shopifyOrderIds": [
        "<string>"
      ],
      "tags": [
        {
          "name": "<string>",
          "source": "<string>"
        }
      ],
      "totals": {
        "charge": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        },
        "exchange": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        },
        "refund": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        },
        "storeCredit": {
          "amount": {
            "amount": "<string>",
            "currency": "<string>"
          }
        }
      },
      "type": "return"
    }
  ]
}

{
  "detail": "<string>",
  "instance": "<string>",
  "title": "<string>",
  "type": "about:blank"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Page-Continue · string

Page marker, from X-Page-Next header

X-Page-Size · integer

Page size, defaults to 20

Required range: 1 <= x <= 500

Path Parameters

storeId · string · required

Store ID

Example:

"64e5a8a1af49a89df37e4ee7"

Query Parameters

updated_at_max · string<date-time>

Maximum updated time, exclusive

updated_at_min · string<date-time>

Minimum updated time, inclusive

shopify_order_name · string

Shopify specific order name

Example:

"XYZ1025"

provider_order_name · string

Provider specific order name

Example:

"XYZ1025"

status · enum<string>

Filter returns by status Return status.

• open: Return has been approved and is awaiting shipment.
• in_transit: Return shipment is in transit.
• delivered: Return shipment has been delivered and awaiting processing.
• needs_review: Return requires review before further action.
• in_review: Return is currently being reviewed.
• complete: The return has been completed successfully.
• rejected: The return has been rejected.
• flagged: A problem with return processing requires merchant action.
• pre_shipment: Return requires pre-shipment merchant authorization.
• deleted: The return has been deleted (Reset).

Available options: open, in_transit, delivered, needs_review, in_review, complete, rejected, flagged, pre_shipment, deleted

Example:

"open"

Response

200

application/json

Success

orders · Order · object[] · required

Show child attributes

returns · Return · object[] · required

Show child attributes