Skip to main content
POST
/
return_orders
Create a return
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
    }
  ],
  "returnMethodAttributes": {
    "trackingUrl": "<string>",
    "addressShopifyId": 123,
    "collectionDate": "2023-12-25"
  },
  "quantity": 99,
  "serials": [
    "<string>"
  ]
}
'
{
  "errors": [
    "Invalid request body"
  ],
  "returnOrders": [
    {
      "id": 123,
      "createdAt": "2023-11-07T05:31:56Z",
      "customer": {
        "id": 123,
        "createdAt": "2023-11-07T05:31:56Z",
        "shopifyId": 123,
        "defaultAddress": {
          "customerId": 123,
          "default": true,
          "firstName": "<string>",
          "lastName": "<string>",
          "company": "<string>",
          "address1": "<string>",
          "address2": "<string>",
          "city": "<string>",
          "province": "<string>",
          "country": "<string>",
          "zip": "<string>",
          "phone": "<string>",
          "name": "<string>",
          "provinceCode": "<string>",
          "countryCode": "<string>",
          "countryName": "<string>"
        },
        "email": "<string>",
        "firstName": "<string>",
        "lastName": "<string>"
      },
      "returnLines": [
        {
          "id": 123,
          "createdAt": "2023-11-07T05:31:56Z",
          "rentalId": 123,
          "condition": {
            "id": 123,
            "createdAt": "2023-11-07T05:31:56Z",
            "severityKey": "<string>",
            "severityTone": "<string>",
            "title": "<string>"
          },
          "item": {
            "id": 123,
            "createdAt": "2023-11-07T05:31:56Z",
            "activeRentalId": 123,
            "productTitle": "<string>",
            "serial": "<string>",
            "sequentialId": 123,
            "shopifyVariantId": 123,
            "tags": [
              "<string>"
            ],
            "variantTitle": "<string>",
            "activeReturnId": 123,
            "condition": {
              "id": 123,
              "createdAt": "2023-11-07T05:31:56Z",
              "severityKey": "<string>",
              "severityTone": "<string>",
              "title": "<string>"
            },
            "conditionId": 123,
            "imageUrl": "<string>",
            "location": {
              "shopifyId": 123,
              "name": "<string>"
            },
            "pickLocation": "<string>",
            "shopifyProductId": 123,
            "timelineEvents": [
              {
                "id": 123,
                "eventableId": 123,
                "eventableType": "<string>",
                "eventType": "<string>",
                "metadata": {},
                "createdAt": "2023-11-07T05:31:56Z",
                "updatedAt": "2023-11-07T05:31:56Z",
                "author": "<string>"
              }
            ],
            "customFields": [
              {
                "id": 123,
                "ownerId": 123,
                "definitionId": 123,
                "key": "<string>",
                "value": "<string>",
                "valueJson": "<unknown>"
              }
            ]
          },
          "requestedAt": "2023-11-07T05:31:56Z",
          "restockedAt": "2023-11-07T05:31:56Z"
        }
      ],
      "sequentialId": 123,
      "requestedAt": "2023-11-07T05:31:56Z",
      "returnMethod": {
        "trackingUrl": "<string>",
        "addressShopifyId": 123,
        "collectionDate": "2023-12-25"
      },
      "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>"
      ]
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.supercycle.com/llms.txt

Use this file to discover all available pages before exploring further.

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
​
returnMethodAttributes
object

Return method attributes for creating return with specific method

​
quantity
integer<int32>

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

Expected response to a valid request

​
errors
string[]
​
returnOrders
object[]