Interface CartManagement

Represents operations for managing shopping carts.

interface CartManagement {
    AddItemToBasket: ((sci: AddToBasketObjectInstance) => MsBaseModel<ShoppingCartItemObject>);
    ClearCart: ((customer: number | Customer, shoppingCartType?: MsShoppingCartItemType) => boolean);
    DeleteItemFromBasket: ((sci: number | AddToBasketObjectInstance) => boolean);
    GetCartItemCount: ((customer: number | Customer, shoppingCartType?: MsShoppingCartItemType) => ShoppingCartItemCount);
    GetItemsFromBasket: ((customer: number | Customer, shoppingCartType?: MsShoppingCartItemType) => ShoppingCartItemObject[]);
    UpdateShoppingCartItem: ((sci: ShoppingCartItemObject) => MsModel);
}

Index

Properties

AddItemToBasket ClearCart DeleteItemFromBasket GetCartItemCount GetItemsFromBasket UpdateShoppingCartItem

Properties

AddItemToBasket

AddItemToBasket: ((sci: AddToBasketObjectInstance) => MsBaseModel<ShoppingCartItemObject>)

Adds an item to the shopping basket.

Type declaration

- (sci): MsBaseModel<ShoppingCartItemObject>
- Parameters
  - sci: AddToBasketObjectInstance
    The object instance representing the item to add.
  Returns MsBaseModel<ShoppingCartItemObject>
  The base model containing the added shopping cart item object.

ClearCart

ClearCart: ((customer: number | Customer, shoppingCartType?: MsShoppingCartItemType) => boolean)

Clears the shopping cart.

Type declaration

- (customer, shoppingCartType?): boolean
- Parameters
  - customer: number | Customer
    The ID of the customer or the customer object.
  - OptionalshoppingCartType: MsShoppingCartItemType
    Optional. The type of shopping cart to clear.
  Returns boolean
  A boolean indicating whether the cart was successfully cleared.

DeleteItemFromBasket

DeleteItemFromBasket: ((sci: number | AddToBasketObjectInstance) => boolean)

Deletes an item from the shopping basket.

Type declaration

- (sci): boolean
- Parameters
  - sci: number | AddToBasketObjectInstance
    The ID of the item or the object instance representing the item.
  Returns boolean
  A boolean indicating whether the item was successfully deleted.

GetCartItemCount

GetCartItemCount: ((customer: number | Customer, shoppingCartType?: MsShoppingCartItemType) => ShoppingCartItemCount)

Retrieves the count of items in the shopping cart.

Type declaration

- (customer, shoppingCartType?): ShoppingCartItemCount
- Parameters
  - customer: number | Customer
    The ID of the customer or the customer object.
  - OptionalshoppingCartType: MsShoppingCartItemType
    Optional. The type of shopping cart to retrieve item count for.
  Returns ShoppingCartItemCount
  An object containing the count of items in the shopping cart.

GetItemsFromBasket

GetItemsFromBasket: ((customer: number | Customer, shoppingCartType?: MsShoppingCartItemType) => ShoppingCartItemObject[])

Retrieves items from the shopping basket.

Type declaration

- (customer, shoppingCartType?): ShoppingCartItemObject[]
- Parameters
  - customer: number | Customer
    The ID of the customer or the customer object.
  - OptionalshoppingCartType: MsShoppingCartItemType
    Optional. The type of shopping cart to retrieve items from.
  Returns ShoppingCartItemObject[]
  An array of shopping cart item objects.

UpdateShoppingCartItem

UpdateShoppingCartItem: ((sci: ShoppingCartItemObject) => MsModel)

Updates a shopping cart item.

Type declaration

- (sci): MsModel
- Parameters
  - sci: ShoppingCartItemObject
    The shopping cart item object to update.
  Returns MsModel
  The model representing the result of the update operation.