Class ShippoSystem

Inheritance
System.Object
DisposableObject
ApplicationComponent
Service
Service<System.Object>
ServiceWithInstrumentationBase<System.Object>
ShippingSystem
ShippoSystem
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.Shippo
Assembly: NFX.Web.dll
Syntax
public class ShippoSystem : ShippingSystem, IApplicationComponent, IDisposable, IService, INamed, ILocalizedTimeProvider, IWebClientCaller, IShippingSystemImplementation, IShippingSystem, IConfigurable, IInstrumentable, IExternallyParameterized

Constructors

ShippoSystem(String, IConfigSectionNode)

Declaration
public ShippoSystem(string name, IConfigSectionNode node)
Parameters
Type Name Description
System.String name
IConfigSectionNode node

ShippoSystem(String, IConfigSectionNode, Object)

Declaration
public ShippoSystem(string name, IConfigSectionNode node, object director)
Parameters
Type Name Description
System.String name
IConfigSectionNode node
System.Object director

Fields

CARRIERS

Declaration
public static readonly Dictionary<CarrierType, string> CARRIERS
Field Value
Type Description
System.Collections.Generic.Dictionary<CarrierType, System.String>

CODE_INVALID

Declaration
public const string CODE_INVALID = "Invalid"
Field Value
Type Description
System.String

DIST_UNITS

Declaration
public static readonly Dictionary<Distance.UnitType, string> DIST_UNITS
Field Value
Type Description
System.Collections.Generic.Dictionary<Distance.UnitType, System.String>

FORMATS

Declaration
public static readonly Dictionary<LabelFormat, string> FORMATS
Field Value
Type Description
System.Collections.Generic.Dictionary<LabelFormat, System.String>

HDR_AUTHORIZATION

Declaration
public const string HDR_AUTHORIZATION = "Authorization"
Field Value
Type Description
System.String

HDR_AUTHORIZATION_TOKEN

Declaration
public const string HDR_AUTHORIZATION_TOKEN = "ShippoToken {0}"
Field Value
Type Description
System.String

PURCHASE_PURPOSE

Declaration
public const string PURCHASE_PURPOSE = "PURCHASE"
Field Value
Type Description
System.String

QUOTE_PURPOSE

Declaration
public const string QUOTE_PURPOSE = "QUOTE"
Field Value
Type Description
System.String

SHIPPO_REALM

Declaration
public const string SHIPPO_REALM = "shippo"
Field Value
Type Description
System.String

STATUS_ERROR

Declaration
public const string STATUS_ERROR = "ERROR"
Field Value
Type Description
System.String

STATUS_INVALID

Declaration
public const string STATUS_INVALID = "INVALID"
Field Value
Type Description
System.String

STATUS_SUCCESS

Declaration
public const string STATUS_SUCCESS = "SUCCESS"
Field Value
Type Description
System.String

STATUS_VALID

Declaration
public const string STATUS_VALID = "VALID"
Field Value
Type Description
System.String

TRACK_STATUSES

Declaration
public static readonly Dictionary<string, TrackStatus> TRACK_STATUSES
Field Value
Type Description
System.Collections.Generic.Dictionary<System.String, TrackStatus>

URI_ADDRESS

Declaration
public const string URI_ADDRESS = "/v1/addresses"
Field Value
Type Description
System.String

URI_API_BASE

Declaration
public const string URI_API_BASE = "https://api.goshippo.com"
Field Value
Type Description
System.String

URI_RATES

Declaration
public const string URI_RATES = "/v1/rates/{0}"
Field Value
Type Description
System.String

URI_SHIPMENTS

Declaration
public const string URI_SHIPMENTS = "/v1/shipments"
Field Value
Type Description
System.String

URI_TRACKING

Declaration
public const string URI_TRACKING = "/v1/tracks/{0}/{1}"
Field Value
Type Description
System.String

URI_TRACKING_BY_NUM

Declaration
public const string URI_TRACKING_BY_NUM = "http://tracking.goshippo.com/{0}/{1}"
Field Value
Type Description
System.String

URI_TRACKING_FORM

Declaration
public const string URI_TRACKING_FORM = "http://tracking.goshippo.com/"
Field Value
Type Description
System.String

URI_TRANSACTIONS

Declaration
public const string URI_TRANSACTIONS = "/v1/transactions"
Field Value
Type Description
System.String

WEIGHT_UNITS

Declaration
public static readonly Dictionary<Weight.UnitType, string> WEIGHT_UNITS
Field Value
Type Description
System.Collections.Generic.Dictionary<Weight.UnitType, System.String>

Properties

Capabilities

Declaration
public override IShippingSystemCapabilities Capabilities { get; }
Property Value
Type Description
IShippingSystemCapabilities
Overrides

Methods

CreateLabel(ShippingSession, IShippingContext, Shipment)

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

CreateLabel(ShippoSession, IShippingContext, Shipment)

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

DoStartSession(ShippingConnectionParameters)

Declaration
protected override ShippingSession DoStartSession(ShippingConnectionParameters cParams = null)
Parameters
Type Name Description
ShippingConnectionParameters cParams
Returns
Type Description
ShippingSession
Overrides

EstimateShippingCost(ShippingSession, IShippingContext, Shipment)

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

EstimateShippingCost(ShippoSession, IShippingContext, Shipment)

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

GetTrackingURL(ShippingSession, IShippingContext, String, String)

Declaration
public override 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
Overrides

GetTrackingURL(ShippoSession, IShippingContext, String, String)

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

MakeDefaultSessionConnectParams(IConfigSectionNode)

Declaration
protected override ShippingConnectionParameters MakeDefaultSessionConnectParams(IConfigSectionNode paramsSection)
Parameters
Type Name Description
IConfigSectionNode paramsSection
Returns
Type Description
ShippingConnectionParameters
Overrides

TrackShipment(ShippingSession, IShippingContext, String, String)

Declaration
public override 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
Overrides

TrackShipment(ShippoSession, IShippingContext, String, String)

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

ValidateAddress(ShippingSession, IShippingContext, Address, out ValidateShippingAddressException)

Declaration
public override 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
Overrides

ValidateAddress(ShippoSession, IShippingContext, Address, out ValidateShippingAddressException)

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

Implements

System.IDisposable

Extension Methods