Skip to main content
POST
/
v1
/
products
curl --location --request POST 'https://api.stateset.com/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"]
}'

{
  "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": {}
}

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.

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

​
name
string
required
Product name for display
​
sku
string
required
Unique stock keeping unit (SKU) identifier
​
description
string
Detailed product description
​
category
string
Product category (e.g., “Electronics”, “Clothing”, “Home & Garden”)
​
brand
string
Brand or manufacturer name
​
price
object
required
Pricing information
​
cost
object
Cost information for margin calculations
​
inventory
object
Inventory settings
​
dimensions
object
Product dimensions for shipping calculations
​
variants
array
Product variants (e.g., different sizes, colors)
​
images
array
Product images
​
supplier
object
Supplier information
​
metadata
object
Additional custom fields as key-value pairs
​
tags
array
Array of string tags for categorization and search
​
status
string
Product status: “active”, “draft”, or “archived” (default: “active”)

​
Response

​
id
string
Unique product identifier
​
object
string
Always “product”
​
created_at
string
ISO 8601 timestamp of creation
​
updated_at
string
ISO 8601 timestamp of last update
​
name
string
Product name
​
sku
string
Product SKU
​
status
string
Product status
​
variants
array
Array of product variants with their IDs
​
inventory_summary
object
Summary of inventory across all variants
curl --location --request POST 'https://api.stateset.com/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"]
}'

{
  "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": {}
}