get https://app.ecwid.com/api/v3//storefront-widget-pages
Access scopes
Requires the following access scope: read_storefront_widget_pages
Response
A JSON object with the following fields:
| Name | Type | Description |
|---|---|---|
| status | String | Shows request result:OK - found page with canonicalSlug matching slug from request.NOT_FOUND - not found any matches.NONCANONICAL - found page, but slug specified in the request doesn't match page canonicalSlug. |
| type | String | Page type:ROOT - Root category or home page.PRODUCT - Any product page.CATEGORY - Any category page.SEARCH - Search page, slug: search.LEGAL_PAGE - Legal pages, slugs: legal, legal/*.CART - Cart pages, slugs: cart, cart/*, repeat-orderCHECKOUT - Checkout pages, slugs: checkout*, checkout/*, downloadError, orderFailure, FBAutofillCheckout.CUSTOMER_ACCOUNT - Customer account pages, slugs: account, account/*, signin, signIn, resetPassword, subscribe, unsubscribe.INTERNAL- Internal Ecwid pages. |
| canonicalSlug | String | Canonical URL slug for found page. |
| storeEntityData | Object{storeEntityData} | Product or category ID. Has value only if type is PRODUCT or CATEGORY. |
| staticContent | Object{staticContent} | Static code for found page. Has value only if the request has getStaticContent=true query param. |
storeEntityData
| Name | Type | Description |
|---|---|---|
| id | String | Product or category ID for found page. |
staticContent
| 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 |