RequiredItemAdjustPriceCy
Use the RequiredItemAdjustPriceCy pipeline component to make sure that the current price for each item in the order is set and that it has not been changed.
For more information, see Currency Enhancements.
Intended use: Order Processing pipeline, Item Adjust Price stage.
Configuration Values
None.
Values Read
The RequiredItemAdjustPriceCy pipeline component reads the following values from the indicated dictionaries.
Key |
Dictionary |
Description |
|---|---|---|
item._cy_iadjust_currentprice |
Order |
Reads the current price of each item in the items collection in the Order dictionary. |
item._cy_iadjust_regularprice |
Order |
Reads the regular price of each item in the items collection in the Order dictionary. |
item.cy_placed_price |
Order |
Reads the placed price of each item in the items collection in the Order dictionary. For more information, see the Remarks section. |
MessageManager.pur_badplacedprice |
Context |
The error message text (optional). |
Values Written
The RequiredItemAdjustPriceCy pipeline component writes the following values to the Order dictionary.
Key |
Description |
|---|---|
item.cy_placed_price |
Writes the placed price of an item in the items collection in the Order dictionary. For more information, see the Remarks section. |
item._cy_iadjust_currentprice |
Writes the adjusted current price of an item in the items collection in the Order dictionary. |
_Basket_Errors |
Error messages are written to this SimpleList object. |
Errors
The RequiredItemAdjustPriceCy component returns error level 2 (OPPERRORLEV_WARN) when the placed price is not equal to the current price. Other errors return error level 3 (OPPERRORLEV_FAIL).
This component writes error messages to the _Basket_Errors collection. This component uses a MessageManager object to retrieve user warning message text.
Constant |
Condition |
|---|---|
pur_badplacedprice |
The placed price is not equal to the current price — the current price has changed since the item was added to the basket. |
Remarks
The RequiredItemAdjustPriceCy pipeline component verifies that the current price (_cy_iadjust_currentprice) exists for each item in the items list. If this value does not exist, the component creates it and initializes it to the regular price (_cy_iadjust_regularprice).
In addition, the RequiredItemAdjustPriceCy pipeline component checks the placed price (cy_placed_price) against the current price (cy_iadjust_currentprice) to see whether the current price has changed since the user placed the item in the basket. If the placed price does not exist, the component creates it and sets it to the current price (cy_iadjust_currentprice). If the placed price exists, but is not equal to the current price, the RequiredItemAdjustPriceCy pipeline component retrieves the warning message text for a bad placed price from the MessageManager object, and writes this message to the _Basket_Errors collection of the order form.