Introduction

The API reference documents the canonical types that define the contract between your storefront frontend and connector apps. These types are defined in the @laioutr-core/canonical-types package.

Key Concepts

Entities

Entities are the core data types your storefront works with — products, categories, carts, blog posts, and more. Each entity is composed of components (e.g., a Product has Base, Pricing, Media components) that connectors resolve independently.

Browse all entities in the Entities section.

Queries

Queries define how the frontend fetches entities. Each query specifies an input schema, the entity type it returns, and whether it returns a single item or a list. Connectors implement query handlers to serve this data from their backend.

Actions

Actions define mutations — login, add to cart, subscribe to newsletter. Each action specifies input and output schemas. Connectors implement action handlers to execute these operations.

Links

Links define relationships between entities. A link connects a source entity to a target entity (e.g., Product → ProductVariant, BlogCollection → BlogPost). Links can be single (one target) or multi (many targets with pagination).

Connectors implement link resolvers so the frontend can traverse entity relationships. Each entity's reference page lists its outgoing links.

Page Types

Page types define the kinds of pages your storefront can render and the queries each page needs. They control routing, Studio page management, and entity resolution.

Browse all page types in the Page Types section.