Class ShippingSession

Represents session of ShippingSystem. All PaySystem operation requires session as mandatory parameter

Inheritance
System.Object
DisposableObject
ShippingSession
ManualSession
ShippoSession
Implements
System.IDisposable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NFX.Web.Shipping
Assembly: NFX.Web.dll
Syntax
public abstract class ShippingSession : DisposableObject, IDisposable, INamed

Constructors

ShippingSession(ShippingSystem, ShippingConnectionParameters)

Declaration
protected ShippingSession(ShippingSystem shipSystem, ShippingConnectionParameters cParams)
Parameters
Type Name Description
ShippingSystem shipSystem
ShippingConnectionParameters cParams

Properties

IsValid

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

Name

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

ShippingSystem

Declaration
public ShippingSystem ShippingSystem { get; }
Property Value
Type Description
ShippingSystem

User

Declaration
public User User { get; }
Property Value
Type Description
User

Methods

CreateLabel(IShippingContext, Shipment)

Creates shipping label

Declaration
public Label CreateLabel(IShippingContext context, Shipment shipment)
Parameters
Type Name Description
IShippingContext context
Shipment shipment
Returns
Type Description
Label

Destructor()

Declaration
protected override void Destructor()
Overrides

EstimateShippingCost(IShippingContext, Shipment)

Estimates shipping label cost

Declaration
public ShippingRate EstimateShippingCost(IShippingContext context, Shipment shipment)
Parameters
Type Name Description
IShippingContext context
Shipment shipment
Returns
Type Description
ShippingRate

GetShippingCarriers(IShippingContext)

Returns all the carriers allowed for the system

Declaration
public IEnumerable<ShippingCarrier> GetShippingCarriers(IShippingContext context)
Parameters
Type Name Description
IShippingContext context
Returns
Type Description
System.Collections.Generic.IEnumerable<ShippingCarrier>

GetTrackingURL(IShippingContext, String, String)

Retrieves tracking URL by carrier and number

Declaration
public string GetTrackingURL(IShippingContext context, string carrierID, string trackingNumber)
Parameters
Type Name Description
IShippingContext context
System.String carrierID
System.String trackingNumber
Returns
Type Description
System.String

TrackShipment(IShippingContext, String, String)

Retrieves shipment tracking info

Declaration
public TrackInfo TrackShipment(IShippingContext context, string carrierID, string trackingNumber)
Parameters
Type Name Description
IShippingContext context
System.String carrierID
System.String trackingNumber
Returns
Type Description
TrackInfo

ValidateAddress(IShippingContext, Address, out ValidateShippingAddressException)

Validates shipping address. Returns new Address instance which may contain corrected address fields ('New Yourk' -> 'New York')

Declaration
public Address ValidateAddress(IShippingContext context, Address address, out ValidateShippingAddressException error)
Parameters
Type Name Description
IShippingContext context
Address address
ValidateShippingAddressException error
Returns
Type Description
Address

Implements

System.IDisposable

Extension Methods