IShoppingService Interface

Provides interface for interaction with shopping cart.

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

Syntax

public interface IShoppingService

The IShoppingService type exposes the following members.

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.
Public method	ClearShippingOptionIfNotShippable	Removes the shipping option from the current shopping cart if it's not needed anymore, and evaluates and saves the cart. Does nothing if the cart has no shipping option or contains a shippable product.
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.
Public method	GetCurrentCustomer	Gets the current customer.
Public method	GetCurrentShoppingCart	Gets the shopping cart used by the IShoppingService instance. 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.
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.
Public method	SetBillingAddress	Sets billing address to the current shopping cart and evaluates the cart.
Public method	SetCustomer	Sets the given customer to the current shopping cart and persists changes in the database.
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.
Public method	SetShippingAddress	Sets shipping address to the current shopping cart and evaluates the cart.
Public method	SetShippingOption	Sets the selected shipping option to the current shopping cart, and evaluates and saves it. Does nothing if shippingOptionId is the same as the cart already has.
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.