The Abandoned Order Services module includes the following scenario actions to respond to user activity on abandoned orders:
All of the scenario actions listed above are utilized in the Abandoned Orders scenario that is provide out-of-the-box. For information on this scenario, see the Managing Abandoned Orders chapter in the Guide to Setting Up a Store.
Set Order’s Last Updated Date
This action checks whether the given order has an abandonmentInfo
item and, if it does not, creates one and associates it with the order. It then updates the orderLastUpdated
property of the order’s abandonmentInfo
item with the current date and time.
Action Registry Tag | Value |
---|---|
action name | Set Last Updated |
configuration component |
|
action execution policy | individual |
action error response | continue |
The Set Order’s Last Updated Date action has the following parameters:
Parameter | Required? | Description |
---|---|---|
| yes | The ID of the order that has been modified by the user. |
See also SetLastUpdatedDroplet in Appendix: Core Commerce Servlet Beans of the Guide to Setting Up a Store.
Reanimate Abandoned Order
This action reanimates an abandoned or lost order. More specifically, it does the following:
Removes the order from the list of abandoned orders in the user’s
abandonedOrders
profile property if the order is abandoned and not lost.Modifies the order’s
abandonmentInfo
item as follows:Sets the
state
property to REANIMATED.Sets the
reanimationDate
property to the current date and time.
Fires an
AbandonedOrderReanimated
message if theAbandonedOrderTools.sendOrderReanimatedMessage
property is set totrue
.
Note that if the given order is not abandoned or lost, the action does nothing.
Action Registry Tag | Value |
---|---|
action name | Reanimate Abandoned Order |
configuration component |
|
action execution policy | individual |
action error response | continue |
The Reanimate Abandoned Order action has the following parameters:
Parameter | Required? | Description |
---|---|---|
| yes | The ID of the reanimated order. |
See also ReanimateAbandonedOrderDroplet in Appendix: Core Commerce Servlet Beans of the Guide to Setting Up a Store.
Convert Abandoned Order
This action converts an abandoned, reanimated, or lost order. More specifically, it does the following:
Removes the order from the list of abandoned orders in the user’s
abandonedOrders
profile property if the order was abandoned and not lost or reanimated.Modifies the order’s
abandonmentInfo
item as follows:Sets the
state
property to CONVERTED.Sets the
conversionDate
property to the current date and time.
Fires an
AbandonedOrderConverted
message if theAbandonedOrderTools.sendOrderConvertedMessage
property is set totrue
.
Note that if the state
property in the order’s abandonmentInfo
item is null, then the order has never been abandoned, and the action does nothing.
Action Registry Tag | Value |
---|---|
action name | Convert Abandoned Order |
configuration component |
|
action execution policy | individual |
action error response | continue |
The Convert Abandoned Order action has the following parameters:
Parameter | Required? | Description |
---|---|---|
| yes | The ID of the converted order. |
See also ConvertAbandonedOrderDroplet in Appendix: Core Commerce Servlet Beans of the Guide to Setting Up a Store.
Log Promotion Information
This action logs promotion-related information for a converted order. It calculates the number and total value of the promotions applied to the converted order and stores the information in a convertedOrder
item in the AbandonedOrderRepository
.
Action Registry Tag | Value |
---|---|
action name | Log Promotion Information |
configuration component |
|
action execution policy | individual |
action error response | continue |
The Log Promotion Information action has the following parameters:
Parameter | Required? | Description |
---|---|---|
| yes | The ID of the order whose promotion information is to be logged. |