Class ShippingMgr

• TopLevel.Object
  • dw.order.ShippingMgr

Provides methods to access the shipping information.

Property Summary 

Property	Description
allShippingMethods: Collection (read-only)	Returns the active shipping methods of the current site applicable to the session currency and current customer group.
defaultShippingMethod: ShippingMethod (read-only)	Returns the default shipping method of the current site applicable to the session currency.

Constructor Summary 

This class does not have a constructor, so you cannot create it directly.

Method Summary 

Method	Description
static applyShipping(Basket)	Applies shipping to the given Basket using the platform’s shipping hook dispatch logic.
static applyShippingCost(LineItemCtnr)	Applies product and shipment-level shipping cost to the specified line item container.
static getAllShippingMethods()	Returns the active shipping methods of the current site applicable to the session currency and current customer group.
static getDefaultShippingMethod()	Returns the default shipping method of the current site applicable to the session currency.
static getProductShippingModel(Product)	Returns the shipping model for the specified product.
static getShipmentShippingModel(Shipment)	Returns the shipping model for the specified shipment.
static getShippingCost(ShippingMethod, Money)	Returns the shipping cost amount for the specified shipping method and the specified order value.

Methods inherited from class Object 

assign, create, create, defineProperties, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, hasOwnProperty, is, isExtensible, isFrozen, isPrototypeOf, isSealed, keys, preventExtensions, propertyIsEnumerable, seal, setPrototypeOf, toLocaleString, toString, valueOf, values

Property Details 

allShippingMethods 

allShippingMethods: Collection (read-only)

Returns the active shipping methods of the current site applicable to the session currency and current customer group.

---

defaultShippingMethod 

defaultShippingMethod: ShippingMethod (read-only)

Returns the default shipping method of the current site applicable to the session currency.

Does an additional check if there is a base method and if their currencies are the same. Returns NULL if the two currencies are different.

---

Method Details 

applyShipping(Basket) 

static applyShipping(basket: Basket): void

Applies shipping to the given Basket using the platform's shipping hook dispatch logic.

This method is intended for use in custom {@code dw.order.calculate} hook implementations (e.g., in SFRA or SiteGenesis) that override the default basket calculation. Calling this method instead of directly invoking {@code dw.order.calculateShipping} ensures that Commerce App shipping providers registered via {@code sfcc.app.shipping.calculate} are invoked when available, with automatic fallback to the legacy {@code dw.order.calculateShipping} hook or the platform default shipping calculation.

WARNING: Do NOT call this method from within a {@code dw.order.calculateShipping} hook implementation, as this will cause infinite recursion. This method is designed to be called from {@code dw.order.calculate} hooks only.

The dispatch precedence is:

1. {@code sfcc.app.shipping.calculate}— if a Commerce App shipping provider is installed.
2. {@code dw.order.calculateShipping}— if registered by the storefront.
3. Platform default shipping calculation — using product and shipment shipping cost tables.

Typical usage in a custom {@code dw.order.calculate} hook:

1var ShippingMgr = require('dw/order/ShippingMgr');
2
3exports.calculate = function (basket) {
4    // ... product prices, promotions ...
5    ShippingMgr.applyShipping(basket);
6    // ... tax ...
7    basket.updateTotals();
8};

Parameters:

• basket - the basket for which shipping should be calculated.

Throws:

• NullArgumentException - if {@code basket} is {@code null}.

---

applyShippingCost(LineItemCtnr) 

static applyShippingCost(lineItemCtnr: LineItemCtnr): void

Applies product and shipment-level shipping cost to the specified line item container.

For each product line item in the specified line item container, a product shipping line item is created if product-level shipping cost is defined for the product. If no product-level shipping cost is defined for the product, an existing product shipping line item is removed.

For each shipment in the specified line item container, shipment-level shipping cost is calculated. This cost is determined based on the merchandise total of the shipment after all product and order discounts. Only products without or with surcharge product-specific shipping cost count towards this merchandise total. Products with fixed product-specific shipping cost don't count towards the merchandise total used to calculate shipment-level shipping cost. The calculated shipping cost is set at the standard shipping line item of the shipment.

If 'net' taxation is configured for the site, the merchandise total before tax is used. If 'gross' taxation is configured for the site, the merchandise total after tax is used.

If no shipping method is set for a shipment, neither product nor shipment-level shipping cost can be calculated. In this case, the amount of the standard shipment shipping line item will be set to N/A, and shipping line items of product line items in this shipment will be removed from the line item container.

Special cases for product-level shipping cost:

• if a product is member of multiple shipping cost groups, the lowest shipping cost takes precedence
• if fixed and surcharge shipping cost is defined for a product, the fixed cost takes precedence
• shipping cost defined for a master product is also defined for all variants of this master
• shipping cost is not applied to bundled product line items or options line items

Parameters:

• lineItemCtnr - the line item container to use.

---

getAllShippingMethods() 

static getAllShippingMethods(): Collection

Returns the active shipping methods of the current site applicable to the session currency and current customer group.

Returns:

• the active shipping methods of the current site applicable to the session currency and current customer group.

---

getDefaultShippingMethod() 

static getDefaultShippingMethod(): ShippingMethod

Returns the default shipping method of the current site applicable to the session currency.

Does an additional check if there is a base method and if their currencies are the same. Returns NULL if the two currencies are different.

Returns:

• the default shipping method of the current site applicable to the session currency or null.

---

getProductShippingModel(Product) 

static getProductShippingModel(product: Product): ProductShippingModel

Returns the shipping model for the specified product.

Parameters:

• product - Product

Returns:

• Shipping model for specified product

---

getShipmentShippingModel(Shipment) 

static getShipmentShippingModel(shipment: Shipment): ShipmentShippingModel

Returns the shipping model for the specified shipment.

Parameters:

• shipment - the shipment to use.

Returns:

• Shipping model for specified product

---

getShippingCost(ShippingMethod, Money) 

static getShippingCost(shippingMethod: ShippingMethod, orderValue: Money): Money

Returns the shipping cost amount for the specified shipping method and the specified order value.

If shipping cost cannot be calculated for any reason, Money.NA is returned.

Parameters:

• shippingMethod - Selected shipping method
• orderValue - Order value

Returns:

• Shipping cost

---