Class Fee

Namespace

Dynamicweb.Ecommerce.Orders

Assembly

Dynamicweb.Ecommerce.dll

Represents information about a fee.

[Serializable]
public class Fee

Inheritance

object

Fee

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Fee()

Initializes a new instance of the Fee class.

public Fee()

Fee(IDataReader)

Initializes a new instance of the Fee class from data reader.

[Obsolete("Use Services.Fees instead.")]
public Fee(IDataReader dataReader)

Parameters

dataReader IDataReader

The data reader.

Fee(string)

Initializes a new instance of the Fee class from database by ID.

[Obsolete("Use Services.Fees.GetFeeById instead.")]
public Fee(string feeId)

Parameters

feeId string

The ID

Fields

MethodTypePayment

[Obsolete("Not used")]
public const string MethodTypePayment = "PAY"

Field Value

string

MethodTypeShippment

[Obsolete("Not used")]
public const string MethodTypeShippment = "SHIP"

Field Value

string

Properties

Active

Gets or sets value indicating whether fee is active.

public bool Active { get; set; }

Property Value

bool

The is active value.

CountryCode

Gets or sets the country code.

public string CountryCode { get; set; }

Property Value

string

The country code.

CountryId

Gets or sets the country ID.

[Obsolete("Use CountryCode instead.")]
public string CountryId { get; set; }

Property Value

string

The country ID.

CurrencyCode

Gets or sets the order currency code.

public string CurrencyCode { get; set; }

Property Value

string

The order currency code.

FeeType

Gets or sets the FeeType.

public FeeType FeeType { get; set; }

Property Value

FeeType

The type.

Id

Gets or sets the fee ID.

public string Id { get; set; }

Property Value

string

The ID.

Method

Gets or sets the fee method.

public string Method { get; set; }

Property Value

string

The method.

MethodId

Gets or sets the fee method ID.

public string MethodId { get; set; }

Property Value

string

The method ID.

Name

Gets or sets the fee name.

public string Name { get; set; }

Property Value

string

The value amount.

OrderContextId

Gets or sets the order context id.

public string OrderContextId { get; set; }

Property Value

string

The order context id.

OrderPrice

Gets or sets the order price.

public double OrderPrice { get; set; }

Property Value

double

The value amount.

ProductsAndGroupsIds

Gets or sets the fee products and groups ids.

public string ProductsAndGroupsIds { get; set; }

Property Value

string

The products and groups ids.

RegionCode

Gets or sets the region code.

public string RegionCode { get; set; }

Property Value

string

The region code.

ShopId

Gets or sets the fee shop id.

public string ShopId { get; set; }

Property Value

string

The shop id.

Type

Gets or sets the FeeType.

[Obsolete("Use FeeType instead.")]
public int Type { get; set; }

Property Value

int

The type.

UserCustomerNumber

Gets or sets the fee user customer number.

public string UserCustomerNumber { get; set; }

Property Value

string

The user customer number.

UserGroupId

Gets or sets the fee user group id.

public int? UserGroupId { get; set; }

Property Value

int?

The user group id.

UserId

Gets or sets the fee user id.

public int? UserId { get; set; }

Property Value

int?

The user id.

ValidFrom

Gets or sets the fee valid from date.

public DateTime? ValidFrom { get; set; }

Property Value

DateTime?

The valid from date.

ValidTo

Gets or sets the fee valid to date.

public DateTime? ValidTo { get; set; }

Property Value

DateTime?

The valid to date.

ValueAmount

Gets or sets the value amount.

public double ValueAmount { get; set; }

Property Value

double

The value amount.

ValueAmountString

Gets or sets the value amount in text form

[Obsolete("Use ValueAmount instead.")]
public string ValueAmountString { get; set; }

Property Value

string

The value amount string.

Volume

Gets or sets the volume.

public double Volume { get; set; }

Property Value

double

The volume.

VolumeString

Gets or sets the volume in text form.

[Obsolete("Use Volume instead.")]
public string VolumeString { get; set; }

Property Value

string

The volume string.

Weight

Gets or sets the weight.

public double Weight { get; set; }

Property Value

double

The weight.

WeightString

Gets or sets the weight in text form.

[Obsolete("Use Weight instead.")]
public string WeightString { get; set; }

Property Value

string

The weight string.

Zip

Gets or sets the zip code.

public string Zip { get; set; }

Property Value

string

The zip code.

Methods

ClearCache()

Clear cached fees

[Obsolete("Use Services.Fees.ClearCache instead.")]
public static void ClearCache()

Clone()

Clones this instance.

public Fee Clone()

Returns

Fee

Copy()

Copies this instance.

[Obsolete("Use Clone() instead.")]
public Fee Copy()

Returns

Fee

Delete()

Deletes this fee.

[Obsolete("Use Services.Fees.Delete instead.")]
public void Delete()

Delete(string)

Deletes fee with the specified ID.

[Obsolete("Use Services.Fees.Delete instead.")]
public void Delete(string feeId)

