Products - Colossal

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.

product

SimpleProduct

Show properties

uid

string

required

Product UID.

name

string

required

Product name.

tagline

string

Short tagline.

description

string

Full description.

price

number

required

Resolved price from the default variant.

formattedPrice

string

required

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

currency

string

required

Currency code.

images

string[]

required

All media URLs from the default variant.

interval

string

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

deliverables

Deliverable[]

required

What the customer receives after purchase.

Show properties

uid

string

required

Unique deliverable identifier.

name

string

required

Deliverable name.

type

string

required

file_download, api_key, discord_access, shippable, or custom.

config

JSON

Type-specific configuration.

StoreProduct

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

product

StoreProduct

Show properties

uid

string

required

Unique product identifier.

name

string

required

Product name.

tagline

string

Short tagline.

description

string

Full product description.

contentBlocks

JSON

Structured content blocks.

defaultVariant

Variant

required

The default variant for this product.

Show properties

uid

string

required

Unique variant identifier.

name

string

required

Variant name.

inventoryCount

number

Current inventory count.

prices

Price[]

List of prices for this variant.

Show properties

uid

string

required

Unique price identifier.

currency

string

required

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

isDefault

boolean

required

Whether this is the default price for the variant.

recurringInterval

string

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

trialDuration

string

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

price

LinearPrice | VolumePrice

required

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

media

Media[]

Images and videos attached to this variant.

Show properties

uid

string

required

Unique media identifier.

url

string

required

Media URL.

type

string

required

IMAGE or VIDEO.

status

string

required

Processing status.

deliverables

Deliverable[]

What the customer receives after purchase.

Show properties

uid

string

required

Unique deliverable identifier.

name

string

required

Deliverable name.

type

string

required

file_download, api_key, discord_access, shippable, or custom.

config

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

​Simplified hooks

​Full data hooks

​Types

​SimpleProduct

​StoreProduct

​Next steps

Simplified hooks

Full data hooks

Types

SimpleProduct

StoreProduct

Next steps