npm - @salesforce/b2c-cli - Versions diffs - 0.0.5 → 0.0.8 - Mend

@salesforce/b2c-cli 0.0.5 → 0.0.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (1109) hide show

package/node_modules/@salesforce/b2c-tooling-sdk/data/script-api/dw.order.hooks.ShippingOrderHooks.md DELETED Viewed

@@ -1,426 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class ShippingOrderHooks
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.order.hooks.ShippingOrderHooks](dw.order.hooks.ShippingOrderHooks.md)
-This interface represents all script hooks that can be registered around
-shipping order lifecycle. It contains the extension points (hook names), and
-the functions that are called by each extension point. A function must be
-defined inside a JavaScript source and must be exported. The script with the
-exported hook function must be located inside a site cartridge. Inside the
-site cartridge a 'package.json' file with a 'hooks' entry must exist.
-"hooks": "./hooks.json"
-The hooks entry links to a json file, relative to the 'package.json' file.
-This file lists all registered hooks inside the hooks property:
-```
-"hooks": [
-     {"name": "dw.order.shippingorder.updateShippingOrderItem", "script": "./shippingOrderUpdate.ds"},
-]
-```
-A hook entry has a 'name' and a 'script' property.
-- The 'name' contains the extension point, the hook name.
-- The 'script' contains the script relative to the hooks file, with the  exported hook function.
-Order post-processing APIs (gillian) are now inactive by default and will throw
-an exception if accessed. Activation needs preliminary approval by Product Management.
-Please contact support in this case. Existing customers using these APIs are not
-affected by this change and can use the APIs until further notice.
-## Constant Summary
-| Constant | Description |
-| --- | --- |
-| [extensionPointAfterStatusChange](#extensionpointafterstatuschange): [String](TopLevel.String.md) = "dw.order.shippingorder.afterStatusChange" | The extension point name dw.order.shippingorder.afterStatusChange. |
-| [extensionPointChangeStatus](#extensionpointchangestatus): [String](TopLevel.String.md) = "dw.order.shippingorder.changeStatus" | The extension point name dw.order.shippingorder.changeStatus. |
-| [extensionPointCreateShippingOrders](#extensionpointcreateshippingorders): [String](TopLevel.String.md) = "dw.order.shippingorder.createShippingOrders" | The extension point name dw.order.shippingorder.createShippingOrders. |
-| [extensionPointNotifyStatusChange](#extensionpointnotifystatuschange): [String](TopLevel.String.md) = "dw.order.shippingorder.notifyStatusChange" | The extension point name dw.order.shippingorder.notifyStatusChange. |
-| [extensionPointPrepareCreateShippingOrders](#extensionpointpreparecreateshippingorders): [String](TopLevel.String.md) = "dw.order.shippingorder.prepareCreateShippingOrders" | The extension point name  dw.order.shippingorder.prepareCreateShippingOrders. |
-| [extensionPointResolveShippingOrder](#extensionpointresolveshippingorder): [String](TopLevel.String.md) = "dw.order.shippingorder.resolveShippingOrder" | The extension point name dw.order.shippingorder.resolveShippingOrder . |
-| [extensionPointShippingOrderCancelled](#extensionpointshippingordercancelled): [String](TopLevel.String.md) = "dw.order.shippingorder.setShippingOrderCancelled" | The extension point name dw.order.shippingorder.setShippingOrderCancelled. |
-| [extensionPointShippingOrderShipped](#extensionpointshippingordershipped): [String](TopLevel.String.md) = "dw.order.shippingorder.setShippingOrderShipped" | The extension point name dw.order.shippingorder.setShippingOrderShipped. |
-| [extensionPointShippingOrderWarehouse](#extensionpointshippingorderwarehouse): [String](TopLevel.String.md) = "dw.order.shippingorder.setShippingOrderWarehouse" | The extension point name dw.order.shippingorder.setShippingOrderWarehouse. |
-| [extensionPointUpdateShippingOrderItem](#extensionpointupdateshippingorderitem): [String](TopLevel.String.md) = "dw.order.shippingorder.updateShippingOrderItem" | The extension point name dw.order.shippingorder.updateShippingOrderItem. |
-## Constructor Summary
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-| Method | Description |
-| --- | --- |
-| [afterStatusChange](dw.order.hooks.ShippingOrderHooks.md#afterstatuschangeshippingorder)([ShippingOrder](dw.order.ShippingOrder.md)) | After Status change hook. |
-| [changeStatus](dw.order.hooks.ShippingOrderHooks.md#changestatusshippingorder-shippingorderwo)([ShippingOrder](dw.order.ShippingOrder.md), ShippingOrderWO) | Change the status of a shipping order. |
-| [createShippingOrders](dw.order.hooks.ShippingOrderHooks.md#createshippingordersorder)([Order](dw.order.Order.md)) | Called during shipping order creation for an order. |
-| [notifyStatusChange](dw.order.hooks.ShippingOrderHooks.md#notifystatuschangeshippingorder)([ShippingOrder](dw.order.ShippingOrder.md)) | Notify Status change hook. |
-| [prepareCreateShippingOrders](dw.order.hooks.ShippingOrderHooks.md#preparecreateshippingordersorder)([Order](dw.order.Order.md)) | Called before shipping order creation for an order takes place. |
-| [resolveShippingOrder](dw.order.hooks.ShippingOrderHooks.md#resolveshippingordershippingorderwo)(ShippingOrderWO) | Resolve the shipping order. |
-| [setShippingOrderCancelled](dw.order.hooks.ShippingOrderHooks.md#setshippingordercancelledshippingorderwo)(ShippingOrderWO) | Change the status of a shipping order to cancelled. |
-| [setShippingOrderShipped](dw.order.hooks.ShippingOrderHooks.md#setshippingordershippedshippingorderwo)(ShippingOrderWO) | Change the status of a shipping order to shipped. |
-| [setShippingOrderWarehouse](dw.order.hooks.ShippingOrderHooks.md#setshippingorderwarehouseshippingorderwo)(ShippingOrderWO) | Change the status of a shipping order to warehouse. |
-| [updateShippingOrderItem](dw.order.hooks.ShippingOrderHooks.md#updateshippingorderitemshippingorder-shippingorderitemwo)([ShippingOrder](dw.order.ShippingOrder.md), ShippingOrderItemWO) | Updates the status of a shipping order item. |
-### 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
-### extensionPointAfterStatusChange
-- extensionPointAfterStatusChange: [String](TopLevel.String.md) = "dw.order.shippingorder.afterStatusChange"
-  - : The extension point name dw.order.shippingorder.afterStatusChange.
----
-### extensionPointChangeStatus
-- extensionPointChangeStatus: [String](TopLevel.String.md) = "dw.order.shippingorder.changeStatus"
-  - : The extension point name dw.order.shippingorder.changeStatus.
----
-### extensionPointCreateShippingOrders
-- extensionPointCreateShippingOrders: [String](TopLevel.String.md) = "dw.order.shippingorder.createShippingOrders"
-  - : The extension point name dw.order.shippingorder.createShippingOrders.
----
-### extensionPointNotifyStatusChange
-- extensionPointNotifyStatusChange: [String](TopLevel.String.md) = "dw.order.shippingorder.notifyStatusChange"
-  - : The extension point name dw.order.shippingorder.notifyStatusChange.
----
-### extensionPointPrepareCreateShippingOrders
-- extensionPointPrepareCreateShippingOrders: [String](TopLevel.String.md) = "dw.order.shippingorder.prepareCreateShippingOrders"
-  - : The extension point name
-      dw.order.shippingorder.prepareCreateShippingOrders.
----
-### extensionPointResolveShippingOrder
-- extensionPointResolveShippingOrder: [String](TopLevel.String.md) = "dw.order.shippingorder.resolveShippingOrder"
-  - : The extension point name dw.order.shippingorder.resolveShippingOrder .
----
-### extensionPointShippingOrderCancelled
-- extensionPointShippingOrderCancelled: [String](TopLevel.String.md) = "dw.order.shippingorder.setShippingOrderCancelled"
-  - : The extension point name dw.order.shippingorder.setShippingOrderCancelled.
----
-### extensionPointShippingOrderShipped
-- extensionPointShippingOrderShipped: [String](TopLevel.String.md) = "dw.order.shippingorder.setShippingOrderShipped"
-  - : The extension point name dw.order.shippingorder.setShippingOrderShipped.
----
-### extensionPointShippingOrderWarehouse
-- extensionPointShippingOrderWarehouse: [String](TopLevel.String.md) = "dw.order.shippingorder.setShippingOrderWarehouse"
-  - : The extension point name dw.order.shippingorder.setShippingOrderWarehouse.
----
-### extensionPointUpdateShippingOrderItem
-- extensionPointUpdateShippingOrderItem: [String](TopLevel.String.md) = "dw.order.shippingorder.updateShippingOrderItem"
-  - : The extension point name dw.order.shippingorder.updateShippingOrderItem.
----
-## Method Details
-### afterStatusChange(ShippingOrder)
-- afterStatusChange(shippingOrder: [ShippingOrder](dw.order.ShippingOrder.md)): [Status](dw.system.Status.md)
-  - : After Status change hook.
-      The function is called by extension point
-      [extensionPointAfterStatusChange](dw.order.hooks.ShippingOrderHooks.md#extensionpointafterstatuschange).
-      The implementation of this hook is optional. If defined the hook is
-      called after [extensionPointChangeStatus](dw.order.hooks.ShippingOrderHooks.md#extensionpointchangestatus) or respectively after
-      [extensionPointShippingOrderShipped](dw.order.hooks.ShippingOrderHooks.md#extensionpointshippingordershipped),
-      [extensionPointShippingOrderCancelled](dw.order.hooks.ShippingOrderHooks.md#extensionpointshippingordercancelled) or
-      [extensionPointShippingOrderWarehouse](dw.order.hooks.ShippingOrderHooks.md#extensionpointshippingorderwarehouse)
-      Runs inside of a transaction.
-    **Parameters:**
-    - shippingOrder - the shipping order to be updated
-    **Returns:**
-    - the resulting status
----
-### changeStatus(ShippingOrder, ShippingOrderWO)
-- changeStatus(shippingOrder: [ShippingOrder](dw.order.ShippingOrder.md), updateData: ShippingOrderWO): [Status](dw.system.Status.md)
-  - : Change the status of a shipping order.
-      The function is called by extension point
-      [extensionPointChangeStatus](dw.order.hooks.ShippingOrderHooks.md#extensionpointchangestatus).
-      Runs inside a transaction together with the hooks
-      [extensionPointResolveShippingOrder](dw.order.hooks.ShippingOrderHooks.md#extensionpointresolveshippingorder)
-      [extensionPointUpdateShippingOrderItem](dw.order.hooks.ShippingOrderHooks.md#extensionpointupdateshippingorderitem).
-      Runs after the iteration over the input's items collection as the last
-      step in this transaction. The implementation of this hook is mandatory.
-    **Parameters:**
-    - shippingOrder - the shipping order to be updated
-    - updateData - the input data
-    **Returns:**
-    - the resulting status
----
-### createShippingOrders(Order)
-- createShippingOrders(order: [Order](dw.order.Order.md)): [Status](dw.system.Status.md)
-  - : Called during shipping order creation for an order.
-      The function is called by extension point
-      [extensionPointCreateShippingOrders](dw.order.hooks.ShippingOrderHooks.md#extensionpointcreateshippingorders). It is responsible for
-      creating shipping orders and its items for the order. Preparations for
-      shipping order creation can be done before in hook
-      [extensionPointPrepareCreateShippingOrders](dw.order.hooks.ShippingOrderHooks.md#extensionpointpreparecreateshippingorders).
-      Runs inside of a transaction. The implementation of this hook is
-      mandatory.
-    **Parameters:**
-    - order - the order to create shipping orders for
-    **Returns:**
-    - the resulting status
----
-### notifyStatusChange(ShippingOrder)
-- notifyStatusChange(shippingOrder: [ShippingOrder](dw.order.ShippingOrder.md)): [Status](dw.system.Status.md)
-  - : Notify Status change hook.
-      The function is called by extension point
-      [extensionPointNotifyStatusChange](dw.order.hooks.ShippingOrderHooks.md#extensionpointnotifystatuschange).
-      The implementation of this hook is optional. If defined the hook is
-      called after [extensionPointAfterStatusChange](dw.order.hooks.ShippingOrderHooks.md#extensionpointafterstatuschange) as the last step
-      in the shipping order update process.
-      Runs outside of a transaction.
-    **Parameters:**
-    - shippingOrder - the shipping order to be updated
-    **Returns:**
-    - the resulting status
----
-### prepareCreateShippingOrders(Order)
-- prepareCreateShippingOrders(order: [Order](dw.order.Order.md)): [Status](dw.system.Status.md)
-  - : Called before shipping order creation for an order takes place. Typically
-      the hook is used to check the payment authorization status of the order.
-      The function is called by extension point
-      [extensionPointPrepareCreateShippingOrders](dw.order.hooks.ShippingOrderHooks.md#extensionpointpreparecreateshippingorders).
-      Runs inside its own transaction. The value of the return status is used
-      to control whether hook [createShippingOrders(Order)](dw.order.hooks.ShippingOrderHooks.md#createshippingordersorder) is called
-      for the order or not. The implementation of this hook is mandatory.
-    **Parameters:**
-    - order - the order to create shipping orders for
-    **Returns:**
-    -
-      - Status.OK successful preparation - continue with shipping          order creation for this order.
-      - Status.ERROR failed          preparation - skip shipping order creation for this order.
----
-### resolveShippingOrder(ShippingOrderWO)
-- resolveShippingOrder(updateData: ShippingOrderWO): [ShippingOrder](dw.order.ShippingOrder.md)
-  - : Resolve the shipping order. Will be called as first step of the update.
-      The function is called by extension point
-      [extensionPointResolveShippingOrder](dw.order.hooks.ShippingOrderHooks.md#extensionpointresolveshippingorder).
-      Runs inside a transaction together with the hooks
-      [extensionPointUpdateShippingOrderItem](dw.order.hooks.ShippingOrderHooks.md#extensionpointupdateshippingorderitem)
-      [extensionPointChangeStatus](dw.order.hooks.ShippingOrderHooks.md#extensionpointchangestatus). The implementation of this hook is
-      mandatory.
-    **Parameters:**
-    - updateData - the input data
-    **Returns:**
-    - the shipping order to update
----
-### setShippingOrderCancelled(ShippingOrderWO)
-- setShippingOrderCancelled(updateData: ShippingOrderWO): [Order](dw.order.Order.md)
-  - : Change the status of a shipping order to cancelled.
-      The function is called by extension point
-      [extensionPointShippingOrderCancelled](dw.order.hooks.ShippingOrderHooks.md#extensionpointshippingordercancelled).
-      This is an optional hook that can be implemented to have full control
-      over status change to destination status Cancelled. The following hooks
-      will be skipped if an implementation for this hook is registered:
-      [extensionPointResolveShippingOrder](dw.order.hooks.ShippingOrderHooks.md#extensionpointresolveshippingorder),
-      [extensionPointUpdateShippingOrderItem](dw.order.hooks.ShippingOrderHooks.md#extensionpointupdateshippingorderitem),
-      [extensionPointChangeStatus](dw.order.hooks.ShippingOrderHooks.md#extensionpointchangestatus).
-      Runs inside of a transaction.
-    **Parameters:**
-    - updateData - the input data
-    **Returns:**
-    - the changed order or {code}null{code}
----
-### setShippingOrderShipped(ShippingOrderWO)
-- setShippingOrderShipped(updateData: ShippingOrderWO): [Order](dw.order.Order.md)
-  - : Change the status of a shipping order to shipped.
-      The function is called by extension point
-      [extensionPointShippingOrderShipped](dw.order.hooks.ShippingOrderHooks.md#extensionpointshippingordershipped).
-      This is an optional hook that can be implemented to have full control
-      over status change to destination status Shipped. The following hooks
-      will be skipped if an implementation for this hook is registered:
-      [extensionPointResolveShippingOrder](dw.order.hooks.ShippingOrderHooks.md#extensionpointresolveshippingorder)
-      [extensionPointUpdateShippingOrderItem](dw.order.hooks.ShippingOrderHooks.md#extensionpointupdateshippingorderitem),
-      [extensionPointChangeStatus](dw.order.hooks.ShippingOrderHooks.md#extensionpointchangestatus).
-      Runs inside of a transaction.
-    **Parameters:**
-    - updateData - the input data
-    **Returns:**
-    - the changed order or {code}null{code}
----
-### setShippingOrderWarehouse(ShippingOrderWO)
-- setShippingOrderWarehouse(updateData: ShippingOrderWO): [Order](dw.order.Order.md)
-  - : Change the status of a shipping order to warehouse.
-      The function is called by extension point
-      [extensionPointShippingOrderWarehouse](dw.order.hooks.ShippingOrderHooks.md#extensionpointshippingorderwarehouse).
-      This is an optional hook that can be implemented to have full control
-      over status change to destination status Warehouse. The following hooks
-      will be skipped if an implementation for this hook is registered:
-      [extensionPointResolveShippingOrder](dw.order.hooks.ShippingOrderHooks.md#extensionpointresolveshippingorder),
-      [extensionPointUpdateShippingOrderItem](dw.order.hooks.ShippingOrderHooks.md#extensionpointupdateshippingorderitem),
-      [extensionPointChangeStatus](dw.order.hooks.ShippingOrderHooks.md#extensionpointchangestatus).
-      Runs inside of a transaction.
-    **Parameters:**
-    - updateData - the input data
-    **Returns:**
-    - the changed order or {code}null{code}
----
-### updateShippingOrderItem(ShippingOrder, ShippingOrderItemWO)
-- updateShippingOrderItem(shippingOrder: [ShippingOrder](dw.order.ShippingOrder.md), updateItem: ShippingOrderItemWO): [Status](dw.system.Status.md)
-  - : Updates the status of a shipping order item.
-      The function is called by extension point
-      [extensionPointUpdateShippingOrderItem](dw.order.hooks.ShippingOrderHooks.md#extensionpointupdateshippingorderitem).
-      Runs inside a transaction together with the hooks
-      [extensionPointResolveShippingOrder](dw.order.hooks.ShippingOrderHooks.md#extensionpointresolveshippingorder)
-      [extensionPointChangeStatus](dw.order.hooks.ShippingOrderHooks.md#extensionpointchangestatus). The implementation of this hook is
-      mandatory.
-    **Parameters:**
-    - shippingOrder - the shipping order
-    - updateItem - the input data
-    **Returns:**
-    - the resulting status
----
-<!-- prettier-ignore-end -->

package/node_modules/@salesforce/b2c-tooling-sdk/data/script-api/dw.order.hooks.md DELETED Viewed

@@ -1,12 +0,0 @@
-# Package dw.order.hooks
-## Classes
-| Class | Description |
-| --- | --- |
-| [BasketMergeHooks](dw.order.hooks.BasketMergeHooks.md) | This interface represents all script hooks that can be registered to merge baskets. |
-| [CalculateHooks](dw.order.hooks.CalculateHooks.md) | This interface represents all script hooks that can be registered to customize the order and basket calculation  functionality. |
-| [CheckoutHooks](dw.order.hooks.CheckoutHooks.md) | This interface represents script hooks that can be registered to populate customer details into a basket. |
-| [OrderHooks](dw.order.hooks.OrderHooks.md) | This interface represents all script hooks that can be registered to customize the order logic. |
-| [PaymentHooks](dw.order.hooks.PaymentHooks.md) | This interface represents all script hooks that can be registered to  customize the order center payment functionality. |
-| [ReturnHooks](dw.order.hooks.ReturnHooks.md) | This interface represents all script hooks that can be registered to  customizing the order center return resource. |
-| [ShippingOrderHooks](dw.order.hooks.ShippingOrderHooks.md) | This interface represents all script hooks that can be registered around  shipping order lifecycle. |

package/node_modules/@salesforce/b2c-tooling-sdk/data/script-api/dw.order.md DELETED Viewed

@@ -1,64 +0,0 @@
-# Package dw.order
-## Classes
-| Class | Description |
-| --- | --- |
-| [AbstractItem](dw.order.AbstractItem.md) | An item which references, or in other words is based upon, an [OrderItem](dw.order.OrderItem.md). |
-| [AbstractItemCtnr](dw.order.AbstractItemCtnr.md) | Basis for item-based objects stemming from a single [Order](dw.order.Order.md), with these common  properties (Invoice is used as an example):   <ul>  <li>  The object has been created from an Order accessible using [getOrder()](dw.order.AbstractItemCtnr.md#getorder)</li>  <li>Contains a collection of [items](dw.order.AbstractItemCtnr.md#getitems), each item related to exactly one [OrderItem](dw.order.OrderItem.md) which in turn represents  an extension to one of the order [ProductLineItem](dw.order.ProductLineItem.md) or one [ShippingLineItem](dw.order.ShippingLineItem.md). |
-| [Appeasement](dw.order.Appeasement.md) | The Appeasement represents a shopper request for an order credit.<br/>  Example: The buyer finds any problem with the products but he agrees to preserve them, if he would be compensated,  rather than return them.<br/>  <br/>  The Appeasement contains 1..n appeasement items. |
-| [AppeasementItem](dw.order.AppeasementItem.md) | Represents an item of an [Appeasement](dw.order.Appeasement.md) which is associated with one [OrderItem](dw.order.OrderItem.md) usually representing an [Order](dw.order.Order.md)  [ProductLineItem](dw.order.ProductLineItem.md). |
-| [Basket](dw.order.Basket.md) | The Basket class represents a shopping cart. |
-| [BasketMgr](dw.order.BasketMgr.md) | Provides static helper methods for managing baskets. |
-| [BonusDiscountLineItem](dw.order.BonusDiscountLineItem.md) | Line item representing an applied [BonusChoiceDiscount](dw.campaign.BonusChoiceDiscount.md) in a LineItemCtnr. |
-| [CouponLineItem](dw.order.CouponLineItem.md) | The CouponLineItem class is used to store redeemed coupons in the Basket. |
-| [CreateAgentBasketLimitExceededException](dw.order.CreateAgentBasketLimitExceededException.md) | This exception is thrown by [BasketMgr.createAgentBasket()](dw.order.BasketMgr.md#createagentbasket) to indicate that the open agent basket limit for  the current session customer is already reached, and therefore no new agent basket could be created. |
-| [CreateBasketFromOrderException](dw.order.CreateBasketFromOrderException.md) | This APIException is thrown by method [BasketMgr.createBasketFromOrder(Order)](dw.order.BasketMgr.md#createbasketfromorderorder)  to indicate no Basket could be created from the Order. |
-| [CreateCouponLineItemException](dw.order.CreateCouponLineItemException.md) | This exception could be thrown by [LineItemCtnr.createCouponLineItem(String, Boolean)](dw.order.LineItemCtnr.md#createcouponlineitemstring-boolean)  when the provided coupon code is invalid. |
-| [CreateOrderException](dw.order.CreateOrderException.md) | This APIException is thrown by method [OrderMgr.createOrder(Basket, String)](dw.order.OrderMgr.md#createorderbasket-string)  to indicate no Order could be created from the Basket. |
-| [CreateTemporaryBasketLimitExceededException](dw.order.CreateTemporaryBasketLimitExceededException.md) | This exception is thrown by [BasketMgr.createTemporaryBasket()](dw.order.BasketMgr.md#createtemporarybasket) to indicate that the open temporary basket  limit for the current session customer is already reached, and therefore no new temporary basket could be created. |
-| [GiftCertificate](dw.order.GiftCertificate.md) | Represents a Gift Certificate that can be used to purchase  products. |
-| [GiftCertificateLineItem](dw.order.GiftCertificateLineItem.md) | Represents a Gift Certificate line item in the cart. |
-| [GiftCertificateMgr](dw.order.GiftCertificateMgr.md) | The GiftCertificateMgr class contains a set of static methods for  interacting with GiftCertificates. |
-| [GiftCertificateStatusCodes](dw.order.GiftCertificateStatusCodes.md) | Helper class containing status codes for the various errors that can occur  when redeeming a gift certificate. |
-| [Invoice](dw.order.Invoice.md) | The Invoice can be a debit or credit invoice, and is created  from custom scripts using one of the methods  [ShippingOrder.createInvoice(String)](dw.order.ShippingOrder.md#createinvoicestring),  [Appeasement.createInvoice(String)](dw.order.Appeasement.md#createinvoicestring),  [ReturnCase.createInvoice(String)](dw.order.ReturnCase.md#createinvoicestring) or  [Return.createInvoice(String)](dw.order.Return.md#createinvoicestring). |
-| [InvoiceItem](dw.order.InvoiceItem.md) | Represents a specific item in an [Invoice](dw.order.Invoice.md). |
-| [LineItem](dw.order.LineItem.md) | Common line item base class. |
-| [LineItemCtnr](dw.order.LineItemCtnr.md) | A container for line items, such as ProductLineItems, CouponLineItems, GiftCertificateLineItems. |
-| [Order](dw.order.Order.md) | The Order class represents an order. |
-| [OrderAddress](dw.order.OrderAddress.md) | The Address class represents a customer's address. |
-| [OrderItem](dw.order.OrderItem.md) | Defines _extensions_ to [ProductLineItem](dw.order.ProductLineItem.md)s and  [ShippingLineItem](dw.order.ShippingLineItem.md)s belonging to an [order](dw.order.Order.md). |
-| [OrderMgr](dw.order.OrderMgr.md) | <p>  Provides static helper methods for managing orders. |
-| [OrderPaymentInstrument](dw.order.OrderPaymentInstrument.md) | Represents any payment instrument used to pay orders, such as credit card  or bank transfer. |
-| [OrderProcessStatusCodes](dw.order.OrderProcessStatusCodes.md) | Contains constants representing different status codes  for interacting with an order, such as cancelling  or editing an order. |
-| [PaymentCard](dw.order.PaymentCard.md) | Represents payment cards and provides methods to access the payment card  attributes and status. |
-| [PaymentInstrument](dw.order.PaymentInstrument.md) | Base class for payment instrument either stored in the customers profile  or related to an order. |
-| [PaymentMethod](dw.order.PaymentMethod.md) | The PaymentMethod class represents a logical type of payment a customer can  make in the storefront. |
-| [PaymentMgr](dw.order.PaymentMgr.md) | [PaymentMgr](dw.order.PaymentMgr.md) is used to access payment methods and payment  cards of the current site. |
-| [PaymentProcessor](dw.order.PaymentProcessor.md) | A PaymentProcessor represents an entity that processes payments of one or more types. |
-| [PaymentStatusCodes](dw.order.PaymentStatusCodes.md) | Helper class containing status codes for the various errors that can occur  when validating a payment card. |
-| [PaymentTransaction](dw.order.PaymentTransaction.md) | The PaymentTransaction class represents a payment transaction. |
-| [PriceAdjustment](dw.order.PriceAdjustment.md) | The PriceAdjustment class represents an adjustment to the price of an order. |
-| [PriceAdjustmentLimitTypes](dw.order.PriceAdjustmentLimitTypes.md) | Helper class containing price adjustment limit types. |
-| [ProductLineItem](dw.order.ProductLineItem.md) | Represents a specific product line item. |
-| [ProductShippingCost](dw.order.ProductShippingCost.md) | Instances of ProductShippingCost represent product specific shipping costs. |
-| [ProductShippingLineItem](dw.order.ProductShippingLineItem.md) | Represents a specific line item in a shipment. |
-| [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. |
-| [Return](dw.order.Return.md) | The Return represents a physical customer return, and contains 1..n  [ReturnItem](dw.order.ReturnItem.md)s. |
-| [ReturnCase](dw.order.ReturnCase.md) | All returns exist in the context of a ReturnCase, each [Order](dw.order.Order.md)  can have any number of ReturnCases. |
-| [ReturnCaseItem](dw.order.ReturnCaseItem.md) | An item of a [ReturnCase](dw.order.ReturnCase.md), created using method  [ReturnCase.createItem(String)](dw.order.ReturnCase.md#createitemstring). |
-| [ReturnItem](dw.order.ReturnItem.md) | An item of a [Return](dw.order.Return.md), created using [Return.createItem(String)](dw.order.Return.md#createitemstring). |
-| [Shipment](dw.order.Shipment.md) | Represents an order shipment. |
-| [ShipmentShippingCost](dw.order.ShipmentShippingCost.md) | Represents shipping cost applied to shipments. |
-| [ShipmentShippingModel](dw.order.ShipmentShippingModel.md) | Instances of ShipmentShippingModel provide access to shipment-level  shipping information, such as applicable and inapplicable shipping methods  and shipping cost. |
-| [ShippingLineItem](dw.order.ShippingLineItem.md) | Represents a specific line item in a shipment. |
-| [ShippingLocation](dw.order.ShippingLocation.md) | Represents a specific location for a shipment. |
-| [ShippingMethod](dw.order.ShippingMethod.md) | ShippingMethod represents how the shipment will be shipped. |
-| [ShippingMgr](dw.order.ShippingMgr.md) | Provides methods to access the shipping information. |
-| [ShippingOrder](dw.order.ShippingOrder.md) | A shipping order is used to specify items that should be shipped, and is  typically exported to, and updated by a back-office warehouse management  system. |
-| [ShippingOrderItem](dw.order.ShippingOrderItem.md) | One or more ShippingOrderItems are contained in a  [ShippingOrder](dw.order.ShippingOrder.md), created using  [ShippingOrder.createShippingOrderItem(OrderItem, Quantity)](dw.order.ShippingOrder.md#createshippingorderitemorderitem-quantity)  and can be retrieved by  [ShippingOrder.getItems()](dw.order.ShippingOrder.md#getitems). |
-| [SumItem](dw.order.SumItem.md) | Container used to represent an subtotal or grandtotal item which contains various prices and a tax breakdown  held in a collection of tax-items. |
-| [TaxGroup](dw.order.TaxGroup.md) | Contains the formal definition of a tax including a type (it's just the key), a [percentage value](dw.order.TaxGroup.md#getrate)  if provided, a [caption](dw.order.TaxGroup.md#getcaption) and a [description](dw.order.TaxGroup.md#getdescription). |
-| [TaxItem](dw.order.TaxItem.md) | An item containing tax information allowing a tax breakdown between a number of [TaxGroup](dw.order.TaxGroup.md)s. |
-| [TaxMgr](dw.order.TaxMgr.md) | Provides methods to access the tax table. |
-| [TrackingInfo](dw.order.TrackingInfo.md) | Provides basic information about a tracking info. |
-| [TrackingRef](dw.order.TrackingRef.md) | Provides basic information about the [TrackingInfo](dw.order.TrackingInfo.md) a  [ShippingOrderItem](dw.order.ShippingOrderItem.md) is contained. |