Update basic store information in an Ecwid store: settings, store location, email, etc.
Access scopes
Requires the following access scope: update_store_profile
Headers
Name
Type
Description
Authorization
string
Authorize request with an access token. Format:Bearer access_token.
Example: Bearer secret_ab***cd, where secret_ab***cd is your access token.
Request
A JSON object of type 'Profile' with the following fields:
📘
All fields are optional. Omitted field will not be affected
Profile
Field
Type
Description
generalInfo
<GeneralInfo>
Store basic data
account
<Account>
Store owner's account data
settings
<Settings>
Store general settings
mailNotifications
<MailNotifications>
Mail notifications settings
phoneNotifications
<phoneNotifications>
Phone notifications settings (for future usage).
company
<Company>
Company info
formatsAndUnits
<FormatsAndUnits>
Store formats/untis settings
languages
<Languages>
Store language settings
shipping
<Shipping>
Store shipping settings (only handling fee is included at the moment)
taxSettings
<TaxSettings>
Store taxes settings
zones
Array<Zone>
Store destination zones
businessRegistrationID
<BusinessRegistrationID>
Company registration ID, e.g. VAT reg number or company ID, which is set under Settings / Invoice in Control panel
legalPagesSettings
<LegalPagesSettingsDetails>
Legal pages settings for a store (System Settings → General → Legal Pages)
designSettings
<DesignSettingsInfo>
Design settings of an Ecwid store. Can be overriden by updating store profile or by customizing design via JS config in storefront. If designSettings field is not provided in request, it will not be changed
productFiltersSettings
<ProductFiltersSettings>
Settings for product filters in a store
orderInvoiceSettings
<OrderInvoiceSettings>
Store settings for order invoices
taxInvoiceSettings
<TaxInvoiceSettings>
Store settings for tax invoices
registrationAnswers
<RegistrationAnswers>
Merchants' answers provided while registering their Ecwid accounts
tipsSettings
<TipsSettings>
Store settings for tips
GeneralInfo
Field
Type
Description
storeUrl
string
Storefront URL. If this field is empty in the store settings and omitted in the request, it will be automatically copied from the current Instant Site URL. When updating, make sure to add protocol to the URL (http:// or https://).
starterSite
<InstantSiteInfo>
Instant Site settings
websitePlatform
string
Website platform that store is added to. Possible values: "wix", "wordpress", "iframe", "joomla", "yola", etc. Default is "unknown".
Account
Field
Type
Description
accountName
string
Full store owner name
Settings
Field
Type
Description
closed
string
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
googleRemarketingEnabled
boolean
true if Remarketing with Google Analytics is enabled, false otherwise
3-letters code of the store currency (ISO 4217). Examples: USD, CAD
currencyPrefix
string
Currency prefix (e.g. $)
currencySuffix
string
Currency suffix
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. Possible values: IN,CM,MM,YD
orderNumberPrefix
string
Order number prefix in a store
orderNumberSuffix
string
Order number suffix in a store
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
<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%.
AddressFormat
Field
Type
Description
plain
string
Single line address format, with a delimiter.
multiline
string
Multiline address format.
Languages
System Settings → General → Languages
Field
Type
Description
enabledLanguages
Array<string>
A list of enabled languages in the storefront. Use first item to set default storefront language
defaultLanguage
string
ISO code of the default language in store
Shipping
System Settings → Shipping
Field
Type
Description
handlingFee
<HandlingFee>
Handling fee settings
HandlingFee
System Settings → Shipping → Handling Fee
Field
Type
Description
name
string
Handling fee name set by store admin. E.g. Wrapping
value
number
Handling fee value. If handling fee is 0 then it's disabled.
description
string
Handling fee description for customer
TaxSettings
System Settings → Taxes
Field
Type
Description
automaticTaxEnabled
boolean
true if taxes are calculated automatically, else otherwise
taxes
Array<Taxes>
Manual tax settings for a store. To create a new tax, send all existing taxes and add a new one to the array, without id field
pricesIncludeTax
boolean
true if store has "gross prices" setting enabled. false if store has "net prices" setting enabled.
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).
Store subdomain on ecwid.com domain, e.g. mysuperstore in mysuperstore.ecwid.com (will be ignored if you update with the subdomain that already exists)
customDomain
string
Custom Instant site domain, e.g. www.mysuperstore.com More info: Buying custom domains
LegalPagesSettingsDetails
System Settings → General → Legal Pages
Field
Type
Description
requireTermsAgreementAtCheckout
boolean
true if customers must agree to store's terms of service at checkout
legalPages
<LegalPagesInfo>
Information about the legal pages set up in a store
LegalPagesInfo
Field
Type
Description
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
< Translations>
Available translations for legal page title.
display
string
Legal page display mode – in a popup or on external URL. One of: "INLINE", "EXTERNAL_URL"
text
string
HTML contents of a legal page
textTranslated
< Translations>
Available translations for legal page text.
externalUrl
string
URL to external location of a legal page
DesignSettingsInfo
Field
Type
Description
DESIGN_CONFIG_FIELD_NAME
string or boolean
Store design settings as seen in storefront design customization. If a specific config field is not provided, it will not be changed
ProductFiltersSettings
Field
Type
Description
enabledInStorefront
boolean
true if product filters are enabled in storefront. false otherwise.
filterSections
<ProductFiltersSections>
Specific product filters in a store. Use PUT method to add/update/delete these
ProductFiltersSections
Field
Type
Description
name
boolean
Name of the product field. Works only with OPTION and ATTRIBUTE filter types and is required for them
type
boolean
Type of specific product filter. Possible values: PRICE, IN_STOCK, ON_SALE, CATEGORIES, SEARCH, OPTION, ATTRIBUTE
enabled
boolean
true if specific product filter is enabled. false otherwise
AbandonedSalesSettings
Field
Type
Description
autoAbandonedSalesRecovery
boolean
true if abandoned sale recovery emails are sent automatically, false otherwise
SalePriceSettings
Field
Type
Description
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>
Translations for sale price text labels
displayDiscount
string
Show discount in three modes: "NONE", "ABS" and "PERCENT
OrderInvoiceSettings
Field
Type
Description
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".
If false, Ecwid will disable printing and viewing tax invoices for customer and store admin. If true, tax invoices will be available to view and print
attachTaxInvoiceToOrderEmailNotifications
string
Possible values: "ATTACH_TO_ALL_EMAILS", "DO_NOT_ATTACH".
generateInvoicesAutomatically
string
Possible values: "DISABLED", "ON_ORDER_PLACED", "WHEN_ORDER_PLACED", "WHEN_ORDER_PAID", "WHEN_ORDER_SHIPPED"
taxInvoiceIdMinDigitsAmount
number
Minimal digits amount for tax number
taxInvoiceIdNextNumber
number
Number of the next tax invoice
SocialLinks
Field
Type
Description
facebook
<SocialLinksSettings>
Settings for the Facebook page
instagram
<SocialLinksSettings>
Settings for the Instagram page
twitter
<SocialLinksSettings>
Settings for the Twitter page
youtube
<SocialLinksSettings>
Settings for the Youtube page
vk
<SocialLinksSettings>
Settings for the Vkontakte page
pinterest
<SocialLinksSettings>
Settings for the Pinterest page
SocialLinksSettings
Field
Type
Description
url
string
URL for the social media page
RegistrationAnswers
Field
Type
Description
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, 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 field website has value 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?"
TipsSettings
Field
Type
Description
enabled
boolean
true if enabled, false otherwise
type
string
Supported values: 'ABSOLUTE', 'PERCENT'
options
array
Array with 3 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
Tip title
subTitle
string
Tip subtitle
titleTranslated
<Translations>
Available translations for tip title
subtitleTranslated
<Translations>
Available translations for tip subtitle
Translations
Object with text field translations in the "lang": "text" format, where the "lang" is an ISO 639-1 language code. Example:
{
"en": "Sample text",
"nl": "Voorbeeldtekst"
}
Translations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings.
Response
A JSON object with the following fields:
UpdateStatus
Field
Type
Description
updateCount
number
Update status (1 – success or 0 – fail)
Language
Click Try It! to start a request and see the response here!