Get Instant Site profile
GET
https://app.ecwid.com/instantsite/{storeId}/profile
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.
storeId
number
Ecwid store ID.
Headers
The Authorization header is required.
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:
siteId
string
Ecwid store ID
locale
string
Site locale that matches the default website language.
enabledLanguages
array of strings
List of enabled languages.
storeName
string
Name of the website used in SEO and visible in browser tabs.
countryCode
string
Two-digit country code of the store location.
postalCode
string
ZIP code of the store location.
string
Email specified as the "store email" in the Instant Site editor.
dateFormat
string
Date format used on the website, for example, "dd.MM.yyyy"
.
timeFormat
string
Time format used on the website, for example, "HH:mm:ss"
.
timezoneOffsetInMinutes
number
Offset of the store time from the UTC +0 in minutes.
storeClosed
boolean
Defines if the store is closed. If a store is closed, it shows a "Closed for maintenance" banner instead of the product browser on the storefront.
storeSuspended
boolean
Defines if the store is suspended. If a store is suspended, its product browser is still available on the storefront, but dthe checkout (and therefore the ability to place orders) is disabled.
isTemplateSite
boolean
Defines if a store is used as a template for one of the Site template applications.
siteUrl
string
Main website URL.
latestPublishTimestamp
number
UNIX timestamp of the latest published change for the Instant Site, for example, 1739945860
.
onboarding
object onboarding
Internal onboarding settings.
vertical
string
Answer to the question "What type of products will you be selling?" that defines sample products added to the store.
Supported values: apparel
, art
, auto
, books
, electronics
, food_restaurant
, food_ecommerce
, gifts
, hardware
, health
, home
, jewelry
, office
, pet
, services
, sports
, streaming
, subscription_product
, toys
, tobacco
, adult
, notsure
, other
.
previewTemplateInsideEditor
boolean
Defines if the Instant Site preview opens inside the editor or on a separate page.
featureFlags
object featureFlags
List of internal features and their states.
isDraftChanged
boolean
Defines if current draft is different from the published version.
hideEcwidLinks
boolean
Defines if Ecwid branding links are visible.
selectedSiteTemplateId
string
Internal ID of the currently selected Site template.
ecwidApiUrl
ыекштп
Base URL for REST API calls.
storefrontFiltersEnabled
boolean
Defines if product filter are enabled on the storefront.
storefrontProductReviewsFeatureEnabled
boolean
Defines if the product reviews are enabled on the storefront.
tracking
googleUniversalAnalyticsId
string
Google Analytics ID assigned to the Instant Site.
heapEnabled
boolean
State of the internal heap feature.
subscription
channelId
string
Google Analytics ID assigned to the Instant Site.
channelType
string
State of the internal heap feature.
planName
string
Internal name of the store billing plan.
planPeriod
string
Billing period. One of: monthly
, yearly
.
isPaid
boolean
Defines if the store is on a paid (true
) or free (false
) plan.
isAllowNewCookieBanner
boolean
Defines if the cookie banner is enabled on the storefront.
maxPageNumber
number
Max number of pages for the Instant Site. Default value: 100
.
isMultilingualStoreFeatureEnabled
boolean
Defines if the multilingual feature is enabled for the store.
isAdvancedDiscountsFeatureAvailable
boolean
Defines if the promotions (advanced discounts feature) are enabled in the store.
isBasicEcommerceFeatureEnabled
boolean
Defines if the checkout is enabled in the store.
isRichTextEditorEnabled
boolean
Defines if the "rich text" feature is enabled for text fields in the Instant Site editor.
isTemplateMarketFeatureEnabled
boolean
Defines if the Site templates market is enabled in the Instant Site editor.
isAccessToControlPanel
boolean
Defines if access to the Ecwid admin is enabled for the store.
isStorefrontAgeConfirmationFeatureEnabled
boolean
Defines if the age confirmation popup is enabled on the storefront.
Last updated
Was this helpful?