Interactive Custom apply for wall murals
To add the "Custom apply" feature for wall murals on your website, you will need to create a custom_apply object. Here's an example of what it should look like:
Example of integration with deployment-kit.
To open the visualizer with the customized mural, you must set the product info in the parameters property data-parameters
- this is JSON string. Please note that the list of parameters varies depending on the product type, and is provided below.
Please select the desired integration option below and expand the code sample provided:
Parameters explanations
Parameter | Type | Required | Possible values | Default Value | Example | Description |
---|---|---|---|---|---|---|
custom_apply | object | yes |
| Head element |
| |
product | object | yes |
| Contains product attributes |
| |
type | string | yes | wall_mural | - | “wall_mural” |
|
name | string | yes |
| - | “My mural name“ |
|
vendor_code | string | yes |
| - | “vendor_code_or_sku“ | Product’s code or SKU |
image_path | string | yes (when you use depKit integration) no when is_base64=1(only when you use old iframe integration. ) |
| - | base_64 string | Generated texture in base64. We will use it to use it in our fitting room. |
link | string | no |
| - | Your clients will be able to use that link to go to your product page. | |
unit | string | yes when unit = in | cm, m, in | m | m |
|
width | numeric(float or integer) | yes when unit = cm,m |
| - | 10 |
|
hight | numeric(float or integer) | yes when unit = cm,m |
| - | 12.5 |
|
height_feet | integer | yes when unit = in |
| 0 | 15 |
|
height_inch | integer | yes when unit = in |
| 0 | 0 |
|
width_feet | integer | yes when unit = in |
| 0 | 10 |
|
width_inch | integer | yes when unit = in |
| 0 | 2 |
|
repeatable | integer | yes | 0, 1 | 0 | 0 | 0 - pattern won’t repeat (used for interactive products)1 - pattern will repeat vertically and horizontally on the wall. |
customized_size | integer | yes | 0,1 | 0 | 0 | 1 - the texture can scale, 0 - the texture only moves along the wall without scaling. |
is_base64 | integer | yes | 0,1 | 0 | 0 | To use image_path via base64. |