Get store profile

Get basic information about an Ecwid store: settings, store location, email, etc. This request is available with any access token.

Headers

NameTypeDescription
AuthorizationstringoAuth token with mandatory Bearer before it. Example: Bearer e***s0, where e***s0 should be replaced with your oAuth token.

Q: How can I specify what fields I want to receive in response?

Add responseFields query param, specifying field names you want to receive.
Example: ?responseFields=generalInfo(storeId,storeUrl),settings(storeName)

Query parameters

FieldTypeDescription
showExtendedInfobooleanIf set to true, then the accountBilling fields are returned, if false, then the accountBilling fields are not returned. The access scope READ_STORE_PROFILE_EXTENDED is required.
langstringISO code of the language you expect to receive JSON data in (e.g. en, fr). Is used for the fields that have translations: title, description, pickupInstruction, text and etc.

Response

A JSON object of type 'Profile' with the following fields:

Profile

FieldTypeDescription
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
taxSettings<TaxSettings>Store taxes settings
zonesArray<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)
payment<PaymentInfo>Store payment settings information
featureToggles<FeatureTogglesInfo>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
designSettings<DesignSettingsInfo>Design settings of an Ecwid store. Can be overriden by updating store profile or by customizing design via JS config in storefront.
productFiltersSettings<ProductFiltersSettings>Settings for product filters in a store
fbMessengerSettings<FBMessengerSettings>Store settings for FB Messenger feature. Read only
mailchimpSettings<MailchimpSettings>Store settings for Mailchimp integration. Read only
orderInvoiceSettings<OrderInvoiceSettings>Store settings for order invoices
socialLinksSettings<SocialLinks>Store settings for social media accounts
registrationAnswers<RegistrationAnswers>Merchants' answers provided while registering their Ecwid accounts
giftCardSettings<GiftCardSettings>Store settings for gift cards
tipsSettings<TipsSettings>Store settings for tips
accountBilling<AccountBilling>Store billing and plan info

GeneralInfo

FieldTypeDescription
storeIdnumberEcwid Store ID
storeUrlstringStorefront URL
starterSite<InstantSiteInfo>Details of Ecwid Instant site for account. Learn more about Instant site
websitePlatformstringWebsite platform that store is added to. Possible values: "wix", "wordpress", "iframe", "joomla", "yola", etc. Default is "unknown".

Account

FieldTypeDescription
accountNamestringFull store owner name
accountNickNamestringStore owner nickname on the Ecwid forums
accountEmailstringStore owner email. Note: Not WL-friendly. If you want to send notifications/emails to customers, use adminNotificationEmailsfield instead.
whiteLabelbooleantrue if Ecwid brand is not mentioned in merchant's interface, false otherwise. Read only
suspendedbooleantrue if Ecwid account is suspended (prevents the storefront from showing any products or creating orders), false otherwise. Read only
availableFeaturesArray<string>A list of the premium features available on the store's pricing plan
registrationDatestringThe store registration date
limitsAndRestrictions<LimitsAndRestrictions>Store limits and restrictions, e.g. maximum number of available products. Required scope: READ_STORE_LIMITS

LimitsAndRestrictions

FieldTypeDescription
maxProductLimitnumberMaximum 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.

Settings

