sfcc-dev-mcp 1.0.19 → 1.0.20

package/docs/dw_order.hooks/CalculateHooks.md

@@ -1,77 +0,0 @@
-## Package: dw.order.hooks
-
-# Class CalculateHooks
-
-## Inheritance Hierarchy
-
-- dw.order.hooks.CalculateHooks
-
-## Description
-
-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.
-
-## Constants
-
-## Properties
-
-## Constructor Summary
-
-## Method Summary
-
-### calculate
-
-**Signature:** `calculate(lineItemCtnr : LineItemCtnr) : Status`
-
-The function is called by extension point extensionPointCalculate.
-
-### calculateShipping
-
-**Signature:** `calculateShipping(lineItemCtnr : LineItemCtnr) : Status`
-
-The function is called by extension point extensionPointCalculateShipping.
-
-### calculateTax
-
-**Signature:** `calculateTax(lineItemCtnr : LineItemCtnr) : Status`
-
-The function is called by extension point extensionPointCalculateTax.
-
-## Method Detail
-
-## Method Details
-
-### calculate
-
-**Signature:** `calculate(lineItemCtnr : LineItemCtnr) : Status`
-
-**Description:** The function is called by extension point 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 for tax calculation extensionPointCalculateShipping for shipping calculation
-
-**Parameters:**
-
-- `lineItemCtnr`: the line item container to be (re)calculated.
-
----
-
-### calculateShipping
-
-**Signature:** `calculateShipping(lineItemCtnr : LineItemCtnr) : Status`
-
-**Description:** The function is called by extension point 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
-
-**Signature:** `calculateTax(lineItemCtnr : LineItemCtnr) : Status`
-
-**Description:** The function is called by extension point 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.
-
----

package/docs/dw_order.hooks/OrderHooks.md

@@ -1,41 +0,0 @@
-## Package: dw.order.hooks
-
-# Class OrderHooks
-
-## Inheritance Hierarchy
-
-- dw.order.hooks.OrderHooks
-
-## Description
-
-This interface represents all script hooks that can be registered to customize the order logic. 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.createOrderNo", "script": "./orders.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.
-
-## Constants
-
-## Properties
-
-## Constructor Summary
-
-## Method Summary
-
-### createOrderNo
-
-**Signature:** `createOrderNo() : String`
-
-This hook is responsible for creating a new order number.
-
-## Method Detail
-
-## Method Details
-
-### createOrderNo
-
-**Signature:** `createOrderNo() : String`
-
-**Description:** This hook is responsible for creating a new order number. By default order numbers are generated by using OrderMgr.createOrderSequenceNo(). Use this hook to customize the order number generation. E.g. a prefix or suffix could be added. exports.createOrderNo = function(){ var orderSeqNo = OrderMgr.createOrderSequenceNo(); var prefix = Site.getCurrent().getSiteId(); return prefix + "_"+orderSeqNo; }; If the method returns null or an blank string order number generation will fall back to OrderMgr.createOrderSequenceNo(). The maximum length of the order number is 50 characters.
-
-**Returns:**
-
-the order number
-
----

package/docs/dw_order.hooks/PaymentHooks.md

