ShippingDiscountAmount Property

For the latest version of Commerce Server 2007 Help, see the Microsoft Web site.

Gets or sets the shipping discount amount.

Namespace:  Microsoft.CommerceServer.Runtime.Orders
Assembly:  Microsoft.CommerceServer.Runtime (in Microsoft.CommerceServer.Runtime.dll)

Syntax

'Declaration
Public Property ShippingDiscountAmount As Decimal
'Usage
Dim instance As Shipment
Dim value As Decimal

value = instance.ShippingDiscountAmount

instance.ShippingDiscountAmount = value
public decimal ShippingDiscountAmount { get; set; }
public:
property Decimal ShippingDiscountAmount {
    Decimal get ();
    void set (Decimal value);
}
public function get ShippingDiscountAmount () : decimal
public function set ShippingDiscountAmount (value : decimal)

Property Value

Type: System..::.Decimal
The shipping discount amount.

Exceptions

Exception Condition
ArgumentException

The value is set to a negative value.

Remarks

Stores the shipping discount amount.

ShippingDiscountAmount is calculated during execution of the pipeline. If you add line items and access ShippingDiscountAmount without executing a pipeline, ShippingDiscountAmount remains at 0.

Permissions

See Also

Reference

Shipment Class

Shipment Members

Microsoft.CommerceServer.Runtime.Orders Namespace