Create Instant Site tile

POST https://vuega.ecwid.com/api/v1/{storeId}/tile

Required access scopes

Your app must have the following access scopes to make this request: manage_instant_site

Path params

All path params are required.

Param
Type
Description

storeId

number

Ecwid store ID.

Headers

The Authorization header is required.

Field
Type
Description

Authorization

string

Token for Instant Site API calls. Get token Requires a token with grant_type=authorization_code type.

Request JSON

A JSON object with the following fields:

Field
Type
Description

tileShowcaseItemId

string

Internal tile ID.

tileCategoryType

string

Tile category type. Tile is placed into the matching category in the Instant Site editor. One of: HEADER, COVER, SPECIAL_OFFER, COMPANY_INFO, SHIPPING_PAYMENT, STORE, LOCATION, CUSTOMER_REVIEW, ANNOUNCEMENT, SLIDER, TEMPLATE, CUSTOM, VIDEO, VIDEO_LIST, LOGO_GALLERY, FEATURED_PRODUCT, CATEGORY_PRODUCTS, CATEGORY_COLLECTION, FOOTER, CONTACT_US.

tileOrder

number

Order in the tiles list where the new tile should appear.

useTileShowcase

boolean

Define if the new tile should use showcase settings.

tile

object tile

Internal ID of the tile pre-built by the Ecwid team.

pageId

string

Internal page ID where the tile should be added.

tile

Field
Type
Description

type

string

Tile type that defines its functionality. One of: GLOBAL, TEXT, CALL_TO_ACTION, CONTACT_INFO_CALL_TO_ACTION, GIFT_CARD, COVER, STORE, IMAGE_TEXT, HEADER, FOOTER, LOCATION, MULTI_LOCATION, PRODUCT_BROWSER, GDPR_BANNER, FEATURED_PRODUCTS, ROOT_CATEGORIES, CUSTOMER_REVIEW, FEATURE_LIST, ANNOUNCEMENT_BAR, SLIDER, CUSTOM, CUSTOM_HEADER, CUSTOM_FOOTER, VIDEO, VIDEO_LIST, CATEGORY_PRODUCTS, CATEGORY_COLLECTION, FEATURED_PRODUCT, LOGO_GALLERY, CONTACT_US, AGE_CONFIRMATION.

tileName

string

Name of the website used in SEO and visible in browser tabs.

content

object content

Tile content, such as texts and images, manageable through the Instant Site editor.

design

object design

Design settings available in the Instant Site editor for tile content from the content object.

visibility

boolean

Visibility of the tile on the storefront. If true, the tile is visible.

order

number

Order in the tiles list defining their order on the storefront from top to bottom. Starts with 0 (displayed at the top) and increments by 1.

hasChanges

boolean

Defines if the draft has changes from the published version.

Last updated

Was this helpful?