@@ -1,180 +0,0 @@
-## Package: dw.order.hooks
-
-# Class PaymentHooks
-
-## Inheritance Hierarchy
-
-- dw.order.hooks.PaymentHooks
-
-## Description
-
-This interface represents all script hooks that can be registered to customize the order center payment 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.payment.authorize", "script": "./authorize.js"}, {"name": "dw.order.payment.validateAuthorization", "script": "./validateAuthorization.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.
-
-## Constants
-
-## Properties
-
-## Constructor Summary
-
-## Method Summary
-
-### authorize
-
-**Signature:** `authorize(order : Order, paymentDetails : OrderPaymentInstrument) : Status`
-
-The function is called by extension point extensionPointAuthorize.
-
-### authorizeCreditCard
-
-**Signature:** `authorizeCreditCard(order : Order, paymentDetails : OrderPaymentInstrument, cvn : String) : Status`
-
-The function is called by extension point extensionPointAuthorizeCreditCard.
-
-### capture
-
-**Signature:** `capture(invoice : Invoice) : Status`
-
-The function is called by extension point extensionPointCapture.
-
-### reauthorize
-
-**Signature:** `reauthorize(order : Order) : Status`
-
-The function is called by extension point extensionPointReauthorize.
-
-### refund
-
-**Signature:** `refund(invoice : Invoice) : Status`
-
-The function is called by extension point extensionPointRefund.
-
-### releaseAuthorization
-
-**Signature:** `releaseAuthorization(order : Order) : Status`
-
-The function is called by extension point extensionPointReleaseAuthorization.
-
-### validateAuthorization
-
-**Signature:** `validateAuthorization(order : Order) : Status`
-
-The function is called by extension point extensionPointValidateAuthorization.
-
-## Method Detail
-
-## Method Details
-
-### authorize
-
-**Signature:** `authorize(order : Order, paymentDetails : OrderPaymentInstrument) : Status`
-
-**Description:** The function is called by extension point extensionPointAuthorize. Custom payment authorization - modify the order as needed. Prerequisite: An order has been created using the data api or via the storefront. Return Status.OK: Corresponding payment transaction is marked as authorized (usually a custom property is used for this). Return Status.ERROR: Order is held, authorization needs to be repeated.
-
-**Parameters:**
-
-- `order`: the order
-- `paymentDetails`: specified payment details
-
-**Returns:**
-
-Status.OK successful authorization. Status.ERROR authorization failed.
-
----
-
-### authorizeCreditCard
-
-**Signature:** `authorizeCreditCard(order : Order, paymentDetails : OrderPaymentInstrument, cvn : String) : Status`
-
-**Description:** The function is called by extension point extensionPointAuthorizeCreditCard. Custom payment authorization of a credit card - modify the order as needed. Prerequisite: An order has been created using the data api or via the storefront. Return Status.OK: Corresponding payment transaction is marked as authorized (usually a custom property is used for this). Return Status.ERROR: Order is held, authorization needs to be repeated.
-
-**Parameters:**
-
-- `order`: the order
-- `paymentDetails`: specified payment details
-- `cvn`: the credit card verification number
-
-**Returns:**
-
-Status.OK successful authorization. Status.ERROR authorization failed.
-
----
-
-### capture
-
-**Signature:** `capture(invoice : Invoice) : Status`
-
-**Description:** The function is called by extension point extensionPointCapture. Custom payment capture - modify the order as needed. Prerequisite: [ either ] As a result of shipping (or part-shipping) a shipping -order the warehouse updates the status of the shipping-order resulting in the creation of an unpaid debit invoice (the creation of the invoice is usually handled in ShippingOrderHooks.changeStatus(ShippingOrder, ShippingOrderWO)). [ or ] A unpaid debit invoice has been created using the data api. Context: An unpaid debit invoice is passed to the payment system for capture. The capture attempt can either succeed (complete invoice amount captured) or fail. As a result the invoice status is updated by ordercenter for further processing. See Invoice. Hook responsibility: The hook should attempt to capture the amount located in invoice.grandTotal.grossPrice. When successful, the capture hook should also update the invoice by calling Invoice.addCaptureTransaction(OrderPaymentInstrument, Money) which serves to record the capturedAmount and associate the invoice with the payment-transaction. Return Status.OK: Indicates capture succeeded: Order Center sets the Invoice status to Invoice.STATUS_PAID. Return Status.ERROR: Indicates capture failed: Order Center sets the Invoice status to Invoice.STATUS_FAILED for further processing. Post processing: When the capture hook returns with success, order center not only sets the relevant invoice status, but also sets the relevant capturedAmount values on the invoice item. Returning success means the entire invoice total has been captured, so each item within the invoice can also be marked as completely captured. Note the script implementing the hook can take responsibility for this if desired order center will not overwrite existing values, but normally the standard implementation fits. As a result each invoice item and the related order item can return a capturedAmount, useful for calculating possible refunds.
-
-**Parameters:**
-
-- `invoice`: the invoice
-
-**Returns:**
-
-Status.OK for successful capture of entire invoice amount. Status.ERROR capture failed
-
----
-
-### reauthorize
-
-**Signature:** `reauthorize(order : Order) : Status`
-
-**Description:** The function is called by extension point extensionPointReauthorize. Custom payment authorization - modify the order as needed. Prerequisite: [ either ] Based on a selected Order, a ShippingOrder (which represents the whole or part of the order which can be shipped) is to be created ready for export to the warehouse system. [ or ] A ShippingOrder is to be directly created using the data api. Context: The related order is passed to the payment hook to check its authorization has not become invalid. Two hooks are called: a. validateAuthorization(Order) is used to check the orders authorization is still valid b. reauthorize(Order) is called if step a. returns Error Return Status.OK: Corresponding payment transaction is marked as authorized (usually a custom property is used for this). If the order had been previously authorized, the custom property values may be overwritten during reauthorization. Return Status.ERROR: Order is held, authorization needs to be repeated.
-
-**Parameters:**
-
-- `order`: the order
-
-**Returns:**
-
-Status.OK successful authorization. Status.ERROR authorization failed
-
----
-
-### refund
-
-**Signature:** `refund(invoice : Invoice) : Status`
-
-**Description:** The function is called by extension point extensionPointRefund. Custom payment refund - modify the order as needed. Prerequisite: [ either ] Goods returned by the customer result in the creation of one or more return documents, resulting in the creation of an unpaid customer credit invoice (the creation of the invoice is usually handled in ReturnHooks.changeStatus(Return, ReturnWO)). [ or ] An unpaid customer credit invoice is created using the data api (perhaps as a result of the creation of a customer appeasement). Context: An unpaid credit invoice is passed to the payment system for refund. The refund attempt can either succeed (complete invoice amount refunded) or fail. As a result the invoice status is updated by ordercenter for further processing. See Invoice. Hook responsibility: The hook should attempt to refund the amount located in invoice.grandTotal.grossPrice. When successful, the refund hook should also update the invoice by calling Invoice.addRefundTransaction(OrderPaymentInstrument, Money) which serves to record the refundedAmount and associate the invoice with the payment-transaction. Return Status.OK: Indicates refund succeeded: Order Center sets the Invoice status to Invoice.STATUS_PAID. Return Status.ERROR: Indicates refund failed: Order Center sets the Invoice status to Invoice.STATUS_FAILED for further processing. Post processing: When the refund hook returns with success, order center not only sets the relevant invoice status, but also sets the relevant refundAmount values on the invoice item. Returning success means the entire invoice total has been refunded, so each item within the invoice can also be marked as completely refunded. Note the script implementing the hook can take responsibility for this if desired order center will not overwrite existing values, but normally the standard implementation fits. As a result each invoice item and the related order item can return a refundedAmount, useful for calculating further possible refunds.
-
-**Parameters:**
-
-- `invoice`: the invoice
-
-**Returns:**
-
-Status.OK for successful refund of entire invoice amount. Status.ERROR refund failed
-
----
-
-### releaseAuthorization
-
-**Signature:** `releaseAuthorization(order : Order) : Status`
-
-**Description:** The function is called by extension point extensionPointReleaseAuthorization. Custom payment release authorization - modify the order as needed. Prerequisite: an authorized order is updated resulting in a need to release the remaining authorization. This happens when: - order is cancelled - order is complete after remaining order items are cancelled. Return Status.OK - successful release authorization Return Status.ERROR - failed release authorization
-
-**Parameters:**
-
-- `order`: the order
-
-**Returns:**
-
-Status.OK for successful release authorization. Status.ERROR failed release authorization
-
----
-
-### validateAuthorization
-
-**Signature:** `validateAuthorization(order : Order) : Status`
-
-**Description:** The function is called by extension point extensionPointValidateAuthorization. Custom payment authorization - modify the order as needed. Context: This hook is called to validate whether a payment authorization exists for the order. It should usually check: - Whether the authorize or reauthorize hook was previously successfully executed for the order, e.g. by checking whether custom property has been previously set. - Whether an existing authorization has expired e.g. by comparing a timestamp set on authorization with the current time. Return Status.OK: indicates the order has a valid payment authorization. Return Status.ERROR: indicates reauthorize(Order) should be called. See reauthorize(Order) for more details.
-
-**Parameters:**
-
-- `order`: the order
-
-**Returns:**
-
-Status.OK order has a valid payment authorization. Status.ERROR order has no valid payment authorization, reauthorize(Order) should be called
-
----

