ECommerceSettings Class

Class providing access to E-commerce related settings.

Inheritance Hierarchy

System.Object
  CMS.Ecommerce.ECommerceSettings

Namespace: CMS.Ecommerce
Assembly: CMS.Ecommerce (in CMS.Ecommerce.dll) Version: 10.0.0

Syntax

public static class ECommerceSettings

The ECommerceSettings type exposes the following members.

Fields

	Name	Description
Public field Static member	ADD_TO_CART_CONVERSION_NAME	Represents CMSStoreAddToShoppingCartConversionName e-commerce setting key name.
Public field Static member	ADD_TO_CART_CONVERSION_VALUE	Represents CMSStoreAddToShoppingCartConversionValue e-commerce setting key name.
Public field Static member	ALLOW_ANONYMOUS_CUSTOMERS	Represents CMSStoreAllowAnonymousCustomers e-commerce setting key name.
Public field Static member	ALLOW_GLOBAL_DEPARTMENTS	Represents CMSStoreAllowGlobalDepartments e-commerce setting key name.
Public field Static member	ALLOW_GLOBAL_DISCOUNT_COUPONS	Represents CMSStoreAllowGlobalDiscountCoupons e-commerce setting key name.
Public field Static member	ALLOW_GLOBAL_MANUFACTURERS	Represents CMSStoreAllowGlobalManufacturers e-commerce setting key name.
Public field Static member	ALLOW_GLOBAL_PAYMENT_METHODS	Represents CMSStoreAllowGlobalPaymentMethods e-commerce setting key name.
Public field Static member	ALLOW_GLOBAL_PRODUCT_OPTIONS	Represents CMSStoreAllowGlobalProductOptions e-commerce setting key name.
Public field Static member	ALLOW_GLOBAL_PRODUCTS	Represents CMSStoreAllowGlobalProducts e-commerce setting key name.
Public field Static member	ALLOW_GLOBAL_SUPPLIERS	Represents CMSStoreAllowGlobalSuppliers e-commerce setting key name.
Public field Static member	ALLOW_PRODUCTS_WITHOUT_DOCUMENTS	Represents CMSStoreAllowProductsWithoutDocuments e-commerce setting key name.
Public field Static member	APPLY_TAXES_BASED_ON	Represents CMSStoreApplyTaxBasedOn e-commerce setting key name.
Public field Static member	AUTOMATIC_REGISTRATION_CUSTOMER	Represents CMSStoreAutoRegisterCustomer e-commerce setting key name.
Public field Static member	AUTOMATIC_REGISTRATION_EMAIL_TEMPLATE	Represents CMSStoreAutoRegistrationEmailTemplate e-commerce setting key name.
Public field Static member	DEFAULT_COUNTRY_NAME	Represents CMSStoreDefaultCountryName e-commerce setting key name.
Public field Static member	DEFAULT_PRODUCT_IMAGE_URL	Represents CMSDefaultProductImageURL e-commerce setting key name.
Public field Static member	DISPLAY_PRICE_INCLUDING_DISCOUNTS	Represents CMSStoreDisplayPriceIncludingDiscounts e-commerce setting key name.
Public field Static member	DISPLAY_PRICE_INCLUDING_TAXES	Represents CMSStoreDisplayPriceIncludingTaxes e-commerce setting key name.
Public field Static member	DISPLAY_PRODUCTS_IN_SECTIONS_TREE	Represents CMSStoreDisplayProductsInSectionsTree e-commerce setting key name.
Public field Static member	EPRODUCTS_REMINDER	Represents CMSStoreEProductsReminder e-commerce setting key name.
Public field Static member	CHEAPEST_VARIANT_ADVERTISING	Represents CMSCheapestVariantAdvertising e-commerce setting key name.
Public field Static member	CHECKOUT_PROCESS	Represents CMSStoreCheckoutProcess e-commerce setting key name.
Public field Static member	INVOICE_NUMBER_PATTERN	Pattern (macro expression) used to generate an invoice number.
Public field Static member	INVOICE_TEMPLATE	Represents CMSStoreInvoiceTemplate e-commerce setting key name.
Public field Static member	MARK_SHOPPING_CART_AS_ABANDONED_PERIOD	Represents CMSMarkShoppingCartAsAbandonedPeriod e-commerce setting key name.
Public field Static member	MASS_UNIT	Represents CMSStoreMassUnit e-commerce setting key name.
Public field Static member	NEW_PRODUCT_STATUS	Represents CMSStoreNewProductStatus e-commerce setting key name.
Public field Static member	ORDER_CONVERSION_NAME	Represents CMSStoreOrderConversionName e-commerce setting key name.
Public field Static member	ORDER_CONVERSION_VALUE	Represents CMSStoreOrderConversionValue e-commerce setting key name.
Public field Static member	PRODUCTS_ARE_NEW_FOR	Represents CMSStoreProductsAreNewFor e-commerce setting key name.
Public field Static member	PRODUCTS_STARTING_PATH	Represents CMSStoreProductsStartingPath e-commerce setting key name.
Public field Static member	PRODUCTS_TREE	Represents CMSStoreProductsTree e-commerce setting key name.
Public field Static member	REDIRECT_TO_SHOPPINGCART	Represents CMSStoreRedirectToShoppingCart e-commerce setting key name.
Public field Static member	REGISTRATION_CONVERSION_NAME	Represents CMSStoreRegistrationConversionName e-commerce setting key name.
Public field Static member	REGISTRATION_CONVERSION_VALUE	Represents CMSStoreRegistrationConversionValue e-commerce setting key name.
Public field Static member	RELATED_PRODUCTS_RELATIONSHIP_NAME	Represents CMSStoreRelatedProductsRelationshipName e-commerce setting key name.
Public field Static member	REQUIRE_COMPANYINFO	Represents CMSStoreRequireCompanyInfo e-commerce setting key name.
Public field Static member	SEND_EMAILS_FROM	Represents CMSStoreSendEmailsFrom e-commerce setting key name.
Public field Static member	SEND_EMAILS_TO	Represents CMSStoreSendEmailsTo e-commerce setting key name.
Public field Static member	SEND_ORDER_NOTIFICATION	Represents CMSStoreSendOrderNotification e-commerce setting key name.
Public field Static member	SEND_PAYMENT_NOTIFICATION	Represents CMSStoreSendPaymentNotification e-commerce setting key name.
Public field Static member	SHOPPING_CART_EXPIRATION_PERIOD	Represents CMSShoppingCartExpirationPeriod e-commerce setting key name.
Public field Static member	SHOPPINGCART_URL	Represents CMSShoppingCartURL e-commerce setting key name.
Public field Static member	SHOW_ORGANIZATION_ID	Represents CMSStoreShowOrganizationID e-commerce setting key name.
Public field Static member	SHOW_TAX_REGISTRATION_ID	Represents CMSStoreShowTaxRegistrationID e-commerce setting key name.
Public field Static member	USE_CUSTOMER_CULTURE_FOR_EMAILS	Represents CMSStoreUseCustomerCultureForEmails e-commerce settings key name.
Public field Static member	USE_EXTRA_COMPANYADDRESS	Represents CMSStoreUseExtraCompanyAddress e-commerce setting key name.
Public field Static member	USE_GLOBAL_CREDIT	Represents CMSStoreUseGlobalCredit e-commerce setting key name.
Public field Static member	USE_GLOBAL_CURRENCIES	Represents CMSStoreUseGlobalCurrencies e-commerce setting key name.
Public field Static member	USE_GLOBAL_EXCHANGE_RATES	Represents CMSStoreUseGlobalExchangeRates e-commerce setting key name.
Public field Static member	USE_GLOBAL_INTERNAL_STATUS	Represents CMSStoreUseGlobalInternalStatus e-commerce setting key name.
Public field Static member	USE_GLOBAL_INVOICE	Represents CMSStoreUseGlobalInvoice e-commerce setting key name.
Public field Static member	USE_GLOBAL_ORDER_STATUS	Represents CMSStoreUseGlobalOrderStatus e-commerce setting key name.
Public field Static member	USE_GLOBAL_PUBLIC_STATUS	Represents CMSStoreUseGlobalPublicStatus e-commerce setting key name.
Public field Static member	USE_GLOBAL_TAX_CLASSES	Represents CMSStoreUseGlobalTaxClasses e-commerce setting key name.
Public field Static member	WEIGHT_FORMATTING_STRING	Represents CMSStoreWeightFormattingString e-commerce setting key name.
Public field Static member	WISHLIST_URL	Represents CMSWishlistURL e-commerce setting key name.

