Get Instant Site tile config by type

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

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.

configType

string

Type of the tile category whose config you want to get. One of: GLOBAL, TEXT, 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.

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

type

string

Tile type of the requested config.

config

object config

Details about the config.

config

Field
Type
Description

layoutConfigList

array of objects layoutConfigList

Details about the layouts assigned to the config.

layoutConfigList

Field
Type
Description

name

string

Internal name of the layout.

contentEditorConfig

object contentEditorConfig

Object with content settings available in the Instant Site editor for this layout.

designEditorConfig

object designEditorConfig

Object with design settings available in the Instant Site editor for this layout.

defaults

object defaults

Object with default content and design settings for this layout.

deprecated

boolean

Layout state (for internal use only).

svgIcon

string

Details about the SVG icon assigned to the layout (visible in the editor).

svgIconText

string

Hover text for the SVG icon.

Last updated

Was this helpful?