Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Expand
titleBase structure

Code Block
languagejs
{
  "custom_apply": {
    {
      product: {
        type: "wallpaper",
        name: "product_name",
        vendor_code: "product_sku_id",
        image_path: "https://images.host.ai/images/pim-data/5411d399-baec-4c35-8e81-8c1cc185dee1/7141/paintedworldmap.png",
        unit: "m",
        width: 0.56,
        height: 0.64,
        link: "https://wizart.ai",
    }
  }
}

Parameter

Type

Required

Possible values

Default Value

Example

Description

custom_apply

object

yes

Head element

product

object

yes

Contains product attributes

type

string

yes

wallpaper

-

“wallpaper”

name

string

yes

-

“My wallpaper name“

vendor_code

string

yes

-

“vendor_code_or_sku“

Product’s code or SKU

image_path

string

no when is_base64=1

yes in other cases

-

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

-

https://images.host.ai/images/pim-data/5411d399-baec-4c35-8e81-8c1cc185dee1/7141/paintedworldmap-preview.png

Generated texture preview for our fitting room.

link

string

no

-

https://my-website.com/my-product-page

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

-

0.56

Width of the pattern design

hight

numeric(float or integer)

yes when unit = cm,m

-

0.64

Height of the pattern design

height_feet

integer

yes when unit = in

0

8

height_inch

integer

yes when unit = in

0

0

width_feet

integer

yes when unit = in

0

15

width_inch

integer

yes when unit = in

0

2

pattern_offset

float

no

Applicable for: wallpaper

0

0.34

Pattern offset should be specified if applicable to ensure correct wallpaper visualization and installation.

overlap

numeric(float or integer)
when unit = cm,m

No

-

0.56

overlap_feet

integer
when unit = in

No

-

1

overlap_inch

integer
when unit = in

No

-

2

repeatable

repeatable

No

0,1

1

0

0 - pattern won’t repeat 1 - pattern will repeat vertically and horizontally on the wall

is_base64

integer

No

0,1

0

0

To use image_path via base64.