Update product access and attributes
1. List all products the current account can access
Base URL: GET /api/v3/products.json
URL Parameters:
| Name | Description |
|---|---|
| query | partial model # |
| page | page of products |
Returns:
{
"page": current page of the products, defaults to 1
"totalPages": total pages of the products
"products": [{
"id": ID
"manufacturer_id": Manufacturer ID
"modelnum": Model #
"created_at": "0000-00-00T00:00:00Z"
"updated_at": "0000-00-00T00:00:00Z"
"delisted_at": "0000-00-00T00:00:00Z"
"product_type": bulb type/ul type
"product_id": DLC/Energy Star ID
"has_integral_controls": "YES" | "NO" | "NotYetVerified"
"classification": "Premium" | "Standard" | "EnergyStar"
"product_category": product category
"wattage": 0.00
"lumen": 0.00
"efficacy": 0.000
"cct": 0.00000,
"cri": 0.0,
"product_extras": [{ per widget configuration for model
"widget_token": your widget token
"visible": true | false
"display_name": custom display for model
"product_page_link": link to the model page,
"cutsheet_link": link to the model spec sheet page/file,
"image_link": link to the model image,
"product_description": description of the model,
"variants": [{
"variant":
"product_page_link": link to the variant page,
"cutsheet_link": link to the variant spec sheet page/file,
"image_link": link to the variant image,
"product_description": description of the variant,
"integral_controls": {
"network_capability": true / false,
"functions": "DAY" / "DAY|OCC" / "OCC",
"output_level": "Bi-Level" / "Continuous" / "Multi-Level" / "On Off",
"mounting": "Integral",
}
}, { ... }, ...]
}, { ... }, ...]
}, { ... }, ...]
}
2. Update attributes of a single product
Base URL: POST /api/v3/products/update_product.json
Request Body:
{
"product": {
"id": ID
"product_extras": [{ per widget configuration for model
"widget_token": your widget token
"visible": true | false
"display_name": custom display for model
"product_page_link": link to the model page,
"cutsheet_link": link to the model spec sheet page/file,
"image_link": link to the model image,
"product_description": description of the model,
"variants" : [{
"variant": variant
"product_page_link": link to the variant page,
"cutsheet_link": link to the variant spec sheet page/file,
"image_link": link to the variant image,
"product_description": description of the variant,
"integral_controls": {
"network_capability": true / false,
"functions": "DAY" / "DAY|OCC" / "OCC",
"output_level": "Bi-Level" / "Continuous" / "Multi-Level" / "On Off",
"mounting": "Integral",
}
}, { ... }, ...]
}, { ... }, ...]
}
}
Returns:
{
"id": ID
"manufacturer_id": Manufacturer ID
"modelnum": Model #
"created_at": "0000-00-00T00:00:00Z"
"updated_at": "0000-00-00T00:00:00Z"
"delisted_at": "0000-00-00T00:00:00Z"
"product_type": bulb type/ul type
"product_id": DLC/Energy Star ID
"has_integral_controls": "YES" | "NO" | "NotYetVerified"
"classification": "Premium" | "Standard" | "EnergyStar"
"product_category": product category
"wattage": 0.00
"lumen": 0.00
"efficacy": 0.000
"cct": 0.00000,
"cri": 0.0,
"product_extras": [{ per widget configuration for model
"widget_token": your widget token
"visible": true | false
"display_name": custom display for model
"product_page_link": link to the model page,
"cutsheet_link": link to the model spec sheet page/file,
"image_link": link to the model image,
"product_description": description of the model,
"variants": [{
"variant":
"product_page_link": link to the variant page,
"cutsheet_link": link to the variant spec sheet page/file,
"image_link": link to the variant image,
"product_description": description of the variant,
"integral_controls": {
"network_capability": true / false,
"functions": "DAY" / "DAY|OCC" / "OCC",
"output_level": "Bi-Level" / "Continuous" / "Multi-Level" / "On Off",
"mounting": "Integral",
}
}, { ... }, ...]
}, { ... }, ...]
}
3. Update attributes of a few products
Base URL: POST /api/v3/products/update_products.json
Request Body:
{
"products": [{
"id": ID
"product_extras": [{ per widget configuration for model
"widget_token": your widget token
"visible": true | false
"display_name": custom display for model
"product_page_link": link to the model page,
"cutsheet_link": link to the model spec sheet page/file,
"image_link": link to the model image,
"product_description": description of the model,
"variants" : [{
"variant": variant
"product_page_link": link to the variant page,
"cutsheet_link": link to the variant spec sheet page/file,
"image_link": link to the variant image,
"product_description": description of the variant,
"integral_controls": {
"network_capability": true / false,
"functions": "DAY" / "DAY|OCC" / "OCC",
"output_level": "Bi-Level" / "Continuous" / "Multi-Level" / "On Off",
"mounting": "Integral",
}
}, { ... }, ...]
}, { ... }, ...]
}, { ... }, ...]
}
Returns:
{
"products": [{
"id": ID
"modelnum": Model #
"result": 'OK' | Errors
}, { ... }, ...]
}