Parameters

feeId string

The ID STR.

Delete(string, string)

Deletes fee with the specified ID and method.

[Obsolete("Use Services.Fees.Delete instead.")]
public void Delete(string feeId, string methodAlias)

Parameters

feeId string

The ID STR.

methodAlias string

The method STR.

Delete(string, string, string)

Deletes fee with the specified ID and method.

[Obsolete("Use Services.Fees.Delete instead.")]
public void Delete(string feeId, string methodAlias, string feeMethodId)

Parameters

feeId string

The ID STR.

methodAlias string

The method STR.

feeMethodId string

The method ID.

GetFees(string, string)

Gets fees by method and method ID.

[Obsolete("Use Services.Fees.GetFeesByMethodAndCountryRegion instead.")]
public static FeeCollection GetFees(string method, string feeMethodId)

Parameters

method string

The method.

feeMethodId string

The method ID.

Returns

FeeCollection

FeeCollection object

See Also

FeeCollection

GetFees(string, string, string)

Gets the fees.

[Obsolete("Use Services.Fees.GetFeesByMethodAndCountryRegion instead.")]
public static FeeCollection GetFees(string method, string feeMethodId, string countryId)

Parameters

method string

The method.

feeMethodId string

The method ID.

countryId string

The country ID.

Returns

FeeCollection

GetFees(string, string, string, string)

Gets the fees.

[Obsolete("Use Services.Fees.GetFeesByMethod or Services.Fees.GetFeesByMethodAndCountryRegion instead.")]
public static FeeCollection GetFees(string method, string feeMethodId, string countryId, string regionId)

Parameters

method string

The method.

feeMethodId string

The method ID.

countryId string

The country ID.

regionId string

The region ID.

Returns

FeeCollection

GetFees(string, string, string, string, bool)

Gets the fees.

[Obsolete("Use Services.Fees.GetFeesByMethodAndCountryRegion instead.")]
public static FeeCollection GetFees(string method, string feeMethodId, string countryId, string regionId, bool takeIntoAccountMethodCountryRelation)

Parameters

method string

The method.

feeMethodId string

The method ID.

countryId string

The country ID.

regionId string

The region ID.

takeIntoAccountMethodCountryRelation bool

Returns

FeeCollection

GetFeesForDiscount(string)

Gets the fees for discount.

[Obsolete("Not used")]
public static FeeCollection GetFeesForDiscount(string feeMethodId)

Parameters

feeMethodId string

The method ID.

Returns

FeeCollection

GetFeesForPaymethod(string)

Gets the fees for pay method.

[Obsolete("Use Services.Fees.GetFeesByMethodAndCountryRegion instead.")]
public static FeeCollection GetFeesForPaymethod(string feeMethodId)

Parameters

feeMethodId string

The method ID.

Returns

FeeCollection

GetFeesForPaymethod(string, string)

Gets the fees for pay method.

[Obsolete("Use Services.Fees.GetFeesByMethodAndCountryRegion instead.")]
public static FeeCollection GetFeesForPaymethod(string feeMethodId, string countryId)

Parameters

feeMethodId string

The method ID.

countryId string

The country ID.

Returns

FeeCollection

GetFeesForPaymethod(string, string, string)

Gets the fees for pay method.

[Obsolete("Use Services.Fees.GetFeesByMethod or Services.Fees.GetFeesByMethodAndCountryRegion instead.")]
public static FeeCollection GetFeesForPaymethod(string feeMethodId, string countryId, string regionId)

Parameters

feeMethodId string

The method ID.

countryId string

The country ID.

regionId string

The region ID.

Returns

FeeCollection

GetFeesForShippingmethods(string)

Gets the fees for shipping methods.

[Obsolete("Use Services.Fees.GetFeesByMethodAndCountryRegion instead.")]
public static FeeCollection GetFeesForShippingmethods(string feeMethodId)

Parameters

feeMethodId string

The method ID.

Returns

FeeCollection

GetFeesForShippingmethods(string, string)

Gets the fees for shipping methods.

[Obsolete("Use Services.Fees.GetFeesByMethodAndCountryRegion instead.")]
public static FeeCollection GetFeesForShippingmethods(string feeMethodId, string countryId)

Parameters

feeMethodId string

The method ID.

countryId string

The country ID.

Returns

FeeCollection

GetFeesForShippingmethods(string, string, string)

Gets the fees for shipping methods.

[Obsolete("Use Services.Fees.GetFeesByMethod or Services.Fees.GetFeesByMethodAndCountryRegion instead.")]
public static FeeCollection GetFeesForShippingmethods(string feeMethodId, string countryId, string regionId)

Parameters

feeMethodId string

The method ID.

countryId string

The country ID.

regionId string

The region ID.

Returns

FeeCollection

Save(string)

Saves fee. If the fee with specified ID exists, it will be overwritten

[Obsolete("Use Services.Fees.Save instead.")]
public void Save(string feeId)

Parameters

feeId string

The fee ID.