Class: module:models/ShippingMethod

module:models/ShippingMethod(cStorePickupEnabled, id)

new module:models/ShippingMethod(cStorePickupEnabled, id)

Constructs a new ShippingMethod. Document representing a shipping method.

Parameters:
Name Type Description
cStorePickupEnabled Boolean
id String

The shipping method id.
Source:

Members

(inner) c_storePickupEnabled :Boolean

Type:
  • Boolean
Source:

(inner) description :String

The localized description of the shipping method.

Type:
  • String
Source:

(inner) external_shipping_method :String

The external shipping method.

Type:
  • String
Source:

(inner) id :String

The shipping method id.

Type:
  • String
Source:

(inner) name :String

The localized name of the shipping method.

Type:
  • String
Source:

(inner) price :Number

The shipping cost total, including shipment level costs and product level fix and surcharge costs.

Type:
  • Number
Source:

(inner) shipping_promotions :Array.<module:models/ShippingPromotion>

The array of active customer shipping promotions for this shipping method. This array can be empty.

Type:
Source:

Methods

(static) constructFromObject(data, obj) → {module:models/ShippingMethod}

Constructs a ShippingMethod from a plain JavaScript object, optionally creating a new instance. Copies all relevant properties from data to obj if supplied or a new instance if not.

Parameters:
Name Type Description
data Object

The plain JavaScript object bearing properties of interest.
obj module:models/ShippingMethod

Optional instance to populate.
Source:
Returns:

The populated ShippingMethod instance.

Type
module:models/ShippingMethod