Click or drag to resize
ECommerceSettings Class
Class providing access to E-commerce related settings.
Inheritance Hierarchy
SystemObject
  CMS.EcommerceECommerceSettings

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 8.2.23
Syntax
C#
public static class ECommerceSettings

The ECommerceSettings type exposes the following members.

Methods
  NameDescription
Public methodStatic memberAddToCartConversionName
Name of the conversion that will be logged when a user adds a product to the shopping cart.
Public methodStatic memberAddToCartConversionValue
Number that will be recorded along with the specified conversion when a product is added to the shopping cart.
Public methodStatic memberAllowAnonymousCustomers
Indicates if customers need to register in your site so that they can make the purchase.
Public methodStatic memberAllowCombineSiteAndGlobal
Indicates if ecommerce object of given type can be combined site and global within one site. False means that site can use only global or only site records.
Public methodStatic memberAllowGlobalDepartments
Indicates if global departments are allowed.
Public methodStatic memberAllowGlobalDiscountCoupons
Indicates if global discount coupons are allowed.
Public methodStatic memberAllowGlobalManufacturers
Indicates if global manufacturers are allowed.
Public methodStatic memberAllowGlobalObjects
Indicates if global objects of given type are allowed/used on the site specified by site name.
Public methodStatic memberAllowGlobalPaymentMethods
Indicates if global payment methods are allowed.
Public methodStatic memberAllowGlobalProductOptions
Indicates if global product options are allowed.
Public methodStatic memberAllowGlobalProducts
Indicates if global products are allowed.
Public methodStatic memberAllowGlobalShippingOptions Obsolete.
Indicates if global shipping options are allowed.
Public methodStatic memberAllowGlobalSuppliers
Indicates if global suppliers are allowed.
Public methodStatic memberAllowProductsWithoutDocuments
Indicates whether it is possible to create products without document data.
Public methodStatic memberApplyTaxesBasedOn
Indicates whether the tax is applied based on shipping or billing address.
Public methodStatic memberAutomaticCustomerRegistration
Indicates if customer is automatically registered after checkout process and email is send.
Public methodStatic memberAutomaticRegistrationEmailTemplateCodeName
Returns email template code name for automatic customer registration email notification.
Public methodStatic memberDefaultCountryName
Gets default country, choose your country or country where you sell the most. All taxes are applied based on their values in the default country unless the customer specifies their country or state during the checkout process.
Public methodStatic memberDefaultProductImageURL
Gets the URL of the default product image which is used when image of the product is not specified.
Public methodStatic memberDisplayPriceIncludingDiscounts
Indicates if product prices on the live site are displayed including discounts. This takes effect only to prices which are displayed using GetSKUFormattedPrice() method.
Public methodStatic memberDisplayPriceIncludingTaxes
Indicates if product prices on the live site are displayed including taxes. This takes effect only to prices which are displayed using GetSKUFormattedPrice() method.
Public methodStatic memberDisplayProductsInSectionsTree
Indicates if products will be displayed in products sections tree. This setting has no effect when not using sections tree.
Public methodStatic memberEProductsReminder
Gets number of days before e-product expiration when reminder is to be sent.
Public methodStatic memberGetApplyTaxesBasedOnString
Converts ApplyTaxBasedOnEnum to string value.
Public methodStatic memberGetGlobalKeyForType
Returns settings key name allowing global object of given object type.
Public methodStatic memberGetProductsTreeModeString
Converts ProductsTreeModeEnum to string value. Default value is None.
Public methodStatic memberCheapestVariantAdvertising
Indicates if the system updates the product price, visible in the product listing, automatically with the price of the cheapest product variant.
Public methodStatic memberCheckoutProcess
Gets the checkout process used in the store shopping cart.
Public methodStatic memberInvoiceNumberPattern
Pattern (macro expression) for generating of invoice number.
Public methodStatic memberInvoiceTemplate
Gets HTML template used to generate an invoice (or receipt) after an order is finished and saved.
Public methodStatic memberMassUnit
Gets the mass unit code used by the system to represent weights.
Public methodStatic memberNewProductStatus
Product public status which represents the status of the product which is evaluated as a new product (according to the 'Products are new for' setting and 'In store from' product property).
Public methodStatic memberOrderConversionName
Name of the conversion that will be logged when a user completes an order.
Public methodStatic memberOrderConversionValue
Number that will be recorded along with the Order conversion when it is logged.
Public methodStatic memberProductsAreNewFor
Number of days for which created products are marked as 'new products' in the store. Days are counted from the product 'In store from' property.
Public methodStatic memberProductsStartingPath
Path within the content tree where sub-tree of product sections starts.
Public methodStatic memberProductsTree
Returns the mode of displaying tree in the products administration UI.
Public methodStatic memberRedirectToShoppingCart
Indicates if user will be redirected to shopping cart after adding product to cart.
Public methodStatic memberRegistrationConversionName
Name of the conversion that will be logged when a user successfully registers on the website through the checkout process.
Public methodStatic memberRegistrationConversionValue
Number that will be recorded along with the Registration conversion when it is logged.
Public methodStatic memberRelatedProductsRelationshipName
Relationship name to be used for related products.
Public methodStatic memberRequireCompanyInfo
Indicates if it is compulsory to provide company account information in the check out process.
Public methodStatic memberSendEmailsFrom
Gets an e-mail address the e-commerce notification e-mails are sent from.
Public methodStatic memberSendEmailsTo
Gets site-related e-mail address (e.g. merchant's e-mail address) the e-commerce notification e-mails are sent to.
Public methodStatic memberSendOrderNotification
Indicates if e-mail notifications are sent after an order is finished and saved.
Public methodStatic memberSendPaymentNotification
Indicates if e-mail notifications are sent after an order payment is completed.
Public methodStatic memberShoppingCartURL
Gets the URL of the shopping cart page.
Public methodStatic memberShowOrganizationID
Indicates if organization ID field should be displayed.
Public methodStatic memberShowTaxRegistrationID
Indicates if organization ID field (e.g. VAT registration ID) should be displayed.
Public methodStatic memberUseCustomerCultureForEmails
Indicates if emails to customer will be sent in shopping cart culture.
Public methodStatic memberUseExtraCompanyAddress
Indicates if the option of providing company address is available in the check out process.
Public methodStatic memberUseGlobalCredit
Indicates if global credit is used.
Public methodStatic memberUseGlobalCurrencies
Indicates if global currencies are used.
Public methodStatic memberUseGlobalExchangeRates
Indicates if global exchange rates are used.
Public methodStatic memberUseGlobalInternalStatus
Indicates if global internal statuses are used.
Public methodStatic memberUseGlobalInvoice
Indicates if global invoice is used.
Public methodStatic memberUseGlobalOrderStatus
Indicates if global order statuses are used.
Public methodStatic memberUseGlobalPublicStatus
Indicates if global public statuses are used.
Public methodStatic memberUseGlobalTaxClasses
Indicates if global tax classes are used.
Public methodStatic memberWeightFormattingString
Gets the format used to display product weight. Use {0} expression to insert the weight into the formatting string.
Public methodStatic memberWishListURL
Gets the URL of the wish list page.
Top
Fields
  NameDescription
Public fieldStatic memberADD_TO_CART_CONVERSION_NAME
Represents CMSStoreAddToShoppingCartConversionName e-commerce setting key name.
Public fieldStatic memberADD_TO_CART_CONVERSION_VALUE
Represents CMSStoreAddToShoppingCartConversionValue e-commerce setting key name.
Public fieldStatic memberALLOW_ANONYMOUS_CUSTOMERS
Represents CMSStoreAllowAnonymousCustomers e-commerce setting key name.
Public fieldStatic memberALLOW_GLOBAL_DEPARTMENTS
Represents CMSStoreAllowGlobalDepartments e-commerce setting key name.
Public fieldStatic memberALLOW_GLOBAL_DISCOUNT_COUPONS
Represents CMSStoreAllowGlobalDiscountCoupons e-commerce setting key name.
Public fieldStatic memberALLOW_GLOBAL_MANUFACTURERS
Represents CMSStoreAllowGlobalManufacturers e-commerce setting key name.
Public fieldStatic memberALLOW_GLOBAL_PAYMENT_METHODS
Represents CMSStoreAllowGlobalPaymentMethods e-commerce setting key name.
Public fieldStatic memberALLOW_GLOBAL_PRODUCT_OPTIONS
Represents CMSStoreAllowGlobalProductOptions e-commerce setting key name.
Public fieldStatic memberALLOW_GLOBAL_PRODUCTS
Represents CMSStoreAllowGlobalProducts e-commerce setting key name.
Public fieldStatic memberALLOW_GLOBAL_SHIPPING_OPTIONS Obsolete.
Represents CMSStoreAllowGlobalShippingOptions e-commerce setting key name.
Public fieldStatic memberALLOW_GLOBAL_SUPPLIERS
Represents CMSStoreAllowGlobalSuppliers e-commerce setting key name.
Public fieldStatic memberALLOW_PRODUCTS_WITHOUT_DOCUMENTS
Represents CMSStoreAllowProductsWithoutDocuments e-commerce setting key name.
Public fieldStatic memberAPPLY_TAXES_BASED_ON
Represents CMSStoreApplyTaxBasedOn e-commerce setting key name.
Public fieldStatic memberAUTOMATIC_REGISTRATION_CUSTOMER
Represents CMSStoreAutoRegisterCustomer e-commerce setting key name.
Public fieldStatic memberAUTOMATIC_REGISTRATION_EMAIL_TEMPLATE
Represents CMSStoreAutoRegistrationEmailTemplate e-commerce setting key name.
Public fieldStatic memberDEFAULT_COUNTRY_NAME
Represents CMSStoreDefaultCountryName e-commerce setting key name.
Public fieldStatic memberDEFAULT_PRODUCT_IMAGE_URL
Represents CMSDefaultProductImageURL e-commerce setting key name.
Public fieldStatic memberDISPLAY_PRICE_INCLUDING_DISCOUNTS
Represents CMSStoreDisplayPriceIncludingDiscounts e-commerce setting key name.
Public fieldStatic memberDISPLAY_PRICE_INCLUDING_TAXES
Represents CMSStoreDisplayPriceIncludingTaxes e-commerce setting key name.
Public fieldStatic memberDISPLAY_PRODUCTS_IN_SECTIONS_TREE
Represents CMSStoreDisplayProductsInSectionsTree e-commerce setting key name.
Public fieldStatic memberEPRODUCTS_REMINDER
Represents CMSStoreEProductsReminder e-commerce setting key name.
Public fieldStatic memberCHEAPEST_VARIANT_ADVERTISING
Represents CMSCheapestVariantAdvertising e-commerce setting key name.
Public fieldStatic memberCHECKOUT_PROCESS
Represents CMSStoreCheckoutProcess e-commerce setting key name.
Public fieldStatic memberINVOICE_NUMBER_PATTERN
Pattern (macro expression) used to generate an invoice number.
Public fieldStatic memberINVOICE_TEMPLATE
Represents CMSStoreInvoiceTemplate e-commerce setting key name.
Public fieldStatic memberMASS_UNIT
Represents CMSStoreMassUnit e-commerce setting key name.
Public fieldStatic memberNEW_PRODUCT_STATUS
Represents CMSStoreNewProductStatus e-commerce setting key name.
Public fieldStatic memberORDER_CONVERSION_NAME
Represents CMSStoreOrderConversionName e-commerce setting key name.
Public fieldStatic memberORDER_CONVERSION_VALUE
Represents CMSStoreOrderConversionValue e-commerce setting key name.
Public fieldStatic memberPRODUCTS_ARE_NEW_FOR
Represents CMSStoreProductsAreNewFor e-commerce setting key name.
Public fieldStatic memberPRODUCTS_STARTING_PATH
Represents CMSStoreProductsStartingPath e-commerce setting key name.
Public fieldStatic memberPRODUCTS_TREE
Represents CMSStoreProductsTree e-commerce setting key name.
Public fieldStatic memberREDIRECT_TO_SHOPPINGCART
Represents CMSStoreRedirectToShoppingCart e-commerce setting key name.
Public fieldStatic memberREGISTRATION_CONVERSION_NAME
Represents CMSStoreRegistrationConversionName e-commerce setting key name.
Public fieldStatic memberREGISTRATION_CONVERSION_VALUE
Represents CMSStoreRegistrationConversionValue e-commerce setting key name.
Public fieldStatic memberRELATED_PRODUCTS_RELATIONSHIP_NAME
Represents CMSStoreRelatedProductsRelationshipName e-commerce setting key name.
Public fieldStatic memberREQUIRE_COMPANYINFO
Represents CMSStoreRequireCompanyInfo e-commerce setting key name.
Public fieldStatic memberSEND_EMAILS_FROM
Represents CMSStoreSendEmailsFrom e-commerce setting key name.
Public fieldStatic memberSEND_EMAILS_TO
Represents CMSStoreSendEmailsTo e-commerce setting key name.
Public fieldStatic memberSEND_ORDER_NOTIFICATION
Represents CMSStoreSendOrderNotification e-commerce setting key name.
Public fieldStatic memberSEND_PAYMENT_NOTIFICATION
Represents CMSStoreSendPaymentNotification e-commerce setting key name.
Public fieldStatic memberSHOPPINGCART_URL
Represents CMSShoppingCartURL e-commerce setting key name.
Public fieldStatic memberSHOW_ORGANIZATION_ID
Represents CMSStoreShowOrganizationID e-commerce setting key name.
Public fieldStatic memberSHOW_TAX_REGISTRATION_ID
Represents CMSStoreShowTaxRegistrationID e-commerce setting key name.
Public fieldStatic memberUSE_CUSTOMER_CULTURE_FOR_EMAILS
Represents CMSStoreUseCustomerCultureForEmails e-commerce settings key name.
Public fieldStatic memberUSE_EXTRA_COMPANYADDRESS
Represents CMSStoreUseExtraCompanyAddress e-commerce setting key name.
Public fieldStatic memberUSE_GLOBAL_CREDIT
Represents CMSStoreUseGlobalCredit e-commerce setting key name.
Public fieldStatic memberUSE_GLOBAL_CURRENCIES
Represents CMSStoreUseGlobalCurrencies e-commerce setting key name.
Public fieldStatic memberUSE_GLOBAL_EXCHANGE_RATES
Represents CMSStoreUseGlobalExchangeRates e-commerce setting key name.
Public fieldStatic memberUSE_GLOBAL_INTERNAL_STATUS
Represents CMSStoreUseGlobalInternalStatus e-commerce setting key name.
Public fieldStatic memberUSE_GLOBAL_INVOICE
Represents CMSStoreUseGlobalInvoice e-commerce setting key name.
Public fieldStatic memberUSE_GLOBAL_ORDER_STATUS
Represents CMSStoreUseGlobalOrderStatus e-commerce setting key name.
Public fieldStatic memberUSE_GLOBAL_PUBLIC_STATUS
Represents CMSStoreUseGlobalPublicStatus e-commerce setting key name.
Public fieldStatic memberUSE_GLOBAL_TAX_CLASSES
Represents CMSStoreUseGlobalTaxClasses e-commerce setting key name.
Public fieldStatic memberWEIGHT_FORMATTING_STRING
Represents CMSStoreWeightFormattingString e-commerce setting key name.
Public fieldStatic memberWISHLIST_URL
Represents CMSWishlistURL e-commerce setting key name.
Top
Properties
  NameDescription
Public propertyStatic memberEnableOrderItemEditing
If true, order item parameters, such as order item name and order item unit price, can be modified when editing an existing order. Value is taken from webconfig key CMSEnableOrderItemEditing. Default value is false.
Public propertyStatic memberShoppingCartExpirationPeriod
Number of days before the shopping cart is expired. Value is taken from webconfig key CMSShoppingCartExpirationPeriod. Default value is 30 days.
Public propertyStatic memberUseMetaFileForProductImage
Indicates if meta file should be used for product image. Value is taken from webconfig key CMSUseMetaFileForProductImage. Default value is true.
Top
See Also