CartLine
Extends Object. CartLine objects are retrieved when obtaining cart.lines() from the Cart object.
Properties |
---|
attributes
Array
The specification for the CartLine. Attributes contain information such as variation options selected by the user. See CartLine.attributes below. |
booking
Object
Basic booking information if purchasing a ticket to an Event. See CartLine.booking below. |
channelCurrency
String
The three character currency ISO code for the website when the product was added to cart. |
currency
String
The three character currency ISO code for the item in the cart. |
deliveryDate
Date | null
Currently the same as startDate. |
depth
Number
The individual packaged depth of the product in mm. |
discount
Money
The net or gross discount on the line depending on the tax rule for the document. |
discountType
String | null
The type of discounts currently available are:
If the line is not discounted the discountType is set to |
endDate
Date | null
The end of the hire period for Hired products, otherwise set to null. |
exchangeRate
Number
The estimated exchange rate between the channelCurrency and currency for
the line.
|
hasDiscount
Boolean
True if the CartLine has a discount applied. |
hasListPrice
Boolean
True if the item in the cart has a price in the product database, this may not always be true if the item price is only available on application. In which case the cart is classed as an enquiry. |
height
Number
The individual packaged height of the product in mm. |
id
Number
The system ID for the CartLine object. |
isBooking
Boolean
True if the product is a ticket and the line is a booking for an event slot. |
isBuy
Boolean
True if the product has a priceType of 'buy'. |
isCurrencyConversion
Boolean
True if the price in the cart was not a price explicitly set in the admin panel, but converted via Evance's conversion table. |
isHire
Boolean
True if the product has a priceType of 'hire'. |
isPurchasable
Boolean
True if the product in the CartLine may be purchased online. |
isRecurring
Boolean
True if the product has a priceType of subscription. |
isRental
Boolean
True if the product has a priceType of 'hire'. |
isSubscription
Boolean
True if the product has a priceType of subscription. |
itemPrice
Money
The price per quantity of the product in the CartLine. The price will include or exclude tax depending on the taxRule. |
priceType
String
This is either buy, hire or subscription. |
priceUnit
String
The unit type for the product.
The unit type for the purchased products is currently always 'each'. Other priceUnits are applicable to the hire or subscription priceType. |
priceUnits
String
The plural versions of priceUnit. Takes into account 1 'year', or 2 'years'. |
productId
Number
The system ID for the Product within the CartLine object. |
quantity
Number
The number of products on order for this line. |
quantityShipped
Number
Applicable to orders only. The number of products shipped to the customer. |
quickfind
Number
The quickfind number for the Product within the CartLine object. |
recurringDiscount
Money
The recurring gross or net discount depending on the taxRule. |
recurringItemPrice
Money
The recurring price per quantity including or excluding tax depending on the taxRule. |
recurringTotal
Money
The recurring gross total for the CartLine. |
recurringUnitPrice
Money
The recurring price per priceUnit including or excluding tax depending on the taxRule. |
reference
String
The sku or product reference for the Product within the CartLine object. |
startDate
Date | null
Hired products have a start date or delivery date, otherwise set to null. |
tax
Money
The total tax levied on the line. |
taxRate
Number
The decimal tax rate for the line e.g. 0.2 for 20%. |
taxRule
String
Either includingTax or excludingTax. |
thumbnail
Url
The thumbnail image for the Product within the CartLine object. |
title
String
The title for the Product within the CartLine object. |
total
Money
The gross total for the CartLine. |
unitPrice
Money
The price per unit of the product in the CartLine. The price will include or exclude tax depending on the taxRule. |
units
Number
The number of priceUnits to hire a product for. Units should not be confused with quantity. For example 2 (quantity) products may be hired for 3 (units) weeks (priceUnits). Purchased products always have 1 units. |
url
Url
The url for the Product in the CartLine. |
weight
Number
The total gross packaged weight of the line in kg. |
width
Number
The individual packaged width of the product in mm. |
CartLine.attributes |
---|
reference
String
The type reference for the attribute, this is used by the system to recognise unique properties of a CartLine. |
title
String
The title for the attribute e.g. Size. |
type
String
The type of attribute in use. |
value
String
The value for the attribute e.g. Large, when the title is Size. |
CartLine.booking |
---|
day
Date
The day/date to attend the EventSlot. |
end
String
The end time of the EventSlot to attend. |
start
String
The start time of the EventSlot to attend. |
title
String
The title of the EventSlot to attend. |