Product Family
The Product Families resource allows you to retrieve a list of product families within the Lumytic platform. Product families represent a more specific grouping of products under a series and category. This endpoint can be filtered by series or category to display only relevant families.
Learn more about adding a product family.
Get Published Families
Retrieves a list of all published product families. This endpoint is useful for displaying families in catalogs, dashboards, or external integrations like external website.
Endpoint:
GET
/product_development/v1/families?series_id={series_id}&category_id=4
Headers:
- ApiKey: YOUR_API_KEY_HERE
- Content-Type: application/json
- Accept-Language: en
Query Parameters (Optional):
| Parameter | Type | Description | Example |
|---|---|---|---|
| series_id | integer | Filter families by a specific series. | ../families?series_id=2 |
| category_id | integer | Filter families by a specific category. | ../families?category_id=4 |
Request Examples
curl -X GET "https://api.lumytic.com/product_development/v1/families?series_id=3" \
-H "ApiKey: YOUR_API_KEY_HERE" \
-H "Content-Type: application/json"
-H "Accept-Language: en"
Response Example
{
"success": true,
"message": "all families fetched successfully.",
"data": {
"families": [
{
"ID": "78",
"series_name": "Product Line 2",
"ProductID": "518",
"created_at": "2021-09-07 02:40:00",
"created_by": "Lillian.Ramirez",
"updated_at": "N/A",
"updated_by": "N/A",
"is_published": "0",
"series_id": "2",
"family_Name": "Muse",
"family_description": "<p>Muse, battery-backed lighting device that switches on automatically when a building experiences a power outage or when a lighting circuit fails Long-life, maintenance-free battery, with more than 3 hours duration emergency time Both surface and recessed installation for walls and ceilings. Suitable for damp locations with ingress protection IP65.</p>\r\n",
"total_items": "1"
"category_names": "Emergency Light",
"category_ids": "38",
"datasheet_url" : "https://{domain_name}.lumytic.com/content/Product/product_datasheet_list/a%3A1%3A%7Bi%3A2%3Ba%3A1%3A%7Bi%3A0%3Bs%3A5%3A%2249450%22%3B%7D%7D/Muse",
"applications": [],
"installation_way": [
"Surface"
],
"family_photo": null,
"file_count": 0
},
{
"ID": "77",
"series_name": "Product Line 2",
"ProductID": "507",
"created_at": "2021-06-15 03:00:00",
"created_by": "Brandon.James",
"updated_at": "2022-04-05 16:13:00",
"updated_by": "Brandon James",
"is_published": "1",
"series_id": "2",
"family_Name": "Day",
"family_description": "<p>Day is a very nice, multifunctional light, can be installed on wall or ceiling, with a very strong and clear lighting effect, it is weather proof as well, made of specially manufactured PC especially to be suitable for outdoor usage, with three power options and three sizes, UFO will surely satisfy you lighting design and will be a great addition to your outdoor wall or ceiling.</p>",
"total_items": "1",
"category_names": "bulkhead lights ",
"category_ids": "8",
"datasheet_url": "https:// {domain_name}.lumytic.com/content/Product/product_datasheet_list/a%3A1%3A%7Bi%3A2%3Ba%3A1%3A%7Bi%3A0%3Bs%3A5%3A%2249449%22%3B%7D%7D/Day",
"applications": [],
"installation_way": [
"Surface"
],
"family_photo": "https://{domain_name}.lumytic.com/tenants/{tenant_name} /files/Product/Economic/507/{image_name}.jpg",
"file_count": 2
},
]
}
}
Possible Error
| Code | Message | Description |
|---|---|---|
| 400 | Bad Request | Invalid query parameters provided |
| 401 | Unauthorized | Missing or invalid API key. |
| 404 | Not found | No family found matching the criteria. |
| 500 | Internal Server Error | An unexpected error occurred on the server. |
GET Family Details
This endpoint retrieves detailed information for a single product family. It is useful when you need to display or integrate full family information, including its attributes, series, and category.
Endpoint:
GET /product_development/v1/families/{family_id}
Path Parameters:
- family_id (integer): The unique identifier of the product family
Request Example
curl -X GET "https://api.lumytic.com/product_development/v1/families/74" \
-H "ApiKey: YOUR_API_KEY_HERE" \
-H "Content-Type: application/json"
-H "Accept-Language: en"
Response Example
{
"success": true,
"message": "all families fetched successfully.",
"data": {
"families": [
{
"ID": "74",
"series_name": "Product Line 2",
"ProductID": "424",
"created_at": "2020-02-29 14:07:00",
"created_by": "May.Jones",
"updated_at": "2021-08-31 03:48:00",
"updated_by": "May Jones",
"series_id": "2",
"family_Name": "Vega",
"family_description": "Modern and elegant design, it comes up to 130LM/W, it is a cost-effective solution, with full range of wattage and optional light distribution, from 30W to 300W full range, high IP67 grade protection, with different beam angle options, asymmetrical light distribution is optional.</li>\r\n\t<li>It is available for multiple applications, sports courts, parking lots, billboard illumination, ports and airports.</li>\r\n\t<li>Different light distribution for various applications even for stadium and billboard. It can also be used as street light with slip fitter mounting accessory ",
"total_items": "3",
"category_names": "Floodlight",
"category_ids": "32",
"datasheet_url": "https://{domain_name}.lumytic.com /content/Product/product_datasheet_list/a%3A1%3A%7Bi%3A2%3Ba%3A3%3A%7Bi%3A0%3Bs%3A5%3A%2249438%22%3Bi%3A1%3Bs%3A5%3A%2249439%22%3Bi%3A2%3Bs%3A5%3A%2249440%22%3B%7D%7D/Vega",
"applications": [
"factory",
"Warehouses",
"Exhibition halls ",
"Gymnasium"
],
"installation_way": [
"Suspendant",
"Recessed",
"Mounted on pole"
],
"family_photo": "https://{domain_name}.lumytic.com/tenants/{tenant_name} /files/Product/Economic/507/{image_name}.jpg",
"file_count": 2
}
]
}
}
Possible Errors for Families
| Code | Message | Description |
|---|---|---|
| 400 | Bad Request | Invalid query parameters provided |
| 401 | Unauthorized | Missing or invalid API key. |
| 404 | Not found | No family found matching the criteria. |
| 500 | Internal Server Error | An unexpected error occurred on the server. |