Class ShippingProvider

Namespace

Dynamicweb.Ecommerce.Cart

Assembly

Dynamicweb.Ecommerce.dll

A ShippingProvider calculates rate of goods delivery. Inherit from this base class to extend shipping services in DynamicWeb eCommerce

public abstract class ShippingProvider : ConfigurableAddIn

Inheritance

object

ConfigurableAddIn

ShippingProvider

Derived

StockLocationShippingProvider

Inherited Members

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Make use of the Dynamicweb AddIn API to add editable properties to the shipping provider.

Fields

IsServicePointSelected

protected static string IsServicePointSelected

Field Value

string

Properties

FieldPrefix

Gets the field prefix.

protected string FieldPrefix { get; }

Property Value

string

The field prefix.

ShippingID

Gets or sets the shipping identifier.

protected string ShippingID { get; set; }

Property Value

string

The shipping identifier.

Methods

CalculateShippingFee(Order)

Calculate shipping fee for the specified order

public virtual PriceRaw CalculateShippingFee(Order order)

Parameters

order Order

The order.

Returns

PriceRaw

Returns shipping fee for the specified order

GetFieldValues()

Gets the field values.

protected Dictionary<string, string> GetFieldValues()

Returns

Dictionary<string, string>

Dictionary(Of System.String, System.String).

GetShippingProviderByShipping(Shipping)

Returns the ShippingProvider from the given shipping, or null if it doesn't exist

public static ShippingProvider GetShippingProviderByShipping(Shipping shipping)

Parameters

shipping Shipping

The shipping represents information about the shipping method

Returns

ShippingProvider

ShippingProvider.

ProcessOrder(Order)

Processes the order.

public virtual void ProcessOrder(Order order)

Parameters

order Order

The order.

Render(Template, Order)

Makes it possible to extend the shipping method template instance.

public virtual void Render(Template renderingTemplate, Order order)

Parameters

renderingTemplate Template

The template instance rendering the shipping method.

order Order

The order currently being checked out.

RenderBackend(Order)

Renders the backend.

public virtual string RenderBackend(Order order)

Parameters

order Order

The order.

Returns

string

System.String.

RenderFrontend(Order)

Renders the frontend.

public virtual string RenderFrontend(Order order)

Parameters

order Order

The order.

Returns

string

System.String.

SaveLog(string, bool)

Saves the log.

protected void SaveLog(string message, bool isRequest)

Parameters

message string

The message.

isRequest bool

if set to true [is request].

SaveXmlLog(XmlDocument, bool)

Saves the xml log.

protected void SaveXmlLog(XmlDocument xml, bool isRequest)

Parameters

xml XmlDocument

The xml.

isRequest bool

if set to true the context is a request.

See Also

ConfigurableAddIn