PUT
/
return_orders
/
{return_order_id}
curl --request PUT \
  --url https://app.supercycle.com/api/v1/return_orders/{return_order_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "requested"
}'
{
  "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"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
return_order_id
integer
required

Numeric ID of the return to retrieve.

Body

application/json
​
status
enum<string>
Available options:
requested,
expected,
received,
in_progress,
completed,
cancelled

Response

200 - application/json
Expected response to a valid request
​
id
integer
required

Numeric ID of the return.

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

Sequential ID of the return.

​
status
enum<string>
required

Status of the return.

Available options:
requested,
expected,
received,
in_progress,
completed,
cancelled
​
requestedAt
string | null
Retrieve a return