Skip to main content
POST
/
api
/
products
{
  "sku": "PROD-001",
  "name": "Example Product",
  "project": 1,
  "description": "Detailed product description",
  "short_description": "Brief overview",
  "price": 99.99,
  "product_type": "simple",
  "status": "active",
  "categories": [1, 2],
  "attributes": {
    "color": "blue",
    "size": "medium"
  }
}

{
  "id": 1,
  "sku": "PROD-001",
  "name": "Example Product",
  "created_at": "2024-01-01T12:00:00Z",
  "status": "active",
  "project": 1
}
Create a new product with the specified attributes and settings.

​
Body Parameters

​
sku
string
required
Unique identifier for the product within a project
​
name
string
required
Product name
​
project
integer
required
ID of the project this product belongs to
​
description
string
Rich text description of the product
​
short_description
string
Brief product description for listings
​
price
decimal
Product price (defaults to 0.00)
​
product_type
string
default:"simple"
Type of product. One of: simple, configurable, virtual, bundle, grouped
​
status
string
default:"active"
Product status. One of: active, inactive, pending, archived
​
categories
array
Array of category IDs this product belongs to
​
attributes
object
Key-value pairs of product attributes and their values

​
Response

​
id
integer
The unique identifier for the created product
​
sku
string
The product SKU
​
created_at
string
Timestamp when the product was created
{
  "sku": "PROD-001",
  "name": "Example Product",
  "project": 1,
  "description": "Detailed product description",
  "short_description": "Brief overview",
  "price": 99.99,
  "product_type": "simple",
  "status": "active",
  "categories": [1, 2],
  "attributes": {
    "color": "blue",
    "size": "medium"
  }
}

{
  "id": 1,
  "sku": "PROD-001",
  "name": "Example Product",
  "created_at": "2024-01-01T12:00:00Z",
  "status": "active",
  "project": 1
}