📦 FetchCollectionResult Type

The getCollection() function returns a standardized object that includes:

• Collection-level metafields
• Optional product list
• Pagination info (if products are included)
• Filter options (if supported)
• And full error handling

type FetchCollectionResult = {
  data: Product[];
  pageInfo: ProductsPageInfo | null;
  availableFilters?: FilterGroup[];
  collectionMetafields?: Record<string, any>;
  error: string | 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 or variantMetafields are provided

For more details, see the Product Types documentation.

📚 collectionMetafields​

Custom fields resolved from the collection’s metafields, defined using collectionMetafields.

collectionMetafields: {
  customType: "Inverters",
  showOnWebsite: true,
  ...
}

These are parsed, casted, optionally transformed, and camelized if enabled.

🔁 pageInfo: ProductsPageInfo​

Relay-style cursor-based pagination object (only when includeProducts: true):

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;
  }[];
};

❌ error: string | null​

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

Always check this before using data or pageInfo.

✅ You’re done with types!