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

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
returnOrderId
integer
required

Numeric ID of the return to retrieve.

Response

200 - application/json

Expected response to a valid request

​
id
integer<int64>
required

Numeric ID of the return.

​
createdAt
string<date-time>
required
​
creditStatus
enum<string>
required
Available options:
uncredited,
partially_recredited,
recredited
​
customer
object
required
​
returnLines
object[]
required
​
sequentialId
integer<int32>
required

Sequential ID of the return.

​
status
enum<string>
required

Status of the return.

Available options:
requested,
expected,
received,
in_progress,
completed,
cancelled
​
receivalStatus
enum<string>
Available options:
unreceived,
partially_received,
received
​
requestedAt
null | string<date-time>
​
returnMethod
object

Return method information

​
timelineEvents
object[]

Timeline events for this return order

​
tags
string[]