Get store home page

Get store home page's static HTML to utilize fast load of store home page on your website pages.


AuthorizationstringoAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.

Query parameters

langstringSet the languages for text labels. If absent, the default store languages are used
clean_urlsbooleanEnable/disable Store SEO format in the product links
base_urlstringSets the base URL for clean URLs. Pass it if you set cleanUrls as true or if the store widget is added to multiple pages
tplvar_*stringUse this to pass any ec.storefront.* appearance option so that the storefront will be generated according to your design settings. Customize appearance
international_pagesstringURL for alternative translated version of the website. Specify each language URL in a separate parameter. Set the language code in brackets, i.e.: international_pages[ru]. HTML is returned in hrefLangHtml field. Google specification
limitnumberLimit for number of products to display per page


A JSON object of type 'Page' with the following fields:


cssFilesArray of stringsList of CSS URLs for the page design to display properly
htmlCodestringHTML code for the static page
metaDescriptionHtmlstringHTML code for the meta title and description
canonicalUrlstringCanonical URL for this page
ogTagsHtmlstringHTML code for Open Graph tags
jsonLDHtmlstringHTML code for JSON-LD product description
hrefLangHtmlstringhreflang HTML tag for translated versions of your website. Returned if international_pages request parameter is set. Google specification
lastUpdatednumberUNIX timestamp for when the page was generated


In case of error, Ecwid responds with an error HTTP status code

HTTP codes

HTTP statusMeaning
400Request parameters are malformed