Component Documentation

cart
Component __cart (Cart Controller)

methods:


addItem, changeQuantity, closeOrder, formExpirationDateHack, getNextPage, getOrder, getOrderData, getOrderID, getOrderItems, getProductData, getSessionCart, getShopLinkHTML, getStepHTML, getStepNum, hasOpenOrder, killSessionCart, loadData, removeItem, setDiscount


addItem

I add an item to a user's cart/order and return the OrderItemID for the added item.

Output: suppressed
Parameters:
   ProductIdentifier: string, required
   Quantity: numeric
changeQuantity

I change the quantity of the given item from the user's cart.

Output: suppressed
Parameters:
   OrderItemID: numeric, required
   Quantity: numeric, required
closeOrder

I close the current order.

Output: suppressed
Parameters:
formExpirationDateHack


Output: suppressed
Parameters:
getNextPage

I return the page that comes after the given page in the checkout process.

Output: suppressed
Parameters:
   page: string, required
getOrder

I return a recordset of cart/order record.

Output: suppressed
Parameters:
getOrderData

I return a recordset of the cart/order record and associated information.

Output: suppressed
Parameters:
getOrderID

I return the OrderID for the current user's order/cart.

Output: suppressed
Parameters:
getOrderItems

I return a recordset of the items in this cart/order.

Output: suppressed
Parameters:
getProductData

I return a structure of the product information for the given product.

Output: suppressed
Parameters:
   ProductIdentifier: string, required (A unique value for a product.)
   Quantity: numeric (The quantity to be returned in the structure.)
getSessionCart

I return the cart component for the current session.

Output: suppressed
Parameters:
getShopLinkHTML

I return the HTML for the link to continue shopping.

Output: suppressed
Parameters:
getStepHTML

I return the HTML for the checkout process steps.

Output: suppressed
Parameters:
   stepnum: numeric, required
getStepNum

I return the step number for the given page.

Output: suppressed
Parameters:
   page: string, required
hasOpenOrder

I indicate whether or not the current user has an open order/cart.

Output: suppressed
Parameters:
killSessionCart


Output: suppressed
Parameters:
loadData


Output: suppressed
Parameters:
removeItem

I remove the given product from the user's cart/order.

Output: suppressed
Parameters:
   ProductIdentifier: string, required
setDiscount

I attempt to apply a discount to the order.

Output: suppressed
Parameters:
   DiscountCode: string, required