The Product Price Object
Define historical, current or future pricing for a Product.
Properties
accessRoleId
Restrict the price to users with an Access Role. Defaults to null.
|
currency
The ISO-4217 currency code for the price. Defaults to the default currency for the Account. |
geozoneId
Restrict the price to a Zone (one or more Countries). Defaults to null.
|
id
read-only
An unsigned 64-bit integer, which is unique across all Prices and all Evance Accounts. |
isLowestInClass
read-only
A calculated property, which is used in conjunction with inClassCount to
determine whether a price may be used as an effect "from as low as..." price. Applicable to stores
with volume/quantity pricing.
|
isTaxIncluded
A boolean indicating whether the price,
standardPrice and rrp properties
include sales tax (
true) or exclude sales tax (false).
|
minimumUnits
An integer, defaults to 1.
Applicable when type is hire or subscription.
Allows you to set the minimum term for rentals or memberships.
|
price
The current/effective price. May be less than or equal to the standardPrice.
Considered a special offer when less than standardPrice.
May be set to null to represent Price on Application.
|
productId
A unsigned 64-bit integer referencing the Product the Price is associated with. |
quantity
An integer, which defaults to the Product's Minimum Order Quantity when adding new prices. Represents the quantity in cart at which the price becomes effective, allowing for explicit quantity/volume pricing. |
rrp
Defaults to null. May be a decimal value representing the Recommended Retail Price.
|
standardPrice
A decimal value representing the standard catalogue price for the product. May be set to null to represent Price on Application.
|
startOn
The effective date of the price. Defaults to the current date when adding new prices. |
status
read-only
A price's status is calculated internally and may be one of the following:
|
type
Also known as the price mechanism. Defaults to the Product's Price Type/Mechanism when adding new prices.
|
unit
The unit is dependent upon the type.
|