Get store profile
Get basic information about an Ecwid store: settings, store location, email, etc.
Last updated
Was this helpful?
Build appsContact API support
Get basic information about an Ecwid store: settings, store location, email, etc.
Last updated
Was this helpful?
GET https://app.ecwid.com/api/v3/{storeId}/profile
Your app must have the following access scopes to make this request: read_store_profile
Additional scopes include read_store_limits granting access to and read_store_profile_extended granting access to data.
All path params are required.
storeId
number
Ecwid store ID.
All query params are optional.
showExtendedInfo
boolean
Set true to receive additional store profile data including account/billing data. Requires read_store_profile_extended access scope.
lang
string
Language ISO code for translations in JSON response, e.g. en, fr. Translates fields like: title, description, pickupInstruction, text, etc.
responseFields
string
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)
Example of using responseFields param:
The Authorization header is required. Request works with any access token, though the public token receives limited data.
Authorization
Bearer secret_ab***cd
Access token of the application.
A JSON object with the following fields:
generalInfo
Basic data about Ecwid store: ID, website URL, website platform, Instant Site settings.
account
Store owner's account details.
settings
Store general settings.
mailNotifications
Mail notifications settings.
phoneNotifications
Phone notifications settings.
company
Information about physical store: company name, phone, address.
formatsAndUnits
Store formats/untis settings.
languages
Store language settings.
shipping
Store shipping settings.
zones
List of store destination zones.
taxes
List of store taxes.
taxSettings
Detailed settings for store taxes.
businessRegistrationID
Company registration ID, e.g. VAT reg number or company ID, which is set under Settings / Invoice in Control panel.
payment
Store payment settings information. Read only
featureToggles
Information about enabled/disabled new store features and their visibility in Ecwid Control Panel. Not provided via public token. Some of them are available in Ecwid JS API. Read only
legalPagesSettings
Legal pages settings for a store (System Settings → General → Legal Pages).
designSettings
Design settings of an Ecwid store. Can be overriden by updating store profile or by customizing design via JS config in storefront.
productFiltersSettings
Settings for product filters in a store.
fbMessengerSettings
Store settings for FB Messenger feature. Read only
mailchimpSettings
Store settings for Mailchimp integration. Read only
orderInvoiceSettings
Store settings for order invoices.
socialLinksSettings
Store settings for social media accounts.
registrationAnswers
Merchants' answers provided while registering their Ecwid accounts.
giftCardSettings
Store settings for gift cards. Read only
tipsSettings
Store settings for tips.
accountBilling
Store billing and plan info. Requires read_store_profile_extended access scope.
Read only
storeId
number
Ecwid Store ID.
profileId
string
Internal profile ID in the store. Profile ID is unique for every staff account in the store and is assigned to custom apps. For example, if a staff account creates a custom app, they'll see their profile ID and not the storo owner's ID.
storeUrl
string
Main website URL.
starterSite
websitePlatform
string
Website platform that store is added to. Possible values: "wix", "wordpress", "iframe", "joomla", "yola", etc. Default is "unknown".
storefrontUrlFormat
string
Format of the product browser links (URLs of catalog, account, cart, and checkout pages) on the storefront. One of:
IFRAME - Store is added to an external website through iframe window.
WIX - Store works on a Wix website.
QUERY - Store uses [deprecated] query-based URL format.
HASH - Store uses old URL format with "hashbangs".
CLEAN - Store uses modern clean URL format.
Read-only
storefrontUrlSlugFormat
string
Format of product and category page URLs on the storefront. Reflects state of the "slugs without IDs" feature in the store.
One of:
WITH_IDS - Old URL format with category/product ID included in the URLs.
WITHOUT_IDS - New URL format with category/product URLs without IDs.
For example:
Product link with ID:
{domain}/products/my_product-p123456
Product link without ID:
{domain}/products/my_product
Read-only
accountName
string
Full store owner name
accountNickName
string
Store owner nickname on the Ecwid forums
accountEmail
string
Store owner email. Note: Not WL-friendly. If you want to send notifications/emails to customers, use adminNotificationEmailsfield instead.
whiteLabel
boolean
true if Ecwid brand is not mentioned in merchant's interface, false otherwise. Read only
suspended
boolean
true if Ecwid account is suspended (prevents the storefront from showing any products or creating orders), false otherwise. Read only
availableFeatures
Array of strings
List of the features available on the store's pricing plan
registrationDate
string
The store registration date
limitsAndRestrictions
Store limits and restrictions, e.g. maximum number of available products. Requires read_store_limits access scope.
maxProductLimit
number
Maximum number of individual products available in the store, e.g. 2500. This number doesn't include product options or variations. Requires read_store_profile_extended scope, read only.
closed
boolean
true if the store is closed for maintenance, false otherwise
storeName
string
The store name displayed in Instant Site
storeDescription
string
HTML description for the main store page – Store Front page
invoiceLogoUrl
string
Company logo displayed on the invoice
emailLogoUrl
string
Company logo displayed in the store email notifications
googleRemarketingEnabled
boolean
true if Remarketing with Google Analytics is enabled, false otherwise
googleAnalyticsId
string
fbPixelId
string
orderCommentsEnabled
boolean
true if order comments feature is enabled, false otherwise
orderCommentsCaption
string
Caption for order comments field in storefront
orderCommentsCaptionTranslated
Available translations for the caption for order comments field.
orderCommentsRequired
boolean
true if order comments are required to be filled, false otherwise
askZipCode
boolean
true if the zip code field is shown on the checkout ('Ask for a ZIP/postal code' in checkout settings is enabled), false otherwise
showPricePerUnit
boolean
true if the "Show price per unit" option is turned on, otherwise false
hideOutOfStockProductsInStorefront
boolean
true if out of stock products are hidden in storefront, false otherwise. This setting is located in Ecwid Control Panel > Settings > General > Cart
askCompanyName
boolean
true if "Ask for the company name" in checkout settings is enabled, false otherwise
favoritesEnabled
boolean
true if favorites feature is enabled for storefront, false otherwise
productReviewsFeatureEnabled
boolean
true if product reviews feature is enabled in the store, false otherwise.
defaultProductSortOrder
string
Default products sort order setting from Settings > Cart & Checkout. Possible values: "DEFINED_BY_STORE_OWNER", "ADDED_TIME_DESC", "PRICE_ASC", "PRICE_DESC", "NAME_ASC", "NAME_DESC"
abandonedSales
Abandoned sales settings
salePrice
Sale (compare to) price settings
showAcceptMarketingCheckbox
boolean
true if merchant shows the checkbox to accept marketing. false otherwise
acceptMarketingCheckboxDefaultValue
boolean
Default value for the checkbox at checkout to accept marketing
acceptMarketingCheckboxCustomText
string
Custom text label for the checkbox to accept marketing at checkout
acceptMarketingCheckboxCustomTextTranslated
Available translations for custom text label for the checkbox to accept marketing at checkout.
askConsentToTrackInStorefront
boolean
true if merchant shows warning to accept cookies in storefront. false otherwise
snapPixelId
string
pinterestTagId
string
googleTagId
string
googleEventId
string
recurringSubscriptionsSettings
Recurring subscription settings information.
allowPreordersForOutOfStockProducts
boolean
true if pre-orders for out of stock products are allowed, false otherwise.
linkUpEnabled
boolean
adminNotificationEmails
Array of strings
Email addresses, which the store admin notifications are sent to
customerNotificationFromEmail
string
The email address used as the 'reply-to' field in the notifications to customers
customerOrderMessages
Settings for email notifications that are automatically sent to customers to confirm their orders and keep them informed about the order progress
adminMessages
Settings for email notifications that are automatically sent to the store owner and staff members
customerMarketingMessages
Settings for email notifications that are automatically sent to customers to engage them and increase store sales
orderConfirmation
Settings for Order confirmation emails. Supported settings: enabled, marketingBlockEnabled, discountCouponId
orderStatusChanged
Settings for Order status changed emails. Supported settings: enabled
orderIsReadyForPickup
Settings for Order is ready for pickup emails. Supported settings: enabled
downloadEgoods
Settings for Download e-goods emails. Supported settings: enabled
orderShipped
Settings for Order shipped emails. Supported settings: enabled
newOrderPlaced
Settings for New order placed emails. Supported settings: enabled
lowStockNotification
Settings for Low stock notification emails. Supported settings: enabled
weeklyStatsReport
Settings for weekly stats reports. Supported settings: enabled
abandonedCartRecovery
Settings for Order confirmation emails. Supported settings: enabled, marketingBlockEnabled, discountCouponId
favoriteProductsReminder
Settings for Order status changed emails. Supported settings: enabled, discountCouponId
feedbackRequest
Settings for Order is ready for pickup emails. Supported settings: enabled, discountCouponId
customerLoyaltyAppreciation
Settings for Order confirmation emails. Supported settings: enabled, discountCouponId
inactiveCustomerReminder
Settings for Order status changed emails. Supported settings: enabled, discountCouponId
purchaseAnniversary
Settings for Order is ready for pickup emails. Supported settings: enabled, discountCouponId
enabled
boolean
true if emails are enabled, false otherwise
marketingBlockEnabled
boolean
true if the marketing block for emails is enabled, false otherwise
discountCouponId
number
id of the discount coupon added to emails
adminNotificationPhones
Array of strings
Phone numbers that are used for store admin notifications, supports up to 100 phone numbers (for future usage).
showRecurringSubscriptionsInControlPanel
boolean
true if recurring subscriptions feature is visible in admin panel, false otherwise.
supportedPaymentMethodsStatuses
Supported payment methods statuses information.
supportedPaymentMethodsAreAvailable
boolean
true if Stripe payment method can be set up in the store, false otherwise. Depends on a country. Read only.
supportedPaymentMethodsAreConnected
boolean
true if Stripe payment method it set up in the store, false otherwise. Read only.
System Settings → General → Store Profile
companyName
string
The company name displayed on the invoice
string
Company (store administrator) email
street
string
Company address. 1 or 2 lines separated by a new line character
city
string
Company city
countryCode
string
A two-letter ISO code of the country
postalCode
string
Postal code or ZIP code
stateOrProvinceCode
string
phone
string
Company phone number
System settings → General → Formats & Units.
currency
string
3-letters code of the store currency (ISO 4217). Examples: USD, CAD
currencyPrefix
string
Currency prefix (e.g. $)
currencySuffix
string
Currency suffix
currencyPrecision
number
Numbers of digits after decimal point in the store prices. E.g. 2 ($2.99) or 0 (¥500).
currencyGroupSeparator
string
Price thousands separator. Supported values: space " ", dot ".", comma "," or empty value "".
currencyDecimalSeparator
string
Price decimal separator. Possible values: . or ,
currencyTruncateZeroFractional
boolean
Hide zero fractional part of the prices in storefront. true or false .
currencyRate
number
Currency rate in U.S. dollars, as set in the merchant control panel
weightUnit
string
Weight unit. Supported values: CARAT, GRAM, OUNCE, POUND, KILOGRAM
weightPrecision
number
Numbers of digits after decimal point in weights displayed in the store
weightGroupSeparator
string
Weight thousands separator. Supported values: space " ", dot ".", comma "," or empty value ""
weightDecimalSeparator
string
Weight decimal separator. Possible values: . or ,
weightTruncateZeroFractional
boolean
Hide zero fractional part of the weight values in storefront. true or false .
dateFormat
string
Date format. Only these formats are accepted: "dd-MM-yyyy", "dd/MM/yyyy", "dd.MM.yyyy", "MM-dd-yyyy", "MM/dd/yyyy", "yyyy/MM/dd", "MMM d, yyyy", "MMMM d, yyyy", "EEE, MMM d, ''yy", "EEE, MMMM d, yyyy"
timeFormat
string
Time format. Only these formats are accepted: "HH:mm:ss", "HH:mm", "hh.mm.ss a", "hh:mm a"
timezone
string
Store timezone, e.g. Europe/Moscow
dimensionsUnit
string
Product dimensions units. Supported values: MM, CM, IN, YD
orderNumberPrefix
string
Prefix for the order ID. Max length: 20 symbols. For example, if a prefix is "01_", then order ID "XGX7J" becomes "01_XGX7J" in all customer nofications and in Ecwid admin.
orderNumberSuffix
string
Suffix for the order ID. Max length: 20 symbols. For example, if a suffix is "_25", then order ID "XGX7J" becomes "XGX7J_25" in all customer nofications and in Ecwid admin.
orderNumberMinDigitsAmount
number
Minimum digits amount of an order number (can be 0-19 digits).
orderNumberNextNumber
number
Next order number in a store (should be more than 0).
addressFormat
Address format: plain and multiline formats. Displays the way address is written according to the requirements of the country set up in the profile settings. Supports the following variables: %NAME%, %COMPANY_NAME%, %STREET%, %CITY%, %STATE_NAME% %POSTAL%, %COUNTRY_NAME%.
plain
string
Single line address format, with a delimiter.
multiline
string
Multiline address format.
System Settings → General → Languages
enabledLanguages
Array of strings
A list of enabled languages in the storefront. First language code is the default language for the store.
facebookPreferredLocale
string
Language automatically chosen be default in Facebook storefront (if any)
defaultLanguage
string
ISO code of the default language in store
System Settings → Shipping
handlingFee
Handling fee settings
shippingOrigin
Shipping origin address. If matches company address, company address is returned. Available in read-only mode only
shippingOptions
Details of each shipping option present in a store. For public tokens enabled methods are returned only. Available in read-only mode only
System Settings → Shipping → Handling Fee
name
string
Handling fee name set by store admin. E.g. Wrapping
value
number
Handling fee value
description
string
Handling fee description for customer
Settings → Shipping & Pickup → Origin address
companyName
string
The company name displayed on the invoice
string
Company (store administrator) email
street
string
Company address. 1 or 2 lines separated by a new line character
city
string
Company city
countryCode
string
A two-letter ISO code of the country
postalCode
string
Postal code or ZIP code
stateOrProvinceCode
string
State code (e.g. NY) or a region name
phone
string
Company phone number
id
string
Unique ID of shipping option
title
string
Title of shipping option in store settings
titleTranslated
Available translations for shipping option title.
enabled
boolean
true if shipping option is used at checkout to calculate shipping. false otherwise
orderby
number
Sort position or shipping option at checkout and in store settings. The smaller the number, the higher the position
fulfilmentType
string
Fulfillment type. "pickup" for in-store pickup methods, "delivery" for local delivery methods, "shipping" for everything else
locationId
number
ID of the pickup location for Lightspeed X-Series integration
minimumOrderSubtotal
number
Order subtotal before discounts. The delivery method won’t be available at checkout for orders below that amount. The field is displayed if the value is not 0
destinationZone
Destination zone set for shipping option. Empty for public token
deliveryTimeDays
string
Estimated delivery time in days. Currently, it is equal to the description value.
description
string
Shipping method description.
descriptionTranslated
Available translations for shipping option description.
carrier
string
Carrier used for shipping the order. Is provided for carrier-calculated shipping options
carrierMethods
Carrier-calculated shipping methods available for this shipping option
carrierSettings
Carrier-calculated shipping option settings
ratesCalculationType
string
Rates calculation type. One of "carrier-calculated", "table", "flat", "app"
shippingCostMarkup
number
Shipping cost markup for carrier-calculated methods
flatRate
Flat rate details
ratesTable
Custom table rates details
appClientId
string
client_id value of the app (for custom shipping apps only)
pickupInstruction
string
String of HTML code of instructions on in-store pickup
pickupInstructionTranslated
Available translations for pickup instruction.
scheduledPickup
boolean
true if pickup time is scheduled, false otehrwise. (Ask for Pickup Date and Time at Checkout option in pickup settings)
pickupPreparationTimeHours
number
Amount of time required for store to prepare pickup (Order Fulfillment Time setting) DEPRECATED
fulfillmentTimeInMinutes
number
Amount of time (in minutes) required for store to prepare pickup or to deliver an order (Order Fulfillment Time setting)
businessHours
Available and scheduled times to pickup orders
pickupBusinessHours
[Deprecated] Available and scheduled times to pickup orders (duplicates businessHours field)
businessHoursLimitationType
string
One of: ALLOW_ORDERS_AND_INFORM_CUSTOMERS - makes it possible to place an order using this delivery method at any time, but if delivery doesn't work at the moment when the order is being placed, a warning will be shown to a customer. DISALLOW_ORDERS_AND_INFORM_CUSTOMERS - makes it possible to place an order using this delivery method only during the operational hours. If delivery doesn't work when an order is placed, this delivery method will be shown at the checkout as a disabled one and will contain a note about when delivery will start working again. ALLOW_ORDERS_AND_DONT_INFORM_CUSTOMERS - makes it possible to place an order using this delivery method at any time. Works only for delivery methods with a schedule.
scheduled
boolean
true if "Allow to select delivery date or time at checkout" or "Ask for Pickup Date and Time at Checkout" setting is enabled. false otherwise.
scheduledTimePrecisionType
string
Format of how delivery date is chosen at the checkout - date or date and time. One of: DATE, DATE_AND_TIME_SLOT.
timeSlotLengthInMinutes
number
Length of the delivery time slot in minutes.
allowSameDayDelivery
boolean
true if same-day delivery is allowed. false otherwise.
cutoffTimeForSameDayDelivery
string
Orders placed after this time (in a 24-hour format) will be scheduled for delivery the next business day.
availabilityPeriod
string
blackoutDates
Dates when the store doesn’t work, so customers can't choose these dates for local delivery. Each period of dates is a JSON object.
id
string
Carrier ID and specific method name
name
string
Carrier method name
enabled
boolean
true if enabled, false otherwise
orderBy
number
Position of that carrier method
defaultCarrierAccountEnabled
boolean
true if default Ecwid account is enabled to calculate the rates. false otherwise
defaultPostageDimensions
Default postage dimensions for this shipping option
length
number
Length of postage
width
number
Width of postage
height
number
Height of postage
rateType
string
One of "ABSOLUTE", "PERCENT"
rate
number
Shipping rate
tableBasedOn
string
What is this table rate based on. Possible values: "subtotal", "discountedSubtotal", "weight"
rates
Details of table rate
conditions
Conditions for this shipping rate in custom table
rate
Table rate details
weightFrom
number
"Weight from" condition value
weightTo
number
"Weight to" condition value
subtotalFrom
number
"Subtotal from" condition value
subtotalTo
number
"Subtotal to" condition value
discountedSubtotalFrom
number
"Discounted subtotal from" condition value
discountedSubtotalTo
number
"Discounted subtotal from" condition value
perOrder
number
Absolute per order rate
percent
number
Percent per order rate
perItem
number
Absolute per item rate
perWeight
number
Absolute per weight rate
MON
Array time range
Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
TUE
Array time range
Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
WED
Array time range
Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
THU
Array time range
Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
FRI
Array time range
Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
SAT
Array time range
Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
SUN
Array time range
Array of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
System Settings → Taxes
automaticTaxEnabled
boolean
true if store taxes are calculated automatically, else otherwise. As seen in the Ecwid Control Panel > Settings > Taxes > Automatic
taxes
Manual tax settings for a store
pricesIncludeTax
boolean
true if store has "gross prices" setting enabled. false if store has "net prices" setting enabled.
taxExemptBusiness
boolean
Defines if your business is tax-exempt under § 19 UStG. When true, it will display the “Tax exemption § 19 UStG” message to customers to explain the zero VAT rate.
ukVatRegistered
boolean
If true and order is sent from EU to UK - charges VAT for orders less than GBP 135.
euIossEnabled
boolean
If true and order is sent to EU - charges VAT for orders less than EUR 150. For Import One-Stop Shop (IOSS).
taxOnShippingCalculationScheme
string
Shipping tax calculation schemes. Default value: AUTOMATIC. Possible values: AUTOMATIC, BASED_ON_PRODUCT_TAXES_PROPORTION_BY_PRICE, BASED_ON_PRODUCT_TAXES_PROPORTION_BY_WEIGHT, TAXED_SEPARATELY_FROM_PRODUCTS
id
number
Unique internal ID of the tax
name
string
Displayed tax name
enabled
boolean
Whether tax is enabled true / false
includeInPrice
boolean
useShippingAddress
boolean
true if the tax is calculated based on shipping address, false if billing address is used
taxShipping
boolean
true is the tax applies to subtotal+shipping cost . false if the tax is applied to subtotal only
appliedByDefault
boolean
true if the tax is applied to all products. false is the tax is only applied to thos product that have this tax enabled
defaultTax
number
Tax value, in %, when none of the destination zones match
rules
Tax rates
zoneId
string
Destination zone ID
tax
number
Tax rate for this zone in %
System Settings → Zones
name
string
Zone displayed name.
countryCodes
Array of strings
Country codes this zone includes .
stateOrProvinceCodes
Array of strings
State or province codes the zone includes.
postCodes
Array of strings
geoPolygons
<COORDINATES>
Array of arrays
Each array contains coordinates of a single dot of the polygon. (E.g. [ [37.036539581171105, -95.66864041664617], [37.07548018723009, -95.6404782452158], ...]).
name
string
ID name, e.g. Vat ID, P.IVA, ABN
value
string
ID value
System Settings → General → Instant site
ecwidSubdomain
string
Store subdomain on ecwid.com domain, e.g. mysuperstore in mysuperstore.ecwid.com
customDomain
string
Custom Instant site domain, e.g. www.mysuperstore.com
generatedUrl
string
Instant Site generated URL, e.g. http://mysuperstore.ecwid.com/
storeLogoUrl
string
Instant Site logo URL
System Settings → General → Legal Pages
requireTermsAgreementAtCheckout
boolean
true if customers must agree to store's terms of service at checkout
legalPages
Information about the legal pages set up in a store
type
string
Legal page type. One of: "LEGAL_INFO", "SHIPPING_COST_PAYMENT_INFO", "REVOCATION_TERMS", "TERMS", "PRIVACY_STATEMENT"
enabled
boolean
true if legal page is shown at checkout process, false otherwise
title
string
Legal page title
titleTranslated
Available translations for legal page title.
display
string
Legal page display mode – in a popup or on external URL. One of: "INLINE", "EXTERNAL_URL"
displayTranslated
Legal translated page display mode – in a popup or on external URL. One of: "INLINE", "EXTERNAL_URL"
text
string
HTML contents of a legal page
textTranslated
Available translations for legal page text.
externalUrl
string
URL to external location of a legal page
externalUrlTranslated
URL to external location of a translated legal page
paymentOptions
Details about all payment methods set up in that store
applePay
Details about Apple Pay setup in that store
applePayOptions
Details about payment processors accepting Apple Pay
id
string
Payment method ID in a store
enabled
boolean
true if payment method is enabled and shown in storefront, false otherwise
configured
boolean
checkoutTitle
string
Payment method title at checkout
checkoutTitleTranslated
Available translations for payment option title.
checkoutDescription
string
Payment method description at checkout (subtitle)
paymentProcessorId
string
Payment processor ID in Ecwid
paymentProcessorTitle
string
Payment processor title. The same as paymentModule in order details in REST API
orderBy
number
Payment method position at checkout and in Ecwid Control Panel. The smaller the number, the higher the position is
appClientId
string
client_id value of payment application. "" if not an application
paymentSurcharges
Payment method fee added to the order as a set amount or as a percentage of the order total
instructionsForCustomer
Customer instructions details
shippingSettings
Shipping settings of the payment option
type
string
Supported values: ABSOLUTE, PERCENT
value
number
Surcharge value
enabled
boolean
true if Apple Pay is enabled and shown in storefront, false otherwise
available
boolean
true if Stripe payment method is set up, false otherwise
gateway
string
Always "stripe"
verificationFile
string
instructionsTitle
string
Payment instructions title
instructions
string
Payment instructions content. Can contain HTML tags
instructionsTranslated
Available translations for instructions.
enabledShippingMethods
Array of strings
Contains IDs of shipping methods, if payment method is available for certain shipping methods only ("Payment Per Shipping" feature)
name
string
Feature name
visible
boolean
true if feature is shown to merchant in Ecwid Control Panel > Settings > What's new. false otherwise
enabled
boolean
true if feature is enabled and active in store
DESIGN_CONFIG_FIELD_NAME
string or boolean
enabledInStorefront
boolean
true if product filters are enabled in storefront. false otherwise.
filterSections
Specific product filters
type
string
Type of specific product filter. Possible values: IN_STOCK, ON_SALE, PRICE, CATEGORIES, SEARCH, SKU, OPTION, ATTRIBUTE, LOCATIONS.
name
string
Name of the product field. Works only with OPTION and ATTRIBUTE filter types and is required for them.
displayComponent
string
Style of displaying OPTION filters on the storefront.
One of:
CHECKBOXES - Default checkboxes style.
BUTTON_GRID - Grid with buttons that better suits product options like "Size".
enabled
boolean
true if specific product filter is enabled. false otherwise
autoAbandonedSalesRecovery
boolean
true if abandoned sale recovery emails are sent automatically, false otherwise
displayOnProductList
boolean
true if sale price is displayed on product list and product details page. false if sale price is displayed on product details page only
oldPriceLabel
string
Text label for sale price name
oldPriceLabelTranslated
Translations for sale price text labels
displayDiscount
string
Show discount in three modes: "NONE", "ABS" and "PERCENT
enabled
boolean
true if enabled, false otherwise
fbMessengerPageId
string
Page ID of the connected page on Facebook
fbMessengerThemeColor
string
Chat color theme for FB Messenger
fbMessengerMessageUsButtonColor
string
Color for the FB Messenger button in storefront
script
string
JS script for the Mailchimp integration, e.g. "<script id="mcjs">!function...</script>"
Settings for the Facebook page
Settings for the Instagram page
Settings for the Twitter page
youtube
Settings for the Youtube page
vk
Settings for the VK page
Settings for the Pinterest page
url
string
URL for the social media page
displayOrderInvoices
boolean
If false, Ecwid will disable printing and viewing order invoices for customer and store admin. If true, order invoices will be available to view and print.
attachInvoiceToOrderEmailNotifications
string
Possible values: "ATTACH_TO_ALL_EMAILS", "DO_NOT_ATTACH".
invoiceLogoUrl
string
Invoice logo URL.
Object with text field translations in the "lang": "text" format, where the "lang" is an ISO 639-1 language code. For example:
Translations are available for all active store languages. Only the default language translations are returned if no other translations are provided for the field. Find active store languages with GET /profile request > languages > enabledLanguages.
alreadySelling
string
Answer to the question "Do you already have experience selling online?", supported values: getting_started, offline_only, online_different, looking_around
goods
string
Answer to the question "What type of products will you be selling?", 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
otherGoods
string
Applicable if the field goods has value other. Merchant's text answer to the question "Your goods?"
forSomeone
string
Answer to the question "Are you setting up a store for someone else?", supported values: yes or no
website
string
Answer to the question "Do you already have a website?", supported values: yes or no
platform
string
Applicable if the previous answer is yes. Answer to the question "What website platform do you use?", supported values: joomla, rapid_weaver, wordpress, wix, weebly, blogspot, drupal, custom_site, not_sure, other
customPlatform
string
Applicable if the field platform has value other. Merchant's text answer to the question "Your platform?"
useFor
string
Answer to the question "What are you planning to use Ecwid for?"
shopEase
string
Answer to the question "How would you like your shop to be?"
costAttitude
string
Answer to the question "What are your budget preferences?"
pos
string
Answer to the question "What point-of-sale system are you using?"
salesChannels
string
Answer to the question Where do you sell online?"
ecom
string
Answer to the question "What e-commerce platform do you use to sell?"
products
Basic information of gift card products in a store
displayLocation
string
Display location for gift cards on storefront: "CATALOG_AND_FOOTER" and "CATALOG". Read only field
id
number
Product ID
name
string
Gift card product name
url
string
Gift card product URL in a store
enabled
boolean
true if enabled, false otherwise
type
string
Tip type that defines how its value is calculated. Supported values:
ABSOLUTE - tip is added as a flat value
PERCENT - tip is added as a percent of the order total
options
Array of numbers
Three number values, e.g. [0, 5, 10]. Each value defines tip amount.
defaultOption
number
Default tip amount. It must match with any value from the options array.
title
string
Text displayed above the tip input field.
subTitle
string
Grayed-out text displayed upder the tip input field.
titleTranslated
Available translations for tip title.
subtitleTranslated
Available translations for tip subtitle.
channelid
string
Store channel id info
pricingPlanId
string
Store plan id
pricingPlanName
string
Store plan name
pricingPlanPeriod
string
Store plan billing period
nextRecurringChargeDate
string
Next charge date
nextRecurringChargeAmount
string
Next charge amount
nextRecurringChargeCurrency
string
Charge currency
nextRecurringChargeAmountFormatted
string
Next charge in the amount and currency format
inGracePeriod
boolean
true if store is on the 'grace' period, false otherwise
willDowngradeAt
string
Date when the 'grace' period will expire in UTC. null if an account is not on the 'grace' period
internalBilling
boolean
Store billing. true if the store is on the internal billing, false otherwise
paymentMethod
string
Store billing payment method
billingPageVisibleInCP
boolean
Store’s ‘Billing and Plans’ page in the Control Panel. true if the page is visible in the Control Panel, false otherwise
itunesSubscriptionAvailableOnChannel
boolean
Store’s interface for iTunes subscription. true if the interface is available, false otherwise
fromDate
string
Starting date of the period, e.g. 2022-04-28.
toDate
string
The end date of the period, e.g. 2022-04-30.
repeatedAnnually
boolean
Specifies whether the period repeats in the following years or not.
Object
Object
Object
Object
Object
Object
Object
Object
Object
Array
Array
Object
Object
Object
Array
Object
Object
Object
Object
Object
Object
Object
Object
Object
Object
Object
Object
Details of Ecwid Instant site for account. Learn more about .
Object
connected to a store
Your Facebook Pixel ID. This field is not returned if it is empty in the Ecwid Control Panel.
Object
Object
Object
Object
Snapchat pixel ID from your
Pinterest Tag Id from your
Global site tag from your
Event snippet from your
Object
true if is enabled, false otherwise
Object
Object
Object
Object
Object
Object
Object
Object
Object
Object
Object
Object
Object
Object
Object
Object
Object
Object
(e.g. NY) or a region name.
Object
Object
Object
Array
Object
Array
Object
Array
Object
Object
Object
Object
Object
Object
The merchant can specify the maximum possible delivery date for ("Allow choosing pickup date within"). Values: THREE_DAYS, SEVEN_DAYS, ONE_MONTH, THREE_MONTHS, SIX_MONTHS, ONE_YEAR, UNLIMITED.
Object
Object
Object
Object
Object
Array
true if the tax rate is included in product prices. More details:
Array
Postcode (or zip code) templates this zone includes. More details: .
Object
Dot coordinates of the polygon (if destination zone is created using ).
Array
Object
Object
Object
Object
Array
Object
Object
Contains the payment method setup status. Read-only for in-built payment methods (where "appClientId": ""). Can be set for payment applications and will affect the payment method list in a store dashboard, see .
Object
Array
Object
Object
Object
Store design settings as seen in . If a specific config field is not provided, it will not be changed
array of objects
Object
Object
Object
Object
Object
Object
Object
Array
Object
Object