StateSet API Docs

curl --location --request POST 'https://api.stateset.com/api/v1/products' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data-raw '{
    "name": "Wireless Bluetooth Headphones",
    "sku": "WBH-001",
    "description": "Premium noise-cancelling wireless headphones with 30-hour battery life",
    "category": "Electronics",
    "brand": "AudioTech",
    "price": {
        "amount": 14999,
        "currency": "USD",
        "compare_at": 19999
    },
    "cost": {
        "amount": 7500,
        "currency": "USD"
    },
    "inventory": {
        "track_inventory": true,
        "quantity": 150,
        "low_stock_threshold": 20,
        "allow_backorder": false
    },
    "dimensions": {
        "weight": 0.5,
        "length": 8,
        "width": 7,
        "height": 3
    },
    "variants": [
        {
            "sku": "WBH-001-BLK",
            "name": "Wireless Bluetooth Headphones - Black",
            "options": {
                "color": "Black"
            },
            "inventory": {
                "quantity": 100
            }
        },
        {
            "sku": "WBH-001-WHT",
            "name": "Wireless Bluetooth Headphones - White",
            "options": {
                "color": "White"
            },
            "inventory": {
                "quantity": 50
            }
        }
    ],
    "images": [
        {
            "url": "https://example.com/images/headphones-main.jpg",
            "alt_text": "Wireless Bluetooth Headphones",
            "position": 1
        }
    ],
    "tags": ["electronics", "audio", "wireless", "bluetooth"]
}'

mutation CreateProduct {
  createProduct(input: {
    name: "Wireless Bluetooth Headphones"
    sku: "WBH-001"
    description: "Premium noise-cancelling wireless headphones with 30-hour battery life"
    category: "Electronics"
    brand: "AudioTech"
    price: {
      amount: 14999
      currency: "USD"
      compare_at: 19999
    }
    inventory: {
      track_inventory: true
      quantity: 150
      low_stock_threshold: 20
    }
  }) {
    id
    name
    sku
    status
    inventory_summary {
      total_quantity
      available_quantity
      reserved_quantity
    }
  }
}

const product = await stateset.products.create({
  name: "Wireless Bluetooth Headphones",
  sku: "WBH-001",
  description: "Premium noise-cancelling wireless headphones with 30-hour battery life",
  category: "Electronics",
  brand: "AudioTech",
  price: {
    amount: 14999,
    currency: "USD",
    compare_at: 19999
  },
  inventory: {
    track_inventory: true,
    quantity: 150,
    low_stock_threshold: 20,
    allow_backorder: false
  },
  variants: [
    {
      sku: "WBH-001-BLK",
      name: "Wireless Bluetooth Headphones - Black",
      options: { color: "Black" },
      inventory: { quantity: 100 }
    },
    {
      sku: "WBH-001-WHT",
      name: "Wireless Bluetooth Headphones - White",
      options: { color: "White" },
      inventory: { quantity: 50 }
    }
  ]
});

product = stateset.products.create({
    "name": "Wireless Bluetooth Headphones",
    "sku": "WBH-001",
    "description": "Premium noise-cancelling wireless headphones with 30-hour battery life",
    "category": "Electronics",
    "brand": "AudioTech",
    "price": {
        "amount": 14999,
        "currency": "USD",
        "compare_at": 19999
    },
    "inventory": {
        "track_inventory": True,
        "quantity": 150,
        "low_stock_threshold": 20,
        "allow_backorder": False
    }
})

{
  "id": "prod_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
  "object": "product",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30: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
  },
  "cost": {
    "amount": 7500,
    "currency": "USD"
  },
  "inventory": {
    "track_inventory": true,
    "low_stock_threshold": 20,
    "allow_backorder": false
  },
  "inventory_summary": {
    "total_quantity": 150,
    "available_quantity": 150,
    "reserved_quantity": 0,
    "by_warehouse": {
      "wh_001": {
        "available": 150,
        "reserved": 0
      }
    }
  },
  "variants": [
    {
      "id": "var_1234567890",
      "sku": "WBH-001-BLK",
      "name": "Wireless Bluetooth Headphones - Black",
      "options": {
        "color": "Black"
      },
      "inventory": {
        "quantity": 100,
        "available": 100,
        "reserved": 0
      }
    },
    {
      "id": "var_0987654321",
      "sku": "WBH-001-WHT",
      "name": "Wireless Bluetooth Headphones - White",
      "options": {
        "color": "White"
      },
      "inventory": {
        "quantity": 50,
        "available": 50,
        "reserved": 0
      }
    }
  ],
  "images": [
    {
      "id": "img_abc123",
      "url": "https://example.com/images/headphones-main.jpg",
      "alt_text": "Wireless Bluetooth Headphones",
      "position": 1
    }
  ],
  "tags": ["electronics", "audio", "wireless", "bluetooth"],
  "metadata": {}
}

