Skip to main content

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

Shopify scopes

The app declares these access scopes in shopify.app.toml:
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 for the full endpoint list and the Webhooks 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 › Shopify Ecosystem › POS True Retail Operations Suite › Developer