Properties

	Name	Description
Public property Static member	EnableOrderItemEditing	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 property Static member	UseMetaFileForProductImage	Indicates if meta file should be used for product image. Value is taken from webconfig key CMSUseMetaFileForProductImage. Default value is true.

Methods

	Name	Description
Public method Static member	AddToCartConversionName	Name of the conversion that will be logged when a user adds a product to the shopping cart.
Public method Static member	AddToCartConversionValue	Number that will be recorded along with the specified conversion when a product is added to the shopping cart.
Public method Static member	AllowAnonymousCustomers	Indicates if customers need to register in your site so that they can make the purchase.
Public method Static member	AllowCombineSiteAndGlobal	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 method Static member	AllowGlobalDepartments	Indicates if global departments are allowed.
Public method Static member	AllowGlobalDiscountCoupons	Indicates if global discount coupons are allowed.
Public method Static member	AllowGlobalManufacturers	Indicates if global manufacturers are allowed.
Public method Static member	AllowGlobalObjects	Indicates if global objects of given type are allowed/used on the site specified by site name.
Public method Static member	AllowGlobalPaymentMethods	Indicates if global payment methods are allowed.
Public method Static member	AllowGlobalProductOptions	Indicates if global product options are allowed.
Public method Static member	AllowGlobalProducts	Indicates if global products are allowed.
Public method Static member	AllowGlobalSuppliers	Indicates if global suppliers are allowed.
Public method Static member	AllowProductsWithoutDocuments	Indicates whether it is possible to create products without document data.
Public method Static member	ApplyTaxesBasedOn	Indicates whether the tax is applied based on shipping or billing address.
Public method Static member	AutomaticCustomerRegistration	Indicates if customer is automatically registered after checkout process and email is send.
Public method Static member	AutomaticRegistrationEmailTemplateCodeName	Returns email template code name for automatic customer registration email notification.
Public method Static member	DefaultCountryName	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 method Static member	DefaultProductImageURL	Gets the URL of the default product image which is used when image of the product is not specified.
Public method Static member	DisplayPriceIncludingDiscounts	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 method Static member	DisplayPriceIncludingTaxes	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 method Static member	DisplayProductsInSectionsTree	Indicates if products will be displayed in products sections tree. This setting has no effect when not using sections tree.
Public method Static member	EProductsReminder	Gets number of days before e-product expiration when reminder is to be sent.
Public method Static member	GetGlobalKeyForType	Returns settings key name allowing global object of given object type.
Public method Static member	CheapestVariantAdvertising	Indicates if the system updates the product price, visible in the product listing, automatically with the price of the cheapest product variant.
Public method Static member	CheckoutProcess	Gets the checkout process used in the store shopping cart.
Public method Static member	InvoiceNumberPattern	Pattern (macro expression) for generating of invoice number.
Public method Static member	InvoiceTemplate	Gets HTML template used to generate an invoice (or receipt) after an order is finished and saved.
Public method Static member	MarkShoppingCartAsAbandonedPeriod	Number of hours after which are shopping carts marked as abandoned. Default value is 4 hours.
Public method Static member	MassUnit	Gets the mass unit code used by the system to represent weights.
Public method Static member	NewProductStatus	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 method Static member	OrderConversionName	Name of the conversion that will be logged when a user completes an order.
Public method Static member	OrderConversionValue	Number that will be recorded along with the Order conversion when it is logged.
Public method Static member	ProductsAreNewFor	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 method Static member	ProductsStartingPath	Path within the content tree where sub-tree of product sections starts.
Public method Static member	ProductsTree	Returns the mode of displaying tree in the products administration UI.
Public method Static member	RedirectToShoppingCart	Indicates if user will be redirected to shopping cart after adding product to cart.
Public method Static member	RegistrationConversionName	Name of the conversion that will be logged when a user successfully registers on the website through the checkout process.
Public method Static member	RegistrationConversionValue	Number that will be recorded along with the Registration conversion when it is logged.
Public method Static member	RelatedProductsRelationshipName	Relationship name to be used for related products.
Public method Static member	RequireCompanyInfo	Indicates if it is compulsory to provide company account information in the check out process.
Public method Static member	SendEmailsFrom	Gets an e-mail address the e-commerce notification e-mails are sent from.
Public method Static member	SendEmailsTo	Gets site-related e-mail address (e.g. merchant's e-mail address) the e-commerce notification e-mails are sent to.
Public method Static member	SendOrderNotification	Indicates if e-mail notifications are sent after an order is finished and saved.
Public method Static member	SendPaymentNotification	Indicates if e-mail notifications are sent after an order payment is completed.
Public method Static member	ShoppingCartExpirationPeriod	Number of days before the shopping cart is expired. Default value is 30 days.
Public method Static member	ShoppingCartURL	Gets the URL of the shopping cart page.
Public method Static member	ShowOrganizationID	Indicates if organization ID field should be displayed.
Public method Static member	ShowTaxRegistrationID	Indicates if organization ID field (e.g. VAT registration ID) should be displayed.
Public method Static member	UseCustomerCultureForEmails	Indicates if emails to customer will be sent in shopping cart culture.
Public method Static member	UseExtraCompanyAddress	Indicates if the option of providing company address is available in the check out process.
Public method Static member	UseGlobalCredit	Indicates if global credit is used.
Public method Static member	UseGlobalCurrencies	Indicates if global currencies are used.
Public method Static member	UseGlobalExchangeRates	Indicates if global exchange rates are used.
Public method Static member	UseGlobalInternalStatus	Indicates if global internal statuses are used.
Public method Static member	UseGlobalInvoice	Indicates if global invoice is used.
Public method Static member	UseGlobalOrderStatus	Indicates if global order statuses are used.
Public method Static member	UseGlobalPublicStatus	Indicates if global public statuses are used.
Public method Static member	UseGlobalTaxClasses	Indicates if global tax classes are used.
Public method Static member	WeightFormattingString	Gets the format used to display product weight. Use {0} expression to insert the weight into the formatting string.
Public method Static member	WishListURL	Gets the URL of the wish list page.