Set Up Wall Panels through API

 

➡️ See the API Reference documentation 🔗 for detailed information.

Set Up the Dimensions

For precut wall panels, width is a mandatory parameter used for price calculation.

Parameter	Type	Possible values	Default value
width	Discrete length	[0 ;∞]	2
depth	Discrete length	[0 ;∞]	1196
height	Continuous length	[0 ;∞]	200 ≤ 550 ≤ 4000

"width": {
    "typeID": 1,
    "values": [
        1196
    ],
    "editable": null,
    "translation": {
        "name": {
            "1": "Longueur",
            "2": "Width",
            "3": "Anchura",
            "4": "Breite"
        },
        "values": {
            "2": {
                "1196": "1196"
            }
        }
    },
    "defaultValue": 2460
}

---

Set Up the Type of Wall Panel

Parameter	Type	Possible values	Default value
wallPanelType	string	precut / custom	precut

    "wallPanelType": {
        "typeID": 4,
        "values": [
            "precut"
        ],
        "editable": null,
        "translation": {
            "name": {
                "2": "wallPanelType"
            },
            "values": {
                "2": {
                    "precut": "precut"
                }
            }
        },
        "defaultValue": "precut"
    }

---

Set Up the Material of the Worktop

Parameter	Type	Possible values	Default value
wallPanelMaterial	string	acrylic / glass / laminate / quartz	laminate

    "wallPanelMaterial": {
        "typeID": 4,
        "values": [
            "laminate"
        ],
        "editable": null,
        "translation": {
            "name": {
                "2": "rail"
            },
            "values": {
                "2": {
                    "laminate": "laminate"
                }
            }
        },
        "defaultValue": "laminate"
    }

---

Set Up the Rail

Parameter	Type	Possible values	Default value
rail	boolean	true / false	false

    "rail": {
        "typeID": 3,
        "editable": null,
        "translation": {
            "name": {
                "2": "rail"
            },
        "defaultValue": 1
    }

Define the Rail Product ID

Parameter	Type	Possible values
railProductID	product	External dbID

 "railProductID": {
    "ids": [
        "14137",
        null
    ],
    "tags": [],
    "typeID": 7,
    "editable": null,
    "nullable": true,
    "translation": {
        "name": {
            "2": "railProductID"
        }
    },
    "defaultValue": "14137"
}

---

Set Up the Reversibility

Define the side Parameter

Parameter	Type	Possible values	Default value
side	integer	1 or -1	1

    "side": {
        "typeID": 2,
        "values": [
            1,
            -1
        ],
        "editable": "R",
        "translation": {
            "name": {
                "2": "side"
            },
            "values": {
                "2": {
                    "1": "Side 1",
                    "-1": "Side 2"
                }
            }
        },
        "defaultValue": 1
    }

Define the Materials

Define the material used for each side of the wall panel. By default:

• material1 is applied to side = 1
• material2 applied to side = -1

Parameter	Type	Possible values
material1	material	External dbID
material2	material	External dbID

"material": {
    "ids": [
        "11"
    ],
    "tags": [],
    "typeID": 6,
    "editable": null,
    "nullable": false,
    "translation": {
        "name": {
            "2": "material"
        }
    },
    "defaultValue": "11"
},

---

Set Up the Edge compatibility

Parameter	Type	Possible values
edgeCompatibility	product	External dbID

"edgeCompatibility": {
    "ids": [
        "14180",
        "14179"
    ],
    "tags": [],
    "typeID": 7,
    "editable": null,
    "nullable": false,
    "translation": {
        "name": {
            "2": "edgeCompatibility"
        }
    },
    "defaultValue": "14179"
},

---

Set Up the Operation Compatibility

Parameter	Type	Possible values
operationCompatibility	product	External dbID

"operationCompatibility": {
    "ids": [
        "21",
        "19",
        "13",
        "20",
        "18",
        null
    ],
    "tags": [],
    "typeID": 7,
    "editable": null,
    "nullable": true,
    "translation": {
        "name": {
            "2": " operationCompatibility "
        }
    },
    "defaultValue": ""
},

---

Set Up Polished Underside

Parameter	Type	Possible values
polishedUnderside	product	External dbID

"polishedUnderside": {
    "ids": [
        "1234"
    ],
    "tags": [],
    "typeID": 7,
    "editable": null,
    "nullable": true,
    "translation": {
        "name": {
            "2": " polishedUnderside "
        }
    },
    "defaultValue": "1234"
},

---

Pricing

For "custom" panels, the pricing method is "per linear meter" and thus, the following value is required:

{"pricingMethod":"linearMeter"} 

"prices": [
    {
       "typePrice": "regular",
       "price": 100,
       "startDate": null,
       "endDate": null,
       "currency": "EUR",
       "additionalInformations": {
       "pricingMethod": "linearMeter"
        }
    }
]

---

Deploy

Setting the wallPanelOption to 'true' in the top-assembly will enable a choice of wall panels in the planner corresponding to products available in the catalog.

Setting the leftWallPanel and rightWallPanel to 'true' in the top-assembly will add a wallpanel on the side of the cabinet or filler, if this side is against a wall.

Parameter	Type	Possible values	Default value
wallPanelOption	boolean	true / false	false
leftWallPanel	boolean	true/false	false
rightWallPanel	boolean	true/false	false

Define the wallPanelOption Parameter

    "wallPanelOption": {
        "typeID": 3,
        "editable": null,
        "translation": {
            "name": {
                "2": "wallPanelOption"
                }
            },
        "defaultValue": 0
        }

Define the leftWallPanel Parameter

    "leftWallPanel": {
        "typeID": 3,
        "editable": null,
        "translation": {
            "name": {
                "2": "leftWallPanel"
                }
            },
        "defaultValue": 0
        }

Define the rightWallPanel Parameter

    "rightWallPanel": {
        "typeID": 3,
        "editable": null,
        "translation": {
            "name": {
                "2": "rightWallPanel"
                }
            },
        "defaultValue": 0
        }