ShoppingService Class

Provides interaction with shopping cart.

Inheritance Hierarchy

System.Object
  CMS.Ecommerce.ShoppingService

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

Syntax

public class ShoppingService : IShoppingService

The ShoppingService type exposes the following members.

Constructors

	Name	Description
Public method	ShoppingService	Initializes a new instance of the ShoppingService class with supplied activity logger.

Methods

	Name	Description
Public method	AddCouponCode	Applies the specified coupon code to the current shopping cart and evaluates the cart.
Public method	AddItemToCart(ShoppingCartItemParameters)	Adds an item to the current shopping cart and logs the activity. Saves the shopping cart if it has not been saved yet. If an item in such configuration is already present in the cart, its quantity is increased by Quantity. Saves all product options and bundle items after adding and evaluates the cart.
Public method	AddItemToCart(Int32, Int32)	Adds an item to the current shopping cart and logs the activity. Saves the shopping cart if it has not been saved yet. If an item in such configuration is already present in the cart, its quantity is increased by quantity. Saves all product options and bundle items after adding and evaluates the cart.
Public method	CalculateShippingOptionPrice	Returns price of the given shipping option based on the current shopping cart.
Public method	CreateOrder	Validates and creates order from current shopping cart. If order creation was successful empties shopping cart. If order requires an user account, handles its creation. Also tracks order conversion, sends order notifications and logs purchase activities.
Public method	GetBillingAddress	Returns the billing address for the current shopping cart.
Protected method	GetCurrentContactId	Gets ID of the current contact.
Public method	GetCurrentCustomer	Gets the current customer.
Public method	GetCurrentShoppingCart	Gets the shopping cart used by the IShoppingService instance. The shopping cart is retrieved using the ICurrentShoppingCartService implementation this instance was initialized with. This member is a backing method of the get_CurrentShoppingCart() property.
Public method	GetPaymentOption	Returns the selected payment option for the current shopping cart.
Public method	GetShippingAddress	Returns the shipping address for the current shopping cart.
Public method	GetShippingOption	Returns the selected shipping option for the current shopping cart.
Protected method	LogProductAddedToCartActivity	Logs the add to shopping cart activity.
Protected method	LogProductRemovedFromCartActivity	Logs the remove from shopping cart activity.
Protected method	LogPurchaseActivities	Logs all items in cart as purchased.
Public method	RemoveAllItemsFromCart	Removes all items from the current shopping cart. Also removes all children and bundle items from the cart, logs the activity and evaluates the cart.
Public method	RemoveCouponCode	Removes the specified coupon code from the current shopping cart and evaluates the cart.
Public method	RemoveItemFromCart(Int32)	Removes item with specified itemId from the current shopping cart. Also removes all children and bundle items from the cart, logs the activity and evaluates the cart.
Public method	RemoveItemFromCart(ShoppingCartItemInfo)	Removes item specified by shoppingCartItemInfo from the current shopping cart. Also removes all children and bundle items from the cart, logs the activity and evaluates the cart.
Public method	SaveCart	Validates and saves the shopping cart into the database.
Protected method	SendOrderNotifications	Sends notifications about created order to administrator and customer.
Protected method	SetAddress	Sets address to the database. Assigns AddressCustomerID/>. Sets AddressName to address if not already set.
Public method	SetBillingAddress	Sets billing address to the current shopping cart and evaluates the cart.
Protected method	SetBillingAddressInternal	Sets billing address to the current shopping cart, evaluates the cart and persists changes in the database if the persistShoppingCart is true.
Protected method	SetCartItem	Sets or updates cart item, its product options and bundle items to the database.
Public method	SetCustomer	Sets the given customer to the current shopping cart and persists changes in the database.
Protected method	SetCustomerInternal	Sets the given customer to the current shopping cart and persists changes in the database if the persistShoppingCart is true.
Public method	SetPaymentOption	Sets the selected payment option to the current shopping cart, and evaluates and saves it. Does nothing if paymentOptionId is the same as the cart already has.
Protected method	SetPaymentOptionInternal	Sets the selected payment option to the current shopping cart, evaluates it and persists changes in the database if the persistShoppingCart is true. Does nothing if paymentOptionId is the same as the cart already has.
Public method	SetShippingAddress	Sets shipping address to the current shopping cart and evaluates the cart.
Protected method	SetShippingAddressInternal	Sets shipping address to the current shopping cart, evaluates the cart and persists changes in the database if the persistShoppingCart is true.
Public method	SetShippingOption	Sets the selected shipping option to the current shopping cart, evaluates it and persists changes in the database. Does nothing if shippingOptionId is the same as the cart already has.
Protected method	SetShippingOptionInternal	Sets the selected shipping option to the current shopping cart, evaluates it and persists changes in the database if the persistShoppingCart is true. Does nothing if shippingOptionId is the same as the cart already has.
Protected method	TrackOrderConversion	Tracks order conversion of the provided cart.
Public method	UpdateItemQuantity(Int32, Int32)	Updates the quantity of a shopping cart item specified by itemId to quantity. Logs the activity resulting from the actual amount of items added or removed and evaluates the cart.
Public method	UpdateItemQuantity(ShoppingCartItemInfo, Int32)	Updates the quantity of a shopping cart item specified by shoppingCartItemInfo to quantity. Logs the activity resulting from the actual amount of items added or removed and evaluates the cart.
Protected method	ValidateAddItemToCart	Validates adding an item to the shopping cart via AddItemToCart(ShoppingCartItemParameters). The method validates whether an item being added belongs to the same site as current shopping cart. Throws an exception when validation fails.
Protected method	ValidateCreateOrder	Validates cart for which order is being created.
Protected method	ValidateSetBillingAddress	Validates billing address which is to be set to the current shopping cart.
Protected method	ValidateSetPaymentOption	Validates whether a payment option is assigned to the same site as the current shopping cart or the payment option is a global object.
Protected method	ValidateSetShippingAddress	Validates shipping address which is to be set to the current shopping cart.
Protected method	ValidateShippingOption	Validates whether a shipping option is assigned to the same site as the current shopping cart or the shipping option is a global object.
Protected method	ValidateShoppingCart	Validates the shopping cart and its items.