Catalyst Fire Ignition Documentation
Shopping
Provides services for managing a NetFORUM server-side shopping cart, owned by the primary organization of currently logged in Ignition user
Definition
Namespace: Ignition.Commerce.Shopping
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
Assembly: CatalystFire.Ignition (in CatalystFire.Ignition.dll) Version: 12.0.3454
C#
public class ShoppingCartServiceForPrimaryOrganization : ShoppingCartServiceVB
Public Class ShoppingCartServiceForPrimaryOrganization
Inherits ShoppingCartServiceC++
public ref class ShoppingCartServiceForPrimaryOrganization : public ShoppingCartServiceF#
type ShoppingCartServiceForPrimaryOrganization =
class
inherit ShoppingCartService
end- Inheritance
- Object ShoppingCartService ShoppingCartServiceForPrimaryOrganization
Constructors
| ShoppingCartServiceForPrimaryOrganization | Default constructor |
Properties
| Cart |
Returns the current state of the NetForum shopping cart
(Inherited from ShoppingCartService) |
| 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.
(Inherited from ShoppingCartService) |
| Token |
A "token" for this shopping cart, used to correlate this instance of the service with a given NetFORUM server-side cart.
(Inherited from ShoppingCartService) |
Methods
| AddCourseRegistration |
Adds an course registration to the shopping cart.
(Inherited from ShoppingCartService) |
| 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.
(Inherited from ShoppingCartService) |
| AddDonation(DonorApplication) |
Adds a donor application to the shopping cart
(Inherited from ShoppingCartService) |
| AddEventRegistration |
Adds an event registration to the shopping cart.
(Inherited from ShoppingCartService) |
| AddEventRegistrationAddendum |
Adds an event registration addendum to the shopping cart.
(Inherited from ShoppingCartService) |
| AddEventRegistrationGroup |
Adds a group event registration to the shopping cart.
(Inherited from ShoppingCartService) |
| AddEventSponsorship |
Adds an event sponsorship to the shopping cart.
(Inherited from ShoppingCartService) |
| AddExhibitorApplication |
Adds an exhibitor application to the shopping cart
(Inherited from ShoppingCartService) |
| 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.
(Inherited from ShoppingCartService) |
| 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
(Inherited from ShoppingCartService) |
| AddMembershipNew(MembershipPackage, Object) |
Adds a new membership to the shopping cart
(Inherited from ShoppingCartService) |
| AddMembershipNew(MembershipPurchaseOption, Object) |
Adds a new membership to the shopping cart
(Inherited from ShoppingCartService) |
| AddMembershipRenewal(Membership, MembershipPackage, Object) |
Adds a renewal membership to the shopping cart.
(Inherited from ShoppingCartService) |
| AddMembershipRenewal(Membership, MembershipPurchaseOption, Object) |
Adds a renewal membership to the shopping cart.
(Inherited from ShoppingCartService) |
| AddOpenInvoice |
Adds an open invoice to the shopping cart.
(Inherited from ShoppingCartService) |
| AddProduct(IProduct, Decimal) |
Adds a product to the shopping cart, allowing NetForum to select the appropriate price
(Inherited from ShoppingCartService) |
| AddProduct(IProduct, IPrice, Decimal) |
Adds a product to the shopping cart with a specific price, bypassing NetForum's price selection mechanism
(Inherited from ShoppingCartService) |
| 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).
(Inherited from ShoppingCartService) |
| AddSubscription(SubscriptionPurchaseOption) |
Adds a subscription to the shopping cart
(Inherited from ShoppingCartService) |
| AddSubscription(IProduct, IPrice) |
Adds a subscription to the shopping cart
(Inherited from ShoppingCartService) |
| 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.
(Inherited from ShoppingCartService) |
| ApplyDiscount(Discount) |
Applies discount to the shopping cart.
(Inherited from ShoppingCartService) |
| ApplyDiscount(String) |
Applies discountCode to the shopping cart.
(Inherited from ShoppingCartService) |
| ApplyDiscountProgramVouchers |
Applies as many of the the cart's Bill-To customer's discount program vouchers to the cart as possible.
(Inherited from ShoppingCartService) |
| 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.
(Inherited from ShoppingCartService) |
| ApplySourceCode(InvoiceSourceCode) |
Applies a source code to the shopping cart
(Inherited from ShoppingCartService) |
| ApplySourceCode(String) |
Applies promotionalCode to the shopping cart
(Inherited from ShoppingCartService) |
| AttemptToIdentify |
Attempts to associate NetFORUM server-side copy of the cart with the id returned by this service's current identity provider.
(Inherited from ShoppingCartService) |
| 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
(Inherited from ShoppingCartService) |
| CalculateAmountDueToday |
Calculates the minimum payment amount required to checkout, given the provided billing settings.
(Inherited from ShoppingCartService) Obsolete. |
| CalculateTotalsForInstallmentCheckout |
Calculates payment amounts related to checking out with installment-billing settings.
(Inherited from ShoppingCartService) |
| ChangeItemQuantity |
Changes the quantity of an item in the shopping cart.
(Inherited from ShoppingCartService) |
| Checkout(CheckoutOptions) |
Places an order on a cart whose amount due today is $0, without providing payment information
(Inherited from ShoppingCartService) |
| Checkout(AchPayment, CheckoutOptions) |
Places an order
(Inherited from ShoppingCartService) |
| Checkout(CashPayment, CheckoutOptions) |
Places an order where "cash" was used for payment
(Inherited from ShoppingCartService) |
| Checkout(CheckPayment, CheckoutOptions) |
Places an order where a check was used for payment
(Inherited from ShoppingCartService) |
| Checkout(CreditCardPayment, CheckoutOptions) |
Places an order
(Inherited from ShoppingCartService) |
| Checkout(SavedCreditCard, CheckoutOptions) |
Places an order
(Inherited from ShoppingCartService) |
| Checkout(AchPayment, Decimal, CheckoutOptions) |
Places an order
(Inherited from ShoppingCartService) |
| Checkout(CreditCardPayment, Decimal, CheckoutOptions) |
Places an order, specifying a fixed payment amount
(Inherited from ShoppingCartService) |
| Checkout(SavedCreditCard, Decimal, CheckoutOptions) |
Places an order, specifying a fixed payment amount
(Inherited from ShoppingCartService) |
| ClearCredits |
Removes all credits that have been applied towards the pending purchase.
(Inherited from ShoppingCartService) |
| ClearDiscountProgramVouchers |
Clear discount program vouchers applied to all items in the shopping cart.
(Inherited from ShoppingCartService) |
| ClearDiscountProgramVouchers(InvoiceDetailCartItem) |
Clear discount program vouchers applied to a single item in the shopping cart.
(Inherited from ShoppingCartService) |
| ClearDiscounts |
Removes all discounts from the shopping cart
(Inherited from ShoppingCartService) |
| ClearItems |
Removes all cart items from the cart.
(Inherited from ShoppingCartService) |
| 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".
(Inherited from ShoppingCartService) |
| 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.
(Inherited from ShoppingCartService) |
| GetShippingMethods |
Returns the available shipping methods based on the current state of the cart.
(Inherited from ShoppingCartService) |
| 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.
(Inherited from ShoppingCartService) |
| New |
Creates a new NetForum shopping cart, replacing any existing shopping cart.
(Inherited from ShoppingCartService) |
| RemoveDiscount(AdditionalInvoiceDetailCartItem) |
Removes a discount from the shopping cart
(Inherited from ShoppingCartService) |
| RemoveDiscount(IDiscountCartItem) |
Removes a discount from the shopping cart
(Inherited from ShoppingCartService) Obsolete. |
| RemoveItem(InvoiceDetailCartItem) |
Removes an invoice detail from the shopping cart.
(Inherited from ShoppingCartService) |
| RemoveItem(IStandardCartItem) |
Removes all of the an cart item and (all of its sub-items) from the shopping cart.
(Inherited from ShoppingCartService) |
| SetBillingAddress |
Sets the billing address of the shopping cart.
(Inherited from ShoppingCartService) |
| SetBillingContact |
Sets the billing contact of the shopping cart, which maps to the inv_ind_cst_billing_key field in NetFORUM.
(Inherited from ShoppingCartService) |
| SetBillToCustomer(ICustomerIdentity) |
Sets the bill-to customer of the shopping cart. This will persist even if the cart main customer is changed.
(Inherited from ShoppingCartService) |
| SetBillToCustomer(NetForumId) |
Sets the bill-to customer of the shopping cart. This will persist even if the cart main customer is changed.
(Inherited from ShoppingCartService) |
| SetShippingAddress |
Sets the shipping address of the entire shopping cart.
(Inherited from ShoppingCartService) |
| 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).
(Inherited from ShoppingCartService) |
| TryApplyDiscount |
Attempts to apply a discountCode to the shopping cart.
(Inherited from ShoppingCartService) |
| TryGetLastReceipt |
Get the receipt from the last successful checkout performed with this cart
(Inherited from ShoppingCartService) |
| UpdateCartItemValues(ICartItem, Object) | (Inherited from ShoppingCartService) 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.
(Inherited from ShoppingCartService) |
| 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.
(Inherited from ShoppingCartService) |
| 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.
(Inherited from ShoppingCartService) |
| UpdateItemQuantity |
Updates the quantity of an invoice detail in the shopping cart.
(Inherited from ShoppingCartService) Obsolete. |
| UpdatePendingDonation |
Updates a single donation in the NetFORUM server-side shopping cart with new values.
(Inherited from ShoppingCartService) |
| UpdatePendingEventRegistration |
Updates a single pending event registration in the NetFORUM server-side shopping cart with new values.
(Inherited from ShoppingCartService) |
| UpdatePendingGroupRegistration |
Updates a single pending group registration in the NetFORUM server-side shopping cart with new values.
(Inherited from ShoppingCartService) |
| UpdatePendingMembership |
Updates a single pending membership in the NetFORUM server-side shopping cart with new values.
(Inherited from ShoppingCartService) |
Fields
| DefaultOrganizationCartName | The default cart name, used if one is not specified via constructor parameter |