Configuration
The configurations API allow to configure your website's API settings and preferences for the theme and features. Get started with customizing your site's functionality and enhancing its user experience.
Endpoint:
api/customer/configurationsHttp Method:
GETSuccess Response:
This API includes keys for managing website. Like key for setting the main logo key used in website branding.
Response Example
{
"code": 200,
"data": {
"CONFIG_VERSION": 1685267769,
"APP_SWITCH": false,
"APP_SWITCH_MESSAGE_AR": null,
"APP_SWITCH_MESSAGE_EN": null,
"WEBSITE_URL": "https://doc.supercommerce.io",
"COUNTRY_CODE": "EG",
"CURRENCY_CODE_EN": "EGP",
"CURRENCY_CODE_AR": "ج.م",
"TRUCK_IMAGE_URL": "https://docapi.supercommerce.io/storage/optimized/inner-logo.webp",
"SHIPPING_ORIGIN_SOURCE": "config",
"ENABLE_PLANS_AND_SUBSCRIPTIONS_PAGE": false,
"ENABLE_LINKED_DOMAINS_PAGE": false,
"SUBSCRIPTION_GATEWAY": "null",
"ENABLE_FONT_FAMILY_OVERWRITE": false,
"FONT_FAMILY_EN": "ProximaNovaSoft",
"FONT_FAMILY_AR": "Cairo",
"FOOTER_ENGLISH_CONTENT": "<div class=\"removeMargin\"><span class=\"copy-right\">COPYRIGHT © (2023) supercommerce STORE. ALL RIGHTS RESERVED. POWERED BY</span><a href=\"https://supercommerce.io/\" class=\"outline-none\" target=\"_blank\"><img height=\"100\" width=\"100\" alt=\"logo\" src=\"https://store.supercommerce.io/assets/images/footerlogo2.png\" /></a></div>",
"FOOTER_ARABIC_CONTENT": "<div class=\"removeMargin\"><span class=\"copy-right\">حقوق الطبع والنشر © (2023) الدكان ستور . جميع الحقوق محفوظة.</span><a href=\"https://supercommerce.io/\" class=\"outline-none\" target=\"_blank\"><img height=\"100\" width=\"100\" alt=\"logo\" src=\"https://store.supercommerce.io/assets/images/footerlogo2.png\" /></a></div>",
"HOTPHONE": "+01279999012",
"HOTPHONE2": null,
"HOTPHONE_LABEL": null,
"HOTPHONE2_LABEL": null,
"HOTPHONE_LABEL_AR": null,
"HOTPHONE2_LABEL_AR": null,
"JWT_SECRET": "uzXgbCEDWK...",
"JWT_TTL": "600000000",
"ENABLE_SEARCH_SIDE_FILTERS": false,
"CART_COUNT_CONFIG": "quantity",
"SHOW_ITEMS_LEFT_LABEL": true,
"ENABLE_PRODUCT_SEARCH_BY_BARCODE": false,
"EDARA_PRICE_REFERENCE": null,
"EDARA_DISCOUNT_PRICE_REFERENCE": null,
"ENABLE_DISTRICT": false,
"ENABLE_BREADCRUMBS_FULL_NAME": false,
"ENABLE_CATEGORY_VIEW": false,
"ENABLE_SUBCATEGORY_VIEW": false,
"enable_prescription": false,
"enable_guest_checkout": false,
"enable_affiliate": false,
"WEB_CONTACT_TIME_TXT_EN": null,
"WEB_CONTACT_TIME_TXT_AR": null,
"ENABLE_DOWNLOAD_APP_TOP_MENU": false,
"ENABLE_DOWNLOAD_APP_FOOTER": false,
"ENABLE_DOWNLOAD_APP": false,
"DOWNLOAD_APP_TITLE_EN": null,
"DOWNLOAD_APP_TEXT_EN": null,
"DOWNLOAD_APP_TITLE_AR": null,
"DOWNLOAD_APP_TEXT_AR": null,
"CHAT_SUPPORT_PROVIDER": null,
"ENABLE_CHAT_SUPPORT_FOR_GUEST": false,
"FRESH_CHAT_TOKEN": null,
"WHATSAPP_LINK": null,
"SHOW_EDIT_ORDER_BTN": false,
"SHOW_OUT_OF_STOCK_IN_WEBSITE": true,
"SHOW_FOOTER_COPY_RIGHTS": false,
"SHOW_TEXT_COLOR": false,
"SHOW_ADDRESS_FLOOR": false,
"stop_delivered_reverse": false,
"ORDER_POLICY_TEXT_EN": null,
"ORDER_POLICY_TEXT_AR": null,
"enablePhoneLogin": false,
"ENABLE_EMAIL_REQUIRED": false,
"FORGET_PASSWORD_VERIFICATION_METHOD": "email",
"SHOW_ADDRESS_MAP": false,
"HIDE_POLYGON_ON_MAP": false,
"APP_ADDRESS_EN": null,
"APP_ADDRESS_AR": null,
"INVOICE_BARCODE": null,
"ONLINE_EMAIL": "info@releaseapi.supercommerce.io",
"INFO_EMAIL": "info@releaseapi.supercommerce.io",
"ENABLE_GROUP_PAGE": false,
"SHOW_DELETE_CART_ITEM_BTN": false,
"DELIVERY_FEES_SOURCE": "city",
"ENABLE_STATIC_MENU": false,
"ENABLE_MODIFACE": false,
"MODIFACE_LINK_AR": null,
"MODIFACE_LINK_EN": null,
"MODIFACE_IMAGE_MOBILE_AR": null,
"MODIFACE_IMAGE_MOBILE_EN": null,
"MODIFACE_IMAGE_WEB_AR": null,
"MODIFACE_IMAGE_WEB_EN": null,
"OUR_BRANCHES_FOOTER_TYPE": "internal",
"OUR_BRANCHES_FOOTER_LINK": null,
"WHATSAPP_SHOW_HIDE_SWITCH": false,
"ORDER_ASSIGNING": "branch",
"ENABLE_SALES_PAGE": false,
"MINIMUM_TOTAL_AMOUNT_FOR_CREATING_ORDER": null,
"SHOW_OUT_OF_STOCK_WITH_KEYWORD_SEARCH": false,
"CHECKOUT_NOTES_EN": null,
"CHECKOUT_NOTES_AR": null,
"INSTANT_DELIVERY_PICKUP_NOTES_EN": null,
"INSTANT_DELIVERY_PICKUP_NOTES_AR": null,
"ENABLE_SIGN_UP": true,
"GUEST_CAN_VIEW_PRICES": true,
"PRODUCT_SORT_BY": "order_n_stock",
"ENABLE_MULTI_INVENTORY": false,
"ENABLE_PROFILE_SET_AREA_FROM_MAP": false,
"ALLOW_ADMIN_CREATE_ORDER_WITH_DEACTIVATED_CITY_AREA": false,
"ENABLE_CHECKOUT_PICKUP_FROM_STORE": false,
"ENABLE_HIDE_COD_WHEN_PICKUP_FROM_STORE": false,
"PICKUP_DELIVERY_SOURCE": "area",
"PICKUP_FROM_STORE_LABEL_TEXT_EN": null,
"PICKUP_FROM_STORE_LABEL_TEXT_AR": null,
"DELIVERY_LABEL_TEXT_EN": null,
"DELIVERY_LABEL_TEXT_AR": null,
"SCHEDULE_ORDER_TYPE": null,
"INSTANT_DELIVERY_START_TIME": null,
"INSTANT_DELIVERY_END_TIME": null,
"ENABLE_USER_WALLET": false,
"ENABLE_ORDER_WITH_NEGATIVE_USER_WALLET": false,
"ENABLE_INCLUDING_VAT": false,
"ENABLE_PRODUCT_SERIAL_NUMBER": false,
"ENABLE_RETURN_ORDER_PRODUCTS": false,
"ENABLE_CATEGORIES_SECTION": false,
"ENABLE_SUBCATEGORIES_SECTION": false,
"ENABLE_GROUPS_SECTION": false,
"RANGE_PER_KM": null,
"DELIVERY_FEES_WITHIN_RANGE": null,
"DELIVERY_FEES_OUT_RANGE_PER_KM": null,
"ENABLE_MOBILE_ADMIN": false,
"ENABLE_MULTI_VENDOR": false,
"SPLIT_CART_BY_VENDOR": false,
"VERIFY_AFTER_SIGNUP": false,
"ADDRESS_AFTER_SIGNUP": false,
"SINGLE_ADDRESS": false,
"ENABLE_SPLIT_ORDERS": false,
"ENABLE_INVENTORY_CUSTOMER_GROUPS": false,
"SET_DRIVER_RATE_TO_REQUIRED": false,
"AUTO_SELECT_SUGGESTED_PROMO": false,
"ENABLE_VOUCHER": false,
"ENABLE_ARABIC_NUMBERS": false,
"ENABLE_POPUP_IMAGE_APP": false,
"POPUP_IMAGE_APP": null,
"DISABLE_RECALCULATE_DELIVERY_FEES_WHILE_EDIT_ORDER": false,
"DISABLE_BRANCH_PHONE_LENGTH_VALIDATION": false,
"PRESCRIPTION_MENU_ITEM_NAME": "prescription",
"SMS_CONNECTION": null,
"erp_id": null,
"GAMEBALL_PUBLIC_KEY": null,
"GOOGLE_CLIENT_ID": "26866059202.apps.googleusercontent.com",
"FACEBOOK_CLIENT_ID": "286292",
"GOOGLE_MAP_API_KEY": null,
"GOOGLE_MAP_LATITUDE": null,
"GOOGLE_MAP_LONGITUDE": null,
"FACEBOOK_DOMAIN_VERIFY": null,
"GOOGLE_DOMAIN_VERIFY": null,
"fbPixelId_2": null,
"FACEBOOK_CONVERSION_ACCESS_TOKEN_2": null,
"GLOBAL_KEYWORDS_AR_WEBSITE": null,
"GLOBAL_KEYWORDS_EN_WEBSITE": null,
"SOCIAL_LABEL_2": null,
"SOCIAL_LABEL_2_AR": null,
"SOCIAL_URL_FACEBOOK": null,
"SOCIAL_URL_FACEBOOK_2": null,
"SOCIAL_URL_SNAPCHAT": null,
"SOCIAL_URL_TWITTER": null,
"SOCIAL_URL_YOUTUBE": null,
"SOCIAL_URL_YOUTUBE_2": null,
"SOCIAL_URL_INSTAGRAM": null,
"SOCIAL_URL_INSTAGRAM_2": null,
"MESSENGER_CHAT_TOKEN": null,
"ENABLE_FB_SIGN_IN": false,
"ENABLE_GOOGLE_SIGN_IN": false,
"WEB_SEO_SCRIPTS": null,
"footerAboutCompanyEn": "Massage, Fitness and Therapy products\n\nWe are glad to see you at OGAWA!",
"footerAboutCompanyAr": "منتجات مساج، لياقة وعلاجية\nنحن سعداء بزيارتكم وبخدمتكم",
"footerPaymentImages": "https://docapi.supercommerce.io/storage/optimized/payment_method1.webp",
"GOOGLE_CONVERSION_ID": null,
"GOOGLE_CONVERSION_LABEL": null,
"GOOGLE_CONVERSION_LABEL_PRODUCT_DETAILS_PAGE": null,
"GOOGLE_CONVERSION_LABEL_ADD_TO_CART": null,
"GOOGLE_CONVERSION_LABEL_CHECKOUT_PAGE": null,
"GOOGLE_CONVERSION_LABEL_ADD_PAYMENT_INFO": null,
"GOOGLE_CONVERSION_LABEL_PURCHASE": null,
"GOOGLE_CONVERSION_TRANSACTION_ID": null,
"fbPixelId": "6456701",
"snapChatPixelId": null,
"tiktokPixelId": null,
"googleTagManID": "GTM-KR...",
"FACEBOOK_CONVERSION_API_VERSION": null,
"FACEBOOK_CONVERSION_ACCESS_TOKEN": null,
"HOTJAR_ID": null,
"GOOGLE_ANALYTICS_ID": null,
"GOOGLE_MAP_BILLS_KEY": null,
"HEADER_CART_ICON": "shopping_cart",
"HEADER_COMPARE_ICON": "compare",
"PRODUCT_TYPE": "variant",
"SLIDER_THEME_TYPE": "default",
"ADS_SLIDER_SIZE": "small",
"ENABLE_PAYMENT_METHODS_LIST": false,
"ENABLE_SUBMENU_TEXT_TRANSFORMER_UPPERCASE": false,
"ENABLE_DISCOUNT_PRICE_SAME_LINE": false,
"VIEW_ALL_BACKGROUND_COLOR": null,
"VIEW_ALL_TEXT_COLOR": "#FFFFFF",
"FOOTER_TITLES_COLOR": null,
"FOOTER_TITLES_SEPARATOR_COLOR": null,
"COPYRIGHT_SEPARATOR_COLOR": null,
"ENABLE_LARGE_IMAGE": true,
"ADS_THEME_TYPE": null,
"SHOW_SECTIONS_AS_SLIDER": false,
"SEARCH_PRODUCTS_THEME_TYPE": null,
"LOADING_SHIMMER_DARK_1": null,
"LOADING_SHIMMER_DARK_2": null,
"LOADING_SHIMMER_DARK_3": null,
"LOADING_SHIMMER_LIGHT_1": null,
"LOADING_SHIMMER_LIGHT_2": null,
"LOGIN_PAGE_IMAGE": null,
"WEB_CONTACT_TIME_TXT_AR_2": null,
"GROUP_MOBILE_ADS": false,
"logoWidth": "180px",
"logoHeight": "60px",
"logoWidthMobile": "100%",
"logoHeightMobile": "80px",
"footerPaymentImageStaticWidth": null,
"ENABLE_SHOW_SLIDER_BRANDS_ON_HOME": false,
"ENABLE_SHOW_BIRTH_DATE": true,
"ENABLE_SHOW_SIZE_CHART": true,
"ENABLE_SHOW_REGISTER_ACCEPT_AR_TEXT": true,
"SOCIAL_ICONS_SIZE": "small",
"FAVORITE_ICON_POSITION": "top",
"FINAL_RECEIPT_MESSAGE_AR": "شكرا لتسوقكم معنا",
"FINAL_RECEIPT_MESSAGE_EN": "Thank you for shopping with us",
"ENABLE_SIMILAR_PRODUCTS_LOOP": true,
"FOOTER_MAP_IMAGE": null,
"FOOTER_MAP_LINK_PLACEHOLDER": null,
"ENABLE_PRESCRIPTION_INSURANCE_COMPANY": false,
"PRESCRIPTION_VIDEO_URL": null,
"SMS_NOTE_WITHIN_VERIFY_PHONE_NUMBER_DIALOG_EN": null,
"SMS_NOTE_WITHIN_VERIFY_PHONE_NUMBER_DIALOG_AR": null,
"TEXT_SIZE": null,
"PRESCRIPTION_DESCRIPTION_EN": null,
"PRESCRIPTION_DESCRIPTION_AR": null,
"ENABLE_ADS_OVERLAY": false,
"LABEL_COLOR": "#c20e0e",
"DISABLE_COMPARE": false,
"FACEBOOK_ICON": null,
"INSTAGRAM_ICON": null,
"YOUTUBE_ICON": null,
"SEARCH_PAGE_VIEW": "grid",
"CATEGORY_STYLE": "slider",
"CATEGORY_CARD": "round",
"BRANDS_STYLE": "slider",
"BRANDS_CARD": "round",
"ENABLE_HEADER_ICONS_BACKGROUND": true,
"ENABLE_HEADER_ICONS_FILL": true,
"HEADER_ICONS_FILL_COLOR": null,
"HEADER_ICONS_BACKGROUND_COLOR": null,
"HEADER_BACKGROUND_COLOR": null,
"HEADER_TEXT_COLOR": null,
"HEADER_SEARCH_BACKGROUND_COLOR": null,
"HEADER_SEARCH_TEXT_COLOR": null,
"HEADER_SEPARATOR_COLOR": null,
"TWITTER_ICON": null,
"SNAPCHAT_ICON": null,
"SOCIAL_URL_TWITTER_2": null,
"SOCIAL_URL_SNAPCHAT_2": null,
"SHOW_CATEGORY_NAME_BEFORE_GROUP_IN_SUBCATEGORY_SEARCH": true,
"ENABLE_REMOVE_HOME_SECTION_BORDER": false,
"ENABLE_SHOW_BUY_NOW_BUTTON": false,
"FLYER_IMAGE_IN_DEALS_PAGE_1": null,
"FOOTER_STORE_ICONS_ANDROID": null,
"FOOTER_STORE_ICONS_IOS": null,
"FOOTER_STORE_ICONS_HUAWEI": null,
"FLYER_IMAGE_WEB_IN_DEALS_PAGE_1": null,
"FLYER_PDF_IN_DEALS_PAGE_1": null,
"FLYER_IMAGE_IN_DEALS_PAGE_2": null,
"FLYER_IMAGE_WEB_IN_DEALS_PAGE_2": null,
"FLYER_PDF_IN_DEALS_PAGE_2": null,
"FLYER_IMAGE_IN_DEALS_PAGE_3": null,
"FLYER_IMAGE_WEB_IN_DEALS_PAGE_3": null,
"FLYER_PDF_IN_DEALS_PAGE_3": null,
"CATEGORY_VIEW_STYLE": "groups_with_subcategories",
"SHOW_SKU_PRODUCT_DETAILS": true,
"SHOW_BARCODE_PRODUCT_DETAILS": false,
"ENABLE_CUSTOM_ADS_INFINITE": true,
"ENABLE_MENU_AS_CARDS": false,
"FOOTER_INPUT_BACKGROUND_COLOR": "#00000000",
"FILL_ICONS_COLOR_HOVER": null,
"ENABLE_MENU_BUTTON": false,
"MENU_BUTTON_IMAGE": null,
"MENU_BUTTON_TEXT": null,
"FOOTER_SUBSCRIBE_TEXT_AR": null,
"FOOTER_SUBSCRIBE_TEXT_EN": null,
"MENU_BUTTON_TEXT_AR": null,
"MENU_BUTTON_COLOR": null,
"MENU_BUTTON_BACKGROUND_COLOR": null,
"MENU_BUTTON_LINK": null,
"ADD_TO_CART_TEXT_FONT_SIZE": "16px",
"ADD_TO_CART_TEXT_EN": "Add To Cart",
"ADD_TO_CART_TEXT_AR": "أضف للعربة",
"SCROLL_COLOR": null,
"LABEL_TEXT_COLOR": null,
"ENABLE_SHOW_OFF_IN_PRODUCT_LABEL": false,
"SECOND_BTN_BG_COLOR": null,
"MENU_LINK_TYPE": "link",
"SOFTBAR_ICON": null,
"SOFTBAR_BG_COLOR": null,
"SOFTBAR_FONT_COLOR": null,
"SOFTBAR_TEXT_EN": null,
"SOFTBAR_TEXT_AR": null,
"ENABLE_SOFTBAR": false,
"ENABLE_BLOG_TOP_MENU": false,
"LABEL_BLOG_TOP_MENU_EN": null,
"LABEL_BLOG_TOP_MENU_AR": null,
"LABEL_MAGAZINE_TOP_MENU_EN": null,
"LABEL_MAGAZINE_TOP_MENU_AR": null,
"ENABLE_SHOW_MAGAZINE_LINK_IN_TOP_MENU": false,
"MAGAZINE_LINK_IN_TOP_MENU": null,
"LINK_BLOG_TOP_MENU_EN": null,
"LINK_BLOG_TOP_MENU_AR": null,
"ENABLE_HOTPHONE": false,
"ENABLE_APPS": false,
"TOPMENU_MESSAGE_EN": null,
"TOPMENU_MESSAGE_AR": null,
"TOPMENU_MESSAGE": false,
"APP_VERSION_IOS": "1",
"APP_VERSION_ANDROID": "1",
"NEXT_DELIVERY_BAR_TXT": null,
"MOBILE_SPLASH_GIF": null,
"PRODUCT_NAME_TEXT_COLOR": null,
"SHOW_PRODUCT_VARIANTS_OPTIONS": false,
"SHOW_OUT_STOCK_PRODUCT_SKU": false,
"SHOW_OUT_STOCK_PRODUCT_PRICE": false,
"SHOW_CATEGORY_ON_PRODUCT_CARD": false,
"ENABLE_SEARCH_PRODUCT_BY_CATEGORY": false,
"CATEGORIES_COUNT_IN_ROW": "8category",
"PRODUCT_CARD_STYLE": "medium",
"ENABLE_PRODUCT_NAME_IN_CARD_ONE_LINE": true,
"ENABLE_PRODUCT_UPTO_IN_CARD": true,
"SHOW_BRAND_ON_PRODUCT": false,
"SHOW_PROMO_LABEL_ON_PRODUCT_CARD": "one",
"PRODUCT_PRICE_TEXT_COLOR": null,
"PRODUCT_PRICE_AFTER_DISCOUNT_TEXT_COLOR": null,
"PRODUCT_PRICE_BEFORE_DISCOUNT_TEXT_COLOR": null,
"SMS_LANGUAGE": "en",
"ENABLE_SEND_SMS_WITH_DLR_VICTORY_LINK": false,
"LOYALTY_PROVIDER": null,
"DISABLE_REFERRAL_CODE": true,
"USE_REFERRED_AS": null,
"REFERRED_WALLET_AMOUNT": null,
"ADD_REFERRED_AMOUNT_TO": "supercommerce-loyalty-points",
"DISPLAY_LOYALTY_POINTS_IN_TABS": true,
"STORE_ANDROID_URL": null,
"STORE_APPLE_URL": null,
"STORE_HWAWEI_URL": null,
"APP_NAME": "supercommerce Documentation",
"APP_NAME_AR": "الدكان",
"sloganEn": "supercommerce Documentation",
"sloganAr": "الدكان",
"FAV_ICON": "https://docapi.supercommerce.io/storage/uploads//FVHvLH-1634473501.png",
"metaDescriptionEn": "supercommerce Documentation",
"metaDescriptionAr": "الدكان",
"COLORED_LOGO_EN": "https://docapi.supercommerce.io/storage/optimized/inner-logo.webp",
"COLORED_LOGO_AR": "https://docapi.supercommerce.io/storage/optimized/inner-logo.webp",
"WHITE_LOGO_EN": "https://docapi.supercommerce.io/storage/optimized/inner-logo.webp",
"WHITE_LOGO_AR": "https://docapi.supercommerce.io/storage/optimized/inner-logo.webp",
"WEB_BRAND_COLOR": "#51843c",
"WEB_SECOND_COLOR": "#000000",
"WEB_FOOTER_BG_COLOR": "#ffffff",
"WEB_FOOTER_FONT_COLOR": "#818796",
"META_TITLE_AR": null,
"META_TITLE_EN": null,
"ADD_ADDRESS_CONFIG": "address",
"ADDRESS_NAME_CONFIG": "show-required",
"ADDRESS_NAME_LABEL_EN": "Address Name",
"ADDRESS_NAME_LABEL_AR": "اسم العنوان",
"ADDRESS_BUILDING_CONFIG": "show-optional",
"ADDRESS_BUILDING_LABEL_EN": "Building",
"ADDRESS_BUILDING_LABEL_AR": "المبني",
"ADDRESS_STREET_CONFIG": "show-required",
"ADDRESS_STREET_LABEL_EN": "Address (street, apartment, suite, unit etc.)",
"ADDRESS_STREET_LABEL_AR": "العنوان (الشارع ، الشقة ، الجناح ، الوحدة ، إلخ)",
"ADDRESS_APT_CONFIG": "show-required",
"ADDRESS_APT_LABEL_EN": "Apartment",
"ADDRESS_APT_LABEL_AR": "شقة",
"ADDRESS_LANDMARK_CONFIG": "show-optional",
"ADDRESS_LANDMARK_LABEL_EN": "Land mark",
"ADDRESS_LANDMARK_LABEL_AR": "علامة",
"ADDRESS_FLOOR_CONFIG": "show-optional",
"ADDRESS_FLOOR_LABEL_EN": "Floor",
"ADDRESS_FLOOR_LABEL_AR": "طابق",
"ADDRESS_SHOP_NAME_CONFIG": "hide",
"ADDRESS_SHOP_NAME_EN": "Shop Name",
"ADDRESS_SHOP_NAME_AR": "اسم المحل",
"ADDRESS_SHOP_IMAGE_CONFIG": "hide",
"ADDRESS_SHOP_IMAGE_LABEL_EN": "Shop Image",
"ADDRESS_SHOP_IMAGE_LABEL_AR": "صورة المحل",
"localization": {
"id": 1,
"name_en": "Egypt",
"name_ar": "مصر",
"country_code": "EG",
"currency_code_en": "EGP",
"currency_code_ar": "ج.م",
"flag": "https://docapi.supercommerce.io/images/country_flags/Flag_Egypt.png",
"phone_prefix": "+2",
"phone_length": 11,
"phone_pattern": "(010|011|012|015)([0-9]{8})",
"phone_placeholder": null,
"default_language": "AR",
"fallback": 1,
"created_at": null,
"updated_at": null
}
},
"meta": []
}
Configuration Key References
General
| Key | Type | Description |
|---|---|---|
ENABLE_SEARCH_SIDE_FILTERS | Text | Controls the visibility of the sidebar, allowing users to show or hide it for filtering purposes in a search page. |
Branding & Style
| Key | Type | Description |
|---|---|---|
APP_NAME | Text | Name of a brand in English that appears in the address bar of a browser. |
APP_NAME_AR | Text | Name of a brand in Arabic that appears in the address bar of a browser. |
sloganEn | Text | Upon accessing the website, the slogan of the brand in English appears next to the brand name in the address bar. |
sloganAr | Text | Upon accessing the website, the slogan of the brand in Arabic appears next to the brand name in the address bar. |
Setting
| Key | Type | Description |
|---|---|---|
enablePhoneLogin | Switch | controls whether phone login is enabled or disabled. Default: false. |
ENABLE_CHECKOUT_PICKUP_FROM_STORE | Switch | determines whether the option for customers to pick up their orders from a physical store is enabled or disabled. Default: false. |
ENABLE_MULTI_INVENTORY | Switch | enables or disables the functionality of handling multiple inventories for products. Multiple inventories allow managing stock availability across different locations or warehouses. Default: false. |
ENABLE_MULTI_VENDOR | Switch | This switch controls the functionality of handling prices for products from multiple vendors. Enabling it allows the system to manage prices across various vendors, enhancing flexibility and pricing management. Default: false. |
ENABLE_CUSTOMER_GROUPS | Switch | It allows businesses to set distinct prices for products based on different customer groups, enhancing pricing flexibility and customization. Default: false. |
PICKUP_DELIVERY_SOURCE | Options | determines the source from which customers can choose to either pick up their order from a store, have it delivered to their area, or both. Options:
Default: area. |
ENABLE_INVENTORY_CUSTOMER_GROUPS | Switch | enables or disables the functionality of assigning customer groups to inventories. Default: false. |
SCHEDULE_ORDER_TYPE | Options | the type of order scheduling functionality. time slot Indicates that customers can select a specific time slot for their order Or time picker Indicates that customers can use a time picker to choose a specific time for order pickup Or disabled Options:
Default: disabled. |
INSTANT_DELIVERY_START_TIME | Time Picker | the start time for instant delivery. It specifies the earliest time at which an order can be delivered instantly. |
INSTANT_DELIVERY_END_TIME | Time Picker | the end time for instant delivery. It specifies the latest time by which an order can be delivered instantly. |
INSTANT_PICKUP_START_TIME | Time Picker | the start time for instant pickup. It specifies the earliest time at which an order can be picked up instantly. |
INSTANT_PICKUP_END_TIME | Time Picker | the end time for instant pickup. It specifies the latest time by which an order can be picked up instantly. |
ENABLE_VOUCHER | Switch | determines whether the voucher functionality is enabled or disabled. Default: false. |
ENABLE_HIDE_COD_WHEN_PICKUP_FROM_STORE | Switch | determines whether the cash on delivery payment method is hidden when customers choose to pick up their order from a store. |
CHECKOUT_NOTES_AR | Text | used to store additional notes related to the checkout process in Arabic. |
CHECKOUT_NOTES_EN | Text | used to store additional notes related to the checkout process in English. |
SET_DRIVER_RATE_TO_REQUIRED | Switch | Determines whether the driver rating is required when customers rate an order. Default: false. |
enable_affiliate | Switch | determines whether the affiliate functionality is enabled or disabled. Default: false. |
Service
| Key | Type | Description |
|---|---|---|
FACEBOOK_CLIENT_ID | Text | Client ID provided by Facebook for your application's authentication. |
FACEBOOK_CLIENT_SECRET | Text | Client secret associated with the Facebook client ID. Retrieve the Client ID and Client Secret from the App's settings in the Facebook Developer Dashboard. |
GOOGLE_CLIENT_ID | Text | Client ID provided by Google for authentication and authorization purposes. |
GOOGLE_CLIENT_SECRET | Text | Client secret associated with the Google client ID. Retrieve the Client ID and Client Secret from the created credentials in the Google Developer Console. |
GOOGLE_REDIRECT | Text | Redirect URL configured in your Google application settings for OAuth2 authentication. |
APPLE_CLIENT_ID | Text | Client ID provided by Apple for authentication. |
APPLE_CLIENT_SECRET | Text | Client secret associated with the Apple client ID. Retrieve the Client ID from the App ID settings and generate a Client Secret using the generated private key in your Apple Developer account. |
APPLE_REDIRECT_URI | Text | Redirect URI specified in your Apple application settings for handling the authorization response. |
Theme
| Key | Type | Description |
|---|---|---|
PRODUCT_TYPE | Options | Product Type. Options:
Default: variant. |
ENABLE_PRESCRIPTION_INSURANCE_COMPANY | Switch | Enable prescription insurance company. Default: false. |
Marketing
| Key | Type | Description |
|---|---|---|
MAILCHIMP_APIKEY | Text | API key provided by Mailchimp for authentication. |
MAILCHIMP_LIST_ID | Text | ID of the list in Mailchimp to which the user will be subscribed. |
Loyalty
| Key | Type | Description |
|---|---|---|
LOYALTY_PROVIDER | Options | Indicates the active loyalty program provider. Providers:
Default: null to disable the loyalty program. |
Address
| Key | Type | Description |
|---|---|---|
ADD_ADDRESS_CONFIG | Options | Address Configurtion. Options:
Default: address. |
ADDRESS_NAME_CONFIG | Text | Address Name Configurtion. Options:
Default: show-required. |
ADDRESS_NAME_LABEL_EN | Text | Address Name Label in English. |
ADDRESS_NAME_LABEL_AR | Text | Address Name Label in Arabic. |
ADDRESS_BUILDING_CONFIG | Text | Address Building Configurtion. Options:
Default: show-optional. |
ADDRESS_BUILDING_LABEL_EN | Text | Address Building Label in English. |
ADDRESS_BUILDING_LABEL_AR | Text | Address Building Label in Arabic. |
ADDRESS_STREET_CONFIG | Text | Address Street Configurtion. Options:
Default: show-required. |
ADDRESS_STREET_LABEL_EN | Text | Address Street Label in English. |
ADDRESS_STREET_LABEL_AR | Text | Address Street Label in Arabic. |
ADDRESS_APT_CONFIG | Text | Address Apartment Configurtion. Options:
Default: show-required. |
ADDRESS_APT_LABEL_EN | Text | Address Apartment Label in English. |
ADDRESS_APT_LABEL_AR | Text | Address Apartment Label in Arabic. |
ADDRESS_LANDMARK_CONFIG | Text | Address Landmark Configurtion. Options:
Default: show-optional. |
ADDRESS_LANDMARK_LABEL_EN | Text | Address Landmark Label in English. |
ADDRESS_LANDMARK_LABEL_AR | Text | Address Landmark Label in Arabic. |
ADDRESS_FLOOR_CONFIG | Text | Address Floor Configurtion. Options:
Default: show-optional. |
ADDRESS_FLOOR_LABEL_EN | Text | Address Floor Label in English. |
ADDRESS_FLOOR_LABEL_AR | Text | Address Floor Label in Arabic. |
ADDRESS_SHOP_NAME_CONFIG | Text | Address Shop Name Configurtion. Options:
Default: hide. |
ADDRESS_SHOP_NAME_EN | Text | Address Shop Name Label in English. |
ADDRESS_SHOP_NAME_AR | Text | Address Shop Name Label in Arabic. |
ADDRESS_SHOP_IMAGE_CONFIG | Text | Address Shop Image Configurtion. Options:
Default: hide. |
ADDRESS_SHOP_IMAGE_LABEL_EN | Text | Address Shop Image Label in English. |
ADDRESS_SHOP_IMAGE_LABEL_AR | Text | Address Shop Image Label in Arabic. |
ADDRESS_CONTACT_NUMBER_CONFIG | Text | Address Contact Number Configurtion. Options:
Default: show-required. |
ADDRESS_CONTACT_NUMBER_LABEL_EN | Text | Address Contact Number Label in English. |
ADDRESS_CONTACT_NUMBER_LABEL_AR | Text | Address Contact Number Label in Arabic. |
ADDRESS_BANK_ACCOUNT_CONFIG | Text | Address Bank Account Configurtion. Options:
Default: hide. |
ADDRESS_BANK_ACCOUNT_LABEL_EN | Text | Address Bank Account Label in English. |
ADDRESS_BANK_ACCOUNT_LABEL_AR | Text | Address Bank Account Label in Arabic. |
ADDRESS_COMMERCIAL_RECORD_CONFIG | Text | Address Commercial Record Configurtion. Options:
Default: hide. |
ADDRESS_COMMERCIAL_RECORD_LABEL_EN | Text | Address Commercial Record Label in English. |
ADDRESS_COMMERCIAL_RECORD_LABEL_AR | Text | Address Commercial Record Label in Arabic. |
ADDRESS_ATTACHMENT_2_CONFIG | Text | Address Attachment 2 Configurtion. Options:
Default: hide. |
ADDRESS_ATTACHMENT_2_LABEL_EN | Text | Address Attachment 2 Label in English. |
ADDRESS_ATTACHMENT_2_LABEL_AR | Text | Address Attachment 2 Label in Arabic. |
ADDRESS_ATTACHMENT_3_CONFIG | Text | Address Attachment 3 Configurtion. Options:
Default: hide. |
ADDRESS_ATTACHMENT_3_LABEL_EN | Text | Address Attachment 3 Label in English. |
ADDRESS_ATTACHMENT_3_LABEL_AR | Text | Address Attachment 3 Label in Arabic. |
معلومات
Check the following section to learn more about the Configuration API Reference