Get page slug and static code

GET https://app.ecwid.com/api/v3/{storeId}/storefront-widget-pages

Required access scopes

Your app must have the following access scopes to make this request: read_store_profile , read_storefront_widget_pages

Path params

All path params are required.

Param
Type
Description

storeId

number

Ecwid store ID.

Query params

All query params are optional.

Name
Type
Description

slug

string

Specify page slug for search.

storeRootPage

boolean

Set true to receive root page slug. If true, slug field is ignored and could be omited from the request.

getStaticContent

boolean

Set true to receive static HTML code for found page.

lang

string

Set language for text labels.

If not specified, Ecwid will respond with default store language.

baseUrl

string

Set base store URL for links in response. If not specified, Ecwid will use the main URL from store settings.

cleanUrls

boolean

Set true to force receiving clean URLs – catalog links without hashbang (/#!/). If not specified, links will use store URL format.

slugsWithoutIds

boolean

Set false to force receiving product and category URLs with their IDs in static page code. Requires getStaticContent=true. If true or not specified, URLs in the static page code will return without IDs.

tplvar_*

string

Pass ec.storefront.* appearance option in the request to customize static page design. If not specified, the response will use current design settings.

internationalPages

string

Set URL to receive store translations. Format: international_pages[en]. HTML is returned in hrefLangHtml field. Google specification

limit

number

Specify the exact fields to receive in response JSON. If not specified, the response JSON will have all available fields for the entity. Example: ?responseFields=generalInfo(storeId,storeUrl)

Last updated

Was this helpful?