📦 FetchCollectionResult Type

The getCollection() function returns a standardized object that includes collection data, products (optional), pagination info, filters, and error handling.

type FetchCollectionResult = {
  data: Product[]; // List of products
  pageInfo: ProductsPageInfo | null;
  availableFilters?: FilterGroup[];
  collectionMetafields?: Record<string, any>;
  error: string | null;
  collection?: {
    id: string;
    title: string;
    handle: string;
    descriptionHtml: string;
    description: string;
    updatedAt: Date | null;
    seo: {
      title: string | null;
      description: string | null;
    };
    image: {
      originalSrc: string;
      altText: string | null;
    } | null;
  };
};

🛍️ data: Product[]​

Array of resolved product objects. Each product may include:

• id, title, handle, descriptionHtml
• price, compareAtPrice (from first variant)
• images[], featuredImage
• variants[]: each with variant-specific metafields
• Custom metafields if productMetafields, collectionMetafields, or variantMetafields are provided

➡️ For more details, see the Product Types documentation.

🔁 pageInfo: ProductsPageInfo​

Relay-style cursor-based pagination object.

type ProductsPageInfo = {
  hasNextPage: boolean;
  hasPreviousPage: boolean;
  endCursor: string | null;
  startCursor: string | null;
};

Use these values to paginate forward or backward in your UI.

🧩 availableFilters?: FilterGroup[]​

Array of filters available for the current product collection.

Returned only if Shopify filtering is enabled on metafields.

type FilterGroup = {
  id: string;
  label: string;
  values: {
    id: string;
    label: string;
    count: number;
  }[];
};

🗂️ collectionMetafields?: Record<string, any>​

Custom metafields resolved for the collection, using collectionMetafields definitions passed to the query.

Returned as camelCase or flat object depending on camelizeKeys option.

🧾 collection?: { ... }​

Resolved basic info for the queried collection (title, handle, image, etc). Only available if the collection exists.

type CollectionInfo = {
  id: string;
  title: string;
  handle: string;
  descriptionHtml: string;
  description: string;
  updatedAt: Date | null;
  seo: {
    title: string | null;
    description: string | null;
  };
  image: {
    originalSrc: string;
    altText: string | null;
  } | null;
};

❌ error: string | null​

A human-readable error message, if something went wrong.

Always check this before using data, pageInfo, or collection.