Create Product

Create a new product.

HTTP Request

POST/api/products

Authorization

Authorization

• Required: Yes
• Permission: Staff or Admin
• Authentication: Token-based (Authorization: Token <your_api_key>)

Request Body

Field	Type	Required	Description
name	String	Yes	Product name
code	String	No	Product code/SKU
slug	String	No	URL-friendly product identifier
active	Boolean	No	Whether the product is active (default: true)
image	Integer	No	ID of the product's main image
order	Integer	No	Display order priority
brand	Integer	No	Brand ID
categories	Array of Integers	No	List of Category IDs
stock_type	String	No	Stock management type
stock	Integer	No	Available stock quantity
regular_price	Decimal	No	Original price of the product
sale_price	Decimal	No	Sale price (if on sale)
price_notes	String	No	Additional pricing notes
excerpt	String	No	Short product description
description	String	No	Full product description

Example Requests

🐍 Python

1import requests
2
3# Create a new product
4response = requests.post('http://www.example.com/api/products', 
5  json={
6      'name': 'Gaming Laptop Pro',
7      'code': 'GLP-2024-001',
8      'slug': 'gaming-laptop-pro',
9      'active': True,
10      'brand': 1,
11      'categories': [5],
12      'stock_type': 'managed',
13      'stock': 50,
14      'regular_price': 1299.99,
15      'sale_price': 999.99,
16      'excerpt': 'High-performance gaming laptop with RTX graphics',
17      'description': 'Ultimate gaming experience with latest processor and graphics card...'
18  },
19  headers={'Authorization': 'Token <your_api_key>'}
20)
21print(response.json())
22
23# Create minimal product
24response = requests.post('http://www.example.com/api/products', 
25  json={
26      'name': 'Simple Product',
27      'regular_price': 29.99
28  },
29  headers={'Authorization': 'Token <your_api_key>'}
30)
31print(response.json())

🌐 Curl

1curl -X POST "http://www.example.com/api/products" -H "Authorization: Token <your_api_key>" -d '{
2      "name": "Gaming Laptop Pro",
3      "code": "GLP-2024-001",
4      "slug": "gaming-laptop-pro",
5      "active": true,
6      "brand": 1,
7      "categories": [5],
8      "stock_type": "managed",
9      "stock": 50,
10      "regular_price": 1299.99,
11      "sale_price": 999.99,
12      "excerpt": "High-performance gaming laptop with RTX graphics",
13      "description": "Ultimate gaming experience with latest processor and graphics card..."
14  }'

Status Codes

Code	Description
201	Product created successfully
400	Bad request — invalid input
401	Unauthorized — authentication required
403	Forbidden — insufficient permissions
500	Internal server error

Response Fields

Field	Type	Description
id	Integer	Unique ID of the product
active	Boolean	Whether the product is active
image_data	Object	Image details (read-only)
order	Integer	Display order priority
code	String	Product code/SKU
name	String	Product name
slug	String	URL-friendly product identifier
stock_type	String	Stock management type
stock	Integer	Available stock quantity
in_stock	Boolean	Whether the product is in stock (computed)
regular_price	Decimal	Original price of the product
sale_price	Decimal	Sale price (if on sale)
discount	Decimal	Discount amount (computed)
discount_percent	Decimal	Discount percentage (computed)
price	Decimal	Final price after discount (computed)
price_notes	String	Additional pricing notes
excerpt	String	Short product description
comments_count	Integer	Number of comments (computed)
rating	Decimal	Average product rating (computed)
description	String	Full product description
created_at	String (ISO 8601)	Timestamp when product was created
updated_at	String (ISO 8601)	Timestamp when product was last updated
brand_data	Object	Brand details (id: int, name: string)
categories_data	Array[Object]	List of categories the product belongs to (id: int, name: string)

Image Data Structure

Field	Type	Description
id	Integer	Unique ID of the image
type	String	File type (e.g., image/jpeg)
name	String	Original file name
size	Integer	File size in bytes
human_readable_size	String	Human readable file size (e.g., 2.5 MB)
f	String	URL to access the image file
width	Integer	Image width in pixels
height	Integer	Image height in pixels
mode	String	Color mode (e.g., RGB, CMYK)

Brand Data Structure

Field	Type	Description
id	Integer	Unique ID of the brand
name	String	Name of the brand

Categories Data Structure

Field	Type	Description
id	Integer	Unique ID of the category
name	String	Name of the category

Notes

• Fields marked as "computed" are generated by the system and cannot be set directly.
• Date fields are in ISO 8601 format (e.g., "2023-01-01T12:00:00Z").