package/docs/dw_order.hooks/ReturnHooks.md

@@ -1,135 +0,0 @@
-## Package: dw.order.hooks
-
-# Class ReturnHooks
-
-## Inheritance Hierarchy
-
-- dw.order.hooks.ReturnHooks
-
-## Description
-
-This interface represents all script hooks that can be registered to customizing the order center return resource. 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.return.createReturn", "script": "./returns.ds"}, {"name": "dw.order.return.addReturnItem", "script": "./returns.ds"}, {"name": "dw.order.return.changeStatus", "script": "./returns.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. Overview Return Functionality Business objects ReturnCase All returns exist in the context of a ReturnCase, each Order can have any number of ReturnCases. A ReturnCase has ReturnCaseItems, each of which is associated with an OrderItem (an extension to either a ProductLineItem or a ShippingLineItem). Each ReturnCaseItem defines an ReturnCaseItem.getAuthorizedQuantity() representing the maximum quantity expected to be returned. A ReturnCaseItem may be associated with 0..n ReturnItems - ReturnItems are added to the ReturnCaseItem when Returns are created. Either - a ReturnCase may be used as an RMA, in which case they are created when a customer first shows a wish to return item(s). The customer then includes the RMA number with the returned item(s). The Return created as a result is then associated with the existing ReturnCase. Or - a ReturnCase is automatically created as part of the return creation, i.e. the customer returns some item(s) leading to a creation of both a Return and an associated ReturnCase. The scripting api allows access to the ReturnCases, whether the ReturnCase is an RMA or not, and the ReturnCase status. Both the ReturnCaseItems and any Returns associated with the ReturnCase can be accessed. A ReturnCase has one of these status values: New - the ReturnCase has been created and can be edited previous to its authorization CONFIRMED - the ReturnCase is CONFIRMED, can no longer be edited, no Returns have been associated with it. Only an New- ReturnCase can be CONFIRMED PARTIAL_RETURNED - the ReturnCase has been associated with at least one Return, but is not yet complete. Only an CONFIRMED- ReturnCase can be set to PARTIAL_RETURNED RETURNED - the ReturnCase has been associated with Returns which match the expected authorized quantity. Only an CONFIRMED- or PARTIAL_RETURNED- return-case can be set to RETURNED Cancelled - the ReturnCase has been cancelled (only a New- or CONFIRMED- ReturnCase can be cancelled) Return A Return represents a physical customer return, and contains 1..n ReturnItems. A Return is associated with one ReturnCase, and each ReturnItem is associated with one ReturnCaseItem and (via the ReturnCaseItem) a single OrderItem usually representing an Order ProductLineItem. A ReturnItem records the quantity returned. A Return can have one of these status values: NEW - the Return is new, i.e. needs to undergo a check before it can be marked as COMPLETED COMPLETED - the return is complete, this is a precondition for refunding the customer for a return. Credit Invoice As a result of making a Return, the customer may be refunded. The refund amount is held in a credit Invoice which may be associated either with one Return or with one ReturnCase. The Invoice is passed to the refund payment hook allowing custom code to handle the payment refund. Process overview Create ReturnCase The creation of ReturnCases is supported using the data-api. The api supports, within the context of an Order, the specification of an (optional) RMA-number and addition of ReturnCaseItems for a given order-item and quantity. Authorize ReturnCase Following its creation, a ReturnCase needs to be CONFIRMED - an CONFIRMED ReturnCase cannot be modified. Cancel ReturnCase Following its creation or authorization, a ReturnCase may be cancelled. Create Return Returns may be imported or created via the data-api. These apis specify an (optional) RMA allowing a Return to be associated with a ReturnCase, and ReturnItems with a quantity and a key allowing them to be associated with an order-item. The process is delegated to custom scripts which control the creation of the Return and the addition of the ReturnItems: Hook extensionPointCreateReturn The creation of the new Return is delegated to the custom script when this hook is called, passing the order, and details of the Return to be created to the script. Typically the script accesses the ReturnCase from the order and creates the return with the provided return-number. It may also update the Order, ReturnCase or Return using custom values passed in the Return details. exports.createReturn = function (order:Order, returnDetails) { var returnNumber=returnDetails.returnNumber; var returnCase = order.getReturnCase(returnDetails.returnCaseNumber); var newReturn = returnCase.createReturn(returnNumber); return newReturn; } Hook extensionPointAddReturnItem This call delegates the creation of individual ReturnItems to a custom script, passing the Order, returnNumber, returnCaseItemId and return-item-details. Typically the script will access the ReturnCaseItem from the order and create a new ReturnItem for it. exports.addReturnItem = function (retrn:Return, returnItemDetails) { var returnCaseItem = order.getReturnCaseItem(returnCaseItemId); var item = returnCaseItem.createReturnItem(returnNr); Hook extensionPointChangeStatus This call delegates the update of the return-status to a custom script, passing the Order, returnNumber and new status. The custom script is responsible for setting the status and taking any other actions necessary, including the possibility of creating a credit invoice: changeStatus = function (retrn:Return, status) { retrn.status=status; Hook extensionPointAfterStatusChange This call delegates the update of the return-status to a custom script, passing the Order, returnNumber and new status. The custom script is responsible for setting the status and taking any other actions necessary, including the possibility of creating a credit invoice: changeStatus = function (retrn:Return, status) { retrn.status=status; 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.
-
-## Constants
-
-## Properties
-
-## Constructor Summary
-
-## Method Summary
-
-### addReturnItem
-
-**Signature:** `addReturnItem(retrn : Return, inputData : ReturnItem) : Status`
-
-The hook provides customization in the process of assigning the returned amount, quantity etc.
-
-### afterStatusChange
-
-**Signature:** `afterStatusChange(retrn : Return) : Status`
-
-Called after method changeStatus(Return, ReturnWO) returns Status.OK.
-
-### changeStatus
-
-**Signature:** `changeStatus(retrn : Return, inputData : Return) : Status`
-
-Responsible to change the status of a Return: the custom script is responsible for setting the new status using Return.setStatus(String).
-
-### createReturn
-
-**Signature:** `createReturn(inputData : Return) : Return`
-
-This hook is responsible for creating a new Return, based on a ReturnCase.
-
-### notifyStatusChange
-
-**Signature:** `notifyStatusChange(retrn : Return) : Status`
-
-Called after method changeStatus(Return, ReturnWO) returns Status.OK (and after method afterStatusChange(Return)) to inform of a successful status change.
-
-## Method Detail
-
-## Method Details
-
-### addReturnItem
-
-**Signature:** `addReturnItem(retrn : Return, inputData : ReturnItem) : Status`
-
-**Description:** The hook provides customization in the process of assigning the returned amount, quantity etc. Here it is possible to refund differently based on the return reason code for example. Also one could correct the inventory based on the return information. Utilize ReturnCaseItem.createReturnItem(String) to create a new ReturnItem.
-
-**Parameters:**
-
-- `retrn`: the return for which an return item should be created
-- `inputData`: the return item
-
-**Returns:**
-
-Status.OK return item is successfully added Status.ERROR return item addition failed.
-
----
-
-### afterStatusChange
-
-**Signature:** `afterStatusChange(retrn : Return) : Status`
-
-**Description:** Called after method changeStatus(Return, ReturnWO) returns Status.OK. The call is made in a separate database transaction allowing the script implementation to make an independent remote call if desired.
-
-**Parameters:**
-
-- `retrn`: the return
-
-**Returns:**
-
-Status.OK status successful Status.ERROR on failure
-
----
-
-### changeStatus
-
-**Signature:** `changeStatus(retrn : Return, inputData : Return) : Status`
-
-**Description:** Responsible to change the status of a Return: the custom script is responsible for setting the new status using Return.setStatus(String). The invoice handling should be implemented here using Return.createInvoice(String) or ReturnCase.createInvoice(String). For example create an Invoice for a Return moving to status Return.STATUS_COMPLETED.
-
-**Parameters:**
-
-- `retrn`: the return which status should change
-- `inputData`: the data in which the new status is included
-
-**Returns:**
-
-Status.OK status successfully changed Status.ERROR status not changed.
-
----
-
-### createReturn
-
-**Signature:** `createReturn(inputData : Return) : Return`
-
-**Description:** This hook is responsible for creating a new Return, based on a ReturnCase. 2 basic workflows are supported: On-the-fly return: create the parent ReturnCase using Order.createReturnCase(String, Boolean). Return-merchandise-authorization (RMA) workflow: resolve an existing ReturnCase using Order.getReturnCase(String). In both cases use this method to create the Return based on the inputData. Additional functionality like creating history entry, handling the return fees or the shipping cost credit can be implemented in the hook after the Return is created.
-
-**Parameters:**
-
-- `inputData`: the return
-
-**Returns:**
-
-the created return
-
----
-
-### notifyStatusChange
-
-**Signature:** `notifyStatusChange(retrn : Return) : Status`
-
-**Description:** Called after method changeStatus(Return, ReturnWO) returns Status.OK (and after method afterStatusChange(Return)) to inform of a successful status change. The call is made outside any database transaction. This is the best hook in which to send customer notifications as the status change has already been successfully written to the database
-
-**Parameters:**
-
-- `retrn`: the return
-
-**Returns:**
-
-Status.OK status successful Status.ERROR on failure
-
----