# Yuko Documentation

## Docs

- [Email Blacklist](https://docs.yuko.so/account/email-blacklist.md): Block disposable email domains and known fraud sources from earning loyalty rewards.
- [General](https://docs.yuko.so/account/general.md): Store name, currency, timezone and core preferences.
- [Account Settings](https://docs.yuko.so/account/overview.md): Configure store-wide preferences — platform connections, email blacklist and core account details.
- [Platforms](https://docs.yuko.so/account/platforms.md): Connected commerce platforms and multi-store setup.
- [Activity Object](https://docs.yuko.so/activity-object.md)
- [Create or update a customer identity](https://docs.yuko.so/create-or-update-a-customer-identity.md)
- [Customer Identity Object](https://docs.yuko.so/customer-identity-object.md)
- [Customer Reward Object](https://docs.yuko.so/customer-reward-object.md)
- [Authentication](https://docs.yuko.so/developer/api/authentication.md)
- [Points estimate](https://docs.yuko.so/developer/api/checkout-points-estimate.md)
- [Classic pagination](https://docs.yuko.so/developer/api/classic-pagination.md)
- [Create a points transaction](https://docs.yuko.so/developer/api/create-a-points-transaction.md)
- [Errors](https://docs.yuko.so/developer/api/errors.md)
- [Get customer balance](https://docs.yuko.so/developer/api/get-customer-balance.md)
- [Get customer tier](https://docs.yuko.so/developer/api/get-customer-tier.md)
- [Get redeemable rewards](https://docs.yuko.so/developer/api/get-redeemable-rewards.md)
- [Get referral program](https://docs.yuko.so/developer/api/get-referral-program.md)
- [Introduction](https://docs.yuko.so/developer/api/introduction.md)
- [List customer activities](https://docs.yuko.so/developer/api/list-customer-activities.md)
- [List customer referrals](https://docs.yuko.so/developer/api/list-customer-referrals.md)
- [List customer rewards](https://docs.yuko.so/developer/api/list-customer-rewards.md)
- [List customers](https://docs.yuko.so/developer/api/list-customers.md)
- [Get customer membership](https://docs.yuko.so/developer/api/list-memberships.md)
- [List points transactions](https://docs.yuko.so/developer/api/list-points-transactions.md)
- [List rewards](https://docs.yuko.so/developer/api/list-rewards.md)
- [List VIP tiers](https://docs.yuko.so/developer/api/list-vip-tiers.md)
- [List earning rules](https://docs.yuko.so/developer/api/list-ways-to-earn.md)
- [Rate Limits](https://docs.yuko.so/developer/api/rate-limits.md)
- [Redeem a reward](https://docs.yuko.so/developer/api/redeem-reward.md)
- [Retrieve a customer](https://docs.yuko.so/developer/api/retrieve-a-customer.md)
- [Loyalty Emails](https://docs.yuko.so/emails/loyalty-emails.md): Templates for points earned, redeemed, tier changes, expiry reminders and personal milestones.
- [Membership Emails](https://docs.yuko.so/emails/membership-emails.md): Templates for membership unlock and membership lost moments.
- [Email Notifications](https://docs.yuko.so/emails/overview.md): Automated emails sent to customers in response to loyalty events — points earned, rewards redeemed, tier changes, referrals, memberships and more.
- [Referral Emails](https://docs.yuko.so/emails/referral-emails.md): Templates for the three referral lifecycle moments — advocate signup, friend reward delivery and advocate reward delivery.
- [Sender & Branding](https://docs.yuko.so/emails/sender-and-branding.md): Configure the from address, sender name, and how store branding flows into your loyalty emails.
- [Shortcodes Reference](https://docs.yuko.so/emails/shortcodes.md): Every merge tag available in Yuko email templates, grouped by category.
- [Template Editor](https://docs.yuko.so/emails/template-editor.md): Use Yuko's visual editor to customise the content, layout and design of every email template.
- [Glossary](https://docs.yuko.so/getting-started/glossary.md): Plain-language definitions of every Yuko term used in this documentation.
- [Quickstart (Shopify)](https://docs.yuko.so/getting-started/quickstart.md): Install Yuko, configure your first earn and redeem rules, and launch a working loyalty program in under an hour.
- [Theme Compatibility & Requirements](https://docs.yuko.so/getting-started/theme-compatibility.md): Confirm your Shopify theme and plan can render Yuko's widgets and extensions.
- [Welcome to Yuko](https://docs.yuko.so/getting-started/welcome.md): Yuko is a loyalty, referrals, VIP, memberships, reviews and workflows platform built for Shopify merchants.
- [Activate the Checkout UI Extension](https://docs.yuko.so/installation-and-setup/checkout-ui-extension.md): Add Yuko's Checkout extension to surface points and redemption options inside Shopify Checkout.
- [Activate the Customer Account Extension](https://docs.yuko.so/installation-and-setup/customer-account-extension.md): Add the Yuko Loyalty hub inside Shopify's new customer accounts.
- [Install Yuko on Shopify](https://docs.yuko.so/installation-and-setup/install-on-shopify.md): Install the Yuko app on your Shopify store, approve permissions and pick a plan.
- [Enable the Yuko Theme App Embed](https://docs.yuko.so/installation-and-setup/theme-app-embed.md): Activate Yuko's theme app embed so storefront widgets can render on your Shopify theme.
- [Verify Your Setup](https://docs.yuko.so/installation-and-setup/verify-setup.md): A short checklist to confirm Yuko is installed correctly and rendering on your live storefront.
- [Custom Apps](https://docs.yuko.so/integrations/custom-apps.md): Connect a custom OAuth or API-key based integration that's not in the standard catalogue.
- [Engati](https://docs.yuko.so/integrations/engati.md): Conversational AI — trigger Engati bot flows from Yuko loyalty events.
- [Facebook & Instagram](https://docs.yuko.so/integrations/facebook-instagram.md): Social verification for Like and Follow earning campaigns.
- [Google Business](https://docs.yuko.so/integrations/google-business.md): Connect your Google Business profile for review-related integrations.
- [Klaviyo](https://docs.yuko.so/integrations/klaviyo.md): Sync customers, points, VIP tier, referral and membership data into Klaviyo as profile properties and trigger events. Use them inside Klaviyo segments, dynamic email content and flows.
- [KwikEngage](https://docs.yuko.so/integrations/kwik-engage.md): Multi-channel messaging (SMS, WhatsApp, push) triggered by Yuko loyalty events.
- [Omnisend](https://docs.yuko.so/integrations/omnisend.md): Sync customers, points, tier and loyalty events into Omnisend.
- [Integrations](https://docs.yuko.so/integrations/overview.md): Connect Yuko to your email, messaging, social and analytics tools — plus the always-available REST API and Webhooks.
- [REST API](https://docs.yuko.so/integrations/rest-api.md): Read and write Yuko data programmatically — customers, points, rewards, tiers, referrals, memberships.
- [Retainful](https://docs.yuko.so/integrations/retainful.md): Email marketing and abandoned cart recovery powered by Yuko loyalty data.
- [Shopify Flow](https://docs.yuko.so/integrations/shopify-flow.md): Trigger Shopify Flow workflows from Yuko loyalty events — native automations on top of your existing Shopify automation stack.
- [Webhooks](https://docs.yuko.so/integrations/webhooks.md): Receive real-time HTTP callbacks when Yuko events happen — the right way to integrate Yuko with anything else.
- [Customers](https://docs.yuko.so/loyalty/customers.md): View customer points balances, activity, rewards, recent orders and adjust points manually.
- [Loyalty Program](https://docs.yuko.so/loyalty/overview.md): Reward customers with points for orders, sign-ups, social actions and more — then let them redeem for discounts, free products, free shipping or store credit.
- [Program Settings](https://docs.yuko.so/loyalty/program-settings.md): Configure your program-wide loyalty rules — points label, conversion ratio, customer eligibility, exclusions and Shopify customer tagging.
- [Anniversary](https://docs.yuko.so/loyalty/ways-to-earn/anniversary.md): Award customers a yearly points bonus on the anniversary of their account signup.
- [Birthday](https://docs.yuko.so/loyalty/ways-to-earn/birthday.md): Award customers a yearly points bonus on their birthday.
- [Daily Visit](https://docs.yuko.so/loyalty/ways-to-earn/daily-visit.md): Reward customers for visiting your store on a daily, weekly or monthly cadence.
- [Facebook Like](https://docs.yuko.so/loyalty/ways-to-earn/facebook-like.md): Reward customers with points for liking your Facebook page.
- [Facebook Share](https://docs.yuko.so/loyalty/ways-to-earn/facebook-share.md): Reward customers with points for sharing your store on Facebook.
- [Instagram Follow](https://docs.yuko.so/loyalty/ways-to-earn/instagram-follow.md): Reward customers with points for following your Instagram account.
- [Ways to Earn](https://docs.yuko.so/loyalty/ways-to-earn/overview.md): Configure how customers earn points across your store — from order placements to social actions and birthdays.
- [Place an Order](https://docs.yuko.so/loyalty/ways-to-earn/place-an-order.md): Reward customers with points every time they complete a paid order on your Shopify store. The cornerstone of any loyalty program.
- [Sign Up](https://docs.yuko.so/loyalty/ways-to-earn/sign-up.md): Reward customers with points the first time they create an account on your Shopify store.
- [Subscribe to Newsletter](https://docs.yuko.so/loyalty/ways-to-earn/subscribe-to-newsletter.md): Reward customers for opting in to your email newsletter.
- [Twitter Follow](https://docs.yuko.so/loyalty/ways-to-earn/twitter-follow.md): Reward customers with points for following your X (Twitter) account.
- [Write a Review](https://docs.yuko.so/loyalty/ways-to-earn/write-a-review.md): Reward customers with points when they submit a product or shop review.
- [Amount Discount](https://docs.yuko.so/loyalty/ways-to-redeem/amount-discount.md): Let customers redeem points for a fixed-amount discount applied at cart or checkout.
- [Free Product](https://docs.yuko.so/loyalty/ways-to-redeem/free-product.md): Let customers redeem points for a specific free product added to their cart.
- [Free Shipping](https://docs.yuko.so/loyalty/ways-to-redeem/free-shipping.md): Let customers redeem points to remove shipping costs from their order.
- [Ways to Redeem](https://docs.yuko.so/loyalty/ways-to-redeem/overview.md): Configure the rewards customers can claim with their points — from amount discounts to free products and store credit.
- [Percentage Discount](https://docs.yuko.so/loyalty/ways-to-redeem/percentage-discount.md): Let customers redeem points for a percentage discount on their order.
- [Store Credit](https://docs.yuko.so/loyalty/ways-to-redeem/store-credit.md): Let customers convert points into a flexible store credit balance they can spend across orders.
- [Membership Object](https://docs.yuko.so/membership-object.md)
- [Contracts](https://docs.yuko.so/memberships/contracts.md): Manage active customer memberships — view subscribers, status, history and handle cancellations.
- [Memberships](https://docs.yuko.so/memberships/overview.md): Sell paid memberships with recurring contracts, exclusive perks and Shopify-native checkout validation.
- [Membership Plans](https://docs.yuko.so/memberships/plans.md): Create paid membership plans with custom benefits, pricing and billing terms.
- [Membership Validation at Checkout](https://docs.yuko.so/memberships/validation-extension.md): A Shopify Checkout extension that validates active membership at checkout and enforces member-only product access.
- [Cart Membership Upsell Widget](https://docs.yuko.so/memberships/widgets/cart-membership-upsell.md): Promote your membership plans on the cart page so customers can join before checking out.
- [Checkout Membership Upsell Widget](https://docs.yuko.so/memberships/widgets/checkout-membership-upsell.md): Promote membership plans inside Shopify Checkout via the Checkout UI extension.
- [Profile Membership Widget](https://docs.yuko.so/memberships/widgets/profile-membership.md): Show the customer's membership status, benefits and renewal date inside their profile.
- [Branding & Locale](https://docs.yuko.so/onsite-widgets/branding-and-locale.md): Apply consistent branding (colors, fonts, icons) and language settings across every Yuko widget.
- [Cart Earn Widget](https://docs.yuko.so/onsite-widgets/cart-earn.md): Show customers the total points they'll earn for the items in their cart — visible at the moment they decide to check out.
- [Cart Redeem Widget](https://docs.yuko.so/onsite-widgets/cart-redeem.md): Show customers their points balance, available rewards and VIP status directly in the cart — letting them apply rewards before checkout.
- [Checkout Earn Widget](https://docs.yuko.so/onsite-widgets/checkout-earn.md): Show customers the points they'll earn for this order, inside Shopify Checkout.
- [Checkout Redeem Widget](https://docs.yuko.so/onsite-widgets/checkout-redeem.md): Let customers apply their loyalty rewards directly inside Shopify Checkout.
- [Customer Account Page (Loyalty Hub)](https://docs.yuko.so/onsite-widgets/customer-account-page.md): Add the full loyalty hub — balance, rewards, VIP status, activity — inside Shopify's new customer accounts.
- [Customer Profile Point Balance Widget](https://docs.yuko.so/onsite-widgets/customer-profile-balance.md): Show the customer's points balance on their profile page inside the storefront.
- [Floating Rewards Launcher](https://docs.yuko.so/onsite-widgets/floating-launcher.md): A persistent loyalty launcher button visible on every page, opening a side panel with balance, rewards and VIP status.
- [Order List Point Balance Widget](https://docs.yuko.so/onsite-widgets/order-list-balance.md): Show the customer's current points balance on their Shopify order history page.
- [Order Status Earn Widget](https://docs.yuko.so/onsite-widgets/order-status-earn.md): Confirm earned points on the Shopify thank-you / order status page right after a customer completes their order.
- [Onsite Widgets](https://docs.yuko.so/onsite-widgets/overview.md): Show points, rewards and VIP status across product pages, cart, checkout, customer accounts and a dedicated loyalty hub.
- [Product Page Earn Widget](https://docs.yuko.so/onsite-widgets/product-page-earn.md): Show customers how many points they will earn on a specific product, directly on the product detail page.
- [Rewards Landing Page](https://docs.yuko.so/onsite-widgets/rewards-landing-page.md): A standalone storefront page that explains the loyalty program and lets customers see their balance and rewards in one place.
- [Points Transaction object](https://docs.yuko.so/points-transaction-object.md)
- [Referrals](https://docs.yuko.so/referrals/overview.md): Turn customers into advocates with a dual-reward referral program — customisable rewards, fraud prevention, social sharing and UTM tracking, all built in.
- [Program Setup](https://docs.yuko.so/referrals/program-setup.md): Configure the referral rewards, sharing channels, fraud prevention and UTM tracking for your referral program.
- [Reward Types](https://docs.yuko.so/referrals/reward-types.md): Pick the right reward for the referrer and the friend.
- [Storefront Widget](https://docs.yuko.so/referrals/widget.md): Add the referral share widget to your storefront so customers can find their referral link, share it, and track successful referrals.
- [Retrieve a points transaction](https://docs.yuko.so/retrieve-a-points-transaction.md)
- [Third Party Checkout Provider Integration Guide](https://docs.yuko.so/third-party-checkout-integrations.md): Step-by-step guide for third party checkout providers to integrate Yuko Loyalty into the checkout experience.
- [VIP Tier Change Object](https://docs.yuko.so/vip-tier-change-object.md)
- [VIP Tiers](https://docs.yuko.so/vip-tiers/overview.md): Reward your most valuable customers with tier-based perks, points multipliers and progression milestones.
- [Action Nodes](https://docs.yuko.so/workflows/action-nodes.md): Send email, credit or debit points, issue a coupon — the things workflows actually do.
- [Workflow Analytics](https://docs.yuko.so/workflows/analytics.md): Track entries, completions and step-level drop-off for every workflow.
- [Build Your First Workflow](https://docs.yuko.so/workflows/build-your-first.md): A 10-minute walkthrough that takes you from a blank canvas to a live workflow.
- [Workflows](https://docs.yuko.so/workflows/overview.md): Visual automation — trigger emails, points and coupons in response to customer events without writing code.
- [Partner Nodes](https://docs.yuko.so/workflows/partner-nodes.md): Hand off workflow execution to Engati or KwikEngage for chat / SMS / WhatsApp messaging.
- [Triggers & Conditions](https://docs.yuko.so/workflows/triggers-and-conditions.md): Triggers start a workflow. Conditions branch it.
- [Wait & Exit Nodes](https://docs.yuko.so/workflows/wait-and-exit.md): Pause workflow execution and end a workflow cleanly.

## OpenAPI Specs

- [openapi](https://docs.yuko.so/collect-reviews/openapi.json)

## Optional

- [Install Yuko](https://apps.shopify.com/yuko)
- [Support](https://yuko.so/support/)
- [Blog](https://yuko.so/blog/)