FieldTypeDescription
closedbooleantrue if the store is closed for maintenance, false otherwise
storeNamestringThe store name displayed in Instant Site
storeDescriptionstringHTML description for the main store page – Store Front page
invoiceLogoUrlstringCompany logo displayed on the invoice
emailLogoUrlstringCompany logo displayed in the store email notifications
googleRemarketingEnabledbooleantrue if Remarketing with Google Analytics is enabled, false otherwise
googleAnalyticsIdstringGoogle Analytics ID connected to a store
fbPixelIdstringYour Facebook Pixel ID. This field is not returned if it is empty in the Ecwid Control Panel. Learn more
orderCommentsEnabledbooleantrue if order comments feature is enabled, false otherwise
orderCommentsCaptionstringCaption for order comments field in storefront
orderCommentsCaptionTranslated<Translations>Available translations for the caption for order comments field.
orderCommentsRequiredbooleantrue if order comments are required to be filled, false otherwise
askZipCodebooleantrue if the zip code field is shown on the checkout ('Ask for a ZIP/postal code' in checkout settings is enabled), false otherwise
showPricePerUnitbooleantrue if the "Show price per unit" option is turned on, otherwise false
hideOutOfStockProductsInStorefrontbooleantrue if out of stock products are hidden in storefront, false otherwise. This setting is located in Ecwid Control Panel > Settings > General > Cart
askCompanyNamebooleantrue if "Ask for the company name" in checkout settings is enabled, false otherwise
favoritesEnabledbooleantrue if favorites feature is enabled for storefront, false otherwise
defaultProductSortOrderstringDefault 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<AbandonedSalesSettings>Abandoned sales settings
salePrice<SalePriceSettings>Sale (compare to) price settings
showAcceptMarketingCheckboxbooleantrue if merchant shows the checkbox to accept marketing. false otherwise
acceptMarketingCheckboxDefaultValuebooleanDefault value for the checkbox at checkout to accept marketing
acceptMarketingCheckboxCustomTextstringCustom text label for the checkbox to accept marketing at checkout
acceptMarketingCheckboxCustomTextTranslated<Translations>Available translations for custom text label for the checkbox to accept marketing at checkout.
askConsentToTrackInStorefrontbooleantrue if merchant shows warning to accept cookies in storefront. false otherwise
snapPixelIdstringSnapchat pixel ID from your Snapchat business account
pinterestTagIdstringPinterest Tag Id from your Pinterest business account
googleTagIdstringGlobal site tag from your Google Ads account
googleEventIdstringEvent snippet from your Google Ads account
recurringSubscriptionsSettings<RecurringSubscriptionsSettings>Recurring subscription settings information.
allowPreordersForOutOfStockProductsbooleantrue if pre-orders for out of stock products are allowed, false otherwise.

MailNotifications

FieldTypeDescription
adminNotificationEmailsArray<string>Email addresses, which the store admin notifications are sent to
customerNotificationFromEmailstringThe email address used as the 'reply-to' field in the notifications to customers
customerOrderMessages<CustomerOrderMessages>Settings for email notifications that are automatically sent to customers to confirm their orders and keep them informed about the order progress
adminMessages<AdminMessages>Settings for email notifications that are automatically sent to the store owner and staff members
customerMarketingMessages<CustomerMarketingMessages>Settings for email notifications that are automatically sent to customers to engage them and increase store sales

CustomerOrderMessages

FieldTypeDescription
orderConfirmation<MailNotificationsSettings>Settings for Order confirmation emails. Supported settings: enabled, marketingBlockEnabled, discountCouponId
orderStatusChanged<MailNotificationsSettings>Settings for Order status changed emails. Supported settings: enabled
orderIsReadyForPickup<MailNotificationsSettings>Settings for Order is ready for pickup emails. Supported settings: enabled
downloadEgoods<MailNotificationsSettings>Settings for Download e-goods emails. Supported settings: enabled
orderShipped<MailNotificationsSettings>Settings for Order shipped emails. Supported settings: enabled

AdminMessages

FieldTypeDescription
newOrderPlaced<MailNotificationsSettings>Settings for New order placed emails. Supported settings: enabled
lowStockNotification<MailNotificationsSettings>Settings for Low stock notification emails. Supported settings: enabled
weeklyStatsReport<MailNotificationsSettingss>Settings for weekly stats reports. Supported settings: enabled

CustomerMarketingMessages

FieldTypeDescription
abandonedCartRecovery<MailNotificationsSettings>Settings for Order confirmation emails. Supported settings: enabled, marketingBlockEnabled, discountCouponId
favoriteProductsReminder<MailNotificationsSettings>Settings for Order status changed emails. Supported settings: enabled, discountCouponId
feedbackRequest<MailNotificationsSettings>Settings for Order is ready for pickup emails. Supported settings: enabled, discountCouponId
customerLoyaltyAppreciation<MailNotificationsSettings>Settings for Order confirmation emails. Supported settings: enabled, discountCouponId
inactiveCustomerReminder<MailNotificationsSettings>Settings for Order status changed emails. Supported settings: enabled, discountCouponId
purchaseAnniversary<MailNotificationsSettings>Settings for Order is ready for pickup emails. Supported settings: enabled, discountCouponId

MailNotificationsSettings

FieldTypeDescription
enabledbooleantrue if emails are enabled, false otherwise
marketingBlockEnabledbooleantrue if the marketing block for emails is enabled, false otherwise
discountCouponIdnumberid of the discount coupon added to emails

phoneNotifications

