RequiredShippingCy
Use the RequiredShippingCy pipeline component to verify that the shipping total has been set.
For more information, see Currency Enhancements.
Intended use: Order Processing pipeline, Shipping stage.
Configuration Values
None.
Values Read
The RequiredShippingCy pipeline component reads the following values from the indicated dictionaries.
Key |
Dictionary |
Description |
|---|---|---|
_cy_shipping_total |
Order |
The total shipping cost for the order. |
MessageManager.pur_badshiping |
Context |
The error message text (optional). |
Values Written
The RequiredShippingCy pipeline component writes the following value to the Order dictionary.
Key |
Description |
|---|---|
_Purchase_Errors |
Error messages are written to this SimpleList object. |
Errors
The RequiredShippingCy pipeline component returns error level 2 (OPPERRORLEV_WARN) when the handling total is not in the order form. Other errors return error level 3 (OPPERRORLEV_FAIL).
The RequiredShippingCy pipeline component also writes an error message to the _Purchase_Errors collection. The component uses a MessageManager object to retrieve error message text.
Constant |
Condition |
|---|---|
pur_badshipping |
The shipping total key does not exist in the order. |
Remarks
The RequiredShippingCy pipeline component verifies that the _cy_shipping_totalkey exists in the order form. If the value does not exist, it uses the pur_badshipping constant to retrieve error message text from the MessageManager object and stores this message in the _Purchase_Errors collection of the Order dictionary.