Class ShippingViewModel

Namespace

Dynamicweb.Ecommerce.Frontend

Assembly

Dynamicweb.Ecommerce.dll

Represents a ViewModelBase for shipping method information, tailored for use within Dynamicweb, including integration details for other ERP systems for certain fields. This class includes properties such as the shipping method identifier, name, description, icon, and additional fields focused on pricing and ERP system integration specifics.

public class ShippingViewModel : ViewModelBase

Inheritance

object

ViewModelBase

ShippingViewModel

Inherited Members

ViewModelBase.ToJson()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AgentCode

The code identifying the shipping agent involved with this shipping method, it's used when integrating with Business Central.

public string AgentCode { get; set; }

Property Value

string

AgentName

The name of the shipping agent providing the shipping service, it's used when integrating with Business Central

public string AgentName { get; set; }

Property Value

string

AgentServiceCode

The service code specific to the shipping agent, it's used when integrating with Business Central.

public string AgentServiceCode { get; set; }

Property Value

string

AgentServiceDescription

A detailed description of the shipping service provided by the agent, it's used when integrating with Business Central.

public string AgentServiceDescription { get; set; }

Property Value

string

Code

An additional code identifying the shipping method, it's used when integrating with Business Central.

public string Code { get; set; }

Property Value

string

Description

A description of the shipping method. This description can include details on the shipping process or any special conditions.

public string Description { get; set; }

Property Value

string

Detailed information about the shipping method.

FeeRulesSource

Indicates the source of the fee rules applied to the shipping method. This can specify whether the fees were calculated by the provider directly or derived from a predefined fee matrix.

public ShippingFeeRulesSources FeeRulesSource { get; set; }

Property Value

ShippingFeeRulesSources

The source of the shipping fee rules.

FreeFeeAmount

The order amount threshold above which shipping becomes free. The shipping fee will simply not be asked for, if the order is above this amount.

public double FreeFeeAmount { get; set; }

Property Value

double

The minimum order amount for free shipping.

Icon

The path or URL to an icon representing the shipping method visually for ease of recognition. If it is a path, the root will be the Dynamicweb Files folder, so a path could be "/Images/Shipping/gls_group_gls_logo_svg.svg"

public string Icon { get; set; }

Property Value

string

URL or path to the shipping method icon.

Id

The unique identifier for the shipping method. This id is crucial for distinguishing between various shipping options within Dynamicweb.

public string Id { get; set; }

Property Value

string

Unique identifier for the shipping method.

MaxWeight

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

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?

Name

The name of the shipping method, presented to users during the checkout process. This name helps users identify the correct shipping option, reflecting the service provider or type of shipping, for example, "GLS Parcelshop", "UPS".

public string Name { get; set; }

Property Value

string

The display name of the shipping method.

PriceOverMaxWeight

This property is actually the "Default fee" when set within Dynamicweb, and will be used as the price if the provider that's used does not return a value.

public double PriceOverMaxWeight { get; set; }

Property Value

double

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>