FieldTypeDescription
adminNotificationPhonesArray of stringsPhone numbers that are used for store admin notifications, supports up to 100 phone numbers (for future usage).

RecurringSubscriptionsSettings

FieldTypeDescription
showRecurringSubscriptionsInControlPanelbooleantrue if recurring subscriptions feature is visible in admin panel, false otherwise.
supportedPaymentMethodsStatuses<SupportedPaymentMethodsStatuses>Supported payment methods statuses information.

SupportedPaymentMethodsStatuses

FieldTypeDescription
supportedPaymentMethodsAreAvailablebooleantrue if Stripe payment method can be set up in the store, false otherwise. Depends on a country. Read only.
supportedPaymentMethodsAreConnectedbooleantrue if Stripe payment method it set up in the store, false otherwise. Read only.

Company

System Settings → General → Store Profile

FieldTypeDescription
companyNamestringThe company name displayed on the invoice
emailstringCompany (store administrator) email
streetstringCompany address. 1 or 2 lines separated by a new line character
citystringCompany city
countryCodestringA two-letter ISO code of the country
postalCodestringPostal code or ZIP code
stateOrProvinceCodestringState code (e.g. NY) or a region name. See valid codes here: https://api-docs.ecwid.com/reference/list-of-state-codes.
phonestringCompany phone number

FormatsAndUnits

System settings → General → Formats & Units.

FieldTypeDescription
currencystring3-letters code of the store currency (ISO 4217). Examples: USD, CAD
currencyPrefixstringCurrency prefix (e.g. $)
currencySuffixstringCurrency suffix
currencyPrecisionnumberNumbers of digits after decimal point in the store prices. E.g. 2 ($2.99) or 0 (¥500).
currencyGroupSeparatorstringPrice thousands separator. Supported values: space " ", dot ".", comma "," or empty value "".
currencyDecimalSeparatorstringPrice decimal separator. Possible values: . or ,
currencyTruncateZeroFractionalbooleanHide zero fractional part of the prices in storefront. true or false .
currencyRatenumberCurrency rate in U.S. dollars, as set in the merchant control panel
weightUnitstringWeight unit. Supported values: CARAT, GRAM, OUNCE, POUND, KILOGRAM
weightPrecisionnumberNumbers of digits after decimal point in weights displayed in the store
weightGroupSeparatorstringWeight thousands separator. Supported values: space " ", dot ".", comma "," or empty value ""
weightDecimalSeparatorstringWeight decimal separator. Possible values: . or ,
weightTruncateZeroFractionalbooleanHide zero fractional part of the weight values in storefront. true or false .
dateFormatstringDate 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"
timeFormatstringTime format. Only these formats are accepted: "HH:mm:ss", "HH:mm", "hh.mm.ss a", "hh:mm a"
timezonestringStore timezone, e.g. Europe/Moscow
dimensionsUnitstringProduct dimensions units. Supported values: MM, CM, IN, YD
orderNumberPrefixstringOrder number prefix in a store
orderNumberSuffixstringOrder number suffix in a store
orderNumberMinDigitsAmountnumberMinimum digits amount of an order number (can be 0-19 digits).
orderNumberNextNumbernumberNext 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

FieldTypeDescription
plainstringSingle line address format, with a delimiter.
multilinestringMultiline address format.

Languages

System Settings → General → Languages

FieldTypeDescription
enabledLanguagesArray<string>A list of enabled languages in the storefront. First language code is the default language for the store.
facebookPreferredLocalestringLanguage automatically chosen be default in Facebook storefront (if any)
defaultLanguagestringISO code of the default language in store

Shipping

System Settings → Shipping

FieldTypeDescription
handlingFee<HandlingFee>Handling fee settings
shippingOrigin<ShippingOrigin>Shipping origin address. If matches company address, company address is returned. Available in read-only mode only
shippingOptionsArray <ShippingOptions>Details of each shipping option present in a store. For public tokens enabled methods are returned only. Available in read-only mode only

HandlingFee

System Settings → Shipping → Handling Fee

FieldTypeDescription
namestringHandling fee name set by store admin. E.g. Wrapping
valuenumberHandling fee value
descriptionstringHandling fee description for customer

ShippingOrigin

Settings → Shipping & Pickup → Origin address

