Link Search Menu Expand Document

Product

object

Attributes

product.accommodations

array of accommodation merchandise

An array of the product’s accommodation merchandise fields.

product.address

address

The product address.

product.blog_post_section

blog post section

The blog post section.

product.category

string

The category the product belongs to.

product.company

Company

The company the product is associated with.

product.country

string

The name of the country the product is based in.

product.dates

string

The dates of the product as a formatted string. e.g. 15 November 2024 for an experience with a duration of less than or equal to one day. e.g. 15 - 20 November 2024 for an experience with a duration of more than one day. If a product is an experience with multiple slots, this returns the range based on the depature dates, and does not account for the experience duration. e.g. November 2024 for an experience with multiple departure dates in the same month. e.g. November 2024 - January 2025 for an experience with multiple departure dates over more than one month.

product.depart_on

timestamp

  • If the product has a fixed date this returns the start date of the event as a timestamp, this can then be used in conjunction with Liquid’s built-in filters.
  • If the product is an experience with multiple slots, this returns the start date of the next upcoming or ongoing slot if there is one, or the start date of the most recent slot if all slots are in the past.

product.deposit

deposit

The product deposit.

product.display_variant

Variant

The products display variant if set in the admin.

product.duration

string

The duration of the product including duration unit e.g. 5 nights.

product.enquire_only

boolean

Returns true if the product has been marked as Enquiry Only within the product payment settings

product.extras

array of Extras

An array of the product’s extras

product.facilities

array of strings

deprecated

An array of the product’s facilities.

Deprecated, replaced with product.whats_included.included.

product.faqs

array of Faqs

An array of the product’s faqs.

product.featured_accommodations

array of accommodation merchandise

An array of the products accommodations which are flagged as featured.

product.featured_variant

Variant

The “featured” variant. This will be the display variant for this product or if none has been set, the variant with the cheapest per-person price, factoring in any promotions. If the product is an experience with multiple slots, this returns the display or cheapest variant across all upcoming slots.

product.gallery

array of Images

An array of Image objects for the products gallery.

product.has_infinite_stock

boolean

deprecated

Returns true if any variant on the product has infinite stock. If a product is an experience with multiple slots, this returns true if any variant on any upcoming date has infinite stock.

Deprecated. Not being maintained as it’s no longer used in Easol themes.

product.hero_image

Image

The products hero image.

product.has_active_promotion

boolean

deprecated

Returns true if one of the variants in the product has an active promotion.

Deprecated. Not being maintained as it’s no longer used in Easol themes.

product.highlights

array of highlights

An array of the product’s highlights.

product.host

Host

deprecated

The first product host.

Deprecated, use product.host_section instead.

product.host_section

Host section

The product host section.

product.id

string

The product id.

product.includes_accommodation

boolean

Returns a boolean indicating whether or not the product includes accommodation or is just a ticket.

product.is_multi_slot_experience

boolean

Returns a boolean indicating whether or not the product is an experience with multiple slots.

product.min_price

boolean

deprecated

Returns a humanized price for the product’s cheapest configuration e.g. $1,027 Per Person or $150 Per Night. This excludes Sold Out and Hidden variants. If the display variant is changed within the product this will be used instead of the cheapest variant.

Deprecated, prices should be retrieved from the product’s variants instead. product.featured_variant can be used to get the “featured” variant.

product.minimum_nights

number

If the product is an accommodation this will return the minimum number of nights the product can be booked for.

product.name

string

The name of the product.

product.overview

string

The overview of the product.

product.overview_image

Image

The products overview image.

product.remaining_stock

number

The sum of remaining stock for a product’s variants, if any of the variants have infinite stock this will return nil. If the product is an experience with multiple slots, this returns the sum total of remaining stock for all variants across all upcoming slots.

product.schedule

array of Schedule elements

deprecated

An array of the product’s schedule elements.

Deprecated, use product.schedule_section instead.

product.schedule_section

Schedule section

The product’s schedule section.

product.series

Series

If the product is in a series this will return a Series object.

product.shop_path

string

deprecated

The path for the product’s cart shop page.

Deprecated, please use shop_urlinstead.

product.shop_url

string

The url for the product’s cart shop page.

product.sold_out

boolean

Returns true if all of the product’s variants are sold out.

A variant is sold out if all stock is sold, it has been manually marked as ‘Sold Out’, or all slots are in the past.

product.subcategory

string

The subcategory the product belongs to.

product.tagline

string

The tagline of the product.

product.testimonials

array of Testimonials

An array of the product’s testimonials.

product.transfers

array of transfers

deprecated

An array of the product’s transfers.

Deprecated, the product admin no longer contains transfer settings. Extras should be used instead.

product.trip_tips

array of Trip tips

An array of the product’s trip tips.

product.type

string

The type of this product, one of "experience" or "accommodation".

product.upcoming_or_recent_slot

experience slot

The product’s next upcoming or ongoing experience slot if there are any. If all dates are in the past, this returns the most recent date.

product.url

string

The url for the product’s page on the site.

product.useful_info

Useful info

The product’s useful info.

product.variants

array of variants

An array of the product’s variants.

product.variant_modifiers

array of modifiers

deprecated

An array of modifiers associated with this product. Deprecated, modifiers should be accessed through each variant modifier group or extra modifier group.

product.venue

Venue

The product’s venue.

product.whats_included

what’s included

The product’s what's included.


Table of contents