Set Up Decoration Strips through API

 

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

Set Up the Dimensions

width is a mandatory parameter used for price calculation.

Parameter	Type	Possible values	Default value
width	Continuous length	[0 ;∞]	0 ≤ 2210 ≤ ∞
depth	Discrete length	[0 ;∞]	20
height	Discrete length	[0 ;∞]	60

"width": {
    "max": null,
    "min": 0,
    "step": 1,
    "typeID": 1,
    "editable": null,
    "translation": {
        "name": {
            "1": "Longueur",
            "2": "Width",
            "3": "Anchura",
            "4": "Breite"
        }
    },
    "defaultValue": 2210
}

---

Set Up the Material

Parameter	Type	Possible values
material	string	External dbID

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

---

Set Up the Sections

Parameter	Type	Possible values
decostripHorizontalSection	string	External dbID
decostripVerticalSection	string	External dbID

"decostripHorizontalSection": {
    "ids": [
        "14145"
    ],
    "tags": [],
    "typeID": 7,
    "editable": null,
    "nullable": false,
    "translation": {
        "name": {
            "2": "decostripHorizontalSection"
        }
    },
    "defaultValue": "14145"
}

"decostripVerticalSection": {
    "ids": [
        "14144"
    ],
    "tags": [],
    "typeID": 7,
    "editable": null,
    "nullable": false,
    "translation": {
        "name": {
            "2": "decostripVerticalSection"
        }
    },
    "defaultValue": "14144"
}

---

Pricing

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

---

Deploy

Some settings have to be made at cabinet level:

• Enable the deco strip option;
• Enable the extension of the deco strip to the sides;
• Enable the modification of the orientation of the deco strip.

Define the decoStripOption Parameter

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

Define the leftDecoStripBack Parameter

"leftDecoStripBack": {
    "typeID": 3,
    "editable": "RW",
    "translation": {
        "name": {
            "2": "leftDecoStripBack"
        }
    },
    "defaultValue": 0
}

Define the rightDecoStripBack Parameter

"rightDecoStripBack": {
    "typeID": 3,
    "editable": "RW",
    "translation": {
        "name": {
            "2": "rightDecoStripBack"
        }
    },
    "defaultValue": 0
}

Define the sectionOrientation Parameter

"sectionOrientation": {
    "typeID": 2,
    "values": [
        0,
        1
    ],
    "editable": "RW",
    "translation": {
        "name": {
            "2": "Section Orientation"
        },
        "values": {
            "2": [
                "Horizontal",
                "Vertical"
            ]
        }
    },
    "defaultValue": 1
}

---

Define a Product Rule

In some cases, you might have an incompatibility between worktop light and side deco strip. Indeed, when the worktop light width equals the cabinet width, it is impossible to mount side deco strips.

In those cases, we suggest to use a product rule to manage that incompatibility.

        {
        "name": "worktopLight/decoStripBack",
        "definition": {
          "version": 1,
          "parameters": [
            {
              "paramID": "worktopLight",
              "paramType": 7
            },
            {
              "paramID": "leftDecoStripBack",
              "paramType": 3
            },
            {
              "paramID": "rightDecoStripBack",
              "paramType": 3
            }
          ],
          "sequencePolicy": 0,
          "compatibilities": [
            [
              {
                "ids": [
                  null
                ]
              },
              {
                "values": [
                  true,
                  false
                ]
              },
              {
                "values": [
                  true,
                  false
                ]
              }
            ],
            [
              {
                "ids": [
                  "14081",
                  "18106"
                ]
              },
              {
                "values": [
                  false
                ]
              },
              {
                "values": [
                  false
                ]
              }
            ]
          ]
        },
        "ruleTypeID": 2,
        "isDeleted": false
        }