Skip to content
Ayra Docs

Install & connect

Installing Ayra is a normal Shopify app install: open the listing (or your private beta invite link), review the permissions, approve, and Ayra opens embedded in your Shopify admin. Connecting takes a few more minutes: pick the modules you want on, enable the app embed in your theme, and confirm that customer accounts are set to the new customer accounts so the account hub can appear. Nothing changes on your storefront until you add a block or enable a module.

  • You need a Shopify store on any plan. Checkout UI extensions (reward redemption inside checkout) need Shopify Plus; everything else works on every plan.
  • Your theme should be an Online Store 2.0 theme (any theme that supports app blocks in the theme editor). Ayra does not modify theme files.
  • If you are replacing another app, read the matching migration guide first. You can keep the old app installed while Ayra imports its data.
  1. During private beta, open the invite link we send you. After launch, open the Ayra listing on the Shopify App Store and click Install.
  2. Shopify shows the permissions Ayra requests (the table below). Click Install app.
  3. Ayra opens inside your admin. Sign-in is handled by Shopify; there is no separate Ayra account or password.
  4. The onboarding screen asks which modules to turn on and offers to import from another app. You can change both later.

Ayra asks only for what the modules you can turn on actually need. The exact list is declared in the app’s configuration file and will be copied here from it before launch.

ScopeWhy Ayra needs itModule
read_customers, write_customersOne profile per customer; tags and metafields for tier and walletAll
read_ordersSignals (order placed, delivered, refunded), order metering for billing, attributionAll
read_productsProduct and variant data for wishlist, back in stock, reviews and recommendationsWishlist, Back in Stock, Reviews, Pre-Order
read_inventoryRestock detectionBack in Stock (later)
write_discountsRewards issued as discount codes and checkout discount functionsLoyalty, Referrals
read_store_credit_accounts, write_store_credit_account_transactionsStore credit as the default reward and Smart Wallet balancesLoyalty, Referrals
read_metaobjects, write_metaobjectsThe ayra_* metaobject definitions themes can readAll
write_pixels, read_customer_eventsStorefront signals through a web pixel (no theme script injection)All
read_selling_plans, write_selling_plansSubscriptions and pre-order selling plansSubscriptions, Pre-Order (later)
read_marketing_events, write_marketing_eventsAttribution of flows and campaigns in Shopify reportsFlows (later)
read_themesDetect whether the app embed is enabled so setup can show the right instructionsAll

Ayra never requests write access to themes, checkout, or payments.

Each module is a switch. A module that is off collects no signals and shows nothing on the storefront. Turn on the ones you are replacing another app with first; add the rest once the first is verified. The setup checklist walks the first ten minutes.

Open Online Store → Themes → Customize → App embeds and switch on Ayra. The embed loads the storefront core bundle (under 15 KB gzipped) that the theme app blocks share. Without it, blocks render but cannot talk to the account or wallet. See Storefront bundle & performance.

The account hub is built with customer account UI extensions, which require Shopify’s new customer accounts. Check Settings → Customer accounts; if your store uses classic accounts, switch to new customer accounts before enabling the Account Hub module. Loyalty and referrals work without the hub, but customers will not see their wallet in their account until it is on.

From the theme editor, add an Ayra block to a product or account page (for example the loyalty points block) and save. Open the storefront as a test customer and confirm it renders. See each module’s Storefront & account blocks page.

In the Ayra admin, open Customers and pick a recent customer. Within a minute of install you should see their orders as signals on the timeline. Place a test order; the order appears as a signal with an attribution of “none” (nothing triggered it), which is the expected baseline.

  • It does not change your theme files or add script tags.
  • It does not send any message to any customer. Flows and module messages are off until you turn them on, and every send passes through Journey Guard.
  • It does not touch existing discounts, customer tags or metafields from other apps. Imports are explicit and reversible; see Uninstall & export.

Something missing or wrong on this page? Ask us and we will fix the docs.