Get store profile
Get basic information about an Ecwid store: settings, store location, email, etc.
GET https://app.ecwid.com/api/v3/{storeId}/profile
Request and response example
Request:
GET /api/v3/1003/profile HTTP/1.1
Authorization: Bearer secret_token
Host: app.ecwid.comResponse:
{
"generalInfo": {
"storeId": 1003,
"storeUrl": "https://store1003.company.site/products",
"websitePlatform": "instantsite",
"profileId": "p3855016",
"starterSite": {
"ecwidSubdomain": "demostore",
"generatedUrl": "https://store1003.company.site",
"storeLogoUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/15695068/1107529597.jpg",
"ecwidSubdomainSuffix": "company.site",
"slugsWithoutIdsEnabled": true
}
},
"account": {
"accountName": "API Team Store",
"accountNickName": "Support team",
"accountEmail": "ec.apps@lightspeedhq.com",
"whiteLabel": false,
"brandName": "Ecwid",
"supportEmail": "support@ecwid.com",
"suspended": false,
"itunesSubscriptionsAvailable": false,
"googlePlaySubscriptionsAvailable": true,
"trackStorefrontStats": true,
"availableFeatures": [
"AFFILIATE",
"BULK_INVOICE_PRINTING",
"BULK_PRICES",
"CDN",
"COMBINATIONS",
"COMPARE_TO_PRICE",
"CSV_EXPORT",
"CUSTOM_NOTIFICATIONS",
"CUSTOMER_GROUPS",
"DESTINATION_ZONES_LIMIT",
"DISCOUNT_COUPONS",
"DISCOUNTS",
"EBAY_AMAZON_THIRD_PARTY",
"GOOGLE_SHOPPING",
"EDIT_INVOICE",
"EGOODS",
"EGOODS_LIMITS",
"FACEBOOK_STORE",
"FB_SYNC_PRODUCTS",
"TRACKING_PIXELS",
"AUTO_FACEBOOK_ADS",
"GOOGLE_REMARKETING",
"INVENTORY_TRACKING",
"LOCAL_PICKUP",
"MARKETPLACES",
"ORDER_AMOUNT_LIMITS",
"PREMIUM",
"API",
"SHIPMENT_TRACKING",
"CUSTOM_DOMAIN",
"CUSTOM_DOMAIN_STARTER_SITE",
"HIDE_POWERED_BY_ECWID_BADGE_INSTANTSITE",
"LINKUP_HIDE_BRANDING",
"LINKUP_ACTIVATE_ANALYTICS",
"STORE_STATS",
"XERO",
"PRODUCT_FILTERS",
"FAVORITES",
"HIDE_POWERED_BY_ECWID_NOTIFICATIONS",
"VEND",
"SQUARE_PAYMENTS",
"HANDLING_FEE",
"CHECKOUT",
"ORDER_EDITOR",
"PRIVATE_ADMIN_NOTES",
"STRIPE_PAYMENTS",
"STRIPE_STORED_CREDIT_CARD",
"MOBILE",
"ECWID_LIVE_CHAT",
"ECWID_LIVE_CHAT_TRIAL",
"AUTOMATIC_TAXES_US",
"AUTOMATIC_TAXES_REST_OF_THE_WORLD",
"VK_MARKET",
"PRODUCT_DIMENSIONS",
"PRINT_SHIPPING_LABELS",
"SEO_FIELDS",
"TAX_EXEMPT_CUSTOMERS",
"CUSTOMER_TAX_ID",
"FB_MESSENGER",
"AUTO_ABANDONED_SALES_RECOVERY",
"LEGACY_ABANDONED_SALES_VIEW",
"MULTIADMIN",
"SCHEDULED_PICKUP_OR_DELIVERY",
"INSTAGRAM_SHOPPING",
"STARTERSITE_SITEMAP",
"INSTANT_SITE_VERIFICATION_CODE",
"INSTANT_SITE_VERIFICATION_CODE_API",
"INSTANT_SITE_CUSTOM_JS_CODE",
"EXPORT_CONTACTS",
"SHIPPING_PER_PRODUCT",
"PRINTFUL",
"CLOVER_PAY",
"MULTILINGUAL_STORE",
"GIFT_CARDS",
"AUTO_YANDEX_ADS",
"TRIGGERED_EMAILS",
"MAILCHIMP",
"WHOLESALE2B",
"STOREFRONT_LABEL_EDITOR",
"SET_DELIVERY_REGION_ON_MAP",
"TIPS",
"INSTANT_SITE_SALE_FEATURE",
"WEBSITES_SALE_FEATURE",
"BUY_BUTTONS_SALE_FEATURE",
"WORDPRESS_SALE_FEATURE",
"JOOMLA_SALE_FEATURE",
"WIX_SALE_FEATURE",
"WEEBLY_SALE_FEATURE",
"SQUARESPACE_SALE_FEATURE",
"RAPID_WEAVER_SALE_FEATURE",
"PRODUCT_SUBTITLES_FEATURE",
"PRODUCT_RIBBONS_FEATURE",
"NAME_YOUR_PRICE_FEATURE",
"TAX_INVOICES_FEATURE",
"RECURRING_SUBSCRIPTION_FEATURE",
"TIKTOK_SHOPS",
"CHECKOUT_CUSTOM_FIELDS",
"PRODUCT_DELIVERY_TIME_FEATURE",
"COST_PRICE_FEATURE",
"PREORDERS_FEATURE",
"PRODUCT_PURCHASE_LIMITS_FEATURE",
"DOMAIN_PURCHASE_FEATURE",
"PAYMENT_METHOD_SURCHARGE_FEATURE",
"PAYPAL_GUEST_CHECKOUT_FEATURE",
"CUSTOM_ORDER_STATUSES",
"STAFF_SCOPES",
"VIDEO_EMBED_IN_GALLERY_FEATURE",
"CUSTOM_REDIRECTS_FOR_INSTANT_SITES",
"CUSTOM_URL_SLUGS_FOR_CATALOG_PAGES",
"INVITE_STAFF_FEATURE",
"ADVANCED_DISCOUNTS_FEATURE",
"NEW_INSTANT_SITE_PAGES",
"LOWEST_PRICE_FEATURE",
"PRODUCT_REVIEWS_FEATURE",
"BASIC_ECOMMERCE_FEATURE",
"LINKUP_EXTERNAL_LINKS",
"FACEBOOK_PIXEL",
"ALL_TRAFFIC",
"NEW_VS_RETURNING_VISITORS",
"VISITORS_BY_DEVICE",
"VISITORS_BY_LANGUAGE",
"VISITORS_BY_COUNTRY",
"ALL_ORDERS",
"NEW_ORDERS_VS_REPEAT_ORDERS",
"INVENTORY_REPORT",
"TOP_OF_SHIPPING_METHODS_BY_ORDERS",
"TOP_OF_PAYMENT_METHODS_BY_ORDERS",
"ALL_REVENUE",
"ALL_EXPENSES",
"CONVERSION_REPORT",
"ADD_TO_CART_CONVERSION",
"CHECKOUT_SALES_FUNNEL",
"TOP_OF_MARKETING_SOURCES",
"CUSTOMERS_BY_MARKETING_CONSENT"
],
"registrationDate": "2018-11-23 14:39:14 +0000",
"paid": true,
"limitsAndRestrictions": {
"maxProductLimit": 2500
}
},
"settings": {
"closed": false,
"storeName": "API Team Store",
"storeDescription": "",
"storeDescriptionTranslated": {
"cs": "",
"en": ""
},
"invoiceLogoUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/15695068/1107529597.jpg",
"emailLogoUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/15695068/1107529597.jpg",
"googleRemarketingEnabled": false,
"googleAnalyticsId": "UA-132449871-2",
"orderCommentsEnabled": false,
"orderCommentsCaption": "Leave order comments here:",
"orderCommentsCaptionTranslated": {
"en": "Leave order comments here:"
},
"orderCommentsRequired": true,
"hideOutOfStockProductsInStorefront": false,
"askCompanyName": true,
"favoritesEnabled": true,
"defaultProductSortOrder": "DEFINED_BY_STORE_OWNER",
"productSortOrderInCart": "TIME_ADDED_TO_CART_ASC",
"abandonedSales": {
"autoAbandonedSalesRecovery": true
},
"salePrice": {
"displayOnProductList": true,
"oldPriceLabel": "",
"oldPriceLabelTranslated": {
"cs": "",
"en": ""
},
"displayDiscount": "PERCENT",
"displayLowestPrice": true
},
"showAcceptMarketingCheckbox": false,
"acceptMarketingCheckboxDefaultValue": true,
"acceptMarketingCheckboxCustomText": "",
"acceptMarketingCheckboxCustomTextTranslated": {
"cs": "",
"en": ""
},
"askConsentToTrackInStorefront": false,
"wixExternalTrackingEnabled": false,
"openBagOnAddition": false,
"requirePhoneOnCheckout": true,
"askZipCode": true,
"showPricePerUnit": true,
"askTaxId": false,
"googleProductCategory": 412,
"googleProductCategoryName": "Food, Beverages & Tobacco",
"productCondition": "NEW",
"recurringSubscriptionsSettings": {
"showRecurringSubscriptionsInControlPanel": true,
"supportedPaymentMethodsStatuses": {
"supportedPaymentMethodsAreAvailable": true,
"supportedPaymentMethodsAreConnected": false
}
},
"allowPreordersForOutOfStockProducts": false,
"showCostPriceInControlPanel": false,
"rootCategorySeoTitle": "",
"rootCategorySeoTitleTranslated": {
"cs": "",
"en": ""
},
"rootCategorySeoDescription": "",
"rootCategorySeoDescriptionTranslated": {
"cs": "",
"en": ""
},
"showRepeatOrderButton": false,
"productReviewsFeatureEnabled": false,
"linkUpEnabled": true
},
"mailNotifications": {
"adminNotificationEmails": [
"ec.apps@lightspeedhq.com"
],
"customerNotificationFromEmail": "ec.support@lightspeedhq.com",
"customerOrderMessages": {
"orderConfirmation": {
"enabled": true,
"marketingBlockEnabled": true
},
"orderStatusChanged": {
"enabled": true
},
"orderIsReadyForPickup": {
"enabled": true
},
"downloadEgoods": {
"enabled": true
},
"orderShipped": {
"enabled": true
},
"orderDelivered": {
"enabled": false
}
},
"adminMessages": {
"newOrderPlaced": {
"enabled": true
},
"lowStockNotification": {
"enabled": true
},
"weeklyStatsReport": {
"enabled": true
}
},
"customerMarketingMessages": {
"abandonedCartRecovery": {
"enabled": true,
"marketingBlockEnabled": false
},
"favoriteProductsReminder": {
"enabled": false
},
"feedbackRequest": {
"enabled": true
},
"customerLoyaltyAppreciation": {
"enabled": false
},
"inactiveCustomerReminder": {
"enabled": false
},
"purchaseAnniversary": {
"enabled": true
}
}
},
"phoneNotifications": {
"adminNotificationPhones": []
},
"company": {
"companyName": "Ecwid API Team Store",
"email": "ec.apps@lightspeedhq.com",
"street": "Test st., 1",
"city": "Tbilisi",
"countryCode": "GE",
"postalCode": "0164",
"stateOrProvinceCode": "TB",
"phone": "0123456789"
},
"formatsAndUnits": {
"currency": "EUR",
"currencyPrefix": "€",
"currencySuffix": "",
"currencyGroupSeparator": " ",
"currencyDecimalSeparator": ",",
"currencyPrecision": 2,
"currencyTruncateZeroFractional": false,
"currencyRate": 1.060951674,
"weightUnit": "KILOGRAM",
"weightGroupSeparator": " ",
"weightDecimalSeparator": ".",
"weightTruncateZeroFractional": false,
"timeFormat": "HH:mm:ss",
"dateFormat": "dd.MM.yyyy",
"timezone": "Europe/London",
"dimensionsUnit": "CM",
"volumeUnit": "ML",
"orderNumberPrefix": "",
"orderNumberSuffix": "",
"addressFormat": {
"plain": "%NAME%, %COMPANY_NAME%, %STREET%, %POSTAL% %CITY% %STATE_NAME%, %COUNTRY_NAME%",
"multiline": "%NAME%\n%COMPANY_NAME%\n%STREET%\n%POSTAL% %CITY% %STATE_NAME%\n%COUNTRY_NAME%"
}
},
"languages": {
"enabledLanguages": [
"en",
"cs"
],
"facebookPreferredLocale": "en_US",
"defaultLanguage": "en"
},
"shipping": {
"handlingFee": {
"value": 0
},
"shippingOrigin": {
"street": "Industrieweg 9-C",
"city": "Oirschot",
"countryCode": "NL",
"countryName": "Netherlands",
"postalCode": "5688 DP",
"stateOrProvinceCode": "NBR"
},
"shippingOptions": [
{
"id": "6589-1709547151586",
"title": "Standard shipping",
"titleTranslated": {
"cs": "",
"en": "Standard shipping"
},
"enabled": true,
"orderby": 30,
"fulfilmentType": "shipping",
"ratesCalculationType": "flat",
"destinationZone": {
"id": "WORLD",
"name": "WORLD"
},
"businessHours": "{\"THU\":[[\"00:00\",\"00:00\"]],\"TUE\":[[\"00:00\",\"00:00\"]],\"WED\":[[\"00:00\",\"00:00\"]],\"SAT\":[[\"00:00\",\"00:00\"]],\"FRI\":[[\"00:00\",\"00:00\"]],\"MON\":[[\"00:00\",\"00:00\"]],\"SUN\":[[\"00:00\",\"00:00\"]]}",
"minimumOrderSubtotal": 0,
"businessHoursLimitationType": "ALLOW_ORDERS_AND_DONT_INFORM_CUSTOMERS",
"flatRate": {
"rateType": "ABSOLUTE",
"rate": 20
},
"carrier": "",
"estimatedShippingTimeAtCheckoutSettings": {
"estimatedDeliveryDateAtCheckoutEnabled": true,
"estimatedTransitTimeInDays": [
2,
4
],
"fulfillmentTimeInDays": [
3,
3
],
"cutoffTimeForSameDayPacking": "16:00",
"shippingBusinessDays": [
"MON",
"TUE",
"WED",
"THU",
"FRI"
],
"deliveryDays": [
"MON",
"TUE",
"WED",
"THU",
"FRI",
"SAT"
]
}
},
{
"id": "3919-1640004025851",
"title": "FREE Shipping",
"titleTranslated": {
"cs": "",
"en": "FREE Shipping"
},
"enabled": true,
"orderby": 40,
"fulfilmentType": "shipping",
"destinationZone": {
"id": "WORLD",
"name": "WORLD"
},
"businessHours": "{\"THU\":[[\"00:00\",\"00:00\"]],\"TUE\":[[\"00:00\",\"00:00\"]],\"WED\":[[\"00:00\",\"00:00\"]],\"SAT\":[[\"00:00\",\"00:00\"]],\"FRI\":[[\"00:00\",\"00:00\"]],\"MON\":[[\"00:00\",\"00:00\"]],\"SUN\":[[\"00:00\",\"00:00\"]]}",
"minimumOrderSubtotal": 0,
"businessHoursLimitationType": "ALLOW_ORDERS_AND_DONT_INFORM_CUSTOMERS",
"estimatedShippingTimeAtCheckoutSettings": {
"estimatedDeliveryDateAtCheckoutEnabled": false,
"estimatedTransitTimeInDays": [
null,
null
],
"fulfillmentTimeInDays": [
2,
2
],
"cutoffTimeForSameDayPacking": "16:00",
"shippingBusinessDays": [
"MON",
"TUE",
"WED",
"THU",
"FRI"
],
"deliveryDays": []
}
},
{
"id": "4959-1595934622523",
"title": "Pickup",
"titleTranslated": {
"cs": "",
"en": "Pickup"
},
"enabled": true,
"orderby": 50,
"fulfilmentType": "pickup",
"destinationZone": {
"id": "WORLD",
"name": "WORLD"
},
"businessHours": "{\"MON\":[[\"00:00\",\"00:00\"]], \"TUE\":[[\"00:00\",\"00:00\"]], \"WED\":[[\"00:00\",\"00:00\"]], \"THU\":[[\"00:00\",\"00:00\"]], \"FRI\":[[\"00:00\",\"00:00\"]]}",
"scheduled": false,
"fulfillmentTimeInMinutes": 0,
"pickupInstruction": "",
"pickupInstructionTranslated": {
"cs": "",
"en": ""
},
"scheduledPickup": false,
"pickupPreparationTimeHours": 0,
"pickupBusinessHours": "{\"MON\":[[\"00:00\",\"00:00\"]], \"TUE\":[[\"00:00\",\"00:00\"]], \"WED\":[[\"00:00\",\"00:00\"]], \"THU\":[[\"00:00\",\"00:00\"]], \"FRI\":[[\"00:00\",\"00:00\"]]}",
"flatRate": {
"rateType": "ABSOLUTE",
"rate": 0
}
}
]
},
"zones": [
{
"id": "2686-1580712192121",
"name": "Весь мир",
"countryCodes": [
"AF",
"AL",
"DZ",
"AS",
"AD",
"AO",
"AI",
"AQ",
"AG",
"AR",
"AM",
"AW",
"AU",
"AT",
"AZ",
"BS",
"BH",
"BD",
"BB",
"BY",
"BE",
"BZ",
"BJ",
"BM",
"BT",
"BO",
"BQ",
"BA",
"BW",
"BV",
"BR",
"IO",
"BN",
"BG",
"BF",
"BI",
"KH",
"CM",
"CA",
"CV",
"KY",
"CF",
"TD",
"CL",
"CN",
"CX",
"CC",
"CO",
"KM",
"CG",
"CD",
"CK",
"CR",
"HR",
"CW",
"CY",
"CZ",
"CI",
"DK",
"DJ",
"DM",
"DO",
"EC",
"EG",
"SV",
"GQ",
"ER",
"EE",
"ET",
"FK",
"FO",
"FJ",
"FI",
"FR",
"GF",
"PF",
"TF",
"GA",
"GM",
"GE",
"DE",
"GH",
"GI",
"GR",
"GL",
"GD",
"GP",
"GU",
"GT",
"GG",
"GN",
"GW",
"GY",
"HT",
"HM",
"VA",
"HN",
"HK",
"HU",
"IS",
"IN",
"ID",
"IQ",
"IE",
"IM",
"IL",
"IT",
"JM",
"JP",
"JE",
"JO",
"KZ",
"KE",
"KI",
"KR",
"KW",
"KG",
"LA",
"LV",
"LB",
"LS",
"LR",
"LY",
"LI",
"LT",
"LU",
"MO",
"MG",
"MW",
"MY",
"MV",
"ML",
"MT",
"MH",
"MQ",
"MR",
"MU",
"YT",
"MX",
"FM",
"MD",
"MC",
"MN",
"ME",
"MS",
"MA",
"MZ",
"MM",
"NA",
"NR",
"NP",
"NL",
"NC",
"NZ",
"NI",
"NE",
"NG",
"NU",
"NF",
"MK",
"MP",
"NO",
"OM",
"PK",
"PW",
"PS",
"PA",
"PG",
"PY",
"PE",
"PH",
"PN",
"PL",
"PT",
"PR",
"QA",
"RO",
"RU",
"RW",
"RE",
"BL",
"SH",
"KN",
"LC",
"MF",
"PM",
"VC",
"WS",
"SM",
"ST",
"SA",
"SN",
"RS",
"SC",
"SL",
"SG",
"SX",
"SK",
"SI",
"SB",
"SO",
"ZA",
"GS",
"ES",
"IC",
"LK",
"SD",
"SR",
"SJ",
"SZ",
"SE",
"CH",
"TW",
"TJ",
"TZ",
"TH",
"TL",
"TG",
"TK",
"TO",
"TT",
"TN",
"TR",
"TM",
"TC",
"TV",
"UG",
"UA",
"AE",
"GB",
"US",
"UM",
"UY",
"UZ",
"VU",
"VE",
"VN",
"VG",
"VI",
"WF",
"EH",
"YE",
"ZM",
"ZW",
"AX"
]
},
{
"id": "WORLD",
"name": "WORLD"
}
],
"taxes": [
{
"id": 947976181,
"name": "10% Tax",
"enabled": true,
"includeInPrice": true,
"useShippingAddress": true,
"taxShipping": false,
"appliedByDefault": true,
"defaultTax": 10,
"rules": []
}
],
"taxSettings": {
"automaticTaxEnabled": false,
"euIossEnabled": false,
"ukVatRegistered": false,
"taxes": [
{
"id": 947976181,
"name": "10% Tax",
"enabled": true,
"includeInPrice": true,
"useShippingAddress": true,
"taxShipping": false,
"appliedByDefault": true,
"defaultTax": 10,
"rules": []
}
],
"pricesIncludeTax": true,
"taxExemptBusiness": false,
"b2b_b2c": "b2c",
"electronicInvoiceFieldsAtCheckoutEnabled": false,
"taxOnShippingCalculationScheme": "AUTOMATIC"
},
"payment": {
"paymentOptions": [
{
"id": "13379-1606718590771",
"enabled": true,
"configured": true,
"checkoutTitle": "Offline",
"checkoutTitleTranslated": {
"cs": "",
"en": "Offline"
},
"checkoutDescription": "",
"paymentProcessorId": "offline",
"paymentProcessorTitle": "",
"orderBy": 0,
"appClientId": "",
"appNamespace": "",
"paymentSurcharges": {
"type": "ABSOLUTE",
"value": 0
},
"instructionsForCustomer": {
"instructionsTitle": "",
"instructions": "<p>TEST</p>",
"instructionsTranslated": {
"cs": "",
"en": "<p>TEST</p>"
}
},
"methods": []
},
{
"id": "110084370-1655211194360",
"enabled": true,
"configured": true,
"checkoutTitle": "Amazon Pay",
"checkoutTitleTranslated": {
"cs": "",
"en": "Amazon Pay"
},
"checkoutDescription": "",
"paymentProcessorId": "customPaymentApp",
"paymentProcessorTitle": "CUSTOM_PAYMENT_APP-infiniteapps-dev",
"orderBy": 10,
"appClientId": "infiniteapps-dev",
"appNamespace": "infiniteapps-dev",
"instructionsForCustomer": {
"instructionsTitle": "",
"instructions": "",
"instructionsTranslated": {
"cs": "",
"en": ""
}
},
"methods": []
},
{
"id": "217779581-1724151534488",
"enabled": true,
"configured": true,
"checkoutTitle": "TEST PAYMENT",
"checkoutTitleTranslated": {
"cs": "",
"en": "TEST PAYMENT"
},
"checkoutDescription": "",
"paymentProcessorId": "customPaymentApp",
"paymentProcessorTitle": "CUSTOM_PAYMENT_APP-custom-app-15695068-1",
"orderBy": 20,
"appClientId": "custom-app-15695068-1",
"appNamespace": "custom-app-15695068-1",
"instructionsForCustomer": {
"instructionsTitle": "",
"instructions": "",
"instructionsTranslated": {
"cs": "",
"en": ""
}
},
"methods": []
}
],
"applePay": {
"enabled": false,
"available": false
},
"applePayOptions": []
},
"featureToggles": [
{
"name": "ALLOW_EMPTY_AND_NON_UNIQUE_SKU",
"visible": false,
"enabled": false
},
{
"name": "CONSECUTIVE_ORDER_IDS",
"visible": false,
"enabled": false
},
{
"name": "INSTANT_SITE_V2",
"visible": true,
"enabled": true
},
{
"name": "NEW_STARTERSITE",
"visible": false,
"enabled": true
},
{
"name": "RANDOM_ORDER_IDS",
"visible": false,
"enabled": true
},
{
"name": "REGIONAL_ADDRESS_RULES_ON_CHECKOUT",
"visible": true,
"enabled": true
}
],
"legalPagesSettings": {
"requireTermsAgreementAtCheckout": false,
"legalPages": []
},
"designSettings": {
"enable_catalog_on_one_page": false,
"product_list_image_size": "SMALL",
"product_list_image_aspect_ratio": "LANDSCAPE_15",
"product_list_image_position": "FIT",
"product_list_category_image_aspect_ratio": "LANDSCAPE_1333",
"product_list_category_image_position": "AUTO",
"product_list_show_product_images": true,
"product_list_product_info_layout": "CENTER",
"product_list_show_frame": false,
"product_list_show_additional_image_on_hover": false,
"product_list_title_behavior": "SHOW",
"product_list_price_behavior": "SHOW",
"product_list_sku_behavior": "HIDE",
"product_list_buybutton_behavior": "SHOW",
"product_list_category_title_behavior": "SHOW_BELOW_IMAGE",
"product_list_image_has_shadow": false,
"show_signin_link": true,
"show_signin_link_with_unified_account_page": false,
"show_footer_menu": true,
"show_breadcrumbs": true,
"product_list_show_sort_viewas_options": true,
"product_filters_position_search_page": "LEFT",
"product_filters_position_category_page": "RIGHT",
"product_filters_opened_by_default_on_category_page": true,
"product_details_show_product_sku": true,
"product_details_layout": "TWO_COLUMNS_SIDEBAR_ON_THE_RIGHT",
"product_details_two_columns_with_right_sidebar_show_product_description_on_sidebar": false,
"product_details_two_columns_with_left_sidebar_show_product_description_on_sidebar": true,
"product_details_show_product_name": true,
"product_details_show_breadcrumbs": true,
"product_details_show_product_price": true,
"product_details_show_sale_price": true,
"product_details_show_tax": true,
"product_details_show_attributes": true,
"product_details_show_weight": false,
"product_details_show_product_description": true,
"product_details_show_delivery_time": true,
"product_details_show_product_options": true,
"product_details_show_wholesale_prices": true,
"product_details_show_save_for_later": true,
"product_details_show_share_buttons": true,
"product_details_position_product_name": 200,
"product_details_position_breadcrumbs": 100,
"product_details_position_product_sku": 300,
"product_details_position_product_price": 400,
"product_details_position_product_options": 600,
"product_details_position_buy_button": 700,
"product_details_position_wholesale_prices": 800,
"product_details_position_product_description": 2147483647,
"product_details_position_save_for_later": 1000,
"product_details_position_share_buttons": 1100,
"product_details_show_price_per_unit": true,
"product_details_show_qty": true,
"product_details_show_in_stock_label": true,
"product_details_show_number_of_items_in_stock": true,
"product_details_gallery_layout": "IMAGE_SINGLE_THUMBNAILS_HORIZONTAL",
"cart_widget_layout": "SMALL_ICON_COUNTER",
"shopping_cart_show_qty_inputs_on_mobile": true,
"enable_page_transitions": true,
"product_list_subtitles_behavior": "SHOW",
"product_details_show_subtitle": true,
"product_details_position_subtitle": 500,
"product_details_show_navigation_arrows": true,
"product_details_show_product_photo_zoom": true,
"product_details_show_breadcrumbs_position": "PRODUCT_DETAILS_SIDEBAR",
"product_details_position_review_section": 950,
"product_details_show_rating_section": true,
"product_details_show_reviews_section": true,
"product_list_rating_section_behavior": "SHOW",
"show_numeric_rating_in_five_stars_view": true,
"show_rating_section_in_single_star_view": false,
"show_review_count_in_five_stars_view": true,
"show_review_section_in_single_review_view": true
},
"productFiltersSettings": {
"enabledInStorefront": true,
"filterSections": [
{
"type": "IN_STOCK",
"enabled": true
},
{
"type": "ON_SALE",
"enabled": true
},
{
"type": "PRICE",
"enabled": true
},
{
"type": "CATEGORIES",
"enabled": true
},
{
"type": "SEARCH",
"enabled": true
},
{
"name": "Custom Attribute 1",
"type": "ATTRIBUTE",
"enabled": true
}
]
},
"orderInvoiceSettings": {
"invoiceLogoUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/15695068/1107529597.jpg",
"attachInvoiceToOrderEmailNotifications": "DO_NOT_ATTACH"
},
"socialLinksSettings": {
"facebook": {},
"instagram": {},
"twitter": {},
"youtube": {},
"vk": {},
"pinterest": {}
},
"registrationAnswers": {
"alreadySelling": "offline_only",
"goods": "health",
"forSomeone": "yes",
"website": "no"
},
"tipsSettings": {
"enabled": false,
"type": "PERCENT",
"options": [
0,
5,
10
],
"defaultOption": 0,
"title": "Support us with a donation",
"subtitle": "We appreciate all donations, and even the tiniest bit helps us continue what we’re doing.",
"titleTranslated": {
"cs": "",
"en": "Support us with a donation"
},
"subtitleTranslated": {
"cs": "",
"en": "We appreciate all donations, and even the tiniest bit helps us continue what we’re doing."
}
},
"taxInvoiceSettings": {
"taxInvoiceLogoUrl": "https://d2j6dbq0eux0bg.cloudfront.net/images/15695068/1107529597.jpg",
"attachTaxInvoiceToOrderEmailNotifications": "ATTACH_TO_ALL_EMAILS",
"enableTaxInvoices": true,
"generateInvoicesAutomatically": "ON_ORDER_PLACED",
"taxInvoiceIdPrefix": "",
"taxInvoiceIdSuffix": "",
"taxInvoiceIdMinDigitsAmount": 2,
"taxInvoiceIdNextNumber": 28
}
}Required access scopes
Your app must have the following access scopes to make this request: read_store_profile
Additional scopes include read_store_limits granting access to store limits and read_store_profile_extended granting access to detailed store billing data.
Path params
All path params are required.
storeId
number
Ecwid store ID.
Query params
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.
getReportAvailabilityStatus
boolean
Set true to receive account > reportAvailabilityDetails field in response.
getStoreVertical
boolean
Set true to receive account > storeVertical field in response.
getFeaturesByPlans
boolean
Set true to receive account > featuresByPlans object in response.
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:
Headers
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.
Response JSON
A JSON object with the following fields:
generalInfo
Object generalInfo
Basic data about Ecwid store: ID, website URL, website platform, Instant Site settings.
businessRegistrationID
Object businessRegistrationID
Company registration ID, e.g. VAT reg number or company ID, which is set under Settings / Invoice in Control panel.
featureToggles
Array 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
Object legalPagesSettings
Legal pages settings for a store (System Settings → General → Legal Pages).
designSettings
Object designSettings
Design settings of an Ecwid store. Can be overriden by updating store profile or by customizing design via JS config in storefront.
registrationAnswers
Object registrationAnswers
Merchants' answers provided while registering their Ecwid accounts.
accountBilling
Object accountBilling
Store billing and plan info. Requires read_store_profile_extended access scope.
Read only
hasEnabledSizeCharts
boolean
If true, the store has enabled size charts.
californiaCbeFeeEnabled
boolean
If true, California Covered Battery-Embedded (CBE) Waste Recycling Fee is enabled for the store.
generalInfo
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
Object starterSite
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".
instantSiteV2Enabled
boolean
Shows if Instant Site V2 is enabled for this store.
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
account
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
Object limitsAndRestrictions
Store limits and restrictions, e.g. maximum number of available products. Requires read_store_limits access scope.
featuresByPlans
Object featuresByPlans
Map of feature name to the minimum plan name where the feature is available for this user.
Features not available on any plan for the current user are excluded.
Returned only when getFeaturesByPlans=true
limitsAndRestrictions
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.