@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.3

package/data/script-api/dw.order.ProductShippingCost.md

@@ -0,0 +1,101 @@
+<!-- prettier-ignore-start -->
+# Class ProductShippingCost
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.order.ProductShippingCost](dw.order.ProductShippingCost.md)
+
+Instances of ProductShippingCost represent product specific shipping costs.
+
+
+
+Use [ProductShippingModel.getShippingCost(ShippingMethod)](dw.order.ProductShippingModel.md#getshippingcostshippingmethod) to get
+the shipping cost for a specific product.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [amount](#amount): [Money](dw.value.Money.md) `(read-only)` | Returns the shipping amount. |
+| [fixedPrice](#fixedprice): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if shipping cost is a fixed-price shipping cost,  and false if surcharge shipping cost. |
+| [surcharge](#surcharge): [Boolean](TopLevel.Boolean.md) `(read-only)` | Returns true if shipping cost is a surcharge to the shipment  shipping cost, and false if fixed-price shipping cost. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getAmount](dw.order.ProductShippingCost.md#getamount)() | Returns the shipping amount. |
+| [isFixedPrice](dw.order.ProductShippingCost.md#isfixedprice)() | Returns true if shipping cost is a fixed-price shipping cost,  and false if surcharge shipping cost. |
+| [isSurcharge](dw.order.ProductShippingCost.md#issurcharge)() | Returns true if shipping cost is a surcharge to the shipment  shipping cost, and false if fixed-price shipping cost. |
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### amount
+- amount: [Money](dw.value.Money.md) `(read-only)`
+  - : Returns the shipping amount.
+
+
+---
+
+### fixedPrice
+- fixedPrice: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns true if shipping cost is a fixed-price shipping cost,
+      and false if surcharge shipping cost.
+
+
+
+---
+
+### surcharge
+- surcharge: [Boolean](TopLevel.Boolean.md) `(read-only)`
+  - : Returns true if shipping cost is a surcharge to the shipment
+      shipping cost, and false if fixed-price shipping cost.
+
+
+
+---
+
+## Method Details
+
+### getAmount()
+- getAmount(): [Money](dw.value.Money.md)
+  - : Returns the shipping amount.
+
+    **Returns:**
+    - Shipping amount
+
+
+---
+
+### isFixedPrice()
+- isFixedPrice(): [Boolean](TopLevel.Boolean.md)
+  - : Returns true if shipping cost is a fixed-price shipping cost,
+      and false if surcharge shipping cost.
+
+
+    **Returns:**
+    - true of fixed-price shipping cost, else false
+
+
+---
+
+### isSurcharge()
+- isSurcharge(): [Boolean](TopLevel.Boolean.md)
+  - : Returns true if shipping cost is a surcharge to the shipment
+      shipping cost, and false if fixed-price shipping cost.
+
+
+    **Returns:**
+    - true of surcharge shipping cost, else false
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.order.ProductShippingLineItem.md

@@ -0,0 +1,336 @@
+<!-- prettier-ignore-start -->
+# Class ProductShippingLineItem
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.object.PersistentObject](dw.object.PersistentObject.md)
+    - [dw.object.ExtensibleObject](dw.object.ExtensibleObject.md)
+      - [dw.order.LineItem](dw.order.LineItem.md)
+        - [dw.order.ProductShippingLineItem](dw.order.ProductShippingLineItem.md)
+
+Represents a specific line item in a shipment. A ProductShippingLineItem defines
+lineitem-specific shipping costs.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| ~~[PRODUCT_SHIPPING_ID](#product_shipping_id): [String](TopLevel.String.md) = "PRODUCT_SHIPPING"~~ | Reserved constant. |
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [adjustedGrossPrice](#adjustedgrossprice): [Money](dw.value.Money.md) `(read-only)` | Returns the gross price of the product shipping line item after applying  all product-shipping-level adjustments. |
+| [adjustedNetPrice](#adjustednetprice): [Money](dw.value.Money.md) `(read-only)` | Returns the net price of the product shipping line item after applying  all product-shipping-level adjustments. |
+| [adjustedPrice](#adjustedprice): [Money](dw.value.Money.md) `(read-only)` | Returns the price of the product shipping line item after applying all  pproduct-shipping-level adjustments. |
+| [adjustedTax](#adjustedtax): [Money](dw.value.Money.md) `(read-only)` | Returns the tax of the unit after applying adjustments, in the purchase  currency. |
+| [priceAdjustments](#priceadjustments): [Collection](dw.util.Collection.md) `(read-only)` | Returns an iterator of price adjustments that have been applied to this  product shipping line item. |
+| [productLineItem](#productlineitem): [ProductLineItem](dw.order.ProductLineItem.md) `(read-only)` | Returns the parent product line item this shipping line item belongs to. |
+| [quantity](#quantity): [Quantity](dw.value.Quantity.md) | Returns the quantity of the shipping cost. |
+| [shipment](#shipment): [Shipment](dw.order.Shipment.md) `(read-only)` | Returns the shipment this shipping line item belongs to. |
+| [surcharge](#surcharge): [Boolean](TopLevel.Boolean.md) | Returns the 'surcharge' flag. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getAdjustedGrossPrice](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)() | Returns the gross price of the product shipping line item after applying  all product-shipping-level adjustments. |
+| [getAdjustedNetPrice](dw.order.ProductShippingLineItem.md#getadjustednetprice)() | Returns the net price of the product shipping line item after applying  all product-shipping-level adjustments. |
+| [getAdjustedPrice](dw.order.ProductShippingLineItem.md#getadjustedprice)() | Returns the price of the product shipping line item after applying all  pproduct-shipping-level adjustments. |
+| [getAdjustedTax](dw.order.ProductShippingLineItem.md#getadjustedtax)() | Returns the tax of the unit after applying adjustments, in the purchase  currency. |
+| [getPriceAdjustments](dw.order.ProductShippingLineItem.md#getpriceadjustments)() | Returns an iterator of price adjustments that have been applied to this  product shipping line item. |
+| [getProductLineItem](dw.order.ProductShippingLineItem.md#getproductlineitem)() | Returns the parent product line item this shipping line item belongs to. |
+| [getQuantity](dw.order.ProductShippingLineItem.md#getquantity)() | Returns the quantity of the shipping cost. |
+| [getShipment](dw.order.ProductShippingLineItem.md#getshipment)() | Returns the shipment this shipping line item belongs to. |
+| [isSurcharge](dw.order.ProductShippingLineItem.md#issurcharge)() | Returns the 'surcharge' flag. |
+| [setPriceValue](dw.order.ProductShippingLineItem.md#setpricevaluenumber)([Number](TopLevel.Number.md)) | Sets price attributes of the line item based on the  purchase currency, taxation policy and line item quantity.<br/>   The method sets the 'basePrice' attribute of the line item. |
+| [setQuantity](dw.order.ProductShippingLineItem.md#setquantityquantity)([Quantity](dw.value.Quantity.md)) | Sets the quantity of the shipping cost. |
+| [setSurcharge](dw.order.ProductShippingLineItem.md#setsurchargeboolean)([Boolean](TopLevel.Boolean.md)) | Sets the 'surcharge' flag. |
+
+### Methods inherited from class LineItem
+
+[getBasePrice](dw.order.LineItem.md#getbaseprice), [getGrossPrice](dw.order.LineItem.md#getgrossprice), [getLineItemCtnr](dw.order.LineItem.md#getlineitemctnr), [getLineItemText](dw.order.LineItem.md#getlineitemtext), [getNetPrice](dw.order.LineItem.md#getnetprice), [getPrice](dw.order.LineItem.md#getprice), [getPriceValue](dw.order.LineItem.md#getpricevalue), [getTax](dw.order.LineItem.md#gettax), [getTaxBasis](dw.order.LineItem.md#gettaxbasis), [getTaxClassID](dw.order.LineItem.md#gettaxclassid), [getTaxRate](dw.order.LineItem.md#gettaxrate), [setBasePrice](dw.order.LineItem.md#setbasepricemoney), [setGrossPrice](dw.order.LineItem.md#setgrosspricemoney), [setLineItemText](dw.order.LineItem.md#setlineitemtextstring), [setNetPrice](dw.order.LineItem.md#setnetpricemoney), [setPriceValue](dw.order.LineItem.md#setpricevaluenumber), [setTax](dw.order.LineItem.md#settaxmoney), [setTaxClassID](dw.order.LineItem.md#settaxclassidstring), [setTaxRate](dw.order.LineItem.md#settaxratenumber), [updatePrice](dw.order.LineItem.md#updatepricemoney), [updateTax](dw.order.LineItem.md#updatetaxnumber), [updateTax](dw.order.LineItem.md#updatetaxnumber-money), [updateTaxAmount](dw.order.LineItem.md#updatetaxamountmoney)
+### Methods inherited from class ExtensibleObject
+
+[describe](dw.object.ExtensibleObject.md#describe), [getCustom](dw.object.ExtensibleObject.md#getcustom)
+### Methods inherited from class PersistentObject
+
+[getCreationDate](dw.object.PersistentObject.md#getcreationdate), [getLastModified](dw.object.PersistentObject.md#getlastmodified), [getUUID](dw.object.PersistentObject.md#getuuid)
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Constant Details
+
+### PRODUCT_SHIPPING_ID
+
+- ~~PRODUCT_SHIPPING_ID: [String](TopLevel.String.md) = "PRODUCT_SHIPPING"~~
+  - : Reserved constant.
+
+    **Deprecated:**
+:::warning
+this reserved constant is deprecated.
+:::
+
+---
+
+## Property Details
+
+### adjustedGrossPrice
+- adjustedGrossPrice: [Money](dw.value.Money.md) `(read-only)`
+  - : Returns the gross price of the product shipping line item after applying
+      all product-shipping-level adjustments.
+
+
+    **See Also:**
+    - [getAdjustedNetPrice()](dw.order.ProductShippingLineItem.md#getadjustednetprice)
+    - [getAdjustedPrice()](dw.order.ProductShippingLineItem.md#getadjustedprice)
+
+
+---
+
+### adjustedNetPrice
+- adjustedNetPrice: [Money](dw.value.Money.md) `(read-only)`
+  - : Returns the net price of the product shipping line item after applying
+      all product-shipping-level adjustments.
+
+
+    **See Also:**
+    - [getAdjustedGrossPrice()](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)
+    - [getAdjustedPrice()](dw.order.ProductShippingLineItem.md#getadjustedprice)
+
+
+---
+
+### adjustedPrice
+- adjustedPrice: [Money](dw.value.Money.md) `(read-only)`
+  - : Returns the price of the product shipping line item after applying all
+      pproduct-shipping-level adjustments. For net pricing the adjusted net
+      price is returned (see [getAdjustedNetPrice()](dw.order.ProductShippingLineItem.md#getadjustednetprice)). For gross
+      pricing, the adjusted gross price is returned (see
+      [getAdjustedGrossPrice()](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)).
+
+
+    **See Also:**
+    - [getAdjustedGrossPrice()](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)
+    - [getAdjustedNetPrice()](dw.order.ProductShippingLineItem.md#getadjustednetprice)
+
+
+---
+
+### adjustedTax
+- adjustedTax: [Money](dw.value.Money.md) `(read-only)`
+  - : Returns the tax of the unit after applying adjustments, in the purchase
+      currency.
+
+
+
+---
+
+### priceAdjustments
+- priceAdjustments: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns an iterator of price adjustments that have been applied to this
+      product shipping line item.
+
+
+
+---
+
+### productLineItem
+- productLineItem: [ProductLineItem](dw.order.ProductLineItem.md) `(read-only)`
+  - : Returns the parent product line item this shipping line item belongs to.
+
+
+---
+
+### quantity
+- quantity: [Quantity](dw.value.Quantity.md)
+  - : Returns the quantity of the shipping cost.
+
+
+---
+
+### shipment
+- shipment: [Shipment](dw.order.Shipment.md) `(read-only)`
+  - : Returns the shipment this shipping line item belongs to.
+
+
+---
+
+### surcharge
+- surcharge: [Boolean](TopLevel.Boolean.md)
+  - : Returns the 'surcharge' flag.
+
+
+---
+
+## Method Details
+
+### getAdjustedGrossPrice()
+- getAdjustedGrossPrice(): [Money](dw.value.Money.md)
+  - : Returns the gross price of the product shipping line item after applying
+      all product-shipping-level adjustments.
+
+
+    **Returns:**
+    - gross price after applying product-shipping-level adjustments
+
+    **See Also:**
+    - [getAdjustedNetPrice()](dw.order.ProductShippingLineItem.md#getadjustednetprice)
+    - [getAdjustedPrice()](dw.order.ProductShippingLineItem.md#getadjustedprice)
+
+
+---
+
+### getAdjustedNetPrice()
+- getAdjustedNetPrice(): [Money](dw.value.Money.md)
+  - : Returns the net price of the product shipping line item after applying
+      all product-shipping-level adjustments.
+
+
+    **Returns:**
+    - net price after applying product-shipping-level adjustments
+
+    **See Also:**
+    - [getAdjustedGrossPrice()](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)
+    - [getAdjustedPrice()](dw.order.ProductShippingLineItem.md#getadjustedprice)
+
+
+---
+
+### getAdjustedPrice()
+- getAdjustedPrice(): [Money](dw.value.Money.md)
+  - : Returns the price of the product shipping line item after applying all
+      pproduct-shipping-level adjustments. For net pricing the adjusted net
+      price is returned (see [getAdjustedNetPrice()](dw.order.ProductShippingLineItem.md#getadjustednetprice)). For gross
+      pricing, the adjusted gross price is returned (see
+      [getAdjustedGrossPrice()](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)).
+
+
+    **Returns:**
+    - Adjusted net or gross price
+
+    **See Also:**
+    - [getAdjustedGrossPrice()](dw.order.ProductShippingLineItem.md#getadjustedgrossprice)
+    - [getAdjustedNetPrice()](dw.order.ProductShippingLineItem.md#getadjustednetprice)
+
+
+---
+
+### getAdjustedTax()
+- getAdjustedTax(): [Money](dw.value.Money.md)
+  - : Returns the tax of the unit after applying adjustments, in the purchase
+      currency.
+
+
+    **Returns:**
+    - the tax of the unit after applying adjustments, in the purchase
+              currency.
+
+
+
+---
+
+### getPriceAdjustments()
+- getPriceAdjustments(): [Collection](dw.util.Collection.md)
+  - : Returns an iterator of price adjustments that have been applied to this
+      product shipping line item.
+
+
+    **Returns:**
+    - a collection of price adjustments that have been applied to this
+      product shipping line item.
+
+
+
+---
+
+### getProductLineItem()
+- getProductLineItem(): [ProductLineItem](dw.order.ProductLineItem.md)
+  - : Returns the parent product line item this shipping line item belongs to.
+
+    **Returns:**
+    - the product line item
+
+
+---
+
+### getQuantity()
+- getQuantity(): [Quantity](dw.value.Quantity.md)
+  - : Returns the quantity of the shipping cost.
+
+    **Returns:**
+    - the shipping quantity
+
+
+---
+
+### getShipment()
+- getShipment(): [Shipment](dw.order.Shipment.md)
+  - : Returns the shipment this shipping line item belongs to.
+
+    **Returns:**
+    - the shipment
+
+
+---
+
+### isSurcharge()
+- isSurcharge(): [Boolean](TopLevel.Boolean.md)
+  - : Returns the 'surcharge' flag.
+
+    **Returns:**
+    - true if this is a surcharge shipping cost, false if fixed shipping cost
+
+
+---
+
+### setPriceValue(Number)
+- setPriceValue(value: [Number](TopLevel.Number.md)): void
+  - : Sets price attributes of the line item based on the
+      purchase currency, taxation policy and line item quantity.
+      
+      
+      The method sets the 'basePrice' attribute of the line item.
+      Additionally, it sets the 'netPrice' attribute of the line item
+      if the current taxation policy is 'net', and the 'grossPrice'
+      attribute, if the current taxation policy is 'gross'. The
+      'netPrice'/'grossPrice' attributes are set by multiplying the
+      specified price value with the line item quantity. 
+      
+      
+      If null is specified as value, the price attributes are reset to
+      Money.NA.
+
+
+    **Parameters:**
+    - value - Price value or null
+
+
+---
+
+### setQuantity(Quantity)
+- setQuantity(quantity: [Quantity](dw.value.Quantity.md)): void
+  - : Sets the quantity of the shipping cost.
+
+    **Parameters:**
+    - quantity - the shipping quantity
+
+
+---
+
+### setSurcharge(Boolean)
+- setSurcharge(flag: [Boolean](TopLevel.Boolean.md)): void
+  - : Sets the 'surcharge' flag.
+
+    **Parameters:**
+    - flag - true if this is a surcharge shipping cost,  false if this is a fixed shipping cost.
+
+
+---
+
+<!-- prettier-ignore-end -->

package/data/script-api/dw.order.ProductShippingModel.md

@@ -0,0 +1,143 @@
+<!-- prettier-ignore-start -->
+# Class ProductShippingModel
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.order.ProductShippingModel](dw.order.ProductShippingModel.md)
+
+Instances of ProductShippingModel provide access to product-level
+shipping information, such as applicable or inapplicable shipping methods
+and shipping cost defined for the product for a specified shipping
+method. 
+
+
+Use [ShippingMgr.getProductShippingModel(Product)](dw.order.ShippingMgr.md#getproductshippingmodelproduct) to get
+the shipping model for a specific product.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [applicableShippingMethods](#applicableshippingmethods): [Collection](dw.util.Collection.md) `(read-only)` | Returns the active applicable shipping methods for the product related  to this shipping model, i.e. |
+| [inapplicableShippingMethods](#inapplicableshippingmethods): [Collection](dw.util.Collection.md) `(read-only)` | Returns the active inapplicable shipping methods for the product related  to this shipping model, i.e. |
+| [shippingMethodsWithShippingCost](#shippingmethodswithshippingcost): [Collection](dw.util.Collection.md) `(read-only)` | Returns the active shipping methods for which either any fixed-price or  surcharge product-level shipping cost is defined for the specified product. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getApplicableShippingMethods](dw.order.ProductShippingModel.md#getapplicableshippingmethods)() | Returns the active applicable shipping methods for the product related  to this shipping model, i.e. |
+| [getInapplicableShippingMethods](dw.order.ProductShippingModel.md#getinapplicableshippingmethods)() | Returns the active inapplicable shipping methods for the product related  to this shipping model, i.e. |
+| [getShippingCost](dw.order.ProductShippingModel.md#getshippingcostshippingmethod)([ShippingMethod](dw.order.ShippingMethod.md)) | Returns the shipping cost object for the related product and  the specified shipping method, or null if no product-level fixed-price or  surcharge shipping cost are defined for the specified product. |
+| [getShippingMethodsWithShippingCost](dw.order.ProductShippingModel.md#getshippingmethodswithshippingcost)() | Returns the active shipping methods for which either any fixed-price or  surcharge product-level shipping cost is defined for the specified product. |
+
+### Methods inherited from class Object
+
+[assign](TopLevel.Object.md#assignobject-object), [create](TopLevel.Object.md#createobject), [create](TopLevel.Object.md#createobject-object), [defineProperties](TopLevel.Object.md#definepropertiesobject-object), [defineProperty](TopLevel.Object.md#definepropertyobject-object-object), [entries](TopLevel.Object.md#entriesobject), [freeze](TopLevel.Object.md#freezeobject), [fromEntries](TopLevel.Object.md#fromentriesiterable), [getOwnPropertyDescriptor](TopLevel.Object.md#getownpropertydescriptorobject-object), [getOwnPropertyNames](TopLevel.Object.md#getownpropertynamesobject), [getOwnPropertySymbols](TopLevel.Object.md#getownpropertysymbolsobject), [getPrototypeOf](TopLevel.Object.md#getprototypeofobject), [hasOwnProperty](TopLevel.Object.md#hasownpropertystring), [is](TopLevel.Object.md#isobject-object), [isExtensible](TopLevel.Object.md#isextensibleobject), [isFrozen](TopLevel.Object.md#isfrozenobject), [isPrototypeOf](TopLevel.Object.md#isprototypeofobject), [isSealed](TopLevel.Object.md#issealedobject), [keys](TopLevel.Object.md#keysobject), [preventExtensions](TopLevel.Object.md#preventextensionsobject), [propertyIsEnumerable](TopLevel.Object.md#propertyisenumerablestring), [seal](TopLevel.Object.md#sealobject), [setPrototypeOf](TopLevel.Object.md#setprototypeofobject-object), [toLocaleString](TopLevel.Object.md#tolocalestring), [toString](TopLevel.Object.md#tostring), [valueOf](TopLevel.Object.md#valueof), [values](TopLevel.Object.md#valuesobject)
+## Property Details
+
+### applicableShippingMethods
+- applicableShippingMethods: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns the active applicable shipping methods for the product related
+      to this shipping model, i.e. shipping methods the product can be shipped
+      with. A product can be shipping with a shipping methods if the shipping
+      method is not explicitely marked as inapplicable for this product.
+
+
+
+---
+
+### inapplicableShippingMethods
+- inapplicableShippingMethods: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns the active inapplicable shipping methods for the product related
+      to this shipping model, i.e. shipping methods the product cannot be
+      shipped with. A product cannot be shipping with a shipping methods if the
+      shipping method is explicitely marked as inapplicable for this product.
+
+
+
+---
+
+### shippingMethodsWithShippingCost
+- shippingMethodsWithShippingCost: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Returns the active shipping methods for which either any fixed-price or
+      surcharge product-level shipping cost is defined for the specified product. 
+      
+      Note that this can include inapplicable shipping methods
+      (see [getInapplicableShippingMethods()](dw.order.ProductShippingModel.md#getinapplicableshippingmethods)).
+
+
+
+---
+
+## Method Details
+
+### getApplicableShippingMethods()
+- getApplicableShippingMethods(): [Collection](dw.util.Collection.md)
+  - : Returns the active applicable shipping methods for the product related
+      to this shipping model, i.e. shipping methods the product can be shipped
+      with. A product can be shipping with a shipping methods if the shipping
+      method is not explicitely marked as inapplicable for this product.
+
+
+    **Returns:**
+    - Applicable shipping methods for the product
+
+
+---
+
+### getInapplicableShippingMethods()
+- getInapplicableShippingMethods(): [Collection](dw.util.Collection.md)
+  - : Returns the active inapplicable shipping methods for the product related
+      to this shipping model, i.e. shipping methods the product cannot be
+      shipped with. A product cannot be shipping with a shipping methods if the
+      shipping method is explicitely marked as inapplicable for this product.
+
+
+    **Returns:**
+    - Inapplicable shipping methods for the product
+
+
+---
+
+### getShippingCost(ShippingMethod)
+- getShippingCost(shippingMethod: [ShippingMethod](dw.order.ShippingMethod.md)): [ProductShippingCost](dw.order.ProductShippingCost.md)
+  - : Returns the shipping cost object for the related product and
+      the specified shipping method, or null if no product-level fixed-price or
+      surcharge shipping cost are defined for the specified product. 
+      
+      The following rules apply:
+      
+      - if fixed and surcharge shipping cost is defined for a product, the fixed cost takes precedence
+      - if a product is member of multiple shipping cost groups, the lowest shipping cost takes precedence
+
+
+    **Parameters:**
+    - shippingMethod - the shipping method to use.
+
+    **Returns:**
+    - Product shipping cost
+
+
+---
+
+### getShippingMethodsWithShippingCost()
+- getShippingMethodsWithShippingCost(): [Collection](dw.util.Collection.md)
+  - : Returns the active shipping methods for which either any fixed-price or
+      surcharge product-level shipping cost is defined for the specified product. 
+      
+      Note that this can include inapplicable shipping methods
+      (see [getInapplicableShippingMethods()](dw.order.ProductShippingModel.md#getinapplicableshippingmethods)).
+
+
+    **Returns:**
+    - Shipping methods with shipping cost
+
+
+---
+
+<!-- prettier-ignore-end -->