Ecommerce

Queries

Queries available for implementation in ecommerce connector apps

Canonical queries define the data-fetching contract between the frontend and your connector app. When you build an ecommerce connector, you implement query handlers for each of these queries so the frontend can retrieve products, categories, carts, and other resources from your commerce backend.

Each query has a name (used to register the handler), an entity type (the shape of data it returns), a type (single for one result, multi for paginated lists), and an input schema (the parameters the frontend sends).

Import these from @laioutr-core/canonical-types/ecommerce.

Product

ProductBySlugQuery

ecommerce/product/by-slug
Product single
Product by slug
slug
stringrequired

ProductByCategoryIdQuery

ecommerce/product/by-category-id
Product multi
Products by Category ID
categoryId
stringrequired

ProductByCategorySlugQuery

ecommerce/product/by-category-slug
Product multi
Products by category slug
categorySlug
stringrequired

ProductSearchQuery

ecommerce/product/search
Product multi
Product search
query
stringrequired
preset
string

Category

CategoryAllQuery

ecommerce/category/all
Category multi
All categories

CategoryBySlugQuery

ecommerce/category/by-slug
Category single
Category by slug
slug
stringrequired

Cart

CartGetCurrentQuery

ecommerce/cart/get-current
Cart single
Get Current Cart
ecommerce/menu/by-alias
MenuItem multi
Menu by Alias
alias
stringrequired

Wishlist

WishlistGetCurrentQuery

ecommerce/wishlist/get-current
Product multi
Wishlist

Entities