Show pickup availability on product pages

Merchants can make their products available through local pickup, and you can display whether a specific product variant is available for local pickup on the product page. This allows customers to view this information without having to add the product to cart and proceed to checkout to view the shipping details.

In this tutorial, you'll learn how to show variant pickup availability on product pages.

Anchor to RequirementsRequirements

Variant selection functionality. The pickup availability JavaScript function needs to be run when variants are selected.

Anchor to ResourcesResources

To implement pickup availability, you'll use the following:

Anchor to Implementing pickup availabilityImplementing pickup availability

To support pickup availability functionality in your theme, you need to implements the following components:

The pickup availability section: Renders the display content, which contains information about each location that the current variant is stocked at.
The pickup availability container: An empty container on the product page that hosts the section content.
A JavaScript function: Renders the section content inside the container, and makes any updates on variant selection.

Caution

The examples below are only meant to illustrate basic considerations for implementing this feature. The full implementation will vary depending on your theme and what you want the display to look like. You can refer to the following files in Dawn for an example of a complete solution:

Anchor to The pickup availability sectionThe pickup availability section

The pickup availability section hosts the actual content to be displayed, which has two main components:

Availability summary
Availability modal

This section is rendered inside the pickup availability container by the JavaScript function.

Anchor to Availability summaryAvailability summary

The availability summary loops through the locations returned from the store_availabilites attribute of the current variant to find any locations that have pick_up_enabled set to true. If there are any, then the availability of the current variant at the first location is displayed, along with a button to open the availability modal.

Anchor to ExampleExample

Anchor to Availability modalAvailability modal

The availability modal displays the product and variant titles, and each location that the current variant is stocked at. For each location, the current availability and address are shown.

Anchor to ExampleExample

Anchor to ExampleExample

The following is an example of a pickup availability section with an availability summary and modal.

Note

You should only output the availability summary and modal if the current variant has at least one location with pickup enabled.

sections/pickup-availability.liquid

{%- assign pick_up_availabilities = product_variant.store_availabilities | where: 'pick_up_enabled', true -%}

{%- if pick_up_availabilities.size > 0 -%}

{%- assign closest_location = pick_up_availabilities.first -%}

{%- if closest_location.available -%}

{% render 'icon-in-stock' %}

{%- else -%}

{% render 'icon-out-of-stock' %}

{%- endif -%}

{%- if closest_location.available -%}

{{ 'pickup_availability.general.pick_up_available_at_html' | t: location_name: closest_location.location.name }}

</p>

</p>

<button

className="pickup-availability-information__button js-modal-open-pickup-availability-modal pickup-availability-small-text"

data-pickup-availability-modal-open aria-haspopup="dialog"

{%- if pick_up_availabilities.size == 1 -%}

{%- else -%}

{%- endif -%}

</button>

{%- else -%}

{{ 'pickup_availability.general.pick_up_unavailable_at_html' | t: location_name: closest_location.location.name }}

</p>

{%- if pick_up_availabilities.size > 1 -%}

</button>

{%- endif -%}

</div>

<div

className="pickup-availabilities-modal modal"

id="PickupAvailabilityModal"

role="dialog"

aria-modal="true"

aria-labelledby="PickupAvailabilitiesModalProductTitle"

<h2

id="PickupAvailabilitiesModalProductTitle"

className="pickup-availabilities-modal__product-title"

data-pickup-availability-modal-product-title

</h2>

className="pickup-availabilities-modal__variant-title pickup-availability-small-text"

data-pickup-availability-modal-variant-title

</p>

</div>

<button

type="button"

className="pickup-availabilities-modal__close js-modal-close-pickup-availability-modal text-link"

aria-label="{{ 'general.accessibility.close_modal' | t }}"

{% render 'icon-close' %}

</button>

</div>

{%- for availability in pick_up_availabilities -%}

</h3>

{%- if availability.available -%}

{% render 'icon-in-stock' %} {{ 'pickup_availability.general.pick_up_available' | t }}, {{ availability.pick_up_time | downcase }}

{%- else -%}

{% render 'icon-out-of-stock' %} {{ 'pickup_availability.general.pick_up_currently_unavailable' | t }}

{%- endif -%}

</div>

{%- assign address = availability.location.address -%}

</address>

{%- if address.phone.size > 0 -%}

{{ address.phone }}<br />

</p>

{%- endif -%}

</li>

{%- endfor -%}

</ul>

</div>

{%- endif -%}

</div>

{% schema %}

{

"name": {},

"settings": []

}

{% endschema %}

Anchor to The pickup availability containerThe pickup availability container

The pickup availability container is an empty <div> element that the JavaScript function will render the section contents inside of. It should be placed wherever you want the availability summary to show on the product page.

Anchor to ExampleExample

<div className="product-single__store-availability-container"

data-store-availability-container

data-product-title="{{ product.title | escape }}"

data-has-only-default-variant="{{ product.has_only_default_variant }}"

data-base-url="{{ shop.url }}{{ routes.root_url }}"

</div>

Anchor to The JavaScript functionThe JavaScript function

To add the pickup availability section content inside the pickup availability container, you need to use the section rendering API. The request needs to be prefixed with a /variants/[variant-id] parameter, where [variant-id] is the variant ID of the selected variant.

To access the variant ID, and update the display when a variant is selected, you need to make a call to your pickup availability JavaScript function from the JavaScript responsible for updating product page elements on variant selection.

Anchor to ExampleExample

fetch(window.Shopify.routes.root + "variants/[variant-id]/?section_id=pickup-availability")

.then(response => response.text())

.then(text => {

const container = document.querySelector('[data-store-availability-container]');

const pickupAvailabilityHTML = new DOMParser()

.parseFromString(text, 'text/html')

.querySelector('.shopify-section');

container.appendChild(pickupAvailabilityHTML);

})

.catch(e => {

console.error(e);

});

Tip

You can't access the Liquid product object in the pickup availability section. This means that product-specific changes, like updating the title and removing the variant title if the product only has a default variant, need to be done through JavaScript. The example availability container includes data-product-title and data-has-only-default-variant attributes for this purpose.

Was this page helpful?