LinearShipping

Use this component to calculate the shipping total on an order form using a fixed rate.

Note

• The LinearShipping component is for backward compatibility only and does not support the new, extended Currency datatype.

Intended use: Order Processing pipeline, Shipping stage.

Configuration Values

You can determine how the LinearShipping component applies the shipping rate and the rate itself by setting component properties. Use the following boxes on the Linear Shipping tab of the Component Properties dialog box to determine this information.

Box	Description
Apply when	Determines when to apply the shipping charge. The values are: Always Default. Specifies that the shipping charge is always applied to the order. 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 value specified in 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 box.
Basis Item Key	The item property to use in computing the shipping charge. Defaults to the sum.quantity key.
Rate	The handling rate, which is an integer value.

Enter the value in the same currency unit in which prices are stored in the database.

Values Read

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

Key	Dictionary	Description
item.sum_quantity	Order	Dynamic. Default shown. The property of the item to use in computing the shipping charge. The key name is determined by the BasisItemKey configuration box.

Values Written

The LinearShipping component writes the following value to the Order dictionary.

Key	Description
_shipping_total	The shipping total for the entire order.

Remarks

The LinearShipping component computes the shipping charge by multiplying the value specified in the Rate box by the sum of the property specified in the Basis Item Key box. For example, you might base the linear shipping charge on the quantity of the items, and the value in the Basis Item Key box might be the sum.quantity key. If the order contains two items, one item with a quantity of four and the other item with a quantity of two, then the basis sum is six. The component calculates the handling charge by multiplying the value in the Rate box by six.

For more general information about basis item keys, see Specifying the Basis Item Key.

See Also

Specifying the Basis Item Key

All rights reserved.