curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/api/v1/returns' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"has_more": true,
"limit": 20,
"next_cursor": "string",
"offset": 1,
"returns": [
{
"created_at": "2026-08-31T14:22:05Z",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reason": "Two-person tent, green — replacement for damaged pole set.",
"refund_amount": "49.00",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
],
"total": 102
}
List returns
List of returns
GET
/
api
/
v1
/
returns
curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/api/v1/returns' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"has_more": true,
"limit": 20,
"next_cursor": "string",
"offset": 1,
"returns": [
{
"created_at": "2026-08-31T14:22:05Z",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reason": "Two-person tent, green — replacement for damaged pole set.",
"refund_amount": "49.00",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
],
"total": 102
}
Confirm your deployment before running this request. This page describes an API contract;
a published reference does not establish hosted availability. Check the dated
host report and obtain your deployment URL and credentials.
Replace the example host if your provisioned service uses a different URL.
Query parameters
integer (int32)
Maximum number of results to return (default: 50).
integer (int32)
Number of results to skip (default: 0). Ignored when
after cursor is set.string
Cursor for keyset pagination (opaque token from
next_cursor).string
Filter by order ID (UUID).
string
Filter by customer ID (UUID).
string
Filter by return status (requested, approved, rejected, received, refunded, closed).
string
Filter by return reason (defective,
wrong_item, not_as_described, changed_mind, other).string
Returns created on or after this date (RFC 3339).
string
Returns created on or before this date (RFC 3339).
Response
ReturnListResponse
boolean
required
Whether more results are available after this page.
integer (int32)
required
Minimum:
0.string,null
Opaque cursor for fetching the next page (keyset pagination).
integer (int32)
required
Minimum:
0.ReturnResponse[]
required
integer
required
Minimum:
0.Status codes
| Code | Meaning |
|---|---|
200 | List of returns |
400 | Invalid filter parameter |
Using this contract
Read the source OpenAPI document for declared schemas and alternatives. This page also includes documented corrections from the spec overlays. Example IDs and values are illustrative; replace them with records from your workspace.curl --silent --show-error --fail-with-body --request GET \
--url 'https://api.stateset.com/api/v1/returns' \
--header "Authorization: Bearer $STATESET_API_KEY"
{
"has_more": true,
"limit": 20,
"next_cursor": "string",
"offset": 1,
"returns": [
{
"created_at": "2026-08-31T14:22:05Z",
"customer_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"order_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"reason": "Two-person tent, green — replacement for damaged pole set.",
"refund_amount": "49.00",
"status": "pending",
"updated_at": "2026-08-31T14:22:05Z"
}
],
"total": 102
}
Last modified on September 21, 2026