Link Search Menu Expand Document

Search

object

Attributes

search.active_promotion

boolean

Returns true or false.

search.category

string

Returns the category searched.

search.country

string

Returns the country searched.

search.departure_date

object

Returns the departure_date as an object i.e. {"greater_than"=>"2022-11-19", "less_than"=>"2023-12-28"}. Specific values can be accessed via: search.departure_date.equal_to, search.departure_date.greater_than and search.departure_date.less_than as relevant.

search.departure_month

string

Returns the departure_month as a string in the form it was passed in i.e. Jan or 1.

search.duration

object

Returns the duration as an object i.e. {"greater_than"=>"3", "less_than"=>"8"}. Specific values can be accessed via: search.duration.equal_to, search.duration.greater_than and search.duration.less_than as relevant.

search.exclude_sold_out_products

boolean

Returns true or false.

search.include_organisation_products

boolean

Returns true or false.

search.month

number

Returns the month as a number, e.g. 2 would represent February.

search.series_id

string

Returns the series_id searched.

search.subcategory

string

Returns the subcategory searched.

search.sort

string

Returns name_asc, name_desc, duration_asc, duration_desc, departure_date_asc or departure_date_desc.

search.year

number

Returns the year as a number, e.g. 2023.