Get Instant Site tile showcases

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

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.

Response JSON

A JSON object with the following fields:

Field
Type
Description

categories

object categories

List of received tile categories and their data.

categories

Field
Type
Description

type

string

Tile category type. Tiles are placed into the matching categories 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.

items

array of objects items

Showcase details: internal ID, image URL, width, height.

items

Field
Type
Description

id

string

Internal ID of the showcase.

previewImageUrl

string

Link to the showcase preview image. Users see this image in the Instant Site editor when adding new tiles.

previewHeight

number

Height of the showcase preview image.

previewWidth

number

Width of the showcase preview image.

featureProperty

string

Internal text for the feature description showcased in the tile. Available only for tiles built by the Ecwid team.

isDeprecated

boolean

Internal field that marks older tiles built by the Ecwid team.

Last updated

Was this helpful?