ShoppingCartService Class

Provides services for managing a NetFORUM server-side shopping cart, owned by the currently logged in Ignition user

Definition

Namespace: Ignition.Commerce.Shopping
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
C#
public class ShoppingCartService
Inheritance
Object    ShoppingCartService
Derived

Constructors

ShoppingCartService Default constructor
ShoppingCartService(CartReferenceToken)Initializes a new instance of the ShoppingCartService class
ShoppingCartService(FuncNetForumId) Default constructor
ShoppingCartService(NetForumId) Default constructor
ShoppingCartService(String)Initializes a new instance of the ShoppingCartService class
ShoppingCartService(CartReferenceToken, NetForumId) Default constructor
ShoppingCartService(CartReferenceToken, FuncNetForumId) Default constructor
ShoppingCartService(String, NetForumId) Default constructor
ShoppingCartService(String, FuncNetForumId) Default constructor

Properties

Cart Returns the current state of the NetForum shopping cart
CartName A "name" for this shopping cart, used to correlate this instance of the service with a given NetFORUM server-side cart, when this feature is enabled.
DefaultCartOwnerProvider 
Token A "token" for this shopping cart, used to correlate this instance of the service with a given NetFORUM server-side cart.

Methods

AddCourseRegistration Adds an course registration to the shopping cart.
AddDonation(DonationOption) Adds a donor application to the shopping cart from a DonationOption, taking all defaults. If you would like to customize your DonorApplication before adding it to the cart, use IDonationShoppingService to directly generate a DonorApplication instead.
AddDonation(DonorApplication) Adds a donor application to the shopping cart
AddEventRegistration Adds an event registration to the shopping cart.
AddEventRegistrationAddendum Adds an event registration addendum to the shopping cart.
AddEventRegistrationGroup Adds a group event registration to the shopping cart.
AddEventSponsorship Adds an event sponsorship to the shopping cart.
AddExhibitorApplication Adds an exhibitor application to the shopping cart
AddHlo Adds a single new HLO (High Level Object) to the NetFORUM server-side shopping cart. This method should only be used if no other methods in IShoppingCartService can accomplish the desired result.
AddMembershipNew(IProduct, Object) Adds a new membership to the shopping cart This overload is intended to be used with membership packages retrieved via the InventoryProductRepository
AddMembershipNew(MembershipPackage, Object) Adds a new membership to the shopping cart
AddMembershipNew(MembershipPurchaseOption, Object) Adds a new membership to the shopping cart
AddMembershipRenewal(Membership, MembershipPackage, Object) Adds a renewal membership to the shopping cart.
AddMembershipRenewal(Membership, MembershipPurchaseOption, Object) Adds a renewal membership to the shopping cart.
AddOpenInvoice Adds an open invoice to the shopping cart.
AddProduct(IProduct, Decimal) Adds a product to the shopping cart, allowing NetForum to select the appropriate price
AddProduct(IProduct, IPrice, Decimal) Adds a product to the shopping cart with a specific price, bypassing NetForum's price selection mechanism
AddShippingMethod Adds a shipping method to be used for shippable items within the shopping cart. Does not replace previously set shipping methods. To replace existing shipping methods, use SetShippingMethod(ShippingMethod).
AddSubscription(SubscriptionPurchaseOption) Adds a subscription to the shopping cart
AddSubscription(IProduct, IPrice) Adds a subscription to the shopping cart
ApplyCreditsTowardsBalance Applies the provided credit balance towards the pending purchase, applying credits in as close to the order provided as possible. Any previously applied credits will be removed.
ApplyDiscount(Discount) Applies discount to the shopping cart.
ApplyDiscount(String) Applies discountCode to the shopping cart.
ApplyDiscountProgramVouchers Applies as many of the the cart's Bill-To customer's discount program vouchers to the cart as possible.
ApplyDiscountProgramVouchers(InvoiceDetailCartItem, IEnumerableString) Applies discount program vouchers matching the supplied codes, to the specified item. Vouchers specified must meet a number of criteria, see remarks for more information.
ApplySourceCode(InvoiceSourceCode) Applies a source code to the shopping cart
ApplySourceCode(String) Applies promotionalCode to the shopping cart
AttemptToIdentify Attempts to associate NetFORUM server-side copy of the cart with the id returned by this service's current identity provider.
CacheCart Replaces the currently cached Cart object with a new instance of IShoppingCartState, presumably because an underlying call to Flashpoint returned to us a more up-to-date representation of the cart
CalculateAmountDueToday Calculates the minimum payment amount required to checkout, given the provided billing settings.
Obsolete.
CalculateTotalsForInstallmentCheckout Calculates payment amounts related to checking out with installment-billing settings.
ChangeItemQuantity Changes the quantity of an item in the shopping cart.
Checkout(CheckoutOptions) Places an order on a cart whose amount due today is $0, without providing payment information
Checkout(AchPayment, CheckoutOptions) Places an order
Checkout(CashPayment, CheckoutOptions) Places an order where "cash" was used for payment
Checkout(CheckPayment, CheckoutOptions) Places an order where a check was used for payment
Checkout(CreditCardPayment, CheckoutOptions) Places an order
Checkout(SavedCreditCard, CheckoutOptions) Places an order
Checkout(AchPayment, Decimal, CheckoutOptions) Places an order
Checkout(CreditCardPayment, Decimal, CheckoutOptions) Places an order, specifying a fixed payment amount
Checkout(SavedCreditCard, Decimal, CheckoutOptions) Places an order, specifying a fixed payment amount
ClearCredits Removes all credits that have been applied towards the pending purchase.
ClearDiscountProgramVouchers Clear discount program vouchers applied to all items in the shopping cart.
ClearDiscountProgramVouchers(InvoiceDetailCartItem) Clear discount program vouchers applied to a single item in the shopping cart.
ClearDiscounts Removes all discounts from the shopping cart
ClearItems Removes all cart items from the cart.
GetAvailableCredits Returns information about the available credit that might be applicable to purchases made through this shopping cart. Credits are limited to those held by the current cart owner, which have an available balance, and are not "coupons".
GetPaymentMethods Uses NetFORUM's baseline auto-detection mechanism to determine which payment methods are valid to be used when checking out with the current shopping cart.
GetShippingMethods Returns the available shipping methods based on the current state of the cart.
Identify Forces a re-evaluation of the owner of the shopping cart. The contents of the cart may change as a result of this operation depending on internal NetFORUM business rules.
New Creates a new NetForum shopping cart, replacing any existing shopping cart.
RemoveDiscount(AdditionalInvoiceDetailCartItem) Removes a discount from the shopping cart
RemoveDiscount(IDiscountCartItem) Removes a discount from the shopping cart
Obsolete.
RemoveItem(InvoiceDetailCartItem) Removes an invoice detail from the shopping cart.
RemoveItem(IStandardCartItem) Removes all of the an cart item and (all of its sub-items) from the shopping cart.
SetBillingAddress Sets the billing address of the shopping cart.
SetBillingContact Sets the billing contact of the shopping cart, which maps to the inv_ind_cst_billing_key field in NetFORUM.
SetBillToCustomer(ICustomerIdentity) Sets the bill-to customer of the shopping cart. This will persist even if the cart main customer is changed.
SetBillToCustomer(NetForumId) Sets the bill-to customer of the shopping cart. This will persist even if the cart main customer is changed.
SetShippingAddress Sets the shipping address of the entire shopping cart.
SetShippingMethod Sets the shipping method to be used for shippable items within the shopping cart. Replaces any and all previously set shipping methods. To add an additional shipping method, without replacing existing ones, use AddShippingMethod(ShippingMethod).
SetSystemWideDefaultCartCustomer(FuncNetForumId) Sets a customer used as the default identity of the Shopping Cart Customer for all instances of ShoppingCartService both current and future.
SetSystemWideDefaultCartCustomer(NetForumId) Sets a customer used as the default identity of the Shopping Cart Customer for all instances of ShoppingCartService both current and future.
TryApplyDiscount Attempts to apply a discountCode to the shopping cart.
TryGetLastReceipt Get the receipt from the last successful checkout performed with this cart
UpdateCartItemValues(ICartItem, Object)Obsolete.
UpdateCartItemValues(InvoiceDetailCartItem, Object) Updates a single cart item (InvoiceDetail object) in the NetFORUM server-side shopping cart with new values. This method should only be used if no other methods in IShoppingCartService can accomplish the desired result.
UpdateCartValues Updates the NetFORUM server-side shopping cart (CentralizedOrderEntry object) with new values. This method should only be used if no other methods in IShoppingCartService can accomplish the desired result.
UpdateHloValues Updates a single HLO (High Level Object) in the NetFORUM server-side shopping cart with new values. This method should only be used if no other methods in IShoppingCartService can accomplish the desired result.
UpdateItemQuantity Updates the quantity of an invoice detail in the shopping cart.
Obsolete.
UpdatePendingDonation Updates a single donation in the NetFORUM server-side shopping cart with new values.
UpdatePendingEventRegistration Updates a single pending event registration in the NetFORUM server-side shopping cart with new values.
UpdatePendingGroupRegistration Updates a single pending group registration in the NetFORUM server-side shopping cart with new values.
UpdatePendingMembership Updates a single pending membership in the NetFORUM server-side shopping cart with new values.

Fields

DefaultCartName The default cart name, used if one is not specified via constructor parameter

See Also