curl --request GET \
--url 'https://prod-api.stateset.cloud.stateset.app/api/v1/returns' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"data": {
"items": [
{
"created_at": "2024-12-09T10:30:00Z",
"id": "880e8400-e29b-41d4-a716-446655440000",
"order_id": "550e8400-e29b-41d4-a716-446655440000",
"reason": "Product arrived damaged - scratches on surface",
"status": "pending",
"updated_at": "2024-12-09T10:30:00Z"
}
],
"limit": 20,
"page": 1,
"total": 49,
"total_pages": 1
},
"errors": [
"string"
],
"message": "Two-person tent, green — replacement for damaged pole set.",
"meta": {
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"timestamp": "2026-08-31T14:22:05Z"
},
"success": true
}
List returns
List returns
GET
/
api
/
v1
/
returns
curl --request GET \
--url 'https://prod-api.stateset.cloud.stateset.app/api/v1/returns' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"data": {
"items": [
{
"created_at": "2024-12-09T10:30:00Z",
"id": "880e8400-e29b-41d4-a716-446655440000",
"order_id": "550e8400-e29b-41d4-a716-446655440000",
"reason": "Product arrived damaged - scratches on surface",
"status": "pending",
"updated_at": "2024-12-09T10:30:00Z"
}
],
"limit": 20,
"page": 1,
"total": 49,
"total_pages": 1
},
"errors": [
"string"
],
"message": "Two-person tent, green — replacement for damaged pole set.",
"meta": {
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"timestamp": "2026-08-31T14:22:05Z"
},
"success": true
}
Query parameters
integer (int64)
Page number (1-indexed)
integer (int64)
Page size (max 100)
string
Optional status filter (case-insensitive)
Response
ApiResponse_PaginatedResponse_ReturnSummary
object
Show data
Show data
object[]
required
Show items
Show items
integer (int64)
required
integer (int64)
required
integer (int64)
required
integer (int64)
required
array,null
string,null
boolean
required
Status codes
| Code | Meaning |
|---|---|
200 | Returns listed |
401 | Unauthorized |
403 | Forbidden |
curl --request GET \
--url 'https://prod-api.stateset.cloud.stateset.app/api/v1/returns' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"data": {
"items": [
{
"created_at": "2024-12-09T10:30:00Z",
"id": "880e8400-e29b-41d4-a716-446655440000",
"order_id": "550e8400-e29b-41d4-a716-446655440000",
"reason": "Product arrived damaged - scratches on surface",
"status": "pending",
"updated_at": "2024-12-09T10:30:00Z"
}
],
"limit": 20,
"page": 1,
"total": 49,
"total_pages": 1
},
"errors": [
"string"
],
"message": "Two-person tent, green — replacement for damaged pole set.",
"meta": {
"request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"timestamp": "2026-08-31T14:22:05Z"
},
"success": true
}
Last modified on August 31, 2026