Commerce Foundation Shipment

This Commerce Server 2009 commerce entity represents the information related to the shipment of one set of line items.

Model

This commerce entity can be modified, as required. This model, taken from the out-of-the-box site, is provided as an example.

<CommerceEntity name="Shipment" >
    <EntityMappings>
      <EntityMapping csType="Microsoft.CommerceServer.Runtime.Orders.Shipment" csAssembly="Microsoft.CommerceServer.Runtime, Version=6.0.1.0, Culture=neutral, PublicKeyToken=31bf3856ad364e35">
        <PropertyMappings>
          <PropertyMapping property="Id" csProperty="ShipmentId"/>
          <PropertyMapping property="DiscountAmount" csProperty="ShippingDiscountAmount"/>
          <PropertyMapping property="ShippingAddressId" csProperty="ShippingAddressId"/>
          <PropertyMapping property="StatusCode" csProperty="Status"/>
          <PropertyMapping property="Total" csProperty="ShipmentTotal"/>
          <PropertyMapping property="TrackingNumber" csProperty="ShipmentTrackingNumber"/>
        </PropertyMappings>
      </EntityMapping>
    </EntityMappings>
</CommerceEntity>

Properties

Property	Type	Description
DiscountAmount	decimal	Sipping discount amount.
Id	String	Unique identifier of the commerce entity
ShippingAddressId	String	ID associated with the shipping address.
StatusCode	String	Status of the current shipment. ValueDescription PendingShipment has not been approved yet. ApprovedShipment has been approved and can be fulfilled. FulfillingItems are being prepared for eventual shipping. ShippedShipment has been submitted to those responsible for delivery. InTransitShipment has been confirmed, by those responsible for delivery, to be on its way. UnconfirmedDeliveryShipment is considered delivered; however, there is no known confirmation. ConfirmedDeliveryDelivery of the shipment has been confirmed by those responsible for delivery.
Total	decimal	Total shipping cost for the current shipment.
TrackingNumber	String	A value that uniquely identifies a shipment.

Relationships

Property	Description
ShippingMethods	Relationship that contains the ShippingMethods for this Shipment.
Discounts	Relationship list that contains a set of Discounts that are being applied to this Shipment.

Supported Operations

Commerce Foundation Basket CommerceQuery

See Also

Other Resources

Developing with the Commerce Foundation Orders System

Commerce Foundation ShippingMethod