new module:models/PriceAdjustmentRequest(level)
Constructs a new PriceAdjustmentRequest.
Document representing a price adjustment request.
Parameters:
| Name | Type | Description |
|---|---|---|
level |
module:models/PriceAdjustmentRequest.LevelEnum | The level at which the adjustment is applied. When a product or shipping level is specified, you must also specify the item id. |
- Source:
Members
(readonly) LevelEnum :String
Allowed values for the level property.
Type:
- String
- Source:
(readonly) ReasonCodeEnum :String
Allowed values for the reason_code property.
Type:
- String
- Source:
(inner, constant) BACKORDER
value: "BACKORDER"
- Source:
(inner) discount :module:models/DiscountRequest
A discount that you can specify instead of a price. When defining a discount, you must specify a type and a value.
Type:
- Source:
(inner, constant) EVEN_EXCHANGE
value: "EVEN_EXCHANGE"
- Source:
(inner) item_id :String
The item to which the price adjustment should be added, depending on the specified level. If the level is 'order', you need not specify an item id. If 'shipping', specify the uuid of the shipping item. If 'product', specify the uuid of the product item.
Type:
- String
- Source:
(inner) item_text :String
The text describing the item in more detail.
Type:
- String
- Source:
(inner) level :module:models/PriceAdjustmentRequest.LevelEnum
The level at which the adjustment is applied. When a product or shipping level is specified, you must also specify the item id.
Type:
- module:models/PriceAdjustmentRequest.LevelEnum
- Source:
(inner, constant) order
value: "order"
- Source:
(inner, constant) PRICE_MATCH
value: "PRICE_MATCH"
- Source:
(inner, constant) product
value: "product"
- Source:
(inner) promotion_id :String
The id of the related promotion. Custom price adjustments can be assigned any promotion id so long it is not used by a price adjustment belonging to the same item and is not used by promotion defined in the promotion engine. If not specified, a promotion id is generated.
Type:
- String
- Source:
(inner) reason_code :module:models/PriceAdjustmentRequest.ReasonCodeEnum
The reason why this price adjustment was made.
Type:
- module:models/PriceAdjustmentRequest.ReasonCodeEnum
- Source:
(inner, constant) shipping
value: "shipping"
- Source:
Methods
(static) constructFromObject(data, obj) → {module:models/PriceAdjustmentRequest}
Constructs a PriceAdjustmentRequest 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/PriceAdjustmentRequest | Optional instance to populate. |
- Source:
Returns:
The populated PriceAdjustmentRequest instance.