@salesforce/b2c-tooling-sdk 0.0.1 → 0.0.2

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

@@ -0,0 +1,261 @@
+<!-- prettier-ignore-start -->
+# Class TrackingInfo
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.object.Extensible](dw.object.Extensible.md)
+    - [dw.order.TrackingInfo](dw.order.TrackingInfo.md)
+
+Provides basic information about a tracking info. An instance is identified by an ID and can be referenced from n ShippingOrderItems
+using [TrackingRef](dw.order.TrackingRef.md)s. This also allows one [ShippingOrderItem](dw.order.ShippingOrderItem.md) to be associated with n TrackingInfo.
+
+
+**See Also:**
+- [ShippingOrder.addTrackingInfo(String)](dw.order.ShippingOrder.md#addtrackinginfostring)
+- [ShippingOrderItem.addTrackingRef(String, Quantity)](dw.order.ShippingOrderItem.md#addtrackingrefstring-quantity)
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [ID](#id): [String](TopLevel.String.md) `(read-only)` | Get the mandatory identifier for this tracking information. |
+| [carrier](#carrier): [String](TopLevel.String.md) | Get the Carrier. |
+| [carrierService](#carrierservice): [String](TopLevel.String.md) | Get the service(ship method) of the used carrier. |
+| [shipDate](#shipdate): [Date](TopLevel.Date.md) | Get the ship date. |
+| [shippingOrder](#shippingorder): [ShippingOrder](dw.order.ShippingOrder.md) `(read-only)` | Gets the shipping order. |
+| [trackingNumber](#trackingnumber): [String](TopLevel.String.md) | Get the tracking number. |
+| [trackingRefs](#trackingrefs): [Collection](dw.util.Collection.md) `(read-only)` | Gets the tracking refs (shipping order items) which are assigned to this tracking info. |
+| [warehouseID](#warehouseid): [String](TopLevel.String.md) | Get the id of the shipping warehouse. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getCarrier](dw.order.TrackingInfo.md#getcarrier)() | Get the Carrier. |
+| [getCarrierService](dw.order.TrackingInfo.md#getcarrierservice)() | Get the service(ship method) of the used carrier. |
+| [getID](dw.order.TrackingInfo.md#getid)() | Get the mandatory identifier for this tracking information. |
+| [getShipDate](dw.order.TrackingInfo.md#getshipdate)() | Get the ship date. |
+| [getShippingOrder](dw.order.TrackingInfo.md#getshippingorder)() | Gets the shipping order. |
+| [getTrackingNumber](dw.order.TrackingInfo.md#gettrackingnumber)() | Get the tracking number. |
+| [getTrackingRefs](dw.order.TrackingInfo.md#gettrackingrefs)() | Gets the tracking refs (shipping order items) which are assigned to this tracking info. |
+| [getWarehouseID](dw.order.TrackingInfo.md#getwarehouseid)() | Get the id of the shipping warehouse. |
+| [setCarrier](dw.order.TrackingInfo.md#setcarrierstring)([String](TopLevel.String.md)) | Set the Carrier. |
+| [setCarrierService](dw.order.TrackingInfo.md#setcarrierservicestring)([String](TopLevel.String.md)) | Set the service(ship method) of the used carrier. |
+| [setShipDate](dw.order.TrackingInfo.md#setshipdatedate)([Date](TopLevel.Date.md)) | Set the ship date. |
+| [setTrackingNumber](dw.order.TrackingInfo.md#settrackingnumberstring)([String](TopLevel.String.md)) | Set the TrackingNumber. |
+| [setWarehouseID](dw.order.TrackingInfo.md#setwarehouseidstring)([String](TopLevel.String.md)) | Set the id of the shipping warehouse. |
+
+### Methods inherited from class Extensible
+
+[describe](dw.object.Extensible.md#describe), [getCustom](dw.object.Extensible.md#getcustom)
+### 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
+
+### ID
+- ID: [String](TopLevel.String.md) `(read-only)`
+  - : Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from
+      [TrackingRef](dw.order.TrackingRef.md)s. To support short shipping a shipping-order-item can manage a list of
+      TrackingRefs, each with an optional quantity value allowing individual items to ship in multiple
+      parcels with known item quantity in each.
+
+
+    **See Also:**
+    - [ShippingOrder.addTrackingInfo(String)](dw.order.ShippingOrder.md#addtrackinginfostring)
+
+
+---
+
+### carrier
+- carrier: [String](TopLevel.String.md)
+  - : Get the Carrier.
+
+
+---
+
+### carrierService
+- carrierService: [String](TopLevel.String.md)
+  - : Get the service(ship method) of the used carrier.
+
+
+---
+
+### shipDate
+- shipDate: [Date](TopLevel.Date.md)
+  - : Get the ship date.
+
+
+---
+
+### shippingOrder
+- shippingOrder: [ShippingOrder](dw.order.ShippingOrder.md) `(read-only)`
+  - : Gets the shipping order.
+
+
+---
+
+### trackingNumber
+- trackingNumber: [String](TopLevel.String.md)
+  - : Get the tracking number.
+
+
+---
+
+### trackingRefs
+- trackingRefs: [Collection](dw.util.Collection.md) `(read-only)`
+  - : Gets the tracking refs (shipping order items) which are assigned to this tracking info.
+
+
+---
+
+### warehouseID
+- warehouseID: [String](TopLevel.String.md)
+  - : Get the id of the shipping warehouse.
+
+
+---
+
+## Method Details
+
+### getCarrier()
+- getCarrier(): [String](TopLevel.String.md)
+  - : Get the Carrier.
+
+    **Returns:**
+    - the Carrier
+
+
+---
+
+### getCarrierService()
+- getCarrierService(): [String](TopLevel.String.md)
+  - : Get the service(ship method) of the used carrier.
+
+    **Returns:**
+    - the carrier service (ship method)
+
+
+---
+
+### getID()
+- getID(): [String](TopLevel.String.md)
+  - : Get the mandatory identifier for this tracking information. The id allows the tracking information to be referenced from
+      [TrackingRef](dw.order.TrackingRef.md)s. To support short shipping a shipping-order-item can manage a list of
+      TrackingRefs, each with an optional quantity value allowing individual items to ship in multiple
+      parcels with known item quantity in each.
+
+
+    **Returns:**
+    - the id
+
+    **See Also:**
+    - [ShippingOrder.addTrackingInfo(String)](dw.order.ShippingOrder.md#addtrackinginfostring)
+
+
+---
+
+### getShipDate()
+- getShipDate(): [Date](TopLevel.Date.md)
+  - : Get the ship date.
+
+    **Returns:**
+    - the ship date
+
+
+---
+
+### getShippingOrder()
+- getShippingOrder(): [ShippingOrder](dw.order.ShippingOrder.md)
+  - : Gets the shipping order.
+
+    **Returns:**
+    - the shipping order
+
+
+---
+
+### getTrackingNumber()
+- getTrackingNumber(): [String](TopLevel.String.md)
+  - : Get the tracking number.
+
+    **Returns:**
+    - the TrackingNumber
+
+
+---
+
+### getTrackingRefs()
+- getTrackingRefs(): [Collection](dw.util.Collection.md)
+  - : Gets the tracking refs (shipping order items) which are assigned to this tracking info.
+
+    **Returns:**
+    - the tracking refs (shipping order items) which are assigned to this tracking info.
+
+
+---
+
+### getWarehouseID()
+- getWarehouseID(): [String](TopLevel.String.md)
+  - : Get the id of the shipping warehouse.
+
+    **Returns:**
+    - the id of the shipping warehouse
+
+
+---
+
+### setCarrier(String)
+- setCarrier(carrier: [String](TopLevel.String.md)): void
+  - : Set the Carrier.
+
+    **Parameters:**
+    - carrier - the Carrier
+
+
+---
+
+### setCarrierService(String)
+- setCarrierService(carrierService: [String](TopLevel.String.md)): void
+  - : Set the service(ship method) of the used carrier.
+
+    **Parameters:**
+    - carrierService - the carrier service, eg. the ship method
+
+
+---
+
+### setShipDate(Date)
+- setShipDate(shipDate: [Date](TopLevel.Date.md)): void
+  - : Set the ship date.
+
+    **Parameters:**
+    - shipDate - the ship date
+
+
+---
+
+### setTrackingNumber(String)
+- setTrackingNumber(trackingNumber: [String](TopLevel.String.md)): void
+  - : Set the TrackingNumber.
+
+    **Parameters:**
+    - trackingNumber - the TrackingNumber
+
+
+---
+
+### setWarehouseID(String)
+- setWarehouseID(warehouseID: [String](TopLevel.String.md)): void
+  - : Set the id of the shipping warehouse.
+
+    **Parameters:**
+    - warehouseID - the id of the shipping warehouse
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,108 @@
+<!-- prettier-ignore-start -->
+# Class TrackingRef
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.order.TrackingRef](dw.order.TrackingRef.md)
+
+Provides basic information about the [TrackingInfo](dw.order.TrackingInfo.md) a
+[ShippingOrderItem](dw.order.ShippingOrderItem.md) is contained.
+
+
+
+## Property Summary
+
+| Property | Description |
+| --- | --- |
+| [quantity](#quantity): [Quantity](dw.value.Quantity.md) | Gets the quantity, the shipping order item is assigned to the tracking  info. |
+| [shippingOrderItem](#shippingorderitem): [ShippingOrderItem](dw.order.ShippingOrderItem.md) `(read-only)` | Gets the shipping order item which is assigned to the tracking info. |
+| [trackingInfo](#trackinginfo): [TrackingInfo](dw.order.TrackingInfo.md) `(read-only)` | Gets the tracking info, the shipping order item is assigned to. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [getQuantity](dw.order.TrackingRef.md#getquantity)() | Gets the quantity, the shipping order item is assigned to the tracking  info. |
+| [getShippingOrderItem](dw.order.TrackingRef.md#getshippingorderitem)() | Gets the shipping order item which is assigned to the tracking info. |
+| [getTrackingInfo](dw.order.TrackingRef.md#gettrackinginfo)() | Gets the tracking info, the shipping order item is assigned to. |
+| [setQuantity](dw.order.TrackingRef.md#setquantityquantity)([Quantity](dw.value.Quantity.md)) | Sets the quantity, the shipping order item is assigned to the tracking  info. |
+
+### 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
+
+### quantity
+- quantity: [Quantity](dw.value.Quantity.md)
+  - : Gets the quantity, the shipping order item is assigned to the tracking
+      info.
+
+
+
+---
+
+### shippingOrderItem
+- shippingOrderItem: [ShippingOrderItem](dw.order.ShippingOrderItem.md) `(read-only)`
+  - : Gets the shipping order item which is assigned to the tracking info.
+
+
+---
+
+### trackingInfo
+- trackingInfo: [TrackingInfo](dw.order.TrackingInfo.md) `(read-only)`
+  - : Gets the tracking info, the shipping order item is assigned to.
+
+
+---
+
+## Method Details
+
+### getQuantity()
+- getQuantity(): [Quantity](dw.value.Quantity.md)
+  - : Gets the quantity, the shipping order item is assigned to the tracking
+      info.
+
+
+    **Returns:**
+    - the quantity the shipping order item is assigned to the tracking
+              info.
+
+
+
+---
+
+### getShippingOrderItem()
+- getShippingOrderItem(): [ShippingOrderItem](dw.order.ShippingOrderItem.md)
+  - : Gets the shipping order item which is assigned to the tracking info.
+
+    **Returns:**
+    - the shipping order item
+
+
+---
+
+### getTrackingInfo()
+- getTrackingInfo(): [TrackingInfo](dw.order.TrackingInfo.md)
+  - : Gets the tracking info, the shipping order item is assigned to.
+
+    **Returns:**
+    - the tracking info
+
+
+---
+
+### setQuantity(Quantity)
+- setQuantity(quantity: [Quantity](dw.value.Quantity.md)): void
+  - : Sets the quantity, the shipping order item is assigned to the tracking
+      info.
+
+
+    **Parameters:**
+    - quantity - the quantity, the shipping order item is assigned to the             tracking info.
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,87 @@
+<!-- prettier-ignore-start -->
+# Class BasketMergeHooks
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.order.hooks.BasketMergeHooks](dw.order.hooks.BasketMergeHooks.md)
+
+This interface represents all script hooks that can be registered to merge baskets. 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.mergeBasket", "script": "./mergeBasket.js"}
+]
+```
+
+
+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.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [extensionPointMerge](#extensionpointmerge): [String](TopLevel.String.md) = "dw.order.mergeBasket" | The extension point name dw.order.mergeBasket. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [mergeBasket](dw.order.hooks.BasketMergeHooks.md#mergebasketbasket-basket)([Basket](dw.order.Basket.md), [Basket](dw.order.Basket.md)) | Merges content from a source basket (typically a former registered shopper's basket) into the current basket  (usually a former guest shopper's basket that was transferred to the registered shopper). |
+
+### 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
+
+### extensionPointMerge
+
+- extensionPointMerge: [String](TopLevel.String.md) = "dw.order.mergeBasket"
+  - : The extension point name dw.order.mergeBasket.
+
+
+---
+
+## Method Details
+
+### mergeBasket(Basket, Basket)
+- mergeBasket(source: [Basket](dw.order.Basket.md), currentBasket: [Basket](dw.order.Basket.md)): [Status](dw.system.Status.md)
+  - : Merges content from a source basket (typically a former registered shopper's basket) into the current basket
+      (usually a former guest shopper's basket that was transferred to the registered shopper).
+      
+      
+      If no override script is registered, the system defaults to the platform's standard basket merging logic.
+      
+      
+      This method is automatically invoked after a successful execution of the /transfer REST API with the query
+      parameter merge=true, if either the guest or the registered users had baskets assigned. The registered shopper's
+      basket will be the source for the merge, and the transferred guest shopper's basket will be the current basket.
+
+
+    **Parameters:**
+    - source - the basket from which data will be merged into the current basket. Will be `null` if the             former guest shopper did not have an assigned basket.
+    - currentBasket - the current basket to merge data into
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,139 @@
+<!-- prettier-ignore-start -->
+# Class CalculateHooks
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.order.hooks.CalculateHooks](dw.order.hooks.CalculateHooks.md)
+
+This interface represents all script hooks that can be registered to customize the order and basket calculation
+functionality. 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.calculate", "script": "./calculate.js"}
+]
+```
+
+
+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.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [extensionPointCalculate](#extensionpointcalculate): [String](TopLevel.String.md) = "dw.order.calculate" | The extension point name dw.order.calculate. |
+| [extensionPointCalculateShipping](#extensionpointcalculateshipping): [String](TopLevel.String.md) = "dw.order.calculateShipping" | The extension point name dw.order.calculateShipping. |
+| [extensionPointCalculateTax](#extensionpointcalculatetax): [String](TopLevel.String.md) = "dw.order.calculateTax" | The extension point name dw.order.calculateTax. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [calculate](dw.order.hooks.CalculateHooks.md#calculatelineitemctnr)([LineItemCtnr](dw.order.LineItemCtnr.md)) | The function is called by extension point [extensionPointCalculate](dw.order.hooks.CalculateHooks.md#extensionpointcalculate). |
+| [calculateShipping](dw.order.hooks.CalculateHooks.md#calculateshippinglineitemctnr)([LineItemCtnr](dw.order.LineItemCtnr.md)) | The function is called by extension point [extensionPointCalculateShipping](dw.order.hooks.CalculateHooks.md#extensionpointcalculateshipping). |
+| [calculateTax](dw.order.hooks.CalculateHooks.md#calculatetaxlineitemctnr)([LineItemCtnr](dw.order.LineItemCtnr.md)) | The function is called by extension point [extensionPointCalculateTax](dw.order.hooks.CalculateHooks.md#extensionpointcalculatetax). |
+
+### 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
+
+### extensionPointCalculate
+
+- extensionPointCalculate: [String](TopLevel.String.md) = "dw.order.calculate"
+  - : The extension point name dw.order.calculate.
+
+
+---
+
+### extensionPointCalculateShipping
+
+- extensionPointCalculateShipping: [String](TopLevel.String.md) = "dw.order.calculateShipping"
+  - : The extension point name dw.order.calculateShipping.
+
+
+---
+
+### extensionPointCalculateTax
+
+- extensionPointCalculateTax: [String](TopLevel.String.md) = "dw.order.calculateTax"
+  - : The extension point name dw.order.calculateTax.
+
+
+---
+
+## Method Details
+
+### calculate(LineItemCtnr)
+- calculate(lineItemCtnr: [LineItemCtnr](dw.order.LineItemCtnr.md)): [Status](dw.system.Status.md)
+  - : The function is called by extension point [extensionPointCalculate](dw.order.hooks.CalculateHooks.md#extensionpointcalculate). It provides a single place for
+      the line item container calculation.
+      
+      
+      To provide a fallback for existing implementations, the default implementation calls the hook
+      dw.ocapi.shop.basket.calculate. However, this hook is deprecated, and calling it will create entries in the
+      deprecated API usage logs. You should override this function to use dw.order.calculate instead.
+      
+      
+      
+      
+      If you provide your own implementation, you should provide and use the following hooks. Best practice is
+      to use the hook manager to retrieve them in the calculate hook, and avoid calling them directly.
+      
+      
+      
+      - [extensionPointCalculateTax](dw.order.hooks.CalculateHooks.md#extensionpointcalculatetax)for tax calculation
+      - [extensionPointCalculateShipping](dw.order.hooks.CalculateHooks.md#extensionpointcalculateshipping)for shipping calculation
+
+
+    **Parameters:**
+    - lineItemCtnr - the line item container to be (re)calculated.
+
+
+---
+
+### calculateShipping(LineItemCtnr)
+- calculateShipping(lineItemCtnr: [LineItemCtnr](dw.order.LineItemCtnr.md)): [Status](dw.system.Status.md)
+  - : The function is called by extension point [extensionPointCalculateShipping](dw.order.hooks.CalculateHooks.md#extensionpointcalculateshipping). It provides a single
+      place for shipping calculation during the line item container calculation.
+
+
+    **Parameters:**
+    - lineItemCtnr - the line item container to be (re)calculated.
+
+
+---
+
+### calculateTax(LineItemCtnr)
+- calculateTax(lineItemCtnr: [LineItemCtnr](dw.order.LineItemCtnr.md)): [Status](dw.system.Status.md)
+  - : The function is called by extension point [extensionPointCalculateTax](dw.order.hooks.CalculateHooks.md#extensionpointcalculatetax). It provides a single place
+      for tax calculation during the line item container calculation.
+
+
+    **Parameters:**
+    - lineItemCtnr - the line item container to be (re)calculated.
+
+
+---
+
+<!-- prettier-ignore-end -->

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

@@ -0,0 +1,88 @@
+<!-- prettier-ignore-start -->
+# Class CheckoutHooks
+
+- [TopLevel.Object](TopLevel.Object.md)
+  - [dw.order.hooks.CheckoutHooks](dw.order.hooks.CheckoutHooks.md)
+
+This interface represents script hooks that can be registered to populate customer details into a basket. 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.populateCustomerDetails", "script": "./populateCustomerDetails.js"}
+]
+```
+
+
+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.
+
+
+
+## Constant Summary
+
+| Constant | Description |
+| --- | --- |
+| [extensionPointPopulateCustomerDetails](#extensionpointpopulatecustomerdetails): [String](TopLevel.String.md) = "dw.order.populateCustomerDetails" | The extension point name dw.order.populateCustomerDetails. |
+
+## Constructor Summary
+
+This class does not have a constructor, so you cannot create it directly.
+## Method Summary
+
+| Method | Description |
+| --- | --- |
+| [populateCustomerDetails](dw.order.hooks.CheckoutHooks.md#populatecustomerdetailsbasket-customer)([Basket](dw.order.Basket.md), [Customer](dw.customer.Customer.md)) | Populates registered customer details into a basket. |
+
+### 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
+
+### extensionPointPopulateCustomerDetails
+
+- extensionPointPopulateCustomerDetails: [String](TopLevel.String.md) = "dw.order.populateCustomerDetails"
+  - : The extension point name dw.order.populateCustomerDetails.
+
+
+---
+
+## Method Details
+
+### populateCustomerDetails(Basket, Customer)
+- populateCustomerDetails(basket: [Basket](dw.order.Basket.md), customer: [Customer](dw.customer.Customer.md)): [Status](dw.system.Status.md)
+  - : Populates registered customer details into a basket. This includes the default shipping address and default
+      payment instrument from the registered customer's profile.
+      
+      
+      If no override script is registered, the system defaults to the platform's standard population logic which copies
+      the customer's default or first address to the basket's default shipment and billing address, then creates a
+      payment instrument from the customer's default or first payment instrument.
+      
+      
+      This method is automatically invoked when the populateCustomerDetails query parameter is set to
+      true on createBasket and transferBasket endpoints.
+
+
+    **Parameters:**
+    - basket - the basket to populate with customer details
+    - customer - the registered customer whose details should be populated into the basket
+
+
+---
+
+<!-- prettier-ignore-end -->