Properties

Name Returns Notes Example
countOfUnfulfilledOrders Long
checkoutItems CheckoutItems
shoppingCartId String
paymentProviders List
cartStates Map
fulfilmentStatuses Map

Methods

Name Returns Notes Example
findRecurringTransactions ( purchaser ) List
findOrders ( customer ) List
findOrders ( customer, sortByField ) List
findVouchers ( cart ) List Returns all vouchers associated with this Cart
toVoucherBean ( v ) VoucherBean Returns a VoucherBean form of the given Voucher, which can be just a bit easier to work with sometimes
setFulfillmentStatus ( cart, status ) void
setFulfillmentStatus ( carts, status ) void
newCart ( customer ) Cart
getCart ( id ) Cart Look up a cart
countOfOrders ( start, finish ) Long Returns orders created between the common start and end dates
searchCarts ( fulfilment, max, query ) List Search carts which have been submitted (ie purchases)
searchCarts ( fulfilment, sCartState, max, query ) List
deleteCart ( cart ) void Performs a physical delete on the cart and its productorders
applyPromoCodes ( cart, store, codes ) List Applies voucher and promotion codes to the cart.
Returns a map of codes with a boolean indicating if the code was applied successfully or not
getOrCreateCustomerGroup ( groupName ) Group
getOrCreatePurchaser ( rc, customerGroup ) Profile
placeOrder ( c, store ) void
placeOrder ( c, store, loc ) void
checkoutItems ( lead ) CheckoutItems
activeCheckoutRules ( store ) List
checkoutItems ( cart ) CheckoutItems Deprecated, use checkoutItems(cart, store) instead
checkoutItems ( cart, store ) CheckoutItems
clearCart ( ) void
cartItemBuilder ( cart, store ) CartItemBuilder
addOrUpdateItem ( cart, sku, quantity, store, increment ) Cart
addOrUpdateItem ( cart, sku, quantity, store, increment ) Cart
removeItem ( lineId ) boolean
numItemsInCart ( p ) BigDecimal Return the total quantity of the current product in the shopping cart. Applies to all SKU's related to the product
numItemsInCart ( sku ) BigDecimal The total quantity related to the given SKU in cart
cartState ( name ) ShoppingCartState returns an enum representation of the given cart state, which can be used in KCriteria
fulfilmentStatus ( name ) FULFILMENT_STATUS_CODE returns an enum representation of the given fulfilment status, which can be used in KCriteria
cartDescription ( cart ) String
cartDescription ( cart ) String Get a description of the items in the cart.
findStore ( checkoutItems ) ECommerceStore Little bit of a hack, we're currently not holding the store on the cart, so need to find it from productorders
findStore ( cart ) ECommerceStore
quantityOfCategory ( catCode, items ) BigDecimal
quantityOfProduct ( prodCode, items ) BigDecimal
quantityOfProductSku ( skuCode, items ) BigDecimal
containsCategory ( catCode, items ) boolean
containsProduct ( code, items ) boolean
containsProductSku ( code, items ) boolean
totalCostExTax ( items ) BigDecimal
totalCostIncTax ( items ) BigDecimal
To get full access to the Kademi Hub existing customers can login here, or new customers can register here.