GET
/
return_orders
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",
      "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,
          "rentalId": 123,
          "requestedAt": null,
          "restockedAt": null,
          "status": "awaiting"
        }
      ],
      "requestedAt": null,
      "sequentialId": 123,
      "status": "requested"
    }
  ],
  "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.

Response

200 - application/json
A paged array of returns
​
data
object[]
​
nextPage
string | null
Update a rentalCreate a return