CartLine

Extends Object. CartLine objects are retrieved when obtaining cart.lines() from the Cart object.  

Properties
attributes

Type Array

The specification for the CartLine. Attributes contain information such as variation options selected by the user. See CartLine.attributesbelow.

booking

Type Object or Null

Basic booking information if purchasing a ticket to an Event. See CartLine.bookingbelow.

channelCurrency

Type String

The three character currency ISO code for the website when the product was added to cart.

currency

Type String

The three character currency ISO code for the item in the cart.

deliveryDate

Type Date or Null

Currently the same as startDate.

depth

Type Number

The individual packaged depth of the product in mm.

discount

Type Money

The net or gross discount on the CartLine depending on the taxRule.

discountType

Type String or Null

The type of discounts currently available are:

  • contact
  • coupon
  • custom
  • public

If the line is not discounted the discountType is set to Null

endDate

Type Date or Null

The end of the hire period for Hired products, otherwise set to null.

exchangeRate

Type Number

The estimated exchange rate between the channelCurrency and currency for the cart line.

hasDiscount

Type Boolean

True if the CartLine has a discount applied.

hasListPrice

Type 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

Type Number

The individual packaged height of the product in mm.

id

Type Number

The system ID for the CartLine object.

isBooking

Type Boolean

True if the product is a ticket and the line is a booking for an event slot.

isBuy

Type Boolean

True if the product has a priceType of 'buy'.

isCurrencyConversion

Type 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

Type Boolean

True if the product has a priceType of 'hire'.

isPurchasable

Type Boolean

True if the product in the CartLine may be purchased online.

isRecurring

Type Boolean

True if the product has a priceType of subscription.

isRental

Type Boolean

True if the product has a priceType of 'hire'.

isSubscription

Type Boolean

True if the product has a priceType of subscription.

itemPrice

Type Money

The price per quantity of the product in the CartLine. The price will include or exclude tax depending on the taxRule.

priceType

Type String

This is either buy, hire or subscription.

priceUnit

Type String

The unit type for the product.

  • each
  • day
  • week
  • month
  • year

The unit type for the purchased products is currently always 'each'. Other priceUnits are applicable to the hire or subscription priceType.

priceUnits

Type String

The plural versions of priceUnit. Takes into account 1 'year', or 2 'years'.

productId

Type Number

The system ID for the Product within the CartLine object.

quantity

Type Number

The number of products on order for this line.

quantityShipped

Type Number

Applicable to orders only. The number of products shipped to the customer.

quickfind

Type Number

The quickfind number for the Product within the CartLine object.

recurringDiscount

Type Money

The recurring gross or net discount depending on the taxRule.

recurringItemPrice

Type Money

The recurring price per quantity including or excluding tax depending on the taxRule.

recurringTotal

Type Money

The recurring gross total for the CartLine.

recurringUnitPrice

Type Money

The recurring price per priceUnit including or excluding tax depending on the taxRule.

reference

Type String

The sku or product reference for the Product within the CartLine object.

startDate

Type Date or Null

Hired products have a start date or delivery date, otherwise set to null.

tax

Type Money

The total tax levied on the line.

taxRate

Type Number

The decimal tax rate for the line e.g. 0.2 for 20%.

taxRule

Type String

Either includingTax or excludingTax.

thumbnail

Type Url

The thumbnail image for the Product within the CartLine object.

title

Type String

The title for the Product within the CartLine object.

total

Type Money

The gross total for the CartLine.

unitPrice

Type Money

The price per unit of the product in the CartLine. The price will include or exclude tax depending on the taxRule.

units

Type 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

Type Url

The url for the Product in the CartLine.

weight

Type Number

The total gross packaged weight of the line in kg.

width

Type Number

The individual packaged width of the product in mm.



CartLine.attributes
reference

Type String

The type reference for the attribute, this is used by the system to recognise unique properties of a CartLine.

title

Type String

The title for the attribute e.g. Size.

type

Type String

The type of attribute in use.

value

Type String

The value for the attribute e.g. Large, when the title is Size.



CartLine.booking
day

Type Date

The day/date to attend the EventSlot.

end

Type String

The end time of the EventSlot to attend.

start

Type String

The start time of the EventSlot to attend.

title

Type String

The title of the EventSlot to attend.