Skip to main content
GET
/
v1
/
products
curl --location --request GET 'https://api.stateset.com/v1/products?limit=10&status=active&category=Electronics' \
--header 'Authorization: Bearer YOUR_API_KEY'

{
  "object": "list",
  "data": [
    {
      "id": "prod_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
      "object": "product",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T14:22:00Z",
      "name": "Wireless Bluetooth Headphones",
      "sku": "WBH-001",
      "description": "Premium noise-cancelling wireless headphones with 30-hour battery life",
      "category": "Electronics",
      "brand": "AudioTech",
      "status": "active",
      "price": {
        "amount": 14999,
        "currency": "USD",
        "compare_at": 19999
      },
      "inventory_summary": {
        "total_quantity": 150,
        "available_quantity": 145,
        "reserved_quantity": 5
      },
      "tags": ["electronics", "audio", "wireless", "bluetooth"]
    },
    {
      "id": "prod_1234567890abcdef",
      "object": "product",
      "created_at": "2024-01-14T09:15:00Z",
      "updated_at": "2024-01-14T09:15:00Z",
      "name": "USB-C Charging Cable",
      "sku": "USB-C-001",
      "description": "Fast charging USB-C cable, 6ft length",
      "category": "Electronics",
      "brand": "TechConnect",
      "status": "active",
      "price": {
        "amount": 1299,
        "currency": "USD",
        "compare_at": null
      },
      "inventory_summary": {
        "total_quantity": 500,
        "available_quantity": 487,
        "reserved_quantity": 13
      },
      "tags": ["electronics", "cables", "charging"]
    }
  ],
  "has_more": true,
  "total_count": 42,
  "next_cursor": "eyJpZCI6InByb2RfMTIzNDU2Nzg5MGFiY2RlZiJ9"
}

Documentation Index

Fetch the complete documentation index at: https://docs.stateset.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Query Parameters

​
limit
integer
Number of products to return (default: 20, max: 100)
​
offset
integer
Number of products to skip (for pagination)
​
cursor
string
Cursor for pagination (alternative to offset)
​
status
string
Filter by status: “active”, “draft”, or “archived”
​
category
string
Filter by product category
​
brand
string
Filter by brand name
​
search
string
Search products by name, SKU, or description
​
sku
string
Filter by exact SKU match
​
tags
string
Filter by tags (comma-separated)
​
price_min
integer
Minimum price filter (in cents)
​
price_max
integer
Maximum price filter (in cents)
​
in_stock
boolean
Filter products with available inventory
​
low_stock
boolean
Filter products below low stock threshold
​
created_after
string
Filter products created after this date (ISO 8601)
​
created_before
string
Filter products created before this date (ISO 8601)
​
updated_after
string
Filter products updated after this date (ISO 8601)
​
sort_by
string
Sort field: “created_at”, “updated_at”, “name”, “price”, “sku” (default: “created_at”)
​
sort_order
string
Sort order: “asc” or “desc” (default: “desc”)
​
include_variants
boolean
Include variant details in response (default: false)
​
include_inventory
boolean
Include inventory summary (default: false)

​
Response

​
object
string
Always “list”
​
data
array
Array of product objects
​
has_more
boolean
Whether there are more products to retrieve
​
total_count
integer
Total number of products matching the filters
​
next_cursor
string
Cursor for retrieving the next page
curl --location --request GET 'https://api.stateset.com/v1/products?limit=10&status=active&category=Electronics' \
--header 'Authorization: Bearer YOUR_API_KEY'

{
  "object": "list",
  "data": [
    {
      "id": "prod_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
      "object": "product",
      "created_at": "2024-01-15T10:30:00Z",
      "updated_at": "2024-01-15T14:22:00Z",
      "name": "Wireless Bluetooth Headphones",
      "sku": "WBH-001",
      "description": "Premium noise-cancelling wireless headphones with 30-hour battery life",
      "category": "Electronics",
      "brand": "AudioTech",
      "status": "active",
      "price": {
        "amount": 14999,
        "currency": "USD",
        "compare_at": 19999
      },
      "inventory_summary": {
        "total_quantity": 150,
        "available_quantity": 145,
        "reserved_quantity": 5
      },
      "tags": ["electronics", "audio", "wireless", "bluetooth"]
    },
    {
      "id": "prod_1234567890abcdef",
      "object": "product",
      "created_at": "2024-01-14T09:15:00Z",
      "updated_at": "2024-01-14T09:15:00Z",
      "name": "USB-C Charging Cable",
      "sku": "USB-C-001",
      "description": "Fast charging USB-C cable, 6ft length",
      "category": "Electronics",
      "brand": "TechConnect",
      "status": "active",
      "price": {
        "amount": 1299,
        "currency": "USD",
        "compare_at": null
      },
      "inventory_summary": {
        "total_quantity": 500,
        "available_quantity": 487,
        "reserved_quantity": 13
      },
      "tags": ["electronics", "cables", "charging"]
    }
  ],
  "has_more": true,
  "total_count": 42,
  "next_cursor": "eyJpZCI6InByb2RfMTIzNDU2Nzg5MGFiY2RlZiJ9"
}