> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pcnaid.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Quickstart

> Get oriented with Pcnaid Loyalty & Rewards — scopes, extensions, and where to find the API reference.

# Quickstart

Pcnaid Loyalty & Rewards is a Shopify loyalty and rewards app that provides points, rewards, referrals, VIP tiers, campaigns, store credit, memberships, and notifications across storefront, checkout, customer accounts, and POS.

## App identity

* **App name:** Pcnaid Loyalty & Rewards
* **App proxy:** `/apps/loyalty/*` → `/api/loyalty/*`

## Shopify access scopes

The app requests these OAuth scopes (from `shopify.app.toml`):

| Scope | Purpose |
| - | - |
| `read_orders`, `write_orders` | Points and refund accounting, order metafields |
| `read_products`, `write_products` | Product rewards, review context, product metafields |
| `read_customers`, `write_customers` | Member enrollment, balances, eligibility, tags |
| `read_discounts`, `write_discounts` | Loyalty discount code creation and management |
| `read_metaobject_definitions`, `write_metaobject_definitions` | App-owned loyalty catalog definitions |
| `read_metaobjects`, `write_metaobjects` | Loyalty data metaobject entries |
| `write_pixels`, `read_pixels`, `read_customer_events` | Loyalty web pixel event ingestion |
| `read_store_credit_accounts`, `read_store_credit_account_transactions`, `write_store_credit_account_transactions` | Shopify native store credit |
| `read_themes` | Theme listing for app block placement (read-only) |

The app uses online tokens (`use_online_tokens = true`) alongside offline background tokens.

## Extension list

| Extension | Type | Target |
| - | - | - |
| **Loyalty Theme Widgets** | Theme App Extension | 10 storefront Liquid blocks |
| **Checkout Loyalty** | Checkout UI Extension | `purchase.checkout.block.render` |
| **POS Loyalty** | POS UI Extension | `pos.customer-details.block.render` |
| **Customer Account Loyalty** | Customer Account Extension | `customer-account.page.render` |
| **Flow Loyalty Triggers** | Flow trigger extension | 10 triggers |
| **Flow Loyalty Actions** | Flow action extension | 6 actions + 5 review templates |
| **Loyalty Web Pixel** | Web pixel extension | Strict-sandbox storefront events |

## Public integration points

* **Public REST API** — tenant-bound API key endpoints at `/api/public/v1/*` covering customers, points, credits, rewards, redemptions, earn rules, redeem rules, custom events, and more. See the [API overview](https://docs.pcnaid.com/nodes/shopify/loyalty-rewards/developer/api/index.md).
* **App proxy** — signed `/apps/loyalty/*` endpoints for storefront customer data, redemption, referrals, history, popups, social actions, wallet passes, and opt-in/out.
* **JavaScript SDK** — TypeScript SDK for headless/custom storefronts.
* **Hydrogen helpers** — server-side API client for Shopify Hydrogen stores.
* **Outbound webhooks** — Svix-compatible HMAC-signed delivery with retry and replay. See [webhooks](https://docs.pcnaid.com/nodes/shopify/loyalty-rewards/developer/webhooks/index.md).
* **Shopify Flow integration** — 10 triggers and 6 actions.

## Sign-in model

The app is a Shopify embedded app. Merchants authenticate via Shopify OAuth. Admin routes derive the shop from the authenticated admin session. App proxy routes use signed proxy params. Webhooks use Shopify's authenticated webhook HMAC.

## Next steps

* [Architecture overview](https://docs.pcnaid.com/nodes/shopify/loyalty-rewards/developer/architecture-overview.md)
* [API reference](https://docs.pcnaid.com/nodes/shopify/loyalty-rewards/developer/api/index.md)
* [Webhooks](https://docs.pcnaid.com/nodes/shopify/loyalty-rewards/developer/webhooks/index.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.