Example 2
This example demonstrates the response structure for retrieving a Product using the Get endpoint.
Response Structure
{
"message": "Successfully found Product with ID 3.",
"payload": {
"data": {
"id": 3,
"product_name": "iPhone 15 Pro",
"sku": "ELE-APL-IP15P-001",
"short_description": "Premium titanium iPhone with A17 Pro chip and advanced camera system.",
"full_description": "The iPhone 15 Pro is a premium flagship smartphone designed and manufactured by Apple Inc\r\n. It features a titanium frame for improved durability and reduced weight, a Super Retina XDR OLED display, and the A17 Pro chip for high-performance computing and console-level mobile gaming.\r\n\r\nThe device includes a triple-camera system with advanced computational photography, enhanced low-light performance, and cinematic video recording capabilities. It supports USB-C charging, 5G connectivity, Face ID, and water resistance rated IP68. Built for both productivity and creative workflows, it integrates seamlessly with the Apple ecosystem.",
"price": "999.00",
"sales_price": "899.00",
"tax_rate": 20,
"stock_quantity": 18200,
"weight": "187.00",
"dimensions": "146.6mm × 70.6mm × 8.25mm",
"release_date": "2023-09-22",
"last_updated": "2026-03-10 16:23:00",
"product_category_id": 156,
"product_sub_categories_id": "159",
"tags_id": "162",
"is_active": 1,
"is_featured": 1,
"is_digital": 0,
"main_image_id": 29,
"instruction_manual_id": 30,
"image_gallery_id": "31,32",
"product_files_id": "33,34",
"review_count": 52840,
"popularity_index": 98,
"availability_status_id": 24,
"shipping_class_id": 165,
"internal_notes": "Top-tier flagship SKU; highest demand in Q4 cycles.",
"created_at": "2026-05-07T10:18:16.000000Z",
"updated_at": "2026-05-07T12:13:46.000000Z",
"deleted_at": null,
"author_id": 1,
"group_id": null,
"rating_score": "4.5"
},
"permissions": true
}
}
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 |