Hook Method Details

afterPOST (customer : dw.customer.Customer, authRequestType : dw.value.EnumValue) : dw.system.Status

The function is called after the customer has been authenticated.

beforePOST (authorizationHeader : String, authRequestType : dw.value.EnumValue) : dw.system.Status

The function is called before the customer has been authenticated.

modifyPOSTResponse (customer : dw.customer.Customer, customerResponse : Customer, authRequestType : dw.value.EnumValue) : dw.system.Status

afterMerge (destinationBasket : dw.order.Basket) : dw.system.Status

The function is called after the basket is merged.

afterTransfer (transferredBasket : dw.order.Basket) : dw.system.Status

The function is called after the basket is transferred.

afterDELETE (basketId : String) : dw.system.Status

The function is called after removing a basket.

afterPATCH (basket : dw.order.Basket, basketInput : Basket) : dw.system.Status

The function is called after updating of the basket.

afterPOST (basket : dw.order.Basket) : dw.system.Status

The function is called after the basket was created.

beforeDELETE (basket : dw.order.Basket) : dw.system.Status

The function is called before removing a basket.

beforeGET (basketId : String) : dw.system.Status

The function is called before the request will be processed.

beforePATCH (basket : dw.order.Basket, basketInput : Basket) : dw.system.Status

The function is called before updating of the basket.

beforePOST_v2 (basketRequest : Basket) : dw.system.Status

The function is called before the request will be processed.

afterPUT (basket : dw.order.Basket, billingAddress : OrderAddress) : dw.system.Status

The function is called after setting of the billing address to the basket.

beforePUT (basket : dw.order.Basket, billingAddress : OrderAddress) : dw.system.Status

The function is called before setting of the billing address to the basket.

modifyPUTResponse (basket : dw.order.Basket, basketResponse : Basket, addressRequest : OrderAddress) : dw.system.Status

afterDELETE (basket : dw.order.Basket, couponItemID : String) : dw.system.Status

The function is called after removing a coupon from a basket.

afterPOST (basket : dw.order.Basket, couponItem : Basket, addressRequest : CouponItem) : dw.system.Status

The function is called after adding a coupon to a basket.

beforeDELETE (basket : dw.order.Basket, couponItemID : String) : dw.system.Status

The function is called before removing a coupon from a basket.

beforePOST (basket : dw.order.Basket, couponItem : Basket, addressRequest : CouponItem) : dw.system.Status

The function is called before adding a coupon to a basket.

modifyDELETEResponse (basket : dw.order.Basket, basketResponse : Basket, couponItemId : String) : dw.system.Status

modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket, couponRequest : Basket, addressRequest : CouponItem) : dw.system.Status

afterPUT (basket : dw.order.Basket, customerInfo : CustomerInfo) : dw.system.Status

The function is called after setting of customer information for the basket.

beforePUT (basket : dw.order.Basket, customerInfo : CustomerInfo) : dw.system.Status

The function is called before setting of customer information for the basket.

modifyPUTResponse (basket : dw.order.Basket, basketResponse : Basket, customerRequest : CustomerInfo) : dw.system.Status

afterDELETE (basket : dw.order.Basket, giftCertificateItemId : String) : dw.system.Status

The function is called after deleting a gift certificate item from a basket.

afterPATCH (basket : dw.order.Basket, giftCertificateItemId : String, item : GiftCertificateItem) : dw.system.Status

The function is called after updating a gift certificate item of a basket.

afterPOST (basket : dw.order.Basket, item : GiftCertificateItem) : dw.system.Status

The function is called after adding a gift certificate item to a basket.

beforeDELETE (basket : dw.order.Basket, giftCertificateItemId : String) : dw.system.Status

The function is called before deleting a gift certificate item from a basket.

beforePATCH (basket : dw.order.Basket, giftCertificateItemId : String, item : GiftCertificateItem) : dw.system.Status

The function is called before updating a gift certificate item of a basket.

beforePOST (basket : dw.order.Basket, item : GiftCertificateItem) : dw.system.Status

The function is called before adding a gift certificate item to a basket.

modifyDELETEResponse (basket : dw.order.Basket, basketResponse : Basket, giftCertificateItemId : String) : dw.system.Status

modifyPATCHResponse (basket : dw.order.Basket, basketResponse : Basket, giftCertificateItemId : String) : dw.system.Status

modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket, certificateItemRequest : GiftCertificateItem) : dw.system.Status

afterDELETE (basket : dw.order.Basket, productItemId : String) : dw.system.Status

The function is called after a basket item is removed.

afterPATCH (basket : dw.order.Basket, item : ProductItem) : dw.system.Status

The function is called after updating of the basket's item.

beforeDELETE (basket : dw.order.Basket, productItemId : String) : dw.system.Status

The function is called before a basket item is removed.

beforePATCH (basket : dw.order.Basket, item : ProductItem) : dw.system.Status

The function is called before updating of the basket's item.

modifyDELETEResponse (basket : dw.order.Basket, basketResponse : Basket, productItemId : String) : dw.system.Status

modifyPATCHResponse (basket : dw.order.Basket, basketResponse : Basket, productItemId : String) : dw.system.Status

afterPOST (basket : dw.order.Basket, items : ProductItem) : dw.system.Status

beforePOST (basket : dw.order.Basket, items : ProductItem) : dw.system.Status

modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket, productItems : ProductItem) : dw.system.Status

modifyGETResponse (basket : dw.order.Basket, basketResponse : Basket) : dw.system.Status

modifyPATCHResponse (basket : dw.order.Basket, basketResponse : Basket) : dw.system.Status

modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket) : dw.system.Status

afterDELETE (basket : dw.order.Basket) : dw.system.Status

It is called after the order payment instrument is removed from the basket.

afterPATCH (basket : dw.order.Basket, paymentInstrument : dw.order.OrderPaymentInstrument, paymentInstrumentRequest : BasketPaymentInstrumentRequest) : dw.system.Status

The function is called after updating a payment instrument of a basket.

afterPOST (basket : dw.order.Basket, paymentInstrument : BasketPaymentInstrumentRequest) : dw.system.Status

The function is called after payment instrument adding to a basket.

beforeDELETE (basket : dw.order.Basket, delete : dw.order.OrderPaymentInstrument) : dw.system.Status

It is called before the order payment instrument is removed from the basket.

beforePATCH (basket : dw.order.Basket, paymentInstrument : dw.order.OrderPaymentInstrument, newPaymentInstrument : BasketPaymentInstrumentRequest) : dw.system.Status

The function is called before updating a payment instrument of a basket.

beforePOST (basket : dw.order.Basket, paymentInstrument : BasketPaymentInstrumentRequest) : dw.system.Status

The function is called before payment instrument adding to a basket.

modifyDELETEResponse (basket : dw.order.Basket, basketResponse : Basket, paymentInstrumentId : String) : dw.system.Status

modifyPATCHResponse (basket : dw.order.Basket, basketResponse : Basket, paymentInstrumentId : String) : dw.system.Status

modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket, paymentInstrumentRequest : BasketPaymentInstrumentRequest) : dw.system.Status

afterGET (basket : dw.order.Basket, paymentMethods : PaymentMethodResult) : dw.system.Status

Called before returning the list of available payment methods to the customer. Allowing modifications of the result.

beforeGET (basketId : String) : dw.system.Status

The function is called before the request will be processed.

modifyGETResponse_v2 (basket : dw.order.Basket, paymentMethodResultResponse : PaymentMethodResult) : dw.system.Status

afterDELETE (basket : dw.order.Basket, shipmentId : String) : dw.system.Status

Called after the basket's shipment was removed.

afterPATCH (basket : dw.order.Basket, shipment : dw.order.Shipment, shipmentInfo : Shipment) : dw.system.Status

The function is called after patching of a shipment for a basket.

afterPOST (basket : dw.order.Basket, shipment : Shipment) : dw.system.Status

The function is called after the creation of a shipment for a basket.

beforeDELETE (basket : dw.order.Basket, shipment : dw.order.Shipment) : dw.system.Status

Called before the basket's shipment is removed.

beforePATCH (basket : dw.order.Basket, shipment : dw.order.Shipment, shipmentInfo : Shipment) : dw.system.Status

The function is called before changing of a shipment for a basket.

beforePOST (basket : dw.order.Basket, shipment : Shipment) : dw.system.Status

The function is called before the creation of a shipment for a basket.

modifyDELETEResponse (basket : dw.order.Basket, basketResponse : Basket, shipmentId : String) : dw.system.Status

modifyPATCHResponse (basket : dw.order.Basket, basketResponse : Basket, shipmentId : String) : dw.system.Status

modifyPOSTResponse (basket : dw.order.Basket, basketResponse : Basket, shipmentRequest : Shipment) : dw.system.Status

afterPUT (basket : dw.order.Basket, shipment : dw.order.Shipment, shippingAddress : OrderAddress) : dw.system.Status

The function is called after setting of the shipping address to a certain shipment of the basket.

beforePUT (basket : dw.order.Basket, shipment : dw.order.Shipment, shippingAddress : OrderAddress) : dw.system.Status

The function is called before setting of the shipping address to a certain shipment of the basket.

modifyPUTResponse (basket : dw.order.Basket, basketResponse : Basket, orderAddressRequest : OrderAddress) : dw.system.Status

afterPUT (basket : dw.order.Basket, shipment : dw.order.Shipment, shippingMethod : ShippingMethod) : dw.system.Status

The function is called after setting of the shipping method to a certain shipment of the basket.

beforePUT (basket : dw.order.Basket, shipment : dw.order.Shipment, shippingMethod : ShippingMethod) : dw.system.Status

The function is called before setting of the shipping method to a certain shipment of the basket.

modifyPUTResponse (basket : dw.order.Basket, basketResponse : Basket, shippingMethodRequest : ShippingMethod) : dw.system.Status

beforeGET (basketId : String, shipmentId : String) : dw.system.Status

The function is called before the request will be processed.

modifyGETResponse_v2 (shipment : dw.order.Shipment, shippingMethodResult : ShippingMethodResult) : dw.system.Status

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

validateBasket (basketResponse : Basket, duringSubmit : boolean) : dw.system.Status

Allows the addition of custom flashes or removal of internal flashes. The presence of a flash indicates that the basket cannot yet be submitted. Parameter duringSubmit indicates the current call is during the basket submit process. Default implementation returns ERROR if duringSubmit and any flash exists.

Example showing addition, listing, and removal of flashes:

1exports.validateBasket = function(basketResponse, duringSubmit) {
2  basketResponse.addFlash({
3    type: "MyType",
4    message: "My message",
5    path: "my_path",
6    details: {
7      "k1": "v1",
8      "k2": "v2"
9    }
10  });
11  var flashToRemove;
12  for each(f in basketResponse.flashes) {
13    if (f.type == "SomeOtherType") {
14      flashToRemove = f;
15    }
16  }
17  if (flashToRemove != null) {
18    basketResponse.removeFlash(flashToRemove);
19  }
20};

beforeGET (categoryId : String) : dw.system.Status

The function is called before the request will be processed.

modifyGETResponse (scriptCategory : dw.catalog.Category, doc : Category) : dw.system.Status

The function is called after the request has been processed.

modifyGETResponse (configurationsResponse : object) : dw.system.Status

afterPATCH (customer : dw.customer.Customer, customerInput : Customer) : dw.system.Status

The function is called after a customer was updated.

afterPOST (customer : dw.customer.Customer, registration : CustomerRegistration) : dw.system.Status

The function is called after a new customer registration.

afterPOST (customer : dw.customer.Customer) : dw.system.Status

The function is called after the customer has been authenticated.

beforePOST (customer : dw.customer.Customer) : dw.system.Status

The function is called before the customer has been authenticated.

modifyPOSTResponse (customer : dw.customer.Customer, customerResponse : Customer) : dw.system.Status

beforeGET (customerId : String) : dw.system.Status

The function is called before the request will be processed.

modifyGETResponse_v2 (customer : dw.customer.Customer, customerBasketsResultResponse : BasketsResult) : dw.system.Status

beforeGET (customerId : String) : dw.system.Status

The function is called before the request will be processed.

beforePATCH (customer : dw.customer.Customer, customerInput : Customer) : dw.system.Status

The function is called before a customer is updated.

beforePOST (registration : CustomerRegistration) : dw.system.Status

The function is called before a new customer registration.

modifyGETResponse (customer : dw.customer.Customer, customerResponse : Customer) : dw.system.Status

modifyPATCHResponse (customer : dw.customer.Customer, customerResponse : Customer) : dw.system.Status

modifyPOSTResponse (customer : dw.customer.Customer, customerResponse : Customer) : dw.system.Status

beforeGET (customerId : String) : dw.system.Status

The function is called before the request will be processed.

modifyGETResponse_v2 (customer : dw.customer.Customer, customerOrderResultResponse : CustomerOrderResult) : dw.system.Status

beforePUT (customerId : String) : dw.system.Status

The function is called before updating a customer's password.

afterPUT_v2 (customer : dw.customer.Customer, passwordChangeRequest : PasswordChangeRequest) : dw.system.Status

The function is called to update a customer's password. The default implementation tries to change the authenticated user password to the new password provided in the request. In case of an error, the default implementation returns one of the error statuses listed in dw.customer.Credentials#setPassword(String, String, boolean). To change a password in a third-party system, use a custom implementation. Because the password is updated in this hook, not in the PUT call, if you customize this hook, your custom code must update the password. Otherwise, the password is not updated.

afterPOST (customer : dw.customer.Customer, resetToken : String) : dw.system.Status

Allows resetting a customer password. See the example below sending an email with a password reset link.

1var variables: Map = new dw.util.HashMap();
2variables.put("Customer", customer);
3variables.put("ResetPasswordToken", token);
4var template: Template = new dw.util.Template("mail/resetpasswordemail.isml");
5var content: MimeEncodedText = template.render(variables);
6var mail: Mail = new Mail()
7  .setSubject("Password Reset")
8  .setContent(content)
9  .setFrom("noreply@salesforce.com")
10  .addTo(customer.profile.email);
11mail.send();

beforePOST (customer : dw.customer.Customer) : dw.system.Status

The function is called before the request will be processed.

afterDELETE (customer : dw.customer.Customer, paymentInstrumentId : String) : dw.system.Status

The function is called after removing a payment instrument of a customer.

afterPOST (customer : dw.customer.Customer, paymentInstrument : CustomerPaymentInstrumentRequest) : dw.system.Status

The function is called after a payment instrument was added to a customer.

beforeDELETE (customer : dw.customer.Customer, paymentInstrumentId : String) : dw.system.Status

The function is called before removing a payment instrument of a customer.

beforeGET (customerId : String) : dw.system.Status

The function is called before the request will be processed.

beforePOST (customer : dw.customer.Customer, paymentInstrument : CustomerPaymentInstrumentRequest) : dw.system.Status

The function is called before a payment instrument is added to a customer.

modifyGETResponse (customer : dw.customer.Customer, customerPaymentInstrument : dw.customer.CustomerPaymentInstrument, customerPaymentInstrumentResponse : CustomerPaymentInstrument) : dw.system.Status

modifyPOSTResponse (customer : dw.customer.Customer, customerPaymentInstrument : dw.customer.CustomerPaymentInstrument, customerPaymentInstrumentResponse : CustomerPaymentInstrument) : dw.system.Status

beforeGET (customerId : String, paymentMethodId : String) : dw.system.Status

The function is called before the request will be processed.

modifyGETResponse_v2 (customer : dw.customer.Customer, customerPaymentInstrumentResultResponse : CustomerPaymentInstrumentResult) : dw.system.Status

afterDELETE (customer : dw.customer.Customer, productListId : String) : dw.system.Status

The function is called after a customer product list is deleted.

afterPATCH (customer : dw.customer.Customer, productList : CustomerProductList) : dw.system.Status

The function is called after modifying a customer product list.

beforeDELETE (customer : dw.customer.Customer, productList : dw.customer.ProductList) : dw.system.Status

The function is called before a customer product list is deleted.

beforeGET (customerId : String, productListId : String) : dw.system.Status

The function is called before the request will be processed.

beforePATCH (customer : dw.customer.Customer, productList : CustomerProductList) : dw.system.Status

The function is called before modifying a customer product list.

afterDELETE (customer : dw.customer.Customer, productList : dw.customer.ProductList, itemId : String) : dw.system.Status

The function is called after deleting an item from a customer product list.

afterPATCH (customer : dw.customer.Customer, productList : dw.customer.ProductList, item : CustomerProductListItem) : dw.system.Status

The function is called after updating an item of a customer product list.

beforeDELETE (customer : dw.customer.Customer, productList : dw.customer.ProductList, item : dw.customer.ProductListItem) : dw.system.Status

The function is called before deleting an item from a customer product list.

beforeGET (customerId : String, productListId : String, productListItemId : String) : dw.system.Status

The function is called before the request will be processed.

beforePATCH (customer : dw.customer.Customer, productList : dw.customer.ProductList, item : CustomerProductListItem) : dw.system.Status

The function is called before updating an item of a customer product list.

modifyGETResponse (customer : dw.customer.Customer, productListItem : dw.customer.ProductListItem, customerProductListItemResponse : CustomerProductListItem) : dw.system.Status

modifyPATCHResponse (customer : dw.customer.Customer, productList : dw.customer.ProductList, customerProductListItemResponse : CustomerProductListItem, customerProductListItemRequest : CustomerProductListItem) : dw.system.Status

modifyPOSTResponse (customer : dw.customer.Customer, productList : dw.customer.ProductList, customerProductListItemResponse : CustomerProductListItem, customerProductListItemRequest : CustomerProductListItem) : dw.system.Status

afterPOST (customer : dw.customer.Customer, productList : dw.customer.ProductList, item : CustomerProductListItem) : dw.system.Status

The function is called after adding an item to a customer product list.

beforeGET (customerId : String, productListId : String) : dw.system.Status

The function is called before the request will be processed.

beforePOST (customer : dw.customer.Customer, productList : dw.customer.ProductList, item : CustomerProductListItem) : dw.system.Status

The function is called before adding an item to a customer product list.

modifyGETResponse_v2 (customer : dw.customer.Customer, productList : dw.customer.ProductList, customerProductListItemResultResponse : CustomerProductListItemResult) : dw.system.Status

modifyGETResponse (customer : dw.customer.Customer, productList : dw.customer.ProductList, customerProductListResponse : CustomerProductList) : dw.system.Status