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",
  "return_lines": [
    {
      "id": 123,
      "status": "awaiting"
    }
  ]
}'
{
  "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",
  "timeline_events": [
    {
      "id": 123,
      "eventableId": 123,
      "eventableType": "<string>",
      "eventType": "<string>",
      "metadata": {},
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z",
      "author": "<string>"
    }
  ]
}

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

Response

200 - application/json
Expected response to a valid request

The response is of type object.