Class: module:models/PriceAdjustmentLimit

module:models/PriceAdjustmentLimit()

new module:models/PriceAdjustmentLimit()

Constructs a new PriceAdjustmentLimit. A price adjustment limit specifies the amount of manual adjustment that can be applied by a user at the specified level.

Source:

Members

(readonly) TypeEnum :String

Allowed values for the type property.

Type:
  • String
Source:

(inner) amount :Number

The value for the currency or null if no currency value is specified.

Type:
  • Number
Source:

(inner) currency :String

Returns the currency of the Price Adjustment Limit or null if not applicable. Will be null if this is a percent limit only. Price adjustment limits can be given up to a fixed amount (unit=a currency unit).

Type:
  • String
Source:

(inner, constant) item

value: "item"

Source:

(inner, constant) order

value: "order"

Source:

(inner) percent :Number

Returns percentage value of the Price Adjustment Limit or null if not applicable. Will be null if this is a currency limit only.

Type:
  • Number
Source:

(inner, constant) shipping

value: "shipping"

Source:

(inner) type :module:models/PriceAdjustmentLimit.TypeEnum

The Price Adjustment Limit type - ITEM, SHIPPING or ORDER. It identifies the level at which the Price Adjustment is applicable.

Type:
  • module:models/PriceAdjustmentLimit.TypeEnum
Source:

Methods

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

Constructs a PriceAdjustmentLimit 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/PriceAdjustmentLimit

Optional instance to populate.

Source:
Returns:

The populated PriceAdjustmentLimit instance.

Type
module:models/PriceAdjustmentLimit