Get Instant Site tile

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

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.

tileId

string

Internal tile 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.

Response JSON

A JSON object with the following fields:

Field
Type
Description

id

string

Internal tile ID.

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.

role

string

Tile role. One of: BLOCK, NOTICE.

tileName

string

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

sourceId

string

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

content

object content

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

externalContent

object externalContent

Tile content unavailable in the Instant Site editor, such as information about store products or external links to legal pages.

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.

featuresEnabled

object featuresEnabled

Internal list of features enabled for this tile.

Last updated

Was this helpful?