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",
  "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>"
  ]
}

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

The response is of type object.