Skip to main content

Set Up Worktops through API

➑️ See the API Reference documentation πŸ”— for detailed information.

Set Up the Dimensions​

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

ParameterTypePossible values
widthreal[0 ;∞]
depthreal[0 ;∞]
heightreal[0 ;∞]

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


Set Up the Type of Worktop​

ParameterTypePossible values
worktopTypestringcustom or precut

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


Set Up the Waterfall​

ParameterTypePossible values
waterfallPossiblebooleantrue or false
waterfallTypestringangled or straight
waterfallJointProductproductexternal dbID
"waterfallPossible": {
"typeID": 3,
"editable": null,
"translation": {
"name": {
"2": "waterfallPossible"
}
},
"defaultValue": 0
}


Set Up the Joint between two Worktops​

ParameterTypePossible values
cornerJointPossiblebooleantrue or false
cornerHandedJointPossiblebooleantrue or false
notchOffsetreal[0 ;∞]

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

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

"notchOffset": {
"typeID": 1,
"editable": null,
"translation": {
"name": {
"2": "notchOffset"
}
},
"defaultValue": 20
}


Enable an Arc Operation​

ParameterTypePossible values
arcOperationPossiblebooleantrue or false
"arcOperationPossible": {
"typeID": 3,
"editable": null,
"translation": {
"name": {
"2": "arcOperationPossible"
}
},
"defaultValue": 0
}


Set Up the Number of Rounded Cuts Allowed​

ParameterTypePossible values
roundedCutAllowedNumberinteger0 / ... / Infinite
"roundedCutAllowedNumber": {
"typeID": 4,
"values": [
1
2
4
],
"editable": null,
"translation": {
"name": {
"2": "roundedCutAllowedNumber"
},
"values": {
"2": {
"1": "1"
"2": "2"
"3": "4"
}
}
},
"defaultValue": 1
}


Filtering Parameters​

You can create the parameter of your choice to be used by the customer to filter the list of worktops in the edit panel. Below are two possible filtering parameters.

Filter Worktops with Material​

ParameterTypePossible values
worktopMaterialstringacrylic / laminate / quartz / wood
"worktopMaterial": {
"typeID": 4,
"values": [
"acrylic"
],
"editable": null,
"translation": {
"name": {
"2": "worktopMaterial"
},
"values": {
"2": {
"laminate": "acrylic"
}
}
},
"defaultValue": "acrylic"
}

⚠️The MinDistanceTapHoleAndSink πŸ”— and MinDistanceTapHoleAndWTBackEdge πŸ”— Applicative Rules are based on the worktopMaterial parameter (value: quartz) and make this parameter mandatory on the worktop product. In this case, worktopMaterial is not limited to a filtering usage.

Filter Worktops with Thickness​

ParameterTypePossible values
worktopThicknessstring[0 ;∞]

"worktopThickness": {
"typeID": 1,
"values": [
38
],
"editable": null,
"translation": {
"name": {
"2": "worktopThickness"
},
"values": {
"2": {
"38": "38"
}
}
},
"defaultValue": 38
}


Reversible Worktops​

The topMaterial, bottomMaterial and edgeMaterial parameters​

Then, define the materials for each side of the worktop:

ParameterTypePossible values
topMaterialMaterialExternal dbID
bottomMaterialMaterialExternal dbID
edgeMaterialMaterialExternal dbID

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

Double-sided option​

The doubleSided and doubleSidedWaterfall parameters​

ParameterTypePossible valuesDefault value
doubleSidedbooleanTRUE / FALSEFALSE
doubleSidedWaterfallbooleanTRUE / FALSEFALSE
"doubleSided": {
"typeID": 3,
"editable": null,
"translation": {
"name": {
"2": "doubleSided"
}
},
"defaultValue": 0
},
"doubleSidedWaterfall": {
"typeID": 3,
"editable": null,
"translation": {
"name": {
"2": "doubleSidedWaterfall"
}
},
"defaultValue": 1
}

The doubleSidedProduct parameter​

ParameterTypePossible values
doubleSideProductProductExternal dbID

πŸ“Œ doubleSidedProduct must be defined on all the available worktop board products, not the worktop generic product.

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

Set Up Edge Compatibility​

ParameterTypePossible values
edgeCompatibilityproductExternal dbID

⚠️ This parameter cannot be nullable because of its dependency with applicative rules.

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


Set Up Default Edge Finish Products​

ParameterTypePossible values
adjacentEdgeFinishproductExternal dbID
backEdgeFinishproductExternal dbID
frontEdgeFinishproductExternal dbID
nonVisibleEdgeFinishproductExternal dbID
"adjacentEdgeFinish": {
"ids": [
"14180",
"14179"
],
"tags": [],
"typeID": 7,
"editable": null,
"nullable": true,
"translation": {
"name": {
"2": "adjacentEdgeFinish"
}
},
"defaultValue": "14179"
},
"backEdgeFinish": {
"ids": [
"14180",
"14179"
],
"tags": [],
"typeID": 7,
"editable": null,
"nullable": true,
"translation": {
"name": {
"2": "backEdgeFinish"
}
},
"defaultValue": "14179"
},
"frontEdgeFinish": {
"ids": [
"14180",
"14179"
],
"tags": [],
"typeID": 7,
"editable": null,
"nullable": true,
"translation": {
"name": {
"2": "frontEdgeFinish"
}
},
"defaultValue": "14179"
},
"nonVisibleEdgeFinish": {
"ids": [
"14180",
"14179"
],
"tags": [],
"typeID": 7,
"editable": null,
"nullable": true,
"translation": {
"name": {
"2": "nonVisibleEdgeFinish"
}
},
"defaultValue": "14179"
},


Set Up Operation Compatibility​

ParameterTypePossible values
operationCompatibilityproductExternal 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​

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


Pricing​

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


{"pricingMethod":"linearMeter"}

Price Sample​

(additional information is not mandatory)

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

Deploy​

To definitely activate the worktop option on a cabinet, the worktopOption parameter must set to 'true' at top-assembly level.

ParameterTypeDefault value
worktopOptionbooleantrue
"worktopOption": {
"typeID": 3,
"editable": null,
"translation": {
"name": {
"2": "worktopOption"
}
},
"defaultValue": 0
}