curl --request GET \
--url 'https://prod-api.stateset.cloud.stateset.app/api/v1/orders' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"data": {
"items": [
{
"billing_address": {
"city": "San Francisco",
"country": "US",
"postal_code": "94102",
"state": "CA",
"street": "123 Main Street"
},
"created_at": "2024-12-09T10:30:00Z",
"currency": "USD",
"customer_id": "123e4567-e89b-12d3-a456-426614174000",
"fulfillment_status": "unfulfilled",
"id": "550e8400-e29b-41d4-a716-446655440000",
"items": [
{
"id": "item-001",
"product_id": "prod-abc123",
"product_name": "Wireless Bluetooth Headphones",
"quantity": 2,
"sku": "WBH-BLK-001",
"tax_amount": "8.00",
"tax_rate": "0.08",
"total_price": "99.98",
"unit_price": "49.99"
}
],
"notes": "Please deliver to back door",
"order_date": "2024-12-09T10:30:00Z",
"order_number": "ORD-2024-001234",
"payment_method_id": "pm_card_visa",
"payment_status": "pending",
"shipping_address": {
"city": "San Francisco",
"country": "US",
"postal_code": "94102",
"state": "CA",
"street": "123 Main Street"
},
"status": "pending",
"total_amount": "149.99",
"updated_at": "2024-12-09T10:30:00Z",
"version": 1
}
],
"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 orders
Get a paginated list of orders with optional filtering, search, and sorting
GET
/
api
/
v1
/
orders
curl --request GET \
--url 'https://prod-api.stateset.cloud.stateset.app/api/v1/orders' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"data": {
"items": [
{
"billing_address": {
"city": "San Francisco",
"country": "US",
"postal_code": "94102",
"state": "CA",
"street": "123 Main Street"
},
"created_at": "2024-12-09T10:30:00Z",
"currency": "USD",
"customer_id": "123e4567-e89b-12d3-a456-426614174000",
"fulfillment_status": "unfulfilled",
"id": "550e8400-e29b-41d4-a716-446655440000",
"items": [
{
"id": "item-001",
"product_id": "prod-abc123",
"product_name": "Wireless Bluetooth Headphones",
"quantity": 2,
"sku": "WBH-BLK-001",
"tax_amount": "8.00",
"tax_rate": "0.08",
"total_price": "99.98",
"unit_price": "49.99"
}
],
"notes": "Please deliver to back door",
"order_date": "2024-12-09T10:30:00Z",
"order_number": "ORD-2024-001234",
"payment_method_id": "pm_card_visa",
"payment_status": "pending",
"shipping_address": {
"city": "San Francisco",
"country": "US",
"postal_code": "94102",
"state": "CA",
"street": "123 Main Street"
},
"status": "pending",
"total_amount": "149.99",
"updated_at": "2024-12-09T10:30:00Z",
"version": 1
}
],
"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
}
Get a paginated list of orders with optional filtering, search, and sorting
Query parameters
integer (int64)
Page number (default: 1)
integer (int64)
Items per page (default: 20, max: 100)
OrderStatus
Filter by order status
string (uuid)
Filter by customer ID
string
Search by order number, notes, or shipping address
string
Only include orders created after this RFC3339 timestamp
string
Only include orders created before this RFC3339 timestamp
OrderSortField
Sort field (created_at, order_date, total_amount, order_number)
SortDirection
Sort direction (asc, desc)
boolean
If true, include line items for each order in the response
Response
ApiResponse_PaginatedResponse_OrderResponse
object
Show data
Show data
object[]
required
Show items
Show items
Address,null
string (date-time)
required
Creation timestamp
string,null
Currency code (ISO 4217)
string
required
Customer identifier (UUID)
string
required
Fulfillment status (unfulfilled, partially_fulfilled, fulfilled)
string
required
Unique order identifier (UUID)
OrderItem[]
required
Order line items
string,null
Order notes
string (date-time)
required
Date when the order was placed
string
required
Human-readable order number
string,null
Payment method identifier
string
required
Payment status (pending, paid, failed, refunded)
string,null
Associated shipment identifier
Address,null
OrderStatus
required
Current order status
string,null
Total order amount
string (date-time)
required
Last update timestamp
integer (int32)
required
Version number for optimistic locking
integer (int64)
required
integer (int64)
required
integer (int64)
required
integer (int64)
required
array,null
string,null
boolean
required
Status codes
| Code | Meaning |
|---|---|
200 | Orders retrieved successfully |
400 | Invalid request parameters |
401 | Unauthorized |
403 | Forbidden |
429 | Rate limit exceeded |
500 | Internal server error |
curl --request GET \
--url 'https://prod-api.stateset.cloud.stateset.app/api/v1/orders' \
--header 'Authorization: Bearer YOUR_API_KEY'
{
"data": {
"items": [
{
"billing_address": {
"city": "San Francisco",
"country": "US",
"postal_code": "94102",
"state": "CA",
"street": "123 Main Street"
},
"created_at": "2024-12-09T10:30:00Z",
"currency": "USD",
"customer_id": "123e4567-e89b-12d3-a456-426614174000",
"fulfillment_status": "unfulfilled",
"id": "550e8400-e29b-41d4-a716-446655440000",
"items": [
{
"id": "item-001",
"product_id": "prod-abc123",
"product_name": "Wireless Bluetooth Headphones",
"quantity": 2,
"sku": "WBH-BLK-001",
"tax_amount": "8.00",
"tax_rate": "0.08",
"total_price": "99.98",
"unit_price": "49.99"
}
],
"notes": "Please deliver to back door",
"order_date": "2024-12-09T10:30:00Z",
"order_number": "ORD-2024-001234",
"payment_method_id": "pm_card_visa",
"payment_status": "pending",
"shipping_address": {
"city": "San Francisco",
"country": "US",
"postal_code": "94102",
"state": "CA",
"street": "123 Main Street"
},
"status": "pending",
"total_amount": "149.99",
"updated_at": "2024-12-09T10:30:00Z",
"version": 1
}
],
"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