Package availability

The package_availability tag returns an object with the package availability and price for the specificed date and time. Useful when determining whether a package is sellable based on a customer’s choice in a calendar.

Example 1 - all adult counts

input

{% package_availability package, start_date: "2024-04-15", start_time: "11:00" %}
  {% assign any_available = result.is_available %}

  <select name="package[adult_count]">
    {% for adult_count in result.adult_counts %}
      <option value="{{ adult_count.count }}" {% unless adult_count.is_available %}disabled{% endunless %}>
        {{ adult_count.count }} {{ adult_count.count | pluralize: 'guest' }}
        {% if adult_count.is_available %}
          ({{ adult_count.price.fractional | money }})
        {% endif %}
      </option>
    {% endfor %}
  </select>
{% endpackage_availability %}

output

<select name="package[adult_count]">
  <option value="1">1 guest ($100)</option>
  <option value="2">2 guests ($200)</option>
  <option value="3">3 guests ($300)</option>
  <option value="4" disabled>4 guests</option>
</select>

Example 2 - specify a single adult count

input

{% package_availability package, adult_count: adult_count, start_date: start_date, start_time: start_time %}

  Package is available: {{ result.is_available }}

  {% if result.is_available %}
    Total price: {{ result.price.fractional | money }}
    Per-person price: {{ result.price.per_person_fractional | money }}
  {% endif %}
{% endpackage_availability %}

output

<p>Package is available: true</p>
<p>Total price: £180</p>
<p>Per-person price: £60</p>

Attributes

result.adult_counts

array of objects

This returns availability and price information for each adult count. It will return an array of objects, each containing the following methods:

adult_count.count

integer

The adult count.

adult_count.is_available

boolean

Whether the package is available or not for this adult count. A package will be available when all its included items and required steps items (if any) have availability on the specified date and the variants with availabilty will have enough stock to accommodate the adult count based on the quantity strategy chosen for that item when the package has been put toghether.

• If package is fixed date, all the slots need to have enough availability given the adult_count.
• If package is multi_date, there needs to be at least one available slot for each included item and each required step.

adult_count.price

Package Price

The price of the package for the adult count (total or per-person).

• If package is sum-total and is multi-date, then the price will be the sum of the price of all slots based on the date strategy chosen for each individual item (i.e. “Closest to the calendar choice”, “Exact match with calendar choice”) in relation to the specified start_date and start_time.
• If package is sum-total and is fixed-date, then the price will be the sum of the price of all slots for the given start_date and start_time.
• If the package is custom-priced it will return its custom price.

result.is_available

boolean

Whether the package is available or not. If the adult_count parameter has been provided, then this will return the availability for that adult count. Otherwise, this will return true if any of the possible adult counts have availability.

result.price

Package Price

The price of the package (total or per-person). If the adult_count parameter has been provided, then this will return the price for that adult count. Otherwise, this will return the cheapest price amongst the possible adult counts that have availability.

Parameters

It’s possible to use any of the following attributes in the package availability tag itself.

adult_acount

Optionally specify the number of guests used to look up the package availability. If this is blank, it will default to returning information about all possible adult counts e.g If passed “3”, the package availabilty tag will use return availability information based on whether the package has enough stock to accommodate 3 guests on the given start_date and start_time.

start_date

The date the package used to look up the package availability. e.g. if passed in “2024-04-15”, the package availability tag will availability information based on whether the package items will have available slots on that day (if the package is fixed date or multi-date with a “Exact match with calendar choice” strategy) or relative to the date (if the package is multi date and has available upcoming slots when the strategy is “Closest to the calendar choice”)

start_time

The date the package used to look up the package availability. e.g. if passed in “11:00”, the package availability tag will availability information based on whether the package items will have available time slots at “11:00” on that day specified at start_date (if the package is fixed date or multi-date with a “Exact match with calendar choice” strategy) or relative to the “11:00” (if the package is multi date and has available upcoming time slots on the specified start_date when the strategy is “Closest to the calendar choice”)