Set Up Wall Edge Strips through API

 

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

Set Up the Dimensions

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

Parameter	Type	Possible values	Default value
width	Discrete length	[0 ;∞]	3000
depth	Discrete length	[0 ;∞]	30
height	Discrete length	[0 ;∞]	30

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

---

Set Up the Type of Wall Edge Strip

Parameter	Type	Possible values	Default value
wallEdgeStripType	Discrete variation	precut / custom	precut

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

---

Set Up the Section Type

Parameter	Type	Possible values	Default value
sectionType	Discrete variation	triangle / rectangle	triangle

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

---

Set Up the Material of the Edge Strip

Parameter	Type	Possible values
material	string	External dbID

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

---

Define Compatible Products for Custom Strips

The edgeCompatibility parameter defines a list of products that can be used as finish for "custom" edge strips.

⚠️ This parameter is not designed to allow nullable value. The way to define it is to provide at least two possible values:
- The default one has no price (non-polished for example)
- The second one can be a special finish (polished) with a price.
In this case the "allow empty value" cannot be set to 'true'.

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"
},

---

Pricing

For "custom" strips, 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 wallEdgeStripOption to 'true' in the top-assembly (cabinet) will enable will enable a choice of wall edge strips in the planner.

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

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