@salesforce/b2c-tooling-sdk 1.19.0 → 1.20.0

package/data/script-api/dw.order.hooks.TaxHooks.md

@@ -1,495 +0,0 @@
-<!-- prettier-ignore-start -->
-# Class TaxHooks
-
-- [TopLevel.Object](TopLevel.Object.md)
-  - [dw.order.hooks.TaxHooks](dw.order.hooks.TaxHooks.md)
-
-This interface represents tax extension points for Commerce App tax providers.
-
-
-These hooks provide integration points for external tax calculation services installed via the Commerce App
-framework. They are distinct from the legacy `dw.order.calculateTax` extension point.
-
-
-**IMPORTANT:** These hooks should **only** be implemented and registered by Commerce Apps
-(applications installed via the Commerce App framework with a CAP file). They are not intended for custom merchant
-cartridges or storefront implementations. Merchants who want custom tax calculation logic should use the legacy
-`dw.order.calculateTax` extension point instead.
-
-
-Hook Registration 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": "sfcc.app.tax.calculate", "script": "./calculate.js"},
-   {"name": "sfcc.app.tax.commit", "script": "./commit.js"},
-   {"name": "sfcc.app.tax.cancel", "script": "./cancel.js"}
-]
-```
-
-
-
-A hook entry has a `name` and a `script` property:
-
-
-
-- The `name`contains the extension point name (the hook name).
-- The `script`contains the script path relative to the hooks file, with the exported hook  function.
-
-
-
-**Function Naming Convention:** The exported JavaScript function name must match the last segment of the
-extension point name, for example, `calculate`, `commit`, `cancel`..
-
-
-Order Lifecycle Context Each hook fires at a specific point in the order lifecycle:
-
-- **calculate:**Fires during basket calculation on every basket operation (e.g., adding items,  changing quantities, updating shipping). Calculates tax amounts for the basket line items.
-- **commit:**Fires immediately after successful order creation (order status `CREATED`).  Notifies the tax provider that the order has been created and tax amounts should be committed.
-- **cancel:**Fires on order cancellation or failure. Notifies the tax provider to void or cancel  previously committed tax amounts.
-
-Hook Precedence
-
-- When `sfcc.app.tax.calculate`is registered, it takes precedence over the legacy  `dw.order.calculateTax`hook.
-- If the Commerce App hook is not registered, the platform falls back to `dw.order.calculateTax`(if  registered).
-- If neither hook is available, the platform uses default platform tax calculation.
-
-
-
-**Important:** If you override the `dw.order.calculate` hook (the parent basket calculation
-hook), the platform's tax hook selection logic is bypassed entirely. In this case, if you want to use Commerce App
-tax providers, you must manually invoke the `sfcc.app.tax.calculate` hook from within your custom
-`dw.order.calculate` implementation.
-
-
-SCAPI Behavior
-
-
-SCAPI requests with `ScapiHookExecutionEnabled` disabled bypass all hooks (both Commerce App tax hooks and
-the legacy `dw.order.calculateTax` hook) and go straight to the default platform tax calculation.
-
-
-Hook Arguments and Return Types
-
-- **calculate:**Receives a `dw.order.LineItemCtnr`(typically a  `dw.order.Basket`) as the first argument. Must return a `dw.system.Status`object (or  `null`for success).
-- **commit:**Receives a `dw.order.Order`object as the first argument. Must return a  `dw.system.Status`object (or `null`for success).
-- **cancel:**Receives a `dw.order.Order`object as the first argument. Must return a  `dw.system.Status`object (or `null`for success).
-
-Error Handling
-For calculate hook:
-
-- **Always blocks on error:**Both returning a `Status.ERROR`and throwing an exception  prevent the basket calculation from completing successfully. The platform logs the error and halts the current basket  operation. Since order creation requires a successful basket calculation, this also prevents orders from being  created with incorrect tax amounts.
-
-For commit hook:
-
-
-The Commerce App developer chooses whether errors should block order creation by how they handle errors in their hook
-implementation:
-
-
-
-- **Non-blocking error:**Catch exceptions and return a `Status.ERROR`. The platform logs  the error as a warning and continues with the order lifecycle. Use this when the tax provider is temporarily  unavailable but the order should still be created.    
-  ```
-  return new Status(Status.ERROR, 'TAX_COMMIT_FAILED', 'Details about the failure');
-  ```
-
-- **Blocking error:**Let exceptions propagate (don't catch them). The platform logs the error and  rolls back the order lifecycle operation, preventing the order from being created.    
-  ```
-  throw new Error('Tax provider unavailable');
-  ```
-
-
-For cancel hook:
-
-
-The Commerce App developer chooses whether errors should block order cancellation by how they handle errors in their
-hook implementation:
-
-
-
-- **Non-blocking error:**Catch exceptions and return a `Status.ERROR`. The platform logs  the error as a warning and continues with the order lifecycle. Use this when the tax provider is temporarily  unavailable but the order cancellation should still proceed.    
-  ```
-  return new Status(Status.ERROR, 'TAX_CANCEL_FAILED', 'Details about the failure');
-  ```
-
-- **Blocking error:**Let exceptions propagate (don't catch them). The platform logs the error and  rolls back the order cancellation operation.    
-  ```
-  throw new Error('Tax provider unavailable');
-  ```
-
-
-
-## Constant Summary
-
-| Constant | Description |
-| --- | --- |
-| [extensionPointAppCalculateTax](#extensionpointappcalculatetax): [String](TopLevel.String.md) = "sfcc.app.tax.calculate" | The extension point name sfcc.app.tax.calculate. |
-| [extensionPointAppCancelTax](#extensionpointappcanceltax): [String](TopLevel.String.md) = "sfcc.app.tax.cancel" | The extension point name sfcc.app.tax.cancel. |
-| [extensionPointAppCommitTax](#extensionpointappcommittax): [String](TopLevel.String.md) = "sfcc.app.tax.commit" | The extension point name sfcc.app.tax.commit. |
-
-## Constructor Summary
-
-This class does not have a constructor, so you cannot create it directly.
-## Method Summary
-
-| Method | Description |
-| --- | --- |
-| [calculate](dw.order.hooks.TaxHooks.md#calculatelineitemctnr)([LineItemCtnr](dw.order.LineItemCtnr.md)) | The function is called by extension point [extensionPointAppCalculateTax](dw.order.hooks.TaxHooks.md#extensionpointappcalculatetax). |
-| [cancel](dw.order.hooks.TaxHooks.md#cancelorder)([Order](dw.order.Order.md)) | The function is called by extension point [extensionPointAppCancelTax](dw.order.hooks.TaxHooks.md#extensionpointappcanceltax) during OrderMgr.failOrder() or  OrderMgr.cancelOrder(). |
-| [commit](dw.order.hooks.TaxHooks.md#commitorder)([Order](dw.order.Order.md)) | The function is called by extension point [extensionPointAppCommitTax](dw.order.hooks.TaxHooks.md#extensionpointappcommittax) during order creation in the order  creation transaction. |
-
-### 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
-
-### extensionPointAppCalculateTax
-
-- extensionPointAppCalculateTax: [String](TopLevel.String.md) = "sfcc.app.tax.calculate"
-  - : The extension point name sfcc.app.tax.calculate.
-
-
----
-
-### extensionPointAppCancelTax
-
-- extensionPointAppCancelTax: [String](TopLevel.String.md) = "sfcc.app.tax.cancel"
-  - : The extension point name sfcc.app.tax.cancel.
-
-
----
-
-### extensionPointAppCommitTax
-
-- extensionPointAppCommitTax: [String](TopLevel.String.md) = "sfcc.app.tax.commit"
-  - : The extension point name sfcc.app.tax.commit.
-
-
----
-
-## Method Details
-
-### calculate(LineItemCtnr)
-- calculate(lineItemCtnr: [LineItemCtnr](dw.order.LineItemCtnr.md)): [Status](dw.system.Status.md)
-  - : The function is called by extension point [extensionPointAppCalculateTax](dw.order.hooks.TaxHooks.md#extensionpointappcalculatetax). It calculates tax amounts for
-      the basket line items during basket calculation. This hook fires on every basket operation (e.g., adding items,
-      changing quantities, updating shipping), not only before order creation.
-      
-      
-      **Note:** If the `dw.order.calculate` hook is overridden, the platform's automatic tax
-      hook selection is bypassed. You must manually invoke this hook from within your custom
-      `dw.order.calculate` implementation if you want to use Commerce App tax providers.
-      
-      
-      
-      
-      **Error Handling:** Both returning a `Status.ERROR` and throwing an exception will
-      prevent the basket calculation from completing successfully. The platform logs the error and halts the current
-      basket operation. Since order creation requires a successful basket calculation, this also prevents orders from
-      being created with incorrect tax amounts.
-      
-      
-      
-      
-      **SCAPI Behavior:** When `ScapiHookExecutionEnabled` is disabled, SCAPI requests bypass
-      this hook and use default platform tax calculation.
-      
-      
-      
-      
-      **Sample Implementation:**
-      
-      
-      
-      
-      ```
-      function calculate(basket) {
-          var TaxMgr = require('dw/order/TaxMgr');
-          var Status = require('dw/system/Status');
-          var HTTPClient = require('dw/net/HTTPClient');
-      
-          // 1. Extract shipping address and line items
-          var shipment = basket.getDefaultShipment();
-          var shippingAddress = shipment.getShippingAddress();
-      
-          // 2. Build request for external tax provider
-          var taxRequest = {
-              addresses: {
-                  shipTo: {
-                      line1: shippingAddress.getAddress1(),
-                      city: shippingAddress.getCity(),
-                      region: shippingAddress.getStateCode(),
-                      country: shippingAddress.getCountryCode().getValue(),
-                      postalCode: shippingAddress.getPostalCode()
-                  }
-              },
-              lines: []
-          };
-      
-          // Add product line items
-          var pliIterator = basket.getProductLineItems().iterator();
-          while (pliIterator.hasNext()) {
-              var pli = pliIterator.next();
-              taxRequest.lines.push({
-                  itemCode: pli.getProductID(),
-                  quantity: pli.getQuantityValue(),
-                  amount: pli.getAdjustedPrice().getValue(),
-                  taxCode: pli.getTaxClassID() // Product tax category
-              });
-          }
-      
-          // 3. Call external tax service
-          var httpClient = new HTTPClient();
-          httpClient.open('POST', 'https://api.taxprovider.com/calculate');
-          httpClient.setRequestHeader('Authorization', 'Bearer ' + apiKey);
-          httpClient.send(JSON.stringify(taxRequest));
-      
-          if (httpClient.statusCode !== 200) {
-              return new Status(Status.ERROR, 'TAX_CALC_FAILED', 'Tax calculation failed: ' + httpClient.errorText);
-          }
-      
-          var taxResponse = JSON.parse(httpClient.text);
-      
-          // 4. Apply tax amounts to basket line items using TaxMgr
-          taxResponse.lines.forEach(function(line, index) {
-              var pli = basket.getProductLineItems()[index];
-              TaxMgr.setProductLineTax(pli, line.tax);
-          });
-      
-          // Set shipping tax if applicable
-          if (taxResponse.shippingTax) {
-              TaxMgr.setShippingTax(shipment, taxResponse.shippingTax);
-          }
-      
-          return new Status(Status.OK);
-      }
-      
-      exports.calculate = calculate;
-      ```
-      
-      
-      
-      **Common APIs used:** `dw.order.TaxMgr` (setProductLineTax, setShippingTax),
-      dw.net.HTTPClient, `dw.order.LineItemCtnr` (getProductLineItems, getShipments),
-      `dw.order.ProductLineItem` (getProductID, getTaxClassID), `dw.order.OrderAddress`
-      (getAddress1, getCity, getStateCode).
-
-
-    **Parameters:**
-    - lineItemCtnr - the line item container (basket) for which tax should be calculated.
-
-    **Returns:**
-    - `Status.OK` or `null` for success; `Status.ERROR` to block the basket
-              calculation with details about the failure. Throwing an exception will also block the basket calculation.
-
-
-
----
-
-### cancel(Order)
-- cancel(order: [Order](dw.order.Order.md)): [Status](dw.system.Status.md)
-  - : The function is called by extension point [extensionPointAppCancelTax](dw.order.hooks.TaxHooks.md#extensionpointappcanceltax) during OrderMgr.failOrder() or
-      OrderMgr.cancelOrder(). It notifies the Commerce App tax provider that the order has been cancelled or has
-      failed, and that previously committed tax amounts should be voided or cancelled in the tax provider.
-      
-      
-      **Error Handling:**
-      
-      
-      
-      - **Non-blocking error:**Return `Status.ERROR`. The platform logs the error as a  warning and continues with the order lifecycle. Use this when the tax provider is temporarily unavailable but the  order cancellation should still proceed.
-      - **Blocking error:**Throw an exception. The platform logs the error and rolls back the order  lifecycle operation.
-      
-      
-      
-      **SCAPI Behavior:** When `ScapiHookExecutionEnabled` is disabled, SCAPI requests bypass
-      this hook.
-      
-      
-      
-      
-      **Sample Implementation:**
-      
-      
-      
-      
-      ```
-      function cancel(order) {
-          var Status = require('dw/system/Status');
-          var HTTPClient = require('dw/net/HTTPClient');
-      
-          // 1. Retrieve the external transaction ID stored during commit
-          var taxProviderTransactionId = order.custom.taxProviderTransactionId;
-      
-          if (!taxProviderTransactionId) {
-              // No transaction to cancel - tax was never committed
-              return new Status(Status.OK);
-          }
-      
-          // 2. Build void/cancel request for external tax provider
-          var cancelRequest = {
-              code: order.getOrderNo(),
-              type: 'SalesInvoice'
-          };
-      
-          // 3. Call external tax service to void/cancel the transaction
-          var httpClient = new HTTPClient();
-          httpClient.open('POST', 'https://api.taxprovider.com/transactions/' + taxProviderTransactionId + '/void');
-          httpClient.setRequestHeader('Authorization', 'Bearer ' + apiKey);
-          httpClient.send(JSON.stringify(cancelRequest));
-      
-          if (httpClient.statusCode !== 200 && httpClient.statusCode !== 204) {
-              // Non-blocking error: log warning but allow order cancellation to proceed
-              return new Status(Status.ERROR, 'TAX_CANCEL_FAILED',
-                  'Failed to void tax transaction in provider, order cancellation will proceed. Error: ' + httpClient.errorText);
-          }
-      
-          return new Status(Status.OK);
-      }
-      
-      exports.cancel = cancel;
-      ```
-      
-      
-      
-      **Common APIs used:** dw.net.HTTPClient, `dw.order.Order` (getOrderNo, custom
-      attributes), dw.system.Status.
-
-
-    **Parameters:**
-    - order - the order that has been cancelled and for which tax should be voided.
-
-    **Returns:**
-    - `Status.OK` or `null` for success; `Status.ERROR` to log a warning
-              without blocking the order cancellation. Throwing an exception will roll back the order cancellation
-              operation.
-
-
-
----
-
-### commit(Order)
-- commit(order: [Order](dw.order.Order.md)): [Status](dw.system.Status.md)
-  - : The function is called by extension point [extensionPointAppCommitTax](dw.order.hooks.TaxHooks.md#extensionpointappcommittax) during order creation in the order
-      creation transaction. It notifies the Commerce App tax provider that the order has been successfully created and
-      that tax amounts should be committed to the tax provider. The order is in `CREATED` status at this
-      point (before being placed).
-      
-      
-      **Error Handling:**
-      
-      
-      
-      - **Non-blocking error:**Return `Status.ERROR`. The platform logs the error as a  warning and continues with the order lifecycle. Use this when the tax provider is temporarily unavailable but the  order should still be created.
-      - **Blocking error:**Throw an exception. The platform logs the error and rolls back the order  lifecycle operation, preventing the order from being created.
-      
-      
-      
-      **SCAPI Behavior:** When `ScapiHookExecutionEnabled` is disabled, SCAPI requests bypass
-      this hook.
-      
-      
-      
-      
-      **Sample Implementation:**
-      
-      
-      
-      
-      ```
-      function commit(order) {
-          var Transaction = require('dw/system/Transaction');
-          var Status = require('dw/system/Status');
-          var HTTPClient = require('dw/net/HTTPClient');
-      
-          // 1. Build commit request for external tax provider
-          var commitRequest = {
-              code: order.getOrderNo(), // Use order number as unique transaction ID
-              type: 'SalesInvoice',
-              companyCode: 'DEFAULT',
-              date: order.getCreationDate(),
-              customerCode: order.getCustomerNo(),
-              addresses: {
-                  shipTo: {
-                      line1: order.getDefaultShipment().getShippingAddress().getAddress1(),
-                      city: order.getDefaultShipment().getShippingAddress().getCity(),
-                      region: order.getDefaultShipment().getShippingAddress().getStateCode(),
-                      country: order.getDefaultShipment().getShippingAddress().getCountryCode().getValue(),
-                      postalCode: order.getDefaultShipment().getShippingAddress().getPostalCode()
-                  }
-              },
-              lines: [],
-              commit: true // Tell provider to commit the transaction
-          };
-      
-          // Add order line items
-          var pliIterator = order.getProductLineItems().iterator();
-          while (pliIterator.hasNext()) {
-              var pli = pliIterator.next();
-              commitRequest.lines.push({
-                  itemCode: pli.getProductID(),
-                  quantity: pli.getQuantityValue(),
-                  amount: pli.getAdjustedPrice().getValue(),
-                  tax: pli.getAdjustedTax().getValue()
-              });
-          }
-      
-          // 2. Call external tax service to commit transaction
-          var httpClient = new HTTPClient();
-          httpClient.open('POST', 'https://api.taxprovider.com/transactions');
-          httpClient.setRequestHeader('Authorization', 'Bearer ' + apiKey);
-          httpClient.send(JSON.stringify(commitRequest));
-      
-          if (httpClient.statusCode !== 200 && httpClient.statusCode !== 201) {
-              // Non-blocking error: log warning but allow order to proceed
-              return new Status(Status.ERROR, 'TAX_COMMIT_FAILED',
-                  'Failed to commit tax to provider, order will proceed. Error: ' + httpClient.errorText);
-          }
-      
-          var commitResponse = JSON.parse(httpClient.text);
-      
-          // 3. Store external transaction ID in order custom attribute for later reference (cancel/refund)
-          Transaction.wrap(function() {
-              order.custom.taxProviderTransactionId = commitResponse.id;
-          });
-      
-          return new Status(Status.OK);
-      }
-      
-      exports.commit = commit;
-      ```
-      
-      
-      
-      **Common APIs used:** dw.system.Transaction, dw.net.HTTPClient, `dw.order.Order`
-      (getOrderNo, getProductLineItems, getDefaultShipment, custom attributes), `dw.order.ProductLineItem`
-      (getAdjustedTax).
-
-
-    **Parameters:**
-    - order - the order that has been created and for which tax should be committed.
-
-    **Returns:**
-    - `Status.OK` or `null` for success; `Status.ERROR` to log a warning
-              without blocking the order. Throwing an exception will roll back the order creation.
-
-
-
----
-
-<!-- prettier-ignore-end -->

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

@@ -1,13 +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. |
-| [TaxHooks](dw.order.hooks.TaxHooks.md) | This interface represents tax extension points for Commerce App tax providers. |

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

@@ -1,65 +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. |
-| [LineItemTax](dw.order.LineItemTax.md) | A tax on a line item: tax identifier, rate, and optional amount. |
-| [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. |