Admin API
Conditions
Locations
TimelineComments
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>"
}
]
},
"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>"
}List all returns
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>"
}
]
},
"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>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
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 Response
A paged array of returns
Show child attributes
Show child attributes
Numeric ID of the return.
uncredited, partially_recredited, recredited Show child attributes
Show child attributes
Numeric ID of the customer.
Default address of the customer.
Show child attributes
Show child attributes
Numeric ID of the customer.
Show child attributes
Show child attributes
Numeric ID of the return line.
Status of the return line.
awaiting, received, missing Show child attributes
Show child attributes
Numeric ID of the condition.
Date and time the condition was created.
Severity key of the condition.
Tone of the condition.
Title of the condition.
Show child attributes
Show child attributes
Numeric ID of the item.
processed, unprocessed available, unavailable, sold, retired Show child attributes
Show child attributes
Numeric ID of the condition.
Date and time the condition was created.
Severity key of the condition.
Tone of the condition.
Title of the condition.
ID of the condition. May be null if no condition is set.
Physical location within warehouse using Zone-Aisle-Shelf-Bin format (e.g., "A1-02-B3"). May be null if no pick location is set.
Timeline events for this item
Show child attributes
Show child attributes
Numeric ID of the timeline event.
Numeric ID of the resource associated with the event.
Type of the resource (e.g., Item, Rental, ReturnOrder).
Type of the timeline event.
Additional data associated with the timeline event.
Timestamp when the event was created.
Timestamp when the event was last updated.
Author of the timeline event.
Sequential ID of the return.
Status of the return.
requested, expected, received, in_progress, completed, cancelled unreceived, partially_received, received Return method information
Show child attributes
Show child attributes
Type of return method
ReturnMethod::Collection, ReturnMethod::ReturnLabel Tracking URL for return label method
Shopify address ID for collection method
Collection date for collection method
Timeline events for this return order
Show child attributes
Show child attributes
Numeric ID of the timeline event.
Numeric ID of the resource associated with the event.
Type of the resource (e.g., Item, Rental, ReturnOrder).
Type of the timeline event.
Additional data associated with the timeline event.
Timestamp when the event was created.
Timestamp when the event was last updated.
Author of the timeline event.
Was this page helpful?