> ## 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 to the POS True Retail Operations app, its Shopify scopes and extensions, and its integration points.

# Quickstart

## What this app is

POS True Retail Operations is a production Shopify embedded app plus POS UI extensions for register-level price adjustments, transaction voids, store credit, inventory and cash operations, and an audit trail. The backend is a Cloudflare Worker (Hono) with D1 storage and Shopify Admin GraphQL access.

## Entry points

| Surface | What it is |
| - | - |
| Embedded admin | A React (Vite + Polaris) App Home inside Shopify admin, served as the Worker's static assets |
| POS UI extensions | Price adjustment, void transaction, store credit, and retail workflows |
| Worker API | Session-token-authenticated endpoints plus public release and callback routes |
| Webhooks | Six Shopify subscriptions including the three mandatory GDPR topics |

## Shopify scopes

The app declares these access scopes in `shopify.app.toml`:

```text theme={null}
read_orders,write_orders,read_products,write_products,read_customers,write_customers,read_locations,read_inventory,write_inventory,read_metaobjects,write_metaobjects,read_metaobject_definitions,write_metaobject_definitions,write_store_credit_account_transactions
```

The app requests `read_customers` and `read_orders`, so Protected Customer Data approval is an owner action in the Shopify Partner Dashboard. The app does not subscribe to customer or order privacy-event data beyond Shopify's mandatory compliance topics.

## POS extensions

The production app ships four POS UI extensions from `extensions/`:

* `price-adjustment` — Smart Grid tile/modal plus a cart line-item action.
* `void-transaction` — Smart Grid tile/modal plus an order action.
* `store-credit` — Smart Grid tile/modal plus a customer action.
* `retail-workflows` — Smart Grid tile/modal for location work.

A fifth package, the receipt-footer renderer, is built and tested but excluded from production because Shopify classifies its target as developer preview. The production extension set is a closed allowlist in `shopify.app.toml`.

## Integration points

* Authenticate API calls with a Shopify session token: `Authorization: Bearer <shopify-session-token>`.
* Start integration reads with `GET /api/health` (authenticated) and `GET /healthz` (public release identity).
* Use the [API overview](https://docs.pcnaid.com/nodes/shopify/pos-true-retail-operations/developer/api/index.md) for the full endpoint list and the [Webhooks](https://docs.pcnaid.com/nodes/shopify/pos-true-retail-operations/developer/webhooks/index.md) page for topics and signature verification.

## OAuth

The app uses Shopify OAuth 2.0. `GET /auth` begins the flow and `GET /auth/callback` completes it. Access tokens are stored encrypted in D1.

[Pcnaid Documentation](https://docs.pcnaid.com/namespace/index.md) › [Shopify Ecosystem](https://docs.pcnaid.com/hubs/shopify-ecosystem/index.md) › [POS True Retail Operations Suite](https://docs.pcnaid.com/nodes/shopify/pos-true-retail-operations/index.md) › [Developer](https://docs.pcnaid.com/nodes/shopify/pos-true-retail-operations/developer/index)


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