LinearShipping

The LinearShipping component, which usually appears in the Shipping Stage of an order processing pipeline, sets order._shipping_total on the order form by multiplying a rate times the sum of a specified field on the order form.

• υKey. (Read-only) The name of a property on the order form used to specify shipping method. The value of this property is compared to the string specified in the Method field to determine whether to apply the shipping charge to the order.
• υApply when. Specifies when to apply the shipping charge.
  • υEqual to Method. Specifies that the shipping charge if the value of the property specified for Key is the same as the string specified in the Method field.
  • υHas Any Value. Specifies that the shipping charge will be applied when the value of the property specified for Key has any value on the order form. If you select this option, the Method field should be left blank.
  • υAlways. Specifies that the shipping charge is always applied to the order.
• υMethod. If Equal to Method is selected, specifies a string that the component compares with the value of shipping_method on the order form to determine whether to apply the shipping charge to the order. The charge will be applied only if there is an exact match.
• υBasis Item Key. Specifies the property of the item that is used to compute the shipping charge. The LinearShipping component computes the charge by multiplying the value specified for Rate by the sum of the property specifies for Basis Item Key. For example, you might base the linear shipping charge on the quantity of the items, and the Basis Item Key might be sum.quantity. 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 multiplies the value specified for Rate by six. See Specifying the Basis Item Key.
• υRate. Number to multiply by the Basis Item Key to obtain the shipping charge to apply to the order.

Example

To calculate the shipping charge for an order on the basis of quantity with a rate of 100, double-click the LinearShipping icon in the Win32®-based Pipeline Editor, or click the Edit link for the component in the ASP-based Pipeline Editor and type the following in the resulting property page.

Related Topics

• υComponent Coordination
• υTableShippingADO