POST

api

products

curl --location --request POST 'https://api.stateset.com/api/v1/products' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data-raw '{
    "name": "Wireless Bluetooth Headphones",
    "sku": "WBH-001",
    "description": "Premium noise-cancelling wireless headphones with 30-hour battery life",
    "category": "Electronics",
    "brand": "AudioTech",
    "price": {
        "amount": 14999,
        "currency": "USD",
        "compare_at": 19999
    },
    "cost": {
        "amount": 7500,
        "currency": "USD"
    },
    "inventory": {
        "track_inventory": true,
        "quantity": 150,
        "low_stock_threshold": 20,
        "allow_backorder": false
    },
    "dimensions": {
        "weight": 0.5,
        "length": 8,
        "width": 7,
        "height": 3
    },
    "variants": [
        {
            "sku": "WBH-001-BLK",
            "name": "Wireless Bluetooth Headphones - Black",
            "options": {
                "color": "Black"
            },
            "inventory": {
                "quantity": 100
            }
        },
        {
            "sku": "WBH-001-WHT",
            "name": "Wireless Bluetooth Headphones - White",
            "options": {
                "color": "White"
            },
            "inventory": {
                "quantity": 50
            }
        }
    ],
    "images": [
        {
            "url": "https://example.com/images/headphones-main.jpg",
            "alt_text": "Wireless Bluetooth Headphones",
            "position": 1
        }
    ],
    "tags": ["electronics", "audio", "wireless", "bluetooth"]
}'

mutation CreateProduct {
  createProduct(input: {
    name: "Wireless Bluetooth Headphones"
    sku: "WBH-001"
    description: "Premium noise-cancelling wireless headphones with 30-hour battery life"
    category: "Electronics"
    brand: "AudioTech"
    price: {
      amount: 14999
      currency: "USD"
      compare_at: 19999
    }
    inventory: {
      track_inventory: true
      quantity: 150
      low_stock_threshold: 20
    }
  }) {
    id
    name
    sku
    status
    inventory_summary {
      total_quantity
      available_quantity
      reserved_quantity
    }
  }
}

const product = await stateset.products.create({
  name: "Wireless Bluetooth Headphones",
  sku: "WBH-001",
  description: "Premium noise-cancelling wireless headphones with 30-hour battery life",
  category: "Electronics",
  brand: "AudioTech",
  price: {
    amount: 14999,
    currency: "USD",
    compare_at: 19999
  },
  inventory: {
    track_inventory: true,
    quantity: 150,
    low_stock_threshold: 20,
    allow_backorder: false
  },
  variants: [
    {
      sku: "WBH-001-BLK",
      name: "Wireless Bluetooth Headphones - Black",
      options: { color: "Black" },
      inventory: { quantity: 100 }
    },
    {
      sku: "WBH-001-WHT",
      name: "Wireless Bluetooth Headphones - White",
      options: { color: "White" },
      inventory: { quantity: 50 }
    }
  ]
});

product = stateset.products.create({
    "name": "Wireless Bluetooth Headphones",
    "sku": "WBH-001",
    "description": "Premium noise-cancelling wireless headphones with 30-hour battery life",
    "category": "Electronics",
    "brand": "AudioTech",
    "price": {
        "amount": 14999,
        "currency": "USD",
        "compare_at": 19999
    },
    "inventory": {
        "track_inventory": True,
        "quantity": 150,
        "low_stock_threshold": 20,
        "allow_backorder": False
    }
})