FieldTypeDescription
companyNamestringThe company name displayed on the invoice
emailstringCompany (store administrator) email
streetstringCompany address. 1 or 2 lines separated by a new line character
citystringCompany city
countryCodestringA two-letter ISO code of the country
postalCodestringPostal code or ZIP code
stateOrProvinceCodestringState code (e.g. NY) or a region name
phonestringCompany phone number

ShippingOptions

FieldTypeDescription
idstringUnique ID of shipping option
titlestringTitle of shipping option in store settings
titleTranslated<Translations>Available translations for shipping option title.
enabledbooleantrue if shipping option is used at checkout to calculate shipping. false otherwise
orderbynumberSort position or shipping option at checkout and in store settings. The smaller the number, the higher the position
fulfilmentTypestringFulfillment type. "pickup" for in-store pickup methods, "delivery" for local delivery methods, "shipping" for everything else
locationIdnumberID of the pickup location for Lightspeed X-Series integration
minimumOrderSubtotalnumberOrder 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<Zone>Destination zone set for shipping option. Empty for public token
deliveryTimeDaysstringEstimated delivery time in days. Currently, it is equal to the description value.
descriptionstringShipping method description.
descriptionTranslated<Translations>Available translations for shipping option description.
carrierstringCarrier used for shipping the order. Is provided for carrier-calculated shipping options
carrierMethodsArray <CarrierMethod>Carrier-calculated shipping methods available for this shipping option
carrierSettings<CarrierSettings>Carrier-calculated shipping option settings
ratesCalculationTypestringRates calculation type. One of "carrier-calculated", "table", "flat", "app"
shippingCostMarkupnumberShipping cost markup for carrier-calculated methods
flatRate<FlatRate>Flat rate details
ratesTable<TableRatesDetails>Custom table rates details
appClientIdstringclient_id value of the app (for custom shipping apps only)
pickupInstructionstringString of HTML code of instructions on in-store pickup
pickupInstructionTranslated<Translations>Available translations for pickup instruction.
scheduledPickupbooleantrue if pickup time is scheduled, false otehrwise. (Ask for Pickup Date and Time at Checkout option in pickup settings)
pickupPreparationTimeHoursnumberAmount of time required for store to prepare pickup (Order Fulfillment Time setting) DEPRECATED
fulfillmentTimeInMinutesnumberAmount of time (in minutes) required for store to prepare pickup or to deliver an order (Order Fulfillment Time setting)
businessHoursstring <BusinessHours>Available and scheduled times to pickup orders
pickupBusinessHoursstring <BusinessHours>[Deprecated] Available and scheduled times to pickup orders (duplicates businessHours field)
businessHoursLimitationTypestringOne 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.
scheduledbooleantrue if "Allow to select delivery date or time at checkout" or "Ask for Pickup Date and Time at Checkout" setting is enabled. false otherwise.
scheduledTimePrecisionTypestringFormat of how delivery date is chosen at the checkout - date or date and time. One of: DATE, DATE_AND_TIME_SLOT.
timeSlotLengthInMinutesnumberLength of the delivery time slot in minutes.
allowSameDayDeliverybooleantrue if same-day delivery is allowed. false otherwise.
cutoffTimeForSameDayDeliverystringOrders placed after this time (in a 24-hour format) will be scheduled for delivery the next business day.
availabilityPeriodstringThe merchant can specify the maximum possible delivery date for local delivery and pickup shipping options ("Allow choosing pickup date within"). Values: THREE_DAYS, SEVEN_DAYS, ONE_MONTH, THREE_MONTHS, SIX_MONTHS, ONE_YEAR, UNLIMITED.
blackoutDatesarray <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.

CarrierMethod

FieldTypeDescription
idstringCarrier ID and specific method name
namestringCarrier method name
enabledbooleantrue if enabled, false otherwise
orderBynumberPosition of that carrier method

CarrierSettings

FieldTypeDescription
defaultCarrierAccountEnabledbooleantrue if default Ecwid account is enabled to calculate the rates. false otherwise
defaultPostageDimensions<DefaultPostageDimensions>Default postage dimensions for this shipping option

DefaultPostageDimensions

FieldTypeDescription
lengthnumberLength of postage
widthnumberWidth of postage
heightnumberHeight of postage

FlatRate

FieldTypeDescription
rateTypestringOne of "ABSOLUTE", "PERCENT"
ratenumberShipping rate

TableRatesDetails

