GET
/
return_orders
List all returns
curl --request GET \
  --url https://app.supercycle.com/api/v1/return_orders \
  --header 'Authorization: Bearer <token>'
{
  "data": [
    {
      "id": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "creditStatus": "uncredited",
      "receivalStatus": "unreceived",
      "customer": {
        "id": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "defaultAddress": null,
        "email": null,
        "firstName": null,
        "lastName": null,
        "shopifyId": 123
      },
      "returnLines": [
        {
          "id": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "condition": null,
          "item": {
            "id": 123,
            "createdAt": "2023-11-07T05:31:56Z",
            "activeRentalId": null,
            "activeReturnId": null,
            "condition": null,
            "conditionId": null,
            "imageUrl": null,
            "location": null,
            "pickLocation": null,
            "productTitle": "<string>",
            "serial": null,
            "sequentialId": 123,
            "shopifyProductId": null,
            "shopifyVariantId": null,
            "status": "processed",
            "tags": [
              "<string>"
            ],
            "variantTitle": null,
            "visibility": "available",
            "timelineEvents": [
              {
                "id": 123,
                "eventableId": 123,
                "eventableType": "<string>",
                "eventType": "<string>",
                "metadata": {},
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "author": "<string>"
              }
            ]
          },
          "rentalId": 123,
          "requestedAt": null,
          "restockedAt": null,
          "status": "awaiting"
        }
      ],
      "requestedAt": null,
      "sequentialId": 123,
      "status": "requested",
      "returnMethod": null,
      "timelineEvents": [
        {
          "id": 123,
          "eventableId": 123,
          "eventableType": "<string>",
          "eventType": "<string>",
          "metadata": {},
          "createdAt": "2023-11-07T05:31:56Z",
          "updatedAt": "2023-11-07T05:31:56Z",
          "author": "<string>"
        }
      ],
      "tags": [
        "<string>"
      ]
    }
  ],
  "nextPage": null
}

Authorizations

​
Authorization
string
header
required

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

Query Parameters

​
limit
integer

A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.

Required range: x <= 100
​
page
string

Cursor token to fetch next page of results.

​
search
string

Filter returns by formatted IDs and customer names

​
status
enum<string>

Filter return orders by status, can be a comma-separated list of statuses

Available options:
requested,
expected,
received,
in_progress,
completed,
cancelled

Response

200 - application/json

A paged array of returns

The response is of type object.