Developers overview
Ayra is one Shopify app built entirely from Shopify’s extension surfaces: an embedded admin for merchants, theme app extensions (an app embed plus app blocks) for the storefront, customer account UI extensions for the account hub, checkout UI extensions and Functions for reward redemption, a POS UI extension for in-store loyalty, and Shopify Flow triggers for automation. It writes to a documented ayra.* metafield namespace and ayra_* metaobjects that themes and other apps can read, and every signal and action is a typed event. Nothing is injected into theme files, and there are no ScriptTags.
The surfaces
Section titled “The surfaces”| Surface | What Ayra uses it for | Reference |
|---|---|---|
| Embedded admin app | Modules, settings, customers and timelines, analytics, billing | — |
| Theme app extension: app embed | The storefront core bundle (wallet state, events, block runtime) | Storefront bundle & performance |
| Theme app extension: app blocks | Points, wallet summary, referral card, reviews, wishlist and restock blocks, placed from the theme editor | Theme app blocks & embeds |
| Customer account UI extensions | The account hub tabs (wallet, orders, referrals, reviews, wishlist, subscriptions) and order status blocks | Customer account extensions |
| Checkout UI extension + Function | Reward redemption inside checkout (Plus), validated by a signed cart attribute | Checkout extensions |
| POS UI extension | Look up a customer, award points, apply rewards in store | Loyalty |
| Metafields and metaobjects | Balances, tier, stage, ratings and attribution readable by themes and apps | Metafields & metaobjects reference |
| Shopify Flow triggers | Ayra signals and decisions as Flow triggers | Shopify Flow triggers |
| Web pixel | Storefront signals (views, wishlist clicks) without theme scripts | Events |
| Webhooks | Shopify → Ayra for orders, customers, products, GDPR; Ayra → you after beta | Webhooks & API |
Principles
Section titled “Principles”- Extensions, not injections. Every storefront element is a theme app block added, moved and removed from the theme editor. Uninstalling Ayra removes them; no theme cleanup.
- Shopify primitives first. Store credit, discounts, selling plans, metaobjects, new customer accounts and Flow are used as they are. Ayra’s own ledgers sit behind them for audit and reversal.
- One profile, typed events. Everything that happens is an event with a name, a customer and a payload; the admin timeline, Flow triggers and the (post-beta) API all read the same stream.
- Readable state. What a theme or another app needs (balance, tier, stage, rating, attribution) is written to metafields with a stable schema rather than requiring API calls.
- Budgeted. The storefront core is at most 15 KB gzipped and each block at most 25 KB; the pixel is separate and tiny. See the bundle page.
Working with Ayra as an agency
Section titled “Working with Ayra as an agency”- Build theme sections around Ayra’s blocks and metafields; do not scrape the DOM of a block. Blocks emit DOM events you can listen for.
- Use Flow triggers or metafields to connect Ayra to other apps today; the public API opens after private beta.
- For a client migrating from another app, the migration guides list what moves and the cut-over order.
Related
Section titled “Related”- How it works: the engine, for non-developers.
- Events
- Data & privacy
Something missing or wrong on this page? Ask us and we will fix the docs.