FieldTypeDescription
tableBasedOnstringWhat is this table rate based on. Possible values: "subtotal", "discountedSubtotal", "weight"
ratesArray <TableRate>Details of table rate

TableRate

FieldTypeDescription
conditions<TableRateConditions>Conditions for this shipping rate in custom table
rate<TableRateDetails>Table rate details

TableRateConditions

FieldTypeDescription
weightFromnumber"Weight from" condition value
weightTonumber"Weight to" condition value
subtotalFromnumber"Subtotal from" condition value
subtotalTonumber"Subtotal to" condition value
discountedSubtotalFromnumber"Discounted subtotal from" condition value
discountedSubtotalTonumber"Discounted subtotal from" condition value

TableRateDetails

FieldTypeDescription
perOrdernumberAbsolute per order rate
percentnumberPercent per order rate
perItemnumberAbsolute per item rate
perWeightnumberAbsolute per weight rate

BusinessHours

FieldTypeDescription
MONArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
TUEArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
WEDArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
THUArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
FRIArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
SATArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']
SUNArray time rangeArray of time ranges in format ["FROM TIME", "TO TIME"]. Ex: ['08:30', '13:30'], ['13:30', '19:00']

TaxSettings

System Settings → Taxes

FieldTypeDescription
automaticTaxEnabledbooleantrue if store taxes are calculated automatically, else otherwise. As seen in the Ecwid Control Panel > Settings > Taxes > Automatic
taxesArray<Taxes>Manual tax settings for a store
pricesIncludeTaxbooleantrue if store has "gross prices" setting enabled. false if store has "net prices" setting enabled.
taxExemptBusinessbooleanDefines 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.
ukVatRegisteredbooleanIf true and order is sent from EU to UK - charges VAT for orders less than GBP 135.
euIossEnabledbooleanIf true and order is sent to EU - charges VAT for orders less than EUR 150. For Import One-Stop Shop (IOSS).
taxOnShippingCalculationSchemestringShipping 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

Taxes

FieldTypeDescription
idnumberUnique internal ID of the tax
namestringDisplayed tax name
enabledbooleanWhether tax is enabled true / false
includeInPricebooleantrue if the tax rate is included in product prices. More details: Taxes in Ecwid
useShippingAddressbooleantrue if the tax is calculated based on shipping address, false if billing address is used
taxShippingbooleantrue is the tax applies to subtotal+shipping cost . false if the tax is applied to subtotal only
appliedByDefaultbooleantrue if the tax is applied to all products. false is the tax is only applied to thos product that have this tax enabled
defaultTaxnumberTax value, in %, when none of the destination zones match
rulesArray<TaxRule>Tax rates

TaxRule

FieldTypeDescription
zoneIdstringDestination zone ID
taxnumberTax rate for this zone in %

Zone

System Settings → Zones

FieldTypeDescription
namestringZone displayed name.
countryCodesArray<string>Country codes this zone includes .
stateOrProvinceCodesArray<string>State or province codes the zone includes.
postCodesArray<string>Postcode (or zip code) templates this zone includes. More details: Destination zones in Ecwid.
geoPolygonsArray <GeoPolygons>Dot coordinates of the polygon (if destination zone is created using Zone on Map).

GeoPolygons

FieldTypeDescription
<COORDINATES>Array of arraysEach array contains coordinates of a single dot of the polygon. (E.g. [ [37.036539581171105, -95.66864041664617], [37.07548018723009, -95.6404782452158], ...]).

BusinessRegistrationID

FieldTypeDescription
namestringID name, e.g. Vat ID, P.IVA, ABN
valuestringID value

InstantSiteInfo

System Settings → General → Instant site

FieldTypeDescription
ecwidSubdomainstringStore subdomain on ecwid.com domain, e.g. mysuperstore in mysuperstore.ecwid.com
customDomainstringCustom Instant site domain, e.g. www.mysuperstore.com
generatedUrlstringInstant Site generated URL, e.g. http://mysuperstore.ecwid.com/
storeLogoUrlstringInstant Site logo URL

LegalPagesSettingsDetails

System Settings → General → Legal Pages

FieldTypeDescription
requireTermsAgreementAtCheckoutbooleantrue 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

