Skip to content

Example 1

This example demonstrates how to create a Product using the Post API endpoint.


Body Structure (form-data)

The request should be sent as form-data, including the required fields for the product.

alt text


Response Structure

{
    "message": "Successfully created Product.",
    "payload": {
        "data": {
            "product_name": "OakCraft Nordic Wooden Coffee Table",
            "sku": "HMF-OCNCT-450",
            "short_description": "Solid oak minimalist coffee table with storage shelf.",
            "full_description": "A handcrafted Scandinavian-style coffee table made from solid oak wood. Finished with a matte natural coating to preserve grain texture while offering resistance to stains and scratches. Designed for modern living rooms with minimalist aesthetics. Includes under-shelf storage for books and décor items.",
            "price": "249.00",
            "sales_price": "199.00",
            "tax_rate": "20",
            "stock_quantity": "1740",
            "weight": "18.50",
            "dimensions": "110cm × 60cm × 45cm",
            "release_date": null,
            "last_updated": "2026-01-05 06:14:00",
            "product_category_id": "158",
            "product_sub_categories_id": "161",
            "tags_id": "164",
            "is_active": "1",
            "is_featured": "0",
            "is_digital": "0",
            "image_gallery_id": "",
            "product_files_id": "",
            "review_count": "2108",
            "popularity_index": "82",
            "availability_status_id": "24",
            "shipping_class_id": "167",
            "internal_notes": "Requires pallet shipping; higher logistics cost.",
            "author_id": 1,
            "group_id": null,
            "updated_at": "2026-05-08T10:40:35.000000Z",
            "created_at": "2026-05-08T10:40:35.000000Z",
            "id": 4
        }
    }
}

Fields

Field Type
product_name Varchar
sku Varchar
short_description Text Area
full_description Text Area
price Decimal
sales_price Decimal
tax_rate Float
stock_quantity Integer
weight Decimal
dimensions Varchar
release_date Date
last_updated Date Time
product_category_id Select
product_sub_categories_id Multi Select
tags_id Multi Select
is_active Checkbox
is_featured Checkbox
is_digital Checkbox
main_image_id Image Upload
instruction_manual_id File Upload
image_gallery_id Multiple Image Upload
product_files_id Multiple File Upload
review_count Calculated
popularity_index Integer
availability_status_id Double
shipping_class_id Radio Button
internal_notes Select
rating_score Text Area