Get basic information about an Ecwid store: settings, store location, email, etc. This request is available with any access token.
Headers
Name
Type
Description
Authorization
string
oAuth 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
Field
Type
Description
showExtendedInfo
boolean
If set to true, then the accountBilling fields are returned, if false, then the accountBilling fields are not returned.
lang
string
ISO 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
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
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)
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
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
Field
Type
Description
storeId
number
Ecwid Store ID
storeUrl
string
Storefront URL
starterSite
<InstantSiteInfo>
Details of Ecwid Instant site for account. Learn more about Instant site
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
accountNickName
string
Store owner nickname on the Ecwid forums
accountEmail
string
Store owner email
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<string>
A list of the premium features available on the store's pricing plan
registrationDate
string
The store registration date
limitsAndRestrictions
<LimitsAndRestrictions>
Store limits and restrictions, e.g. maximum number of available products. Required scope: READ_STORE_LIMITS
LimitsAndRestrictions
Field
Type
Description
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.
Settings
Field
Type
Description
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
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
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. 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
Shipping
System Settings → Shipping
Field
Type
Description
handlingFee
<HandlingFee>
Handling fee settings
shippingOrigin
<ShippingOrigin>
Shipping origin address. If matches company address, company address is returned. Available in read-only mode only
shippingOptions
Array <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
Field
Type
Description
name
string
Handling fee name set by store admin. E.g. Wrapping
value
number
Handling fee value
description
string
Handling fee description for customer
ShippingOrigin
Settings → Shipping & Pickup → Origin address
Field
Type
Description
companyName
string
The company name displayed on the invoice
email
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
ShippingOptions
Field
Type
Description
id
string
Unique ID of shipping option
title
string
Title of shipping option in store settings
titleTranslated
<Translations>
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
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
<Zone>
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
<Translations>
Available translations for shipping option description.
carrier
string
Carrier used for shipping the order. Is provided for carrier-calculated shipping options
carrierMethods
Array <CarrierMethod>
Carrier-calculated shipping methods available for this shipping option
carrierSettings
<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
<FlatRate>
Flat rate details
ratesTable
<TableRatesDetails>
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
<Translations>
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
string <BusinessHours>
Available and scheduled times to pickup orders
pickupBusinessHours
string <BusinessHours>
[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
The 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.
blackoutDates
array <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
Field
Type
Description
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
CarrierSettings
Field
Type
Description
defaultCarrierAccountEnabled
boolean
true if default Ecwid account is enabled to calculate the rates. false otherwise
defaultPostageDimensions
<DefaultPostageDimensions>
Default postage dimensions for this shipping option
DefaultPostageDimensions
Field
Type
Description
length
number
Length of postage
width
number
Width of postage
height
number
Height of postage
FlatRate
Field
Type
Description
rateType
string
One of "ABSOLUTE", "PERCENT"
rate
number
Shipping rate
TableRatesDetails
Field
Type
Description
tableBasedOn
string
What is this table rate based on. Possible values: "subtotal", "discountedSubtotal", "weight"
rates
Array <TableRate>
Details of table rate
TableRate
Field
Type
Description
conditions
<TableRateConditions>
Conditions for this shipping rate in custom table
rate
<TableRateDetails>
Table rate details
TableRateConditions
Field
Type
Description
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
TableRateDetails
Field
Type
Description
perOrder
number
Absolute per order rate
percent
number
Percent per order rate
perItem
number
Absolute per item rate
perWeight
number
Absolute per weight rate
BusinessHours
Field
Type
Description
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']
TaxSettings
System Settings → Taxes
Field
Type
Description
automaticTaxEnabled
boolean
true if store taxes are calculated automatically, else otherwise. As seen in the Ecwid Control Panel > Settings > Taxes > Automatic
taxes
Array<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.
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).
Dot coordinates of the polygon (if destination zone is created using Zone on Map).
GeoPolygons
Field
Type
Description
<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], ...]).
BusinessRegistrationID
Field
Type
Description
name
string
ID name, e.g. Vat ID, P.IVA, ABN
value
string
ID value
InstantSiteInfo
System Settings → General → Instant site
Field
Type
Description
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
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"
displayTranslated
<Translations>
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
<Translations>
Available translations for legal page text.
externalUrl
string
URL to external location of a legal page
externalUrlTranslated
<Translations>
URL to external location of a translated legal page
PaymentInfo
Field
Type
Description
paymentOptions
Array<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
Field
Type
Description
id
string
Payment method ID in a store
enabled
boolean
true if payment method is enabled and shown in storefront, false otherwise
configured
boolean
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 https://ecwid.d.pr/i/FpeCIb.
checkoutTitle
string
Payment method title at checkout
checkoutTitleTranslated
<Translations>
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
<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
Field
Type
Description
type
string
Supported values: ABSOLUTE, PERCENT
value
number
Surcharge value
ApplePayInfo (via Stripe payment method)
Field
Type
Description
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
Payment instructions content. Can contain HTML tags
instructionsTranslated
<Translations>
Available translations for instructions.
ShippingSettings
Field
Type
Description
enabledShippingMethods
Array of string
Contains IDs of shipping methods, if payment method is available for certain shipping methods only ("Payment Per Shipping" feature)
FeatureTogglesInfo
Field
Type
Description
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
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
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
displayDiscount
string
Show discount in three modes: "NONE", "ABS" and "PERCENT
FBMessengerSettings
Field
Type
Description
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
MailchimpSettings
Field
Type
Description
script
string
JS script for the Mailchimp integration, e.g. "<script id="mcjs">!function...</script>"
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
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".
Translations for each available language. If no other translations are provided, the default language translations is returned. See available languages in store language settings
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 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?"
GiftCardSettings
Field
Type
Description
products
Array <GiftCardProducts>
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
GiftCardProducts
Field
Type
Description
id
number
Product ID
name
string
Gift card product name
url
string
Gift card product URL in a store
TipsSettings
Field
Type
Description
enabled
boolean
true if enabled, false otherwise
type
string
Supported values: 'ABSOLUTE', 'PERCENT'
options
array<number>
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
Tip title
subTitle
string
Tip subtitle
titleTranslated
<Translations>
Available translations for tip title
subtitleTranslated
<Translations>
Available translations for tip subtitle
AccountBilling
Field
Type
Description
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
BlackoutDates
Field
Type
Description
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.
Errors
In case of error, Ecwid responds with an error HTTP status code
HTTP codes
HTTP Status
Meaning
400
Request parameters are malformed
402
The request is not available on the merchant plan. To use Ecwid API, store must be on a paid plan
415
Unsupported content-type: expected application/json or text/json
500
Cannot retrieve the coupon info because of an error on the server