FieldTypeDescription
typestringLegal page type. One of: "LEGAL_INFO", "SHIPPING_COST_PAYMENT_INFO", "REVOCATION_TERMS", "TERMS", "PRIVACY_STATEMENT"
enabledbooleantrue if legal page is shown at checkout process, false otherwise
titlestringLegal page title
titleTranslated<Translations>Available translations for legal page title.
displaystringLegal page display mode – in a popup or on external URL. One of: "INLINE", "EXTERNAL_URL"
displayTranslated<Translations>Legal translated page display mode – in a popup or on external URL. One of: "INLINE", "EXTERNAL_URL"
textstringHTML contents of a legal page
textTranslated<Translations>Available translations for legal page text.
externalUrlstringURL to external location of a legal page
externalUrlTranslated<Translations>URL to external location of a translated legal page

PaymentInfo

FieldTypeDescription
paymentOptionsArray<PaymentOptionInfo>Details about all payment methods set up in that store
applePay<ApplePayInfo>Details about Apple Pay setup in that store
applePayOptions<ApplePayInfo>Details about payment processors accepting Apple Pay

PaymentOptionInfo

FieldTypeDescription
idstringPayment method ID in a store
enabledbooleantrue if payment method is enabled and shown in storefront, false otherwise
configuredbooleanContains 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 https://ecwid.d.pr/i/FpeCIb.
checkoutTitlestringPayment method title at checkout
checkoutTitleTranslated<Translations>Available translations for payment option title.
checkoutDescriptionstringPayment method description at checkout (subtitle)
paymentProcessorIdstringPayment processor ID in Ecwid
paymentProcessorTitlestringPayment processor title. The same as paymentModule in order details in REST API
orderBynumberPayment 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<PaymentSurcharges>Payment method fee added to the order as a set amount or as a percentage of the order total
instructionsForCustomer<InstructionsForCustomerInfo>Customer instructions details
shippingSettings<ShippingSettingsInfo>Shipping settings of the payment option

PaymentSurcharges

FieldTypeDescription
typestringSupported values: ABSOLUTE, PERCENT
valuenumberSurcharge value

ApplePayInfo (via Stripe payment method)

FieldTypeDescription
enabledbooleantrue if Apple Pay is enabled and shown in storefront, false otherwise
availablebooleantrue if Stripe payment method is set up, false otherwise
gatewaystringStripe
verificationFilestringhttps://stripe.com/files/apple-pay/apple-developer-merchantid-domain-association
"payment": {
        "paymentOptions": [
            ...
        ],
        "applePay": {
            "enabled": false,
            "available": true,
            "gateway": "stripe",
            "verificationFileUrl": "https://stripe.com/files/apple-pay/apple-developer-merchantid-domain-association"
        }
"payment": {
        "paymentOptions": [
            ...
        ],
        "applePay": {
            "enabled": false,
            "available": false
        }

InstructionsForCustomerInfo

FieldTypeDescription
instructionsTitlestringPayment instructions title
instructionsstringPayment instructions content. Can contain HTML tags
instructionsTranslated<Translations>Available translations for instructions.

ShippingSettings

FieldTypeDescription
enabledShippingMethodsArray of stringContains IDs of shipping methods, if payment method is available for certain shipping methods only ("Payment Per Shipping" feature)

FeatureTogglesInfo

FieldTypeDescription
namestringFeature name
visiblebooleantrue if feature is shown to merchant in Ecwid Control Panel > Settings > What's new. false otherwise
enabledbooleantrue if feature is enabled and active in store

DesignSettingsInfo

FieldTypeDescription
DESIGN_CONFIG_FIELD_NAMEstring or booleanStore design settings as seen in storefront design customization. If a specific config field is not provided, it will not be changed

ProductFiltersSettings

FieldTypeDescription
enabledInStorefrontbooleantrue if product filters are enabled in storefront. false otherwise.
filterSections<ProductFiltersSections>Specific product filters

ProductFiltersSections

FieldTypeDescription
namebooleanName of the product field. Works only with OPTION and ATTRIBUTE filter types and is required for them
typebooleanType of specific product filter. Possible values: PRICE, IN_STOCK, ON_SALE, CATEGORIES, SEARCH, OPTION, ATTRIBUTE
enabledbooleantrue if specific product filter is enabled. false otherwise

AbandonedSalesSettings

FieldTypeDescription
autoAbandonedSalesRecoverybooleantrue if abandoned sale recovery emails are sent automatically, false otherwise

SalePriceSettings

FieldTypeDescription
displayOnProductListbooleantrue if sale price is displayed on product list and product details page. false if sale price is displayed on product details page only
oldPriceLabelstringText label for sale price name
oldPriceLabelTranslated<Translations>Translations for sale price text labels
displayDiscountstringShow discount in three modes: "NONE", "ABS" and "PERCENT

FBMessengerSettings

FieldTypeDescription
enabledbooleantrue if enabled, false otherwise
fbMessengerPageIdstringPage ID of the connected page on Facebook
fbMessengerThemeColorstringChat color theme for FB Messenger
fbMessengerMessageUsButtonColorstringColor for the FB Messenger button in storefront

MailchimpSettings

FieldTypeDescription
scriptstringJS script for the Mailchimp integration, e.g. "<script id="mcjs">!function...</script>"

SocialLinks

FieldTypeDescription
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

FieldTypeDescription
urlstringURL for the social media page

OrderInvoiceSettings

FieldTypeDescription
displayOrderInvoicesbooleanIf 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.
attachInvoiceToOrderEmailNotificationsstringPossible values: "ATTACH_TO_ALL_EMAILS", "DO_NOT_ATTACH".
invoiceLogoUrlstringInvoice logo URL. Use Upload invoice logo endpoint to change the logo

Translations

FieldTypeDescription
<ISO_LANG_CODE>stringTranslations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings

RegistrationAnswers

FieldTypeDescription
alreadySellingstringAnswer to the question "Do you already have experience selling online?", supported values: getting_started, offline_only, online_different, looking_around
goodsstringAnswer 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
otherGoodsstringApplicable if the field goods has value other. Merchant's text answer to the question "Your goods?"
forSomeonestringAnswer to the question "Are you setting up a store for someone else?", supported values: yes or no
websitestringAnswer to the question "Do you already have a website?", supported values: yes or no
platformstringApplicable 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
customPlatformstringApplicable if the field platform has value other. Merchant's text answer to the question "Your platform?"

GiftCardSettings

FieldTypeDescription
productsArray <GiftCardProducts>Basic information of gift card products in a store
displayLocationstringDisplay location for gift cards on storefront: "CATALOG_AND_FOOTER" and "CATALOG". Read only field

GiftCardProducts

FieldTypeDescription
idnumberProduct ID
namestringGift card product name
urlstringGift card product URL in a store

TipsSettings

FieldTypeDescription
enabledbooleantrue if enabled, false otherwise
typestringSupported values: 'ABSOLUTE', 'PERCENT'
optionsarray<number>Three number values, e.g. '[0, 5, 10]'. Each value defines tip amount.
defaultOptionnumberDefault tip amount. It must match with any value from the 'options' array.
titlestringTip title
subTitlestringTip subtitle
titleTranslated<Translations>Available translations for tip title
subtitleTranslated<Translations>Available translations for tip subtitle

AccountBilling

FieldTypeDescription
channelidstringStore channel id info
pricingPlanIdstringStore plan id
pricingPlanNamestringStore plan name
pricingPlanPeriodstringStore plan billing period
nextRecurringChargeDatestringNext charge date
nextRecurringChargeAmountstringNext charge amount
nextRecurringChargeCurrencystringCharge currency
nextRecurringChargeAmountFormattedstringNext charge in the amount and currency format
inGracePeriodbooleantrue if store is on the 'grace' period, false otherwise
willDowngradeAtstringDate when the 'grace' period will expire in UTC. null if an account is not on the 'grace' period
internalBillingbooleanStore billing. true if the store is on the internal billing, false otherwise
paymentMethodstringStore billing payment method
billingPageVisibleInCPbooleanStore’s ‘Billing and Plans’ page in the Control Panel. true if the page is visible in the Control Panel, false otherwise
itunesSubscriptionAvailableOnChannelbooleanStore’s interface for iTunes subscription. true if the interface is available, false otherwise

BlackoutDates

FieldTypeDescription
fromDatestringStarting date of the period, e.g. 2022-04-28.
toDatestringThe end date of the period, e.g. 2022-04-30.
repeatedAnnuallybooleanSpecifies whether the period repeats in the following years or not.

Errors

In case of error, Ecwid responds with an error HTTP status code

HTTP codes

HTTP StatusMeaning
400Request parameters are malformed
402The request is not available on the merchant plan. To use Ecwid API, store must be on a paid plan
415Unsupported content-type: expected application/json or text/json
500Cannot retrieve the coupon info because of an error on the server
Language
Authorization
Query