{
  "id": "prod_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
  "object": "product",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30: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
  },
  "cost": {
    "amount": 7500,
    "currency": "USD"
  },
  "inventory": {
    "track_inventory": true,
    "low_stock_threshold": 20,
    "allow_backorder": false
  },
  "inventory_summary": {
    "total_quantity": 150,
    "available_quantity": 150,
    "reserved_quantity": 0,
    "by_warehouse": {
      "wh_001": {
        "available": 150,
        "reserved": 0
      }
    }
  },
  "variants": [
    {
      "id": "var_1234567890",
      "sku": "WBH-001-BLK",
      "name": "Wireless Bluetooth Headphones - Black",
      "options": {
        "color": "Black"
      },
      "inventory": {
        "quantity": 100,
        "available": 100,
        "reserved": 0
      }
    },
    {
      "id": "var_0987654321",
      "sku": "WBH-001-WHT",
      "name": "Wireless Bluetooth Headphones - White",
      "options": {
        "color": "White"
      },
      "inventory": {
        "quantity": 50,
        "available": 50,
        "reserved": 0
      }
    }
  ],
  "images": [
    {
      "id": "img_abc123",
      "url": "https://example.com/images/headphones-main.jpg",
      "alt_text": "Wireless Bluetooth Headphones",
      "position": 1
    }
  ],
  "tags": ["electronics", "audio", "wireless", "bluetooth"],
  "metadata": {}
}

This endpoint creates a new product and automatically initializes inventory tracking. Products support multiple variants and can be associated with suppliers and categories.

Authentication

This endpoint requires a valid API key with products:write permissions.

Authorization: Bearer YOUR_API_KEY

Request Body

string

required

Product name for display

string

required

Unique stock keeping unit (SKU) identifier

string

Detailed product description

string

Product category (e.g., “Electronics”, “Clothing”, “Home & Garden”)

string

Brand or manufacturer name

object

required

Pricing information

Show Price object properties

integer

required

Price in cents (e.g., 1999 for $19.99)

string

required

ISO 4217 currency code (e.g., “USD”, “EUR”)

integer

Original price for displaying discounts

object

Cost information for margin calculations

Show Cost object properties

integer

Cost in cents

string

ISO 4217 currency code

object

Inventory settings

Show Inventory object properties

boolean

Whether to track inventory levels (default: true)

integer

Initial stock quantity

integer

Threshold for low stock alerts

boolean

Whether to allow orders when out of stock

string

Primary warehouse ID for this product

object

Product dimensions for shipping calculations

Show Dimensions object properties

number

Weight in pounds

number

Length in inches

number

Width in inches

number

Height in inches

array

Product variants (e.g., different sizes, colors)

Show Variant object properties

string

required

Variant SKU

string

required

Variant name

object

required

Variant options (e.g., size: “M”, color: “Blue”)

object

Variant-specific pricing (overrides base product price)

object

Variant-specific inventory settings

string

UPC, EAN, or other barcode

array

Product images

Show Image object properties

string

required

Image URL

string

Alt text for accessibility

integer

Display order (1-based)

array

Associated variant IDs

object

Supplier information

Show Supplier object properties

string

Existing supplier ID

string

Supplier’s SKU for this product

integer

Expected days for reordering

integer

Minimum quantity for supplier orders

object

Additional custom fields as key-value pairs

array

Array of string tags for categorization and search

string

Product status: “active”, “draft”, or “archived” (default: “active”)

Response

string

Unique product identifier

string

Always “product”

string

ISO 8601 timestamp of creation

string

ISO 8601 timestamp of last update

string

Product name

string

Product SKU

string

Product status

array

Array of product variants with their IDs

object

Summary of inventory across all variants

curl --location --request POST 'https://api.stateset.com/api/v1/products' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_API_KEY' \
--data-raw '{
    "name": "Wireless Bluetooth Headphones",
    "sku": "WBH-001",
    "description": "Premium noise-cancelling wireless headphones with 30-hour battery life",
    "category": "Electronics",
    "brand": "AudioTech",
    "price": {
        "amount": 14999,
        "currency": "USD",
        "compare_at": 19999
    },
    "cost": {
        "amount": 7500,
        "currency": "USD"
    },
    "inventory": {
        "track_inventory": true,
        "quantity": 150,
        "low_stock_threshold": 20,
        "allow_backorder": false
    },
    "dimensions": {
        "weight": 0.5,
        "length": 8,
        "width": 7,
        "height": 3
    },
    "variants": [
        {
            "sku": "WBH-001-BLK",
            "name": "Wireless Bluetooth Headphones - Black",
            "options": {
                "color": "Black"
            },
            "inventory": {
                "quantity": 100
            }
        },
        {
            "sku": "WBH-001-WHT",
            "name": "Wireless Bluetooth Headphones - White",
            "options": {
                "color": "White"
            },
            "inventory": {
                "quantity": 50
            }
        }
    ],
    "images": [
        {
            "url": "https://example.com/images/headphones-main.jpg",
            "alt_text": "Wireless Bluetooth Headphones",
            "position": 1
        }
    ],
    "tags": ["electronics", "audio", "wireless", "bluetooth"]
}'

mutation CreateProduct {
  createProduct(input: {
    name: "Wireless Bluetooth Headphones"
    sku: "WBH-001"
    description: "Premium noise-cancelling wireless headphones with 30-hour battery life"
    category: "Electronics"
    brand: "AudioTech"
    price: {
      amount: 14999
      currency: "USD"
      compare_at: 19999
    }
    inventory: {
      track_inventory: true
      quantity: 150
      low_stock_threshold: 20
    }
  }) {
    id
    name
    sku
    status
    inventory_summary {
      total_quantity
      available_quantity
      reserved_quantity
    }
  }
}

const product = await stateset.products.create({
  name: "Wireless Bluetooth Headphones",
  sku: "WBH-001",
  description: "Premium noise-cancelling wireless headphones with 30-hour battery life",
  category: "Electronics",
  brand: "AudioTech",
  price: {
    amount: 14999,
    currency: "USD",
    compare_at: 19999
  },
  inventory: {
    track_inventory: true,
    quantity: 150,
    low_stock_threshold: 20,
    allow_backorder: false
  },
  variants: [
    {
      sku: "WBH-001-BLK",
      name: "Wireless Bluetooth Headphones - Black",
      options: { color: "Black" },
      inventory: { quantity: 100 }
    },
    {
      sku: "WBH-001-WHT",
      name: "Wireless Bluetooth Headphones - White",
      options: { color: "White" },
      inventory: { quantity: 50 }
    }
  ]
});

product = stateset.products.create({
    "name": "Wireless Bluetooth Headphones",
    "sku": "WBH-001",
    "description": "Premium noise-cancelling wireless headphones with 30-hour battery life",
    "category": "Electronics",
    "brand": "AudioTech",
    "price": {
        "amount": 14999,
        "currency": "USD",
        "compare_at": 19999
    },
    "inventory": {
        "track_inventory": True,
        "quantity": 150,
        "low_stock_threshold": 20,
        "allow_backorder": False
    }
})

{
  "id": "prod_0901f083-aa1c-43c5-af5c-0a9d2fc64e30",
  "object": "product",
  "created_at": "2024-01-15T10:30:00Z",
  "updated_at": "2024-01-15T10:30: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
  },
  "cost": {
    "amount": 7500,
    "currency": "USD"
  },
  "inventory": {
    "track_inventory": true,
    "low_stock_threshold": 20,
    "allow_backorder": false
  },
  "inventory_summary": {
    "total_quantity": 150,
    "available_quantity": 150,
    "reserved_quantity": 0,
    "by_warehouse": {
      "wh_001": {
        "available": 150,
        "reserved": 0
      }
    }
  },
  "variants": [
    {
      "id": "var_1234567890",
      "sku": "WBH-001-BLK",
      "name": "Wireless Bluetooth Headphones - Black",
      "options": {
        "color": "Black"
      },
      "inventory": {
        "quantity": 100,
        "available": 100,
        "reserved": 0
      }
    },
    {
      "id": "var_0987654321",
      "sku": "WBH-001-WHT",
      "name": "Wireless Bluetooth Headphones - White",
      "options": {
        "color": "White"
      },
      "inventory": {
        "quantity": 50,
        "available": 50,
        "reserved": 0
      }
    }
  ],
  "images": [
    {
      "id": "img_abc123",
      "url": "https://example.com/images/headphones-main.jpg",
      "alt_text": "Wireless Bluetooth Headphones",
      "position": 1
    }
  ],
  "tags": ["electronics", "audio", "wireless", "bluetooth"],
  "metadata": {}
}

Get Product Update Product

StateSet One API

StateSet API v1

Customer Management

Order Management

Checkouts

Returns Management

Warranty Management

Wholesale Management

Inventory Management

ASN Management

Purchase Orders

Manufacturing

Warehouse Operations

CRM

Suppliers

E-commerce

Financial

Fulfillment

Communication

System

StateSet Response API

StateSet Cloud API

StateSet Commerce API

Create Product

Authentication

Request Body

Response

​Authentication

​Request Body

​Response

Authentication

Request Body

Response