Interface IShippingSystem

Represents entity that can perform shipping fuctions like labels creation, tracking etc.

Namespace: NFX.Web.Shipping
Assembly: NFX.Web.dll
Syntax
public interface IShippingSystem

Properties

Capabilities

Returns capabilities for this shipping system

Declaration
IShippingSystemCapabilities Capabilities { get; }
Property Value
Type Description
IShippingSystemCapabilities

Methods

CreateLabel(ShippingSession, IShippingContext, Shipment)

Creates shipping direct/return label

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

EstimateShippingCost(ShippingSession, IShippingContext, Shipment)

Estimates shipping label cost.

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

Rate for original or alternative shipment

GetShippingCarriers(ShippingSession, IShippingContext)

Returns all the carriers allowed for the system

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

GetTrackingURL(ShippingSession, IShippingContext, String, String)

Retrieves tracking URL by carrier and number

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

StartSession(ShippingConnectionParameters)

Starts shipping session with given or default connection parameters

Declaration
ShippingSession StartSession(ShippingConnectionParameters cParams = null)
Parameters
Type Name Description
ShippingConnectionParameters cParams
Returns
Type Description
ShippingSession

TrackShipment(ShippingSession, IShippingContext, String, String)

Retrieves shipment tracking info

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

ValidateAddress(ShippingSession, IShippingContext, Address, out ValidateShippingAddressException)

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

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

Extension Methods