November Happy Hour will be moved to Thursday December 5th.

AI OnAI Off

Class SerializableShipment

This type/member supports the EPiServer infrastructure and is not intended to be used directly from your code.

This class represents a shipment in the new cart system. It works with the new database model for cart.

Inheritance
System.Object
SerializableShipment
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Commerce.Order.Internal
Assembly: EPiServer.Business.Commerce.dll
Version: 12.17.2
Syntax
public class SerializableShipment : IShipment, IExtendedProperties, IShipmentInventory, IShipmentDiscountAmount, IShipmentCalculatedAmount

Constructors

SerializableShipment()

Creates an instance of SerializableShipment.

Declaration
public SerializableShipment()

SerializableShipment(ICollection<SerializableLineItem>, SerializableOrderAddress)

Creates an instance of SerializableShipment. This constructor is required for the JSON deserializer to be able to identify concrete classes to use when deserializing the interface properties.

Declaration
public SerializableShipment(ICollection<SerializableLineItem> lineItems, SerializableOrderAddress shippingAddress)
Parameters
Type Name Description
System.Collections.Generic.ICollection<SerializableLineItem> lineItems

The line item collection.
SerializableOrderAddress shippingAddress

The shipping address.

Properties

IsShippingCostUpToDate

Gets or sets the flag indicating whether the ShippingCost is up-to-date.

Declaration
public bool IsShippingCostUpToDate { get; set; }
Property Value
Type Description
System.Boolean

IsShippingTaxUpToDate

Gets or sets the flag indicating whether the ShippingTax is up-to-date.

Declaration
public bool IsShippingTaxUpToDate { get; set; }
Property Value
Type Description
System.Boolean

LineItems

Gets the collection of line items

Declaration
public ICollection<ILineItem> LineItems { get; }
Property Value
Type Description
System.Collections.Generic.ICollection<ILineItem>

The line items.

OperationKeys

Gets or sets the shipment operation keys mapping.

Declaration
public IDictionary<int, IEnumerable<string>> OperationKeys { get; set; }
Property Value
Type Description
System.Collections.Generic.IDictionary<System.Int32, System.Collections.Generic.IEnumerable<System.String>>

OrderShipmentStatus

Gets or sets the order shipment status.

Declaration
public OrderShipmentStatus OrderShipmentStatus { get; set; }
Property Value
Type Description
OrderShipmentStatus

PickListId

Gets or sets the pick list id.

Declaration
public int? PickListId { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

The pick list id.

Properties

Gets or sets the property bag for dealing with custom meta fields.

Declaration
public Hashtable Properties { get; set; }
Property Value
Type Description
System.Collections.Hashtable

ShipmentDiscount

Gets or sets the shipment discount.

Declaration
public decimal ShipmentDiscount { get; set; }
Property Value
Type Description
System.Decimal

ShipmentId

Gets or sets the shipment identifier.

Declaration
public int ShipmentId { get; set; }
Property Value
Type Description
System.Int32

The shipment identifier.

ShipmentTrackingNumber

Gets or sets a string used for tracking the shipment

Declaration
public string ShipmentTrackingNumber { get; set; }
Property Value
Type Description
System.String

The shipment tracking number.

ShippingAddress

Gets or sets the shipping address.

Declaration
public IOrderAddress ShippingAddress { get; set; }
Property Value
Type Description
IOrderAddress

The shipping address.

ShippingCost

Gets or sets the shipping cost.

Declaration
public decimal ShippingCost { get; set; }
Property Value
Type Description
System.Decimal

ShippingMethodId

Gets or sets the shipment method used by the shipment.

Declaration
public Guid ShippingMethodId { get; set; }
Property Value
Type Description
System.Guid

The shipping method id.

ShippingMethodName

Gets the name of the shipping method.

Declaration
public string ShippingMethodName { get; }
Property Value
Type Description
System.String

ShippingTax

Gets or sets the shipping tax.

Declaration
public decimal ShippingTax { get; set; }
Property Value
Type Description
System.Decimal

WarehouseCode

Gets or sets the warehouse code

Declaration
public string WarehouseCode { get; set; }
Property Value
Type Description
System.String

The warehouse code.

Methods

AddOperationKeys(ILineItem, IEnumerable<String>)

Adds the inventory operation keys map.

Declaration
public void AddOperationKeys(ILineItem lineItem, IEnumerable<string> operationKeys)
Parameters
Type Name Description
ILineItem lineItem

The line item.
System.Collections.Generic.IEnumerable<System.String> operationKeys

The collection of operation keys.

ClearOperationKeys()

Clears all inventory operation keys map.

Declaration
public void ClearOperationKeys()

ContainsOperationKeyFor(ILineItem)

Gets the inventory operation keys map.

Declaration
public bool ContainsOperationKeyFor(ILineItem lineItem)
Parameters
Type Name Description
ILineItem lineItem
Returns
Type Description
System.Boolean

GetOperationKeys(ILineItem)

Gets inventory operation keys by line item.

Declaration
public IEnumerable<string> GetOperationKeys(ILineItem lineItem)
Parameters
Type Name Description
ILineItem lineItem

The line item.
Returns
Type Description
System.Collections.Generic.IEnumerable<System.String>

A collection of operation keys corresponded with the line item, empty list if no key found.

InsertOperationKeys(ILineItem, IEnumerable<String>)

Inserts inventory operation keys map with a line item.

Declaration
public bool InsertOperationKeys(ILineItem lineItem, IEnumerable<string> operationKeys)
Parameters
Type Name Description
ILineItem lineItem

The line item.
System.Collections.Generic.IEnumerable<System.String> operationKeys

The collection of operation keys.
Returns
Type Description
System.Boolean

RemoveOperationKey(ILineItem, String)

Removes an inventory operation key map with a line item.

Declaration
public bool RemoveOperationKey(ILineItem lineItem, string operationKey)
Parameters
Type Name Description
ILineItem lineItem

The line item.
System.String operationKey

The operation key.
Returns
Type Description
System.Boolean

Implements

Extension Methods

EPiServer.Commerce.Order.IShipmentExtensions.GetShippingCost(EPiServer.Commerce.Order.IShipment, Mediachase.Commerce.IMarket, Mediachase.Commerce.Currency)
EPiServer.Commerce.Order.IShipmentExtensions.GetShippingCost(EPiServer.Commerce.Order.IShipment, Mediachase.Commerce.IMarket, Mediachase.Commerce.Currency, EPiServer.Commerce.Order.IShippingCalculator)
EPiServer.Commerce.Order.IShipmentExtensions.GetShippingItemsTotal(EPiServer.Commerce.Order.IShipment, Mediachase.Commerce.Currency)
EPiServer.Commerce.Order.IShipmentExtensions.GetShippingItemsTotal(EPiServer.Commerce.Order.IShipment, Mediachase.Commerce.Currency, EPiServer.Commerce.Order.IShippingCalculator)
EPiServer.Commerce.Order.IShipmentExtensions.GetShippingReturnItemsTotal(EPiServer.Commerce.Order.IShipment, Mediachase.Commerce.Currency)
EPiServer.Commerce.Order.IShipmentExtensions.GetShippingReturnItemsTotal(EPiServer.Commerce.Order.IShipment, Mediachase.Commerce.Currency, EPiServer.Commerce.Order.IShippingCalculator)
EPiServer.Commerce.Order.IShipmentExtensions.GetShipmentDiscountPrice(EPiServer.Commerce.Order.IShipment, Mediachase.Commerce.Currency)
EPiServer.Commerce.Order.IShipmentExtensions.GetShipmentDiscountPrice(EPiServer.Commerce.Order.IShipment, Mediachase.Commerce.Currency, EPiServer.Commerce.Order.IShippingCalculator)