POST
/
return_orders
curl --request POST \
  --url https://app.supercycle.com/api/v1/return_orders \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "data": [
    {
      "rentalId": 123,
      "status": null
    }
  ],
  "quantity": 99,
  "serials": [
    "<string>"
  ],
  "visibility": "available"
}'
{
  "errors": [
    "Invalid request body"
  ],
  "returnOrders": [
    {
      "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.

Body

application/json
data
object[]
required
quantity
integer

Number of items to create.

Required range: x < 100
serials
string[]

Serials will be picked from the list and assigned to items.

visibility
enum<string>
Available options:
available,
unavailable,
retired,
sold

Response

200 - application/json
Expected response to a valid request
errors
string[]
returnOrders
object[]