Themes/Theme SDK/Modules/data

data

Store reads: products, categories, collections, attributes, product types and the content pages and posts a setting points to, each one named hook with one result shape.

On this page

import { … } from '@poltura/theme-sdk/data';

Hooks

Name	What it is
`useProducts`	One page of product cards matching a query, priced for the visitor.
`useInfiniteProducts`	Product cards matching a query, a page at a time, for "load more" and endless lists.
`useProduct`	One product with every variant, option and specification, priced for the visitor.
`useCategories`	The store's categories, in the merchant's order.
`useCategory`	One category with its path, description, image and subcategories.
`useCollections`	The store's collections.
`useCollection`	One collection with its description and image.
`useProductAttributes`	Product attributes with their values, by key or as a category offers them for filtering.
`useProductTypes`	The store's product types, such as "T-shirt" or "Gift card".
`useCollectionListEntry`	One pick of a `collectionList` setting, read as a card: its title, page and image.
`usePage`	The site page a `page` setting points to.
`usePost`	The blog post or guide a `post` setting points to.

Constants

Name	What it is
`StoreReadError`	A failed store read; `instanceof StoreReadError` holds for it wherever the theme renders.

Types

Name	What it is
`Category`	A product category with its place in the category tree.
`CategoryQuery`	Which categories `useCategories` lists.
`CategoryRef`	A category as other view models link to it.
`Collection`	A hand-picked group of products with its own page.
`CollectionQuery`	Which collections `useCollections` lists.
`CollectionRef`	A collection as other view models link to it.
`InfiniteQueryResult`	What `useInfiniteProducts` answers: every page loaded so far and a way to load the next.
`PageRequest`	Which page of a list to read.
`ProductAttribute`	A merchant-defined product attribute a list can be filtered by, such as material or colour.
`ProductAttributeValue`	One value of a product attribute, such as "Cotton" or "Red".
`ProductPage`	One page of a product list.
`ProductQuery`	Which products `useProducts` lists; every given narrowing applies at once.
`ProductSort`	The orders a product list can be sorted in.
`ProductTypeRef`	A product type, such as "T-shirt" or "Gift card".
`QueryOptions`	Options every data hook takes.
`QueryResult`	What a data hook answers: the data once it arrived, the read's status and a way to read again.
`QueryStatus`	Where a read is: still loading its first answer, failed, or answered.
`StoreReadErrorCode`	Why a store read failed.
`SuspenseQueryOptions`	`QueryOptions` that suspend: the hook answers a `SuspenseQueryResult`.
`SuspenseQueryResult`	What a data hook answers with `{ suspense: true }`: the component renders only once the data is there.
`ProductLookup`	Names one product, by its URL segment or by its id.
`CategoryLookup`	Names one category, by its URL path from the root or by its id.
`CollectionLookup`	Names one collection, by its URL segment or by its id.
`ProductAttributeLookup`	Selects what `useProductAttributes` reads: by key, or every attribute a category offers.
`CollectionListPick`	One pick of a `collectionList` setting: a collection or a category by its URL segment.
`CollectionListEntry`	A collection or category in a collection list.
`ContentEntry`	A content page, blog post or guide as a setting points to it.
`PostLookup`	The value of a `post` setting: a blog post or a guide by its URL segment.

Last updated Oct 29, 2026