Introduction to Joy Loyalty Widget Integration with Hydrogen
The Joy Loyalty Widget Integration is your bridge to creating a seamless, engaging loyalty experience in a Hydrogen-powered Shopify store. It's a comprehensive solution that transforms customer interactions into valuable, rewarding moments.
You can find a complete guide on our
Why do you need to integrate
Building your Shopify store with Hydrogen, integrating Joy Loyalty is a game-changer. A loyalty program boosts customer retention, increases average order value, and strengthens brand loyalty. With Joy Loyalty, you can incentivize repeat purchases, stand out from competitors, and gain insights into shopper behavior—all while delivering a seamless experience.
How to enable custom storefront development
Go to Settings > Developers > Enable Custom Storefront development
How to set up your Hydrogen store
If you are not on Shopify Plus plan but still want to test this out with development store first. You can update your .env file with Storefront API key from your Custom App
After this, you should be able to see the Joy Loyalty widget in your storefront. Besides, the quickstart template of Hydrogen has box-sizing: content-box so the floating button may look a bit weird. You can add this CSS to app. css to fix it. Otherwise, there should be no CSS issues.
// app/routes/products.$handle.jsx
import {AnalyticsPageType} from '@shopify/hydrogen';
async function loadCriticalData({context, params, request}) {
const {handle} = params;
const {storefront} = context;
if (!handle) {
throw new Error('Expected product handle to be defined');
}
const [{product}] = await Promise.all([
storefront.query(PRODUCT_QUERY, {
variables: {handle, selectedOptions: getSelectedProductOptions(request)},
}),
// Add other queries here, so that they are loaded in parallel
]);
if (!product?.id) {
throw new Response(null, {status: 404});
}
return {
product,
// We need this to detect the page type
analytics: {
pageType: AnalyticsPageType.product,
},
};
}
const PRODUCT_QUERY = `#graphql
query Product($handle: String!, $selectedOptions: [SelectedOptionInput!]!) {
product(handle: $handle) {
id
title
handle
productType
tags
selectedVariant: selectedOrFirstAvailableVariant {
id
price {
amount
}
compareAtPrice {
amount
}
selectedOptions {
name
value
}
}
# Need to add this if have not had it in the query
collections(first: 100) {
nodes {
title
}
}
# Need to add this if have not had it in the query
variants(first: 250) {
nodes {
...ProductVariant
selectedOptions {
name
value
}
# Required for limitations
limitation: metafield(namespace: "custom", key: "limitation") {
value
}
}
}
}
}
`;
Component Implementation
In your product page (e.g., app/routes/products.$handle.jsx):
import {useJoyLoyaltyCalculator} from 'joyso-hydrogen-sdk';
export default function Product() {
// 1. Get product data from loader
const {product, analytics} = useLoaderData();
// 2. Initialize the calculator
useJoyLoyaltyCalculator({
product,
analytics,
});
// 3. Render product details with calculator
return (
<div className="product">
<ProductImage image={selectedVariant?.image} />
<div className="product-main">
<h1>{title}</h1>
<ProductPrice
price={selectedVariant?.price}
compareAtPrice={selectedVariant?.compareAtPrice}
/>
<br />
{/* Add the calculator block */}
<div className="joy-points-calculator__block"></div>
<br />
<ProductForm
productOptions={productOptions}
selectedVariant={selectedVariant}
/>
</div>
</div>
);
}
Test the widget
After these are implemented, you will see the widget display on your custom storefront according to your settings. However, you can compare the widgets on the custom storefront and the Online Store channel to make sure both are working properly. With the widget, you can earn points, redeem points, and use coupons seamlessly on your store.
Wrap up
Our app has other features such as Joy Point Calculator, Joy Rewards Page, etc. If you want to build your own Rewards page using Hydrogen, we will have another post showing how to implement this Rewards page using our Public API and JavaScript SDK.
We hope that this guide provides you with the first step on how to integrate the Joy Loyalty Program widget into your Headless Commerce store.
If you've already developed your Hydrogen store, you're all set! However, if you haven't started yet or are looking to test a Hydrogen store with Joy Loyalty, don't worry. You can easily set up a quick-start Hydrogen store by following this guide: .
