Table of Contents

Class Shipping

Namespace
Dynamicweb.Ecommerce.Orders
Assembly
Dynamicweb.Ecommerce.dll

Represents information about a shipping method

[Serializable]
public class Shipping
Inheritance
Shipping
Inherited Members

Properties

Active

Gets or sets the value indicating whether instance is active.

public bool Active { get; set; }

Property Value

bool

AgentCode

Gets or sets the shipping agent code.

public string AgentCode { get; set; }

Property Value

string

AgentServiceCode

Gets or sets the shipping agent service code.

public string AgentServiceCode { get; set; }

Property Value

string

AllowAnonymousUsers

Gets or sets a value indicating whether the Shipping is available to anonymous uses.

public bool AllowAnonymousUsers { get; set; }

Property Value

bool

true if shipping is available to anonymous users; otherwise, false.

Code

Gets or sets the shipping code.

public string Code { get; set; }

Property Value

string

EligibleForFreeShipping

Gets or sets a value indicating whether shipping is eligible for free.

public bool EligibleForFreeShipping { get; set; }

Property Value

bool

FeeRulesSource

Gets or sets the source of fee rules.

public ShippingFeeRulesSources FeeRulesSource { get; set; }

Property Value

ShippingFeeRulesSources

FeeSelection

Gets or sets the rule for fee selection: high or low.

public string FeeSelection { get; set; }

Property Value

string

FreeFeeAmount

Gets or sets the free fee amount.

public double FreeFeeAmount { get; set; }

Property Value

double

The free fee amount.

Icon

Gets or sets the icon file name.

public string Icon { get; set; }

Property Value

string

Id

Gets or sets the id.

public string Id { get; set; }

Property Value

string

The id.

LimitsUseLogic

Gets or sets the limits use logic.

public ShippingLimitsUseLogics LimitsUseLogic { get; set; }

Property Value

ShippingLimitsUseLogics

MaxWeight

Gets or sets the maximum order weight, in the default weight unit, allowed for this shipping method to be available. If null - there is no maximum weight restriction.

public double? MaxWeight { get; set; }

Property Value

double?

MinWeight

Gets or sets the minimum order weight, in the default weight unit, required for this shipping method to be available. If null - there is no minimum weight restriction.

public double? MinWeight { get; set; }

Property Value

double?

PriceOverMaxWeight

Gets or sets the price for over max weight.

public double PriceOverMaxWeight { get; set; }

Property Value

double

The price over max weight.

ProductFilterMode

Gets or sets the filtering mode that determines how ProductIds and ProductGroupIds are applied. If None - product-based filtering is disabled.

public ShippingProductFilterMode ProductFilterMode { get; set; }

Property Value

ShippingProductFilterMode

ProductGroupIds

Gets or sets the collection of product group IDs that determine the availability of this shipping method. If empty - product groups filter is not applied. The filter behavior is determined by ProductFilterMode.

public IEnumerable<string> ProductGroupIds { get; set; }

Property Value

IEnumerable<string>

ProductIds

Gets or sets the collection of product identifiers that determine the availability of this shipping method. If empty - products filter is not applied. The filter behavior is determined by ProductFilterMode.

public IEnumerable<string> ProductIds { get; set; }

Property Value

IEnumerable<string>

ServiceParameters

Gets or sets the shipping service parameters.

public string ServiceParameters { get; set; }

Property Value

string

The shipping service parameters.

ServiceSystemName

Gets or sets the shipping service SystemName.

public string ServiceSystemName { get; set; }

Property Value

string

The shipping service SystemName.

Sorting

Sort order of current group inside parent group shipping children collection

public int Sorting { get; set; }

Property Value

int

TakeDiscountIntoAccount

Gets or sets a value indicating whether discounts are taken into consideration for free shipping fee.

public bool TakeDiscountIntoAccount { get; set; }

Property Value

bool

Translations

Gets the translations

public TranslationCollection<ShippingTranslation> Translations { get; }

Property Value

TranslationCollection<ShippingTranslation>

UsePriceWithVat

Gets or sets the value indicating whether VAT is taken into consideration for free shipping fee.

public bool UsePriceWithVat { get; set; }

Property Value

bool

UserGroups

Gets or sets to whom user groups the shipping is shown.

public IEnumerable<int> UserGroups { get; set; }

Property Value

IEnumerable<int>

Methods

Clone()

Clones this instance.

public Shipping Clone()

Returns

Shipping

GetAgentName(string)

Gets the agent name of the shipping for the given language.

public string GetAgentName(string languageId)

Parameters

languageId string

Returns

string

GetAgentServiceDescription(string)

Gets the agent service description of the shipping for the given language.

public string GetAgentServiceDescription(string languageId)

Parameters

languageId string

Returns

string

GetDescription(string)

Gets the description of the shipping for the given language.

public string GetDescription(string languageId)

Parameters

languageId string

Returns

string

GetName(string)

Gets the name of the shipping for the given language.

public string GetName(string languageId)

Parameters

languageId string

Returns

string

SetAgentName(string, string)

Sets the agent name of the shipping for the given language.

public void SetAgentName(string languageId, string agentName)

Parameters

languageId string
agentName string

SetAgentServiceDescription(string, string)

Sets the agent service description of the shipping for the given language.

public void SetAgentServiceDescription(string languageId, string agentServiceDescription)

Parameters

languageId string
agentServiceDescription string

SetDescription(string, string)

Sets the description of the shipping for the given language.

public void SetDescription(string languageId, string description)

Parameters

languageId string
description string

SetName(string, string)

Sets the name of the shipping for the given language.

public void SetName(string languageId, string name)

Parameters

languageId string
name string
Improve this doc
To top