Static code for category page

GET https://storefront.ecwid.com/category-page/{storeId}/{categoryId}/static-code

Required access scopes

Request does not require any access scopes.

Path params

All path params are required.

Param
Type
Description

storeId

number

Ecwid store ID.

categoryId

number

Internal category ID.

Query params

All query params are optional.

Name
Type
Description

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.

tplvar_*

string

Pass ec.storefront.* design configs in the request to customize the static page looks. Design configs If not specified, API responds with the current store 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)

Response JSON

A JSON object with the following fields:

Name
Type
Description

cssFiles

Array of strings

List of CSS URLs for the page design to display properly

htmlCode

string

HTML code for the static page

metaDescriptionHtml

string

HTML code for the meta title and description

canonicalUrl

string

Canonical URL for this page

ogTagsHtml

string

HTML code for Open Graph tags

jsonLDHtml

string

HTML code for JSON-LD product description

hrefLangHtml

string

hreflang HTML tag for translated versions of your website. Returned if international_pages request parameter is set. Google specification

lastUpdated

number

UNIX timestamp for when the page was generated

Last updated

Was this helpful?