FixedShipping

  • Article

Use this component to apply a fixed shipping charge to an order.

Ee798911.note(en-US,CS.10).gif Note

  • The FixedShipping component is for backward compatibility with Site Server 3.0 only and does not support the new, extended Currency datatype.

Intended use: Order Processing pipeline, Shipping stage.

Configuration Values

You can determine how the FixedShipping component applies the shipping cost by setting component properties. Use the following boxes on the Fixed Shipping tab of the Component Properties dialog box to determine this information.

Box Description
Apply when Determines when to apply the shipping charge specified in the Cost box. The values are:

Always

Default. Specifies that the shipping charge is always set to the value of the Cost box.

Equal to method

Specifies that the shipping cost should be applied when the value of the shipping_method key in the Order dictionary is the same as the string specified for the Method box.

Has any value

Specifies that the shipping cost is applied when the shipping_method key of the order has any non-null value.
Method The shipping method to match against the value of the shipping_method key in the Order dictionary. Used when the value in the Apply when box is set to Equal to method.
Cost Specifies the shipping charge.

Values Read

The FixedShipping component reads the following value from the indicated dictionary.

Key Dictionary Description
shipping_method Order Read when the value in the Apply when box is set to Equal to method or Has any value.

Values Written

The FixedShipping component writes the following value to the Order dictionary:

Key Description
_shipping_total The shipping total for the entire order.

Remarks

The FixedShipping component sets the value of the _shipping_total key to the fixed amount specified in the Cost box.

You cannot specify more than one method per component. If you need to specify more than one shipping method, add a separate FixedShipping component for each method.

Example

The following example sets the shipping cost to $9.95, for items shipped by Carrier1.

Box Value
Apply when Equal to Method
Method Carrier1
Cost 995

When configuring the components in this stage, make sure that the components are in the order in which you want them executed so that charges are calculated and applied in the correct order.


All rights reserved.