Date
object
Attributes
date.date
timestamp
The date.
date.display_price
The display price for this date in the current user’s currency.
This is determined by finding the cheapest variant that is available across the slots for this date, accounting for promotions.
The price used is the price of the variant at its maximum occupancy, not the per person price.
If an experience has a “display” variant defined, it will use the price of that variant and ignore prices of other variant from that experience.
date.experience
The experience associated with this date. If the date is associated with multiple experiences, this will return the first one.
This is a convenience method to be used when you know there is only one single experience. If it’s possible the date is associated with multiple experiences, date.experiences should be used instead.
date.experiences
array of products
The experiences associated with this date.
date.initial_stock
number or nil
Sums the starting inventory for all slot-variant mappings on this date, unless any mapping is infinite (in which case it returns nil).
date.remaining_stock
number or nil
Sums the available inventory for all slot-variant mappings on this date, unless any mapping is infinite (in which case it returns nil). If any slot is marked as sold out, it is treated as having zero remaining stock.
date.slot_count
number
The total number of slots across all variants for this date. Note that this number does not represent available slots, but rather the total number of slots created on this date.
date.slots_by_variant
array of objects
This returns slot information grouped by variant. It will return an array of objects, each containing the following methods:
-
variantvariant -
slotsarray of slots
date.sold_out
boolean
This returns true if all variants are sold out across all slots on this date.