Reference

Use reference pages when you know which feature you need and want its exact contract. For a complete procedure, start with the how-to guides.

Project and configuration

• Project structure — app-owned and generated files.
• Configuration — registries, Shopify apps, crons, workers, and admin visibility.
• Environment variables — defaults, requirements, and resolution order.
• CLI commands — commands, flags, scripts, and process behavior.
• Public SDK — package entry points and exports.

Background work and storage

• Flows — inputs, runtime context, checkpoints, retries, and cancellation.
• Providers — fields, validation, connectors, and credentials.
• Database and migrations — models, queries, and schema ownership.
• Logging — structured logs and export.
• Errors — framework error types and failure contracts.
• Testing — test contexts, fakes, signed requests, and factories.

Shopify and HTTP

• Authentication — credentials and identity for each HTTP surface.
• Admin API — authenticated endpoint contracts.
• GraphQL codegen — operation types and Shopify client behavior.
• Proxy routes — storefront and Customer Account endpoints.
• Server routes — explicit authentication and Web Response handlers.
• Webhooks — topic matching, context, and acknowledgment behavior.
• Shopify Functions — Function definitions and configuration.
• Custom admin pages — experimental pages, loaders, actions, and policies.
• MCP — tokens, permissions, tools, resources, and JSON-RPC errors.

Security and compatibility

• Security — secret handling and trust boundaries.
• Versioning — beta compatibility and generated project updates.