curl --request GET \
--url https://app.supercycle.com/api/v1/return_orders \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"creditStatus": "uncredited",
"customer": {
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"shopifyId": 123,
"defaultAddress": "<unknown>",
"email": "<unknown>",
"firstName": "<unknown>",
"lastName": "<unknown>"
},
"returnLines": [
{
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"rentalId": 123,
"status": "awaiting",
"condition": "<unknown>",
"item": {
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"activeRentalId": "<unknown>",
"productTitle": "<string>",
"serial": "<unknown>",
"sequentialId": 123,
"shopifyVariantId": "<unknown>",
"status": "processed",
"tags": [
"<string>"
],
"variantTitle": "<unknown>",
"visibility": "available",
"activeReturnId": "<unknown>",
"condition": "<unknown>",
"conditionId": "<unknown>",
"imageUrl": "<unknown>",
"location": "<unknown>",
"pickLocation": "<unknown>",
"shopifyProductId": "<unknown>",
"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,
"ownerType": "Item",
"definitionId": 123,
"key": "<string>",
"value": "<string>",
"valueJson": "<unknown>"
}
]
},
"requestedAt": "<unknown>",
"restockedAt": "<unknown>"
}
],
"sequentialId": 123,
"status": "requested",
"receivalStatus": "unreceived",
"requestedAt": "<unknown>",
"returnMethod": "<unknown>",
"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>"
]
}
],
"nextPage": "<unknown>"
}Get a list of returns, their details and items, given parameters. Used by merchants to list registered returns to start, or check if an item already exists in a return.
curl --request GET \
--url https://app.supercycle.com/api/v1/return_orders \
--header 'Authorization: Bearer <token>'{
"data": [
{
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"creditStatus": "uncredited",
"customer": {
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"shopifyId": 123,
"defaultAddress": "<unknown>",
"email": "<unknown>",
"firstName": "<unknown>",
"lastName": "<unknown>"
},
"returnLines": [
{
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"rentalId": 123,
"status": "awaiting",
"condition": "<unknown>",
"item": {
"id": 123,
"createdAt": "2023-11-07T05:31:56Z",
"activeRentalId": "<unknown>",
"productTitle": "<string>",
"serial": "<unknown>",
"sequentialId": 123,
"shopifyVariantId": "<unknown>",
"status": "processed",
"tags": [
"<string>"
],
"variantTitle": "<unknown>",
"visibility": "available",
"activeReturnId": "<unknown>",
"condition": "<unknown>",
"conditionId": "<unknown>",
"imageUrl": "<unknown>",
"location": "<unknown>",
"pickLocation": "<unknown>",
"shopifyProductId": "<unknown>",
"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,
"ownerType": "Item",
"definitionId": 123,
"key": "<string>",
"value": "<string>",
"valueJson": "<unknown>"
}
]
},
"requestedAt": "<unknown>",
"restockedAt": "<unknown>"
}
],
"sequentialId": 123,
"status": "requested",
"receivalStatus": "unreceived",
"requestedAt": "<unknown>",
"returnMethod": "<unknown>",
"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>"
]
}
],
"nextPage": "<unknown>"
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 50.
x <= 100Cursor token to fetch next page of results.
Filter returns by formatted IDs and customer names
Filter return orders by status, can be a comma-separated list of statuses
requested, expected, received, in_progress, completed, cancelled Was this page helpful?