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.
...
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Expand | |||||
---|---|---|---|---|---|
| |||||
|
Parameters explanations
Expand | |||||
---|---|---|---|---|---|
| |||||
|
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 | - | https://images.host.ai/images/pim-data/5411d399-baec-4c35-8e81-8c1cc185dee1/7141/paintedworldmap.png | Generated texture path. We will use it to download this texture and use it in our fitting room. | |
preview_path | string | no | - | Generated texture preview for 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 | no | 0, 1 | 0 | 0 | 0 - pattern won’t repeat 1 - pattern will repeat vertically and horizontally on the wall |
customized_size | integer | no | 0,1 | 0 | 0 |