Products

Simplified hooks

Return SimpleProduct objects with pre-computed prices and images.

Name	Type	Purpose
`useProducts(storeUid, currency)`	Hook	Fetch all products for a store
`useProduct(productUid)`	Hook	Fetch a single product by UID
`fetchProducts(storeUid, currency)`	Method	Server-side fetch of all products
`fetchProduct(productUid)`	Method	Server-side fetch of a single product

import { useProducts, useProduct } from "@colossal-sh/storefront-sdk";

// All products
const { products, isLoading } = useProducts(storeUid, "USD");

// Single product (currency resolved automatically)
const { product } = useProduct("product-uid-here");

Full data hooks

Return the full StoreProduct shape from the GraphQL API, including all variant, pricing, media, and deliverable data.

Name	Type	Purpose
`useStoreProducts(storeUid)`	Hook	Fetch all products for a store
`useStoreProduct(productUid)`	Hook	Fetch a single product by UID
`fetchStoreProducts(storeUid)`	Method	Server-side fetch of all products
`fetchStoreProduct(productUid)`	Method	Server-side fetch of a single product

import { useStoreProducts, useStoreProduct } from "@colossal-sh/storefront-sdk";

// All products
const { data } = useStoreProducts(storeUid);
const products = data?.productsByStoreUid ?? [];

// Single product
const { data } = useStoreProduct("product-uid-here");
const product = data?.product;

Types

SimpleProduct

Returned by useProducts, useProduct, fetchProducts, and fetchProduct.

SimpleProduct

Show properties

string

required

Product UID.

string

required

Product name.

string

Short tagline.

string

Full description.

number

required

Resolved price from the default variant.

string

required

Formatted price with currency symbol (e.g. "$19.99" or "$9.99/month").

string

required

Currency code.

string[]

required

All media URLs from the default variant.

string

Subscription interval (e.g. "month", "year").

Deliverable[]

required

What the customer receives after purchase.

Show properties

string

required

Unique deliverable identifier.

string

required

Deliverable name.

string

required

file_download, api_key, discord_access, shippable, or custom.

JSON

Type-specific configuration.

StoreProduct

Returned by useStoreProducts, useStoreProduct, fetchStoreProducts, and fetchStoreProduct. The full product shape from the GraphQL API.

StoreProduct

Show properties

string

required

Unique product identifier.

string

required

Product name.

string

Short tagline.

string

Full product description.

JSON

Structured content blocks.

Variant

required

The default variant for this product.

Show properties

string

required

Unique variant identifier.

string

required

Variant name.

number

Current inventory count.

Price[]

List of prices for this variant.

Show properties

string

required

Unique price identifier.

string

required

Three-letter ISO currency code (e.g. USD).

boolean

required

Whether this is the default price for the variant.

string

Subscription interval: month or year. Absent for one-time purchases.

string

Trial period (e.g. one_week, one_month).

LinearPrice | VolumePrice

required

Pricing configuration. Linear has a flat unitPrice. Volume has tiers with firstUnit, lastUnit, and unitPrice.

Media[]

Images and videos attached to this variant.

Show properties

string

required

Unique media identifier.

string

required

Media URL.

string

required

IMAGE or VIDEO.

string

required

Processing status.

Deliverable[]

What the customer receives after purchase.

Show properties

string

required

Unique deliverable identifier.

string

required

Deliverable name.

string

required

file_download, api_key, discord_access, shippable, or custom.

JSON

Type-specific configuration.

Next steps

Cart. Add products to the cart and manage line items
Products concepts. Understand the product data model and pricing

Get started

Platform

Agents

Automations

Storefront

Dev Tools

Simplified hooks

Full data hooks

Types

SimpleProduct

StoreProduct

Next steps

​Simplified hooks

​Full data hooks

​Types

​SimpleProduct

​StoreProduct

​Next steps

Simplified hooks

Full data hooks

Types

SimpleProduct

StoreProduct

Next steps