Adds the given address to the address book of the cart.

Adds a bonus product to the cart associated with the specified BonusDiscountLineItem. The function creates and returns a ProductLineItem by assigning the specified Product and Quantity to the cart. The function adds the new ProductLineItem to the default shipment. The product parameter must be one of the products associated with the BonusDiscountLineItem or the process fails. The process does not validate if the number of bonus products exceeds the maximum allowed by the bonus discount. This is the job of application logic. The function always creates a new product line item, regardless of the value of the site preference 'Add Product Behavior'.

Validates the supplied coupon code and if the coupon code is valid, applies the coupon code to the basket. While applying the coupon code the function adds a new CouponLineItem to the basket, based on the supplied coupon code. The coupon code gets set at the CouponLineItem.

A coupon code can be invalid for the following reasons:

• The coupon code was already added to the basket.
• A coupon code of the same coupon is already in basket. Adding a single coupon code of this coupon is sufficient to enable a promotion. Adding another coupon code of the same coupon does not make sense, since the promotion is already enabled by the previously added code.
• The number of redemptions of this coupon code is 1 and the code was already redeemed.
• The number of redemptions of this coupon code is > 1 and the maximum numbers of redemptions of this coupon code was already reached. The calculation of the redemptions is based on the number of redemptions of this coupon code in past plus the number of redemptions of other coupon codes of the same coupon in the past.
• The maximum number of times this coupon can be redeemed per customer was already reached.
• The maximum number of times this coupon can be redeemed by a customer within a given time period was already reached. The calculation of the redemptions is based on the the number of redemptions of this coupon code in past plus the number of redemptions of other coupon codes of the same coupon in the past.
• The coupon code is unknown to the system.
• The coupon is not enabled.
• There exists no active promotion to which the coupon is assigned.

In this case, no CouponLineItem is added to the basket and the returned "Status" object contains the details of why the coupon was invalid.

Status: The status object representing a detailed result of the operation. The status property (Status.status) is set to 0 if the coupon was successfully applied or 1 otherwise.

The code property (Status.code) is set to one of the following values:

• "OK" = The coupon was applied to the basket.
• CouponStatusCodes.COUPON_CODE_ALREADY_IN_BASKET = Indicates that coupon code was already added to the basket.
• CouponStatusCodes.COUPON_ALREADY_IN_BASKET = Indicates that another code of the same MultiCode/System coupon was already added to basket.
• CouponStatusCodes.COUPON_CODE_ALREADY_REDEEMED = Indicates that code of MultiCode/System coupon was already redeemed.
• CouponStatusCodes.COUPON_CODE_UNKNOWN = Indicates that coupon not found for given coupon code or that the code itself was not found.
• CouponStatusCodes.COUPON_DISABLED = Indicates that coupon is not enabled.
• CouponStatusCodes.REDEMPTION_LIMIT_EXCEEDED = Indicates that number of redemptions per code exceeded.
• CouponStatusCodes.CUSTOMER_REDEMPTION_LIMIT_EXCEEDED = Indicates that number of redemptions per code and customer exceeded.
• CouponStatusCodes.TIMEFRAME_REDEMPTION_LIMIT_EXCEEDED = Indicates that number of redemptions per code, customer and time exceeded.
• CouponStatusCodes.NO_ACTIVE_PROMOTION = Indicates that coupon is not assigned to an active promotion.

Adds a product to the cart and recalculates the cart. By default, when a bundle is added to cart, all its child products are added too, but if those products are variants then the code must replace the master products with the selected variants that are passed in the HTTP params as childPids along with any options.

Adds a product list item to the cart and recalculates the cart.

Triggers the cart calculation by executing the hook 'dw.ocapi.shop.basket.calculate'.

Calculates the total amount of an order paid for by gift certificate payment instruments. Any remaining open amount is applied to the non-gift certificate payment instrument, such as a credit card. Note: this script assumes that only one non-gift certificate payment instrument is used for the payment.

Checks the in-store quantity of all product line items against the store inventory in case the product line item's quantity was updated. If the store inventory does not have as many of the item in stock as is being purchased, the product line item is converted from in-store pickup to home delivery.

Scans the basket and consolidates items that are going to the same store. It also creates shipments with shipment type and method for the rest of checkout.

Creates a gift certificate payment instrument from the given gift certificate ID for the basket. The method attempts to redeem the current balance of the gift certificate. If the current balance exceeds the order total, this amount is redeemed and the balance is lowered.

Creates an Order based on the cart. If the order is created successfully, it has status CREATED. Once the order is created, the cart is removed from the session and marked for removal.

If the order is not created successfully the function returns null, if any of the following conditions are encountered:

• any of the totals (net, gross, tax) of the basket is N/A
• any of the product items is not available
• any campaign-based coupon in the basket is invalid (see dw.order.CouponLineItem.isValid())
• the basket represents an order being edited, but the order has been already been replaced by another order
• the basket represents an order being edited, but the customer associated with the original order is not the same as the current customer

All empty shipments of the basket are removed before creating the order. A shipment is empty if it contains no product or gift certificate line items or all total prices (net, gross, tax) are 0.0.

The function decrements inventory for all products contained in the order. This means the 'reserve inventory for order' functionality must not be subsequently called. The function redeems all coupons contained in the order.

If the cart contains product or gift certificate line items associated with product list items, the function updates the purchase of the product list items. For example, if the basket contains an item added from a gift registry, the purchase history of the respective gift registry item is updated.

Creates a shipping address for the shipment with the given shipment ID.

Determines a unique shipment ID for shipments in the current cart and the given base ID. The function appends a counter to the base ID and checks the existence of the resulting ID. If the resulting ID is unique, this ID is returned; if not, the counter is incremented and checked again.

Gets a new instance for the current or a given basket.

Returns all addresses of the cart's address book. The addresses are stored as a JSON objects in a custom attribute named 'sessionAddressBook'.

Retrieves the list of applicable shipping methods for a given shipment and a full or partial shipping address. A shipping method is applicable if it does not exclude any of the products in the shipment, and does not exclude the specified address.

Returns the bonus discount line item of the cart having the given UUID.

Searches a bundle line item for a product line item with a specific product ID.

Creates a list of gift certificate ids from gift certificate payment instruments.

Checks to see if a new bonus discount line item was created by providing a list of 'previous' discount line items.

Calculates the amount to be paid by a non-gift certificate payment instrument based on the given basket. The function subtracts the amount of all redeemed gift certificates from the order total and returns this value.

Determines the physical shipments of the current cart. Physical shipments are shipments that contain at least one product line item. A shipment that contains only gift certificates is not a physical shipment. Product line items marked for in-store pickup are also not considered physical shipments.

Returns the product line item of the cart with a specific UUID.

Gets or creates a new instance of a basket.

Loads customer addresses and shipment addresses and stores them into the session address book attribute of the cart, if they are available and configured in Business Manager.

Updates the shipping method of the given shipment. If a shipping method ID is given, the given shipping method is used to update the shipment.

"shippingExclDiscounts"         : this.getShippingTotalPrice(),
"shippingInclDiscounts"         : this.getAdjustedShippingTotalPrice(),
"productShippingCosts"          : productShippingCosts,
"productShippingDiscounts"      : productShippingDiscounts,
"shippingPriceAdjustments"      : priceAdjArray,
"shippingPriceAdjustmentsTotal" : priceAdjTotal,
"surchargeAdjusted"             : adustedSurchargeTotal,
"baseShipping"                  : baseShipping,
"baseShippingAdjusted"          : baseShippingAdjusted

Deletes all the products associated with a bonus discount line item.

The function removes all empty shipments of the current cart.

Gets a gift certificate line item.

Determines if the cart already contains payment instruments of the given payment method and removes them from the basket.

Removes a gift certificate payment instrument with the given gift certificate ID from the basket.

Deletes multiple payment instruments.

Creates a new QuantityLineItem helper object for each quantity of a ProductLineItem, if one does not already exist. It does not create QuantityLineItems for products using in-store pickup as the shipping method.

Updates the given address in the cart's address book.

Cleans the shipments of the current basket by putting all gift certificate line items to single, possibly new, shipments, with one shipment per gift certificate line item.

Replaces the current product of the specified product line item with the specified product.

By default, when a bundle is added to a cart, all its child products are added as well. However, if those products are variants then the master products must be replaced with the selected variants that get passed in the CurrentHttpParameterMap.childPids as comma separated list of pids of the bundled products that are variations and any options.

Sets the shipping method of the given shipment to the passed method. The list of allowed shipping methods may be passed in as a parameter. If not, then it is retrieved using ShipmentShippingModel.getApplicableShippingMetods(). If the passed shipping method is not in this list, then the function uses the default shipping method. If the default shipping method is not in the list, the function uses the first method in the list.

Implements a typical shopping cart checkout validation. Some parts of the validation script are specific to the reference application logic and might not be applicable to our customer's storefront applications. However, the shopping cart validation script can be customized to meet specific needs and requirements.

This function implements the validation of the shopping cart against specific conditions in the following steps:

• validate that total price is not N/A
• validate that all products in the basket are still in site catalog and online
• validate that all coupon codes in the basket are valid
• validate that the taxes can be calculated for all products in the basket (if ValidateTax input parameter is true)

Verifies whether existing non-gift-certificate payment instrument methods or cards are still applicable. Returns the collection of valid and invalid payment instruments.