Data loaders

Loaders fetch store data server-side and render it through a child function. Prefetch on the server with PrefetchedLoaders, then render with the matching loader component. The client reads the seeded cache, so the first paint has data and no loading state.

`loaders/collection-loader`

@replohq/sdk/loaders/collection-loader

import { CollectionLoader } from "@replohq/sdk/loaders/collection-loader";

Fetch a Shopify collection by handle or collection GID from Storefront API.

Argument	Type	Required	Description
`handle`	`string`	No
`collectionGid`	`string`	No

Cached for: 60s Exports

Export	Kind	Type
`CollectionLoader`	component	`({ loaderKey, handle, collectionGid, language, country, children, fallback, }: CollectionLoaderProps) => JSX.Element`

`loaders/collection-products-loader`

@replohq/sdk/loaders/collection-products-loader

import { CollectionProductsLoader } from "@replohq/sdk/loaders/collection-products-loader";

Fetch products for a Shopify collection from Storefront API with cursor pagination. Each product includes per-variant availability, price, compareAtPrice, sku, image, and options/optionValues so collection cards can render variant pickers, sold-out states, and strike-through pricing without a per-product fan-out.

Argument	Type	Required
`collectionGid`	`string`	Yes
`first`	`integer`	No
`after`	`string`	No

Always present on the result: id, handle, title, availableForSale, featuredImage, minPrice, maxPrice, compareAtMinPrice, compareAtMaxPrice, options, variants Cached for: 60s Exports

Export	Kind	Type
`CollectionProductsLoader`	component	`({ loaderKey, collectionGid, first, after, language, country, children, fallback, }: CollectionProductsLoaderProps) => JSX.Element`

`loaders/contentful-entries-loader`

@replohq/sdk/loaders/contentful-entries-loader

import { ContentfulEntriesLoader } from "@replohq/sdk/loaders/contentful-entries-loader";

Fetch one page of published entries for a Contentful content type from the Delivery API (limit 1–100, default 100; use skip for further pages). Linked entries/assets resolve into includes. Response includes total/skip/limit.

Argument	Type	Required	Description
`spaceId`	`string`	Yes	Contentful space ID.
`contentType`	`string`	Yes	Content type ID whose entries (the ‘collection’) to load.
`environmentId`	`string`	No	Environment ID. Defaults to ‘master’.
`locale`	`string`	No	Locale code to return fields in (e.g. ‘en-US’). Defaults to the space’s default locale.
`order`	`string`	No	Order by a system or field path, e.g. ‘-sys.updatedAt’ or ‘fields.title’. Prefix with ’-’ for descending.
`limit`	`integer`	No	Max entries to return (1-100, default 100).
`skip`	`integer`	No	Number of entries to skip for pagination (default 0).
`include`	`integer`	No	Depth of linked entries/assets to resolve into `includes` (0-10, default 2).

Cached for: 60s Exports

Export	Kind	Type
`ContentfulEntriesLoader`	component	`({ loaderKey, spaceId, contentType, environmentId, locale, order, limit, skip, include, children, fallback, }: ContentfulEntriesLoaderProps) => JSX.Element`

`loaders/contentful-entry-loader`

@replohq/sdk/loaders/contentful-entry-loader

import { ContentfulEntryLoader } from "@replohq/sdk/loaders/contentful-entry-loader";

Fetch a single published Contentful entry by ID from the Delivery API, with linked entries/assets resolved into includes.

Argument	Type	Required	Description
`spaceId`	`string`	Yes	Contentful space ID.
`entryId`	`string`	Yes	The entry ID to load.
`environmentId`	`string`	No	Environment ID. Defaults to ‘master’.
`locale`	`string`	No	Locale code to return fields in (e.g. ‘en-US’). Defaults to the space’s default locale.
`include`	`integer`	No	Depth of linked entries/assets to resolve into `includes` (0-10, default 2).

Cached for: 60s Exports

Export	Kind	Type
`ContentfulEntryLoader`	component	`({ loaderKey, spaceId, entryId, environmentId, locale, include, children, fallback, }: ContentfulEntryLoaderProps) => JSX.Element`

`loaders/judgeme-review-aggregate-loader`

@replohq/sdk/loaders/judgeme-review-aggregate-loader

import { JudgemeReviewAggregateLoader } from "@replohq/sdk/loaders/judgeme-review-aggregate-loader";

Fetch aggregate review stats (average score, total reviews, star distribution) for a product from Judge.me.

Argument	Type	Required	Description
`productId`	`string`	Yes	Shopify numeric product ID for the product (not a GID). Same value as productExternalId on Judge.me chat tools.

Cached for: 60s Exports

Export	Kind	Type
`JudgemeReviewAggregateLoader`	component	`({ loaderKey, productId, children, fallback, }: JudgemeReviewAggregateLoaderProps) => JSX.Element`

`loaders/judgeme-reviews-loader`

@replohq/sdk/loaders/judgeme-reviews-loader

import { JudgemeReviewsLoader } from "@replohq/sdk/loaders/judgeme-reviews-loader";

Fetch published reviews for a product from the Judge.me Reviews API.

Argument	Type	Required	Description
`productId`	`string`	Yes	Shopify numeric product ID for the product (not a GID). Same value as productExternalId on Judge.me chat tools.
`perPage`	`integer`	No	Reviews to return (default 10, max 100).
`page`	`integer`	No	Page number (1-indexed, default 1).

Cached for: 60s Exports

Export	Kind	Type
`JudgemeReviewsLoader`	component	`({ loaderKey, productId, perPage, page, children, fallback, }: JudgemeReviewsLoaderProps) => JSX.Element`

`loaders/levanta-product-loader`

@replohq/sdk/loaders/levanta-product-loader

import { LevantaProductLoader } from "@replohq/sdk/loaders/levanta-product-loader";

Fetch a Levanta product by ASIN with affiliate link data.

Argument	Type	Required	Description
`asin`	`string`	Yes	Amazon ASIN
`marketplace`	`string`	No	Marketplace code, defaults to US

Cached for: 60s Exports

Export	Kind	Type
`LevantaProductLoader`	component	`({ loaderKey, asin, marketplace, children, fallback, }: LevantaProductLoaderProps) => JSX.Element`

`loaders/loox-review-aggregate-loader`

@replohq/sdk/loaders/loox-review-aggregate-loader

import { LooxReviewAggregateLoader } from "@replohq/sdk/loaders/loox-review-aggregate-loader";

Fetch review aggregate (average rating, total count, 1-5 star distribution) for a Shopify product from the Loox Storefront API.

Argument	Type	Required	Description
`shopifyProductId`	`string`	Yes	Numeric Shopify product ID (e.g. ‘12345’, not the GID).

Cached for: 60s Exports

Export	Kind	Type
`LooxReviewAggregateLoader`	component	`({ loaderKey, shopifyProductId, children, fallback, }: LooxReviewAggregateLoaderProps) => JSX.Element`

`loaders/loox-reviews-loader`

@replohq/sdk/loaders/loox-reviews-loader

import { LooxReviewsLoader } from "@replohq/sdk/loaders/loox-reviews-loader";

Fetch published reviews (including photo/video media) for a Shopify product from the Loox Storefront API.

Argument	Type	Required	Description
`shopifyProductId`	`string`	Yes	Numeric Shopify product ID (e.g. ‘12345’, not the GID).

Cached for: 60s Exports

Export	Kind	Type
`LooxReviewsLoader`	component	`({ loaderKey, shopifyProductId, children, fallback, }: LooxReviewsLoaderProps) => JSX.Element`

`loaders/metaobject-loader`

@replohq/sdk/loaders/metaobject-loader

import { MetaobjectLoader } from "@replohq/sdk/loaders/metaobject-loader";

Fetch a single Shopify metaobject entry by type + handle (or by id) from the Storefront API. Use for reusable structured content a merchant models as a metaobject — size charts, ingredient lists, care instructions. Discover types first with shopify_metaobject_definitions_list. IMPORTANT: this only returns entries whose DEFINITION has storefront access PUBLIC_READ, which is NOT the default — check storefrontAccess before building a page around one, or the page will render empty.

Argument	Type	Required	Description
`type`	`string`	No	Metaobject type handle. Pass together with `handle`.
`handle`	`string`	No	Metaobject handle. Pass together with `type`.
`id`	`string`	No	Metaobject GID, as an alternative to `type` + `handle`.

Cached for: 300s Exports

Export	Kind	Type
`MetaobjectLoader`	component	`({ loaderKey, type, handle, id, children, fallback, }: MetaobjectLoaderProps) => JSX.Element`

`loaders/metaobjects-loader`

@replohq/sdk/loaders/metaobjects-loader

import { MetaobjectsLoader } from "@replohq/sdk/loaders/metaobjects-loader";

Fetch Shopify metaobject entries of one type from the Storefront API with cursor pagination. Same storefront-access caveat as shopify_storefront.metaobject. Entries whose definition has the publishable capability are only returned once ACTIVE, so drafts will be missing.

Argument	Type	Required	Description
`type`	`string`	Yes	Metaobject type handle whose entries to load.
`first`	`integer`	No	Max entries to return (1-250, default 50).
`after`	`string`	No	Pagination cursor for continuing a previous page.
`sortKey`	`string`	No	Sort key, e.g. ‘updated_at’ or ‘display_name’.
`reverse`	`boolean`	No	Reverse the sort order.

Cached for: 300s Exports

Export	Kind	Type
`MetaobjectsLoader`	component	`({ loaderKey, type, first, after, sortKey, reverse, children, fallback, }: MetaobjectsLoaderProps) => JSX.Element`

`loaders/okendo-review-aggregate-loader`

@replohq/sdk/loaders/okendo-review-aggregate-loader

import { OkendoReviewAggregateLoader } from "@replohq/sdk/loaders/okendo-review-aggregate-loader";

Fetch review aggregate (average rating, count, star distribution) for a Shopify product.

Argument	Type	Required	Description
`shopifyProductId`	`string`	Yes	Numeric Shopify product ID

Cached for: 60s Exports

Export	Kind	Type
`OkendoReviewAggregateLoader`	component	`({ loaderKey, shopifyProductId, children, fallback, }: OkendoReviewAggregateLoaderProps) => JSX.Element`

`loaders/okendo-reviews-loader`

@replohq/sdk/loaders/okendo-reviews-loader

import { OkendoReviewsLoader } from "@replohq/sdk/loaders/okendo-reviews-loader";

Fetch published reviews for a Shopify product from the Okendo Storefront API.

Argument	Type	Required	Description
`shopifyProductId`	`string`	Yes	Numeric Shopify product ID

Cached for: 60s Exports

Export	Kind	Type
`OkendoReviewsLoader`	component	`({ loaderKey, shopifyProductId, children, fallback, }: OkendoReviewsLoaderProps) => JSX.Element`

`loaders/product-loader`

@replohq/sdk/loaders/product-loader Serves Replo Products and Shopify. Set loaderKey to choose the source.

import { ProductLoader } from "@replohq/sdk/loaders/product-loader";

Replo Products Fetch a single Replo product by UUID from the Replo database.

Argument	Type	Required	Description
`productId`	`string`	No
`handle`	`string`	No

Cached for: 60s Shopify Fetch a Shopify product by handle or product GID from Storefront API.

Argument	Type	Required
`handle`	`string`	No
`productId`	`string`	No
`productMetafieldIdentifiers`	`array`	No
`variantMetafieldIdentifiers`	`array`	No

Cached for: 60s Exports

Export	Kind	Type
`ProductLoader`	component	`({ loaderKey, handle, productId, productMetafieldIdentifiers, variantMetafieldIdentifiers, language, country, children, fallback, loadingFallback, }: ProductLoaderProps) => JSX.Element`

`loaders/rebuy-recommendations-loader`

@replohq/sdk/loaders/rebuy-recommendations-loader

import { RebuyRecommendationsLoader } from "@replohq/sdk/loaders/rebuy-recommendations-loader";

Fetch AI-powered product recommendations from Rebuy for given Shopify product IDs.

Argument	Type	Required	Description
`shopifyProductIds`	`string`	Yes	Comma-separated Shopify product IDs to get recommendations for
`limit`	`number`	No	Number of recommendations (default 5)

Always present on the result: id, images Cached for: 60s Exports

Export	Kind	Type
`RebuyRecommendationsLoader`	component	`({ loaderKey, shopifyProductIds, limit, children, fallback, }: RebuyRecommendationsLoaderProps) => JSX.Element`

`loaders/reviews-io-review-aggregate-loader`

@replohq/sdk/loaders/reviews-io-review-aggregate-loader

import { ReviewsIoReviewAggregateLoader } from "@replohq/sdk/loaders/reviews-io-review-aggregate-loader";

Fetch aggregate review stats (average score and total reviews) for a product from Reviews.io.

Argument	Type	Required	Description
`sku`	`string`	Yes	Reviews.io product key (API `sku` param). Usually a merchant SKU or Shopify variant ID — whatever this store’s Reviews.io account uses. Resolve via probe-and-confirm (see the reviews-io skill); do not pass a Shopify product ID expecting server-side expansion.

Cached for: 60s Exports

Export	Kind	Type
`ReviewsIoReviewAggregateLoader`	component	`({ loaderKey, sku, children, fallback, }: ReviewsIoReviewAggregateLoaderProps) => JSX.Element`

`loaders/reviews-io-reviews-loader`

@replohq/sdk/loaders/reviews-io-reviews-loader

import { ReviewsIoReviewsLoader } from "@replohq/sdk/loaders/reviews-io-reviews-loader";

Fetch published product reviews from the Reviews.io product review API.

Argument	Type	Required	Description
`sku`	`string`	Yes	Reviews.io product key (API `sku` param). Usually a merchant SKU or Shopify variant ID — whatever this store’s Reviews.io account uses. Resolve via probe-and-confirm (see the reviews-io skill); do not pass a Shopify product ID expecting server-side expansion.
`perPage`	`integer`	No	Reviews to return (default 10, max 100).
`page`	`integer`	No	Page number (1-indexed, default 1).

Cached for: 60s Exports

Export	Kind	Type
`ReviewsIoReviewsLoader`	component	`({ loaderKey, sku, perPage, page, children, fallback, }: ReviewsIoReviewsLoaderProps) => JSX.Element`

`loaders/smile-earning-rules-loader`

@replohq/sdk/loaders/smile-earning-rules-loader

import { SmileEarningRulesLoader } from "@replohq/sdk/loaders/smile-earning-rules-loader";

Fetch all enabled earning rules (ways to earn points). Cached for: 300s Exports

Export	Kind	Type
`SmileEarningRule`	type	`{ id: number; name: string; pointsAwardedType: string; activityToken: string; pointsAwarded?: number; }`
`SmileEarningRulesLoader`	component	`({ loaderKey, children, fallback, }: SmileEarningRulesLoaderProps) => JSX.Element`

`loaders/smile-rewards-loader`

@replohq/sdk/loaders/smile-rewards-loader

import { SmileRewardsLoader } from "@replohq/sdk/loaders/smile-rewards-loader";

Fetch the rewards catalog (points products). Cached for: 300s Exports

Export	Kind	Type
`SmileReward`	type	`{ id: number; name: string; pointsCost: number; rewardType: string; discountValue?: string; }`
`SmileRewardsLoader`	component	`({ loaderKey, children, fallback, }: SmileRewardsLoaderProps) => JSX.Element`

`loaders/smile-vip-tiers-loader`

@replohq/sdk/loaders/smile-vip-tiers-loader

import { SmileVipTiersLoader } from "@replohq/sdk/loaders/smile-vip-tiers-loader";

Fetch all VIP tier definitions with thresholds and colors. Cached for: 300s Exports

Export	Kind	Type
`SmileVipTier`	type	`{ id: number; name: string; minimumPointsRequired: number; color?: string; }`
`SmileVipTiersLoader`	component	`({ loaderKey, children, fallback, }: SmileVipTiersLoaderProps) => JSX.Element`

`loaders/statsig-experiment-loader`

@replohq/sdk/loaders/statsig-experiment-loader

import { StatsigExperimentLoader } from "@replohq/sdk/loaders/statsig-experiment-loader";

Server-side evaluate a Statsig experiment for a visitor (by stable ID) and return the assigned variant group and its parameter values, so a page can render the correct variant during SSR without a flash of the original content.

Argument	Type	Required	Description
`experimentName`	`string`	Yes	The Statsig experiment (or dynamic config) name to evaluate.
`stableId`	`string`	Yes	A durable per-visitor identifier used for deterministic bucketing. Must be the same value across requests and match the ID used for client-side event logging (typically a `statsig_stable_id` cookie).
`userId`	`string`	No	Logged-in user identifier. Provide for user-level experiments; omit for anonymous visitors.
`environmentTier`	`string`	No	Statsig environment tier for evaluation (e.g. production, staging, development).
`customAttributes`	`object`	No	Optional custom user attributes used by the experiment’s targeting rules (e.g. country, plan).

Cached for: 0s Exports

Export	Kind	Type
`StatsigExperimentLoader`	component	`({ loaderKey, experimentName, stableId, userId, environmentTier, customAttributes, children, fallback, }: StatsigExperimentLoaderProps) => JSX.Element`

`loaders/yotpo-review-aggregate-loader`

@replohq/sdk/loaders/yotpo-review-aggregate-loader

import { YotpoReviewAggregateLoader } from "@replohq/sdk/loaders/yotpo-review-aggregate-loader";

Fetch aggregate review stats (average score, total reviews, star distribution) for a product from the public Yotpo widget API.

Argument	Type	Required	Description
`productId`	`string`	Yes	Yotpo external product ID for the product (typically the numeric Shopify product ID).

Cached for: 60s Exports

Export	Kind	Type
`YotpoReviewAggregateLoader`	component	`({ loaderKey, productId, children, fallback, }: YotpoReviewAggregateLoaderProps) => JSX.Element`

`loaders/yotpo-reviews-loader`

@replohq/sdk/loaders/yotpo-reviews-loader

import { YotpoReviewsLoader } from "@replohq/sdk/loaders/yotpo-reviews-loader";

Fetch published reviews for a product from the public Yotpo widget API.

Argument	Type	Required	Description
`productId`	`string`	Yes	Yotpo external product ID for the product (typically the numeric Shopify product ID).
`perPage`	`integer`	No	Reviews to return (default 10, max 150).
`page`	`integer`	No	Page number (1-indexed, default 1).

Cached for: 60s Exports

Export	Kind	Type
`YotpoReviewsLoader`	component	`({ loaderKey, productId, perPage, page, children, fallback, }: YotpoReviewsLoaderProps) => JSX.Element`

`loaders/prefetch-loaders`

@replohq/sdk/loaders/prefetch-loaders

`PrefetchedLoaders`

Server component that prefetches one or more loader queries and seeds the React Query cache via HydrationBoundary. Client components that use useSuspenseQuery with the same queryKey will get the data immediately in the initial HTML — no loading state on first paint. The queryKey is derived internally as [loaderKey, args], matching the convention used by all loader components. Usage:

import { DATA_LOADER_KEYS } from "@replohq/sdk/loaders/loader-keys";

<PrefetchedLoaders
  queries={[
    {
      loaderKey: DATA_LOADER_KEYS.SHOPIFY_PRODUCT,
      args: { productId: "gid://shopify/Product/123" },
    },
  ]}
>
  <ProductPreview productId="gid://shopify/Product/123" />
</PrefetchedLoaders>

import { PrefetchedLoaders } from "@replohq/sdk/loaders/prefetch-loaders";

PrefetchedLoaders: ({ queries, children, }: React.PropsWithChildren<{ queries: PrefetchLoaderConfig[]; }>) => Promise<JSX.Element>

`loaders/invoke-loader-server`

@replohq/sdk/loaders/invoke-loader-server

`invokeLoaderServer`

Server-only loader invocation that calls the canopy-api gateway directly. Used by PrefetchedLoaders to seed the React Query cache during SSR. Results are cached via Next.js unstable_cache so repeated SSR renders for the same loader+args return instantly without a network round-trip to canopy-api. The canopy-api’s own in-memory cache still acts as a second layer for cold starts and cross-instance sharing.

import { invokeLoaderServer } from "@replohq/sdk/loaders/invoke-loader-server";

invokeLoaderServer: ({ loaderKey, args, revalidateSeconds, }: { loaderKey: string; args: Record<string, unknown>; revalidateSeconds?: number | false; }) => Promise<unknown>

Parameter	Description
`revalidateSeconds`	- How long (in seconds) the cached result is considered fresh. Defaults to 60. Set to `false` to cache indefinitely (use tag-based invalidation via `revalidateTag` to purge).

`loaders/loader-keys`

@replohq/sdk/loaders/loader-keys

`DATA_LOADER_KEYS`

Shared data-loader key constants. Loader components and prefetch queries import from here so the strings are never duplicated across a generated site. These keys serve double duty: they identify which backend loader to invoke AND are used as React Query cache key prefixes. Loader components internally construct queryKey as [loaderKey, args]. Naming convention: <integration>.<objectType> or <integration>.<objectType>_<qualifier>.

import { DATA_LOADER_KEYS } from "@replohq/sdk/loaders/loader-keys";

Also exported

Export	Kind	Type
`DataLoaderKey`	type	—

`loaders/loader-schemas`

@replohq/sdk/loaders/loader-schemas Exports

Export	Kind	Type
`ContentfulAssetObject`	type	`{ id: string; title?: string; description?: string; fileName?: string; contentType?: string; url?: string; width?: number; height?: number; }`
`contentfulAssetObjectSchema`	const	`z.ZodObject<{ id: z.ZodString; title: z.ZodNullable<z.ZodString>; description: z.ZodNullable<z.ZodString>; fileName: z.ZodNullable<z.ZodString>; contentType: z.ZodNullable<z.ZodString>; url: z.ZodNullable<z.ZodString>; width: z.ZodNullable<z.ZodNumber>; height: z.ZodNullable<z.ZodNumber>; }, z.core.$strip>`
`ContentfulEntriesLoaderOutput`	type	`{ includes: { entries: { id: string; fields: Record<string, unknown>; contentTypeId?: string; createdAt?: string; updatedAt?: string; }[]; assets: { id: string; title?: string; description?: string; fileName?: string; contentType?: string; url?: string; width?: number; height?: number; }[]; }; items: { id: string; fields: Record<string, unknown>; contentTypeId?: string; createdAt?: string; updatedAt?: string; }[]; limit: number; skip: number; total: number }`
`contentfulEntriesLoaderOutputSchema`	const	—
`ContentfulEntryLoaderOutput`	type	`{ entry: { id: string; fields: Record<string, unknown>; contentTypeId?: string; createdAt?: string; updatedAt?: string; }; includes: { entries: { id: string; fields: Record<string, unknown>; contentTypeId?: string; createdAt?: string; updatedAt?: string; }[]; assets: { id: string; title?: string; description?: string; fileName?: string; contentType?: string; url?: string; width?: number; height?: number; }[]; } }`
`contentfulEntryLoaderOutputSchema`	const	—
`ContentfulEntryObject`	type	`{ id: string; fields: Record<string, unknown>; contentTypeId?: string; createdAt?: string; updatedAt?: string; }`
`contentfulEntryObjectSchema`	const	`z.ZodObject<{ id: z.ZodString; contentTypeId: z.ZodNullable<z.ZodString>; createdAt: z.ZodNullable<z.ZodString>; updatedAt: z.ZodNullable<z.ZodString>; fields: z.ZodRecord<z.ZodString, z.ZodUnknown>; }, z.core.$strip>`
`contentfulIncludesSchema`	const	—
`externalVideoSchema`	const	`z.ZodObject<{ type: z.ZodLiteral<"externalVideo">; alt: z.ZodNullable<z.ZodString>; embedUrl: z.ZodString; host: z.ZodString; originUrl: z.ZodString; previewImage: z.ZodNullable<z.ZodObject<{ alt: z.ZodNullable<z.ZodString>; url: z.ZodString; width: z.ZodNullable<z.ZodNumber>; height: z.ZodNullable<z.ZodNumber>; }, z.core.$strip>>; }, z.core.$strip>`
`FullCollection`	type	`{ id: string; handle: string; title: string; descriptionHtml?: string; image?: { url: string; altText?: string; width?: number; height?: number; }; metafields?: { key: string; namespace: string; type: string; value: string; }[]; }`
`fullCollectionSchema`	const	—
`FullProduct`	type	{ availableForSale: boolean; description?: string; descriptionHtml?: string; featuredImage?: { url: string; altText?: string; width?: number; height?: number; }; handle: string; id: string; images: { url: string; altText?: string; width?: number; height?: number; }[]; media: ({ type: "image"; url: string; alt?: string; width?: number; height?: number; } \| { type: "video"; sources: { url: string; mimeType: string; format: string; width?: number; height?: number; }[]; alt?: string; previewImage?: { url: string; alt?: string; width?: number; height?: number; }; } \| { type: "externalVideo"; embedUrl: string; host: string; originUrl: string; alt?: string; previewImage?: { url: string; alt?: string; width?: number; height?: number; }; })[]; metafields: { key: string; namespace: string; type: string; value: string; }[]; options: { name: string; values: string[]; id?: string; optionValues?: { id: string; value: string; swatch?: { color?: string; imageUrl?: string; }; }[]; }[]; productType?: string; sellingPlanGroups: { options: { name: string; values: string[]; }[]; sellingPlans: { id: string; name: string; optionValues: { value: string; name?: string; }[]; priceAdjustments: { value: number; valueType: "percentage" \| "fixedAmount" \| "price"; }[]; description?: string; appId?: string; price?: string; externalId?: string; }[]; appId?: string; }[]; tags: string[]; title: string; variants: { id: string; title: string; availableForSale: boolean; selectedOptions: { name: string; value: string; }[]; price: { amount: string; currencyCode: string; }; sellingPlanIds: string[]; sku?: string; image?: { url: string; altText?: string; width?: number; height?: number; }; compareAtPrice?: { amount: string; currencyCode: string; }; metafields?: { key: string; namespace: string; type: string; value: string; }[]; }[]; vendor?: string }
`fullProductSchema`	const	—
`FullVariant`	type	`{ availableForSale: boolean; compareAtPrice?: { amount: string; currencyCode: string; }; id: string; image?: { url: string; altText?: string; width?: number; height?: number; }; metafields?: { key: string; namespace: string; type: string; value: string; }[]; price: { amount: string; currencyCode: string; }; selectedOptions: { name: string; value: string; }[]; sellingPlanIds: string[]; sku?: string; title: string }`
`fullVariantSchema`	const	—
`imageSchema`	const	`z.ZodObject<{ url: z.ZodString; altText: z.ZodNullable<z.ZodString>; width: z.ZodNullable<z.ZodNumber>; height: z.ZodNullable<z.ZodNumber>; }, z.core.$strip>`
`judgemeProductReviewAggregateLoaderOutputSchema`	const	`z.ZodObject<{ averageScore: z.ZodNumber; totalReviews: z.ZodNumber; starDistribution: z.ZodRecord<z.ZodString, z.ZodNumber>; }, z.core.$strip>`
`judgemeProductReviewsLoaderOutputSchema`	const	`z.ZodObject<{ reviews: z.ZodArray<z.ZodObject<{ id: z.ZodString; title: z.ZodNullable<z.ZodString>; content: z.ZodNullable<z.ZodString>; score: z.ZodNullable<z.ZodNumber>; createdAt: z.ZodNullable<z.ZodString>; verifiedBuyer: z.ZodBoolean; reviewerName: z.ZodNullable<z.ZodString>; }, z.core.$strip>>; }, z.core.$strip>`
`judgemeReviewLoaderItemSchema`	const	`z.ZodObject<{ id: z.ZodString; title: z.ZodNullable<z.ZodString>; content: z.ZodNullable<z.ZodString>; score: z.ZodNullable<z.ZodNumber>; createdAt: z.ZodNullable<z.ZodString>; verifiedBuyer: z.ZodBoolean; reviewerName: z.ZodNullable<z.ZodString>; }, z.core.$strip>`
`LevantaProductFull`	type	`{ id: string; asin: string; title: string; price: string; commission: string; inStock: boolean; marketplace: string; imageUrl?: string; brand?: { id: string; name: string; }; affiliateLink?: { linkId: string; url: string; }; }`
`levantaProductFullSchema`	const	—
`looxProductReviewAggregateLoaderOutputSchema`	const	`z.ZodObject<{ totalReviews: z.ZodNumber; averageRating: z.ZodNumber; ratingDistribution: z.ZodRecord<z.ZodString, z.ZodNumber>; }, z.core.$strip>`
`looxProductReviewsLoaderOutputSchema`	const	—
`looxReviewLoaderItemSchema`	const	—
`looxReviewMediaSchema`	const	`z.ZodObject<{ type: z.ZodNullable<z.ZodString>; url: z.ZodString; thumbnailUrl: z.ZodNullable<z.ZodString>; }, z.core.$strip>`
`mediaImageSchema`	const	`z.ZodObject<{ type: z.ZodLiteral<"image">; alt: z.ZodNullable<z.ZodString>; url: z.ZodString; width: z.ZodNullable<z.ZodNumber>; height: z.ZodNullable<z.ZodNumber>; }, z.core.$strip>`
`mediaSchema`	const	—
`metafieldSchema`	const	`z.ZodObject<{ key: z.ZodString; namespace: z.ZodString; type: z.ZodString; value: z.ZodString; }, z.core.$strip>`
`okendoReviewSchema`	const	`z.ZodObject<{ id: z.ZodString; title: z.ZodOptional<z.ZodString>; body: z.ZodOptional<z.ZodString>; rating: z.ZodOptional<z.ZodNumber>; productName: z.ZodOptional<z.ZodString>; reviewerName: z.ZodOptional<z.ZodString>; dateCreated: z.ZodOptional<z.ZodString>; status: z.ZodOptional<z.ZodString>; }, z.core.$strip>`
`optionValueSchema`	const	`z.ZodObject<{ id: z.ZodString; value: z.ZodString; swatch: z.ZodNullable<z.ZodObject<{ color: z.ZodNullable<z.ZodString>; imageUrl: z.ZodNullable<z.ZodString>; }, z.core.$strip>>; }, z.core.$strip>`
`optionValueSwatchSchema`	const	`z.ZodObject<{ color: z.ZodNullable<z.ZodString>; imageUrl: z.ZodNullable<z.ZodString>; }, z.core.$strip>`
`PaginatedProducts`	type	{ pageInfo: { hasNextPage: boolean; endCursor?: string; }; products: { id: string; handle?: string; title?: string; description?: string; descriptionHtml?: string; availableForSale?: boolean; status?: "ACTIVE" \| "DRAFT" \| "ARCHIVED" \| "UNLISTED"; featuredImage?: { url: string; altText?: string; width?: number; height?: number; }; options?: { name: string; values: string[]; id?: string; optionValues?: { id: string; value: string; swatch?: { color?: string; imageUrl?: string; }; }[]; }[]; variants?: { id: string; title?: string; availableForSale?: boolean; sku?: string; selectedOptions?: { name: string; value: string; }[]; image?: { url: string; altText?: string; width?: number; height?: number; }; price?: { amount: string; currencyCode: string; }; compareAtPrice?: { amount: string; currencyCode: string; }; sellingPlanIds?: string[]; }[]; minPrice?: { amount: string; currencyCode: string; }; maxPrice?: { amount: string; currencyCode: string; }; compareAtMinPrice?: { amount: string; currencyCode: string; }; compareAtMaxPrice?: { amount: string; currencyCode: string; }; images?: { url: string; altText?: string; width?: number; height?: number; }[]; media?: ({ type: "image"; url: string; alt?: string; width?: number; height?: number; } \| { type: "video"; sources: { url: string; mimeType: string; format: string; width?: number; height?: number; }[]; alt?: string; previewImage?: { url: string; alt?: string; width?: number; height?: number; }; } \| { type: "externalVideo"; embedUrl: string; host: string; originUrl: string; alt?: string; previewImage?: { url: string; alt?: string; width?: number; height?: number; }; })[]; vendor?: string; productType?: string; tags?: string[]; sellingPlanGroups?: { options: { name: string; values: string[]; }[]; sellingPlans: { id: string; name: string; optionValues: { value: string; name?: string; }[]; priceAdjustments: { value: number; valueType: "percentage" \| "fixedAmount" \| "price"; }[]; description?: string; appId?: string; price?: string; externalId?: string; }[]; appId?: string; }[]; metafields?: { key: string; namespace: string; type: string; value: string; }[]; }[] }
`paginatedProductsSchema`	const	—
`previewImageSchema`	const	`z.ZodObject<{ alt: z.ZodNullable<z.ZodString>; url: z.ZodString; width: z.ZodNullable<z.ZodNumber>; height: z.ZodNullable<z.ZodNumber>; }, z.core.$strip>`
`priceSchema`	const	`z.ZodObject<{ amount: z.ZodString; currencyCode: z.ZodString; }, z.core.$strip>`
`Product`	type	{ availableForSale?: boolean; compareAtMaxPrice?: { amount: string; currencyCode: string; }; compareAtMinPrice?: { amount: string; currencyCode: string; }; description?: string; descriptionHtml?: string; featuredImage?: { url: string; altText?: string; width?: number; height?: number; }; handle?: string; id: string; images?: { url: string; altText?: string; width?: number; height?: number; }[]; maxPrice?: { amount: string; currencyCode: string; }; media?: ({ type: "image"; url: string; alt?: string; width?: number; height?: number; } \| { type: "video"; sources: { url: string; mimeType: string; format: string; width?: number; height?: number; }[]; alt?: string; previewImage?: { url: string; alt?: string; width?: number; height?: number; }; } \| { type: "externalVideo"; embedUrl: string; host: string; originUrl: string; alt?: string; previewImage?: { url: string; alt?: string; width?: number; height?: number; }; })[]; metafields?: { key: string; namespace: string; type: string; value: string; }[]; minPrice?: { amount: string; currencyCode: string; }; options?: { name: string; values: string[]; id?: string; optionValues?: { id: string; value: string; swatch?: { color?: string; imageUrl?: string; }; }[]; }[]; productType?: string; sellingPlanGroups?: { options: { name: string; values: string[]; }[]; sellingPlans: { id: string; name: string; optionValues: { value: string; name?: string; }[]; priceAdjustments: { value: number; valueType: "percentage" \| "fixedAmount" \| "price"; }[]; description?: string; appId?: string; price?: string; externalId?: string; }[]; appId?: string; }[]; status?: "ACTIVE" \| "DRAFT" \| "ARCHIVED" \| "UNLISTED"; tags?: string[]; title?: string; variants?: { id: string; title?: string; availableForSale?: boolean; sku?: string; selectedOptions?: { name: string; value: string; }[]; image?: { url: string; altText?: string; width?: number; height?: number; }; price?: { amount: string; currencyCode: string; }; compareAtPrice?: { amount: string; currencyCode: string; }; sellingPlanIds?: string[]; }[]; vendor?: string }
`productOptionSchema`	const	`z.ZodObject<{ id: z.ZodOptional<z.ZodString>; name: z.ZodString; values: z.ZodArray<z.ZodString>; optionValues: z.ZodOptional<z.ZodArray<z.ZodObject<{ id: z.ZodString; value: z.ZodString; swatch: z.ZodNullable<z.ZodObject<{ color: z.ZodNullable<z.ZodString>; imageUrl: z.ZodNullable<z.ZodString>; }, z.core.$strip>>; }, z.core.$strip>>>; }, z.core.$strip>`
`productSchema`	const	—
`reviewsIoProductReviewAggregateLoaderOutputSchema`	const	`z.ZodObject<{ reviewCount: z.ZodNumber; reviewAverageValue: z.ZodNumber; }, z.core.$strip>`
`reviewsIoProductReviewsLoaderOutputSchema`	const	—
`reviewsIoReviewLoaderItemSchema`	const	`z.ZodObject<{ id: z.ZodString; title: z.ZodNullable<z.ZodString>; body: z.ZodNullable<z.ZodString>; rating: z.ZodNullable<z.ZodNumber>; createdAt: z.ZodNullable<z.ZodString>; verifiedBuyer: z.ZodBoolean; reviewerName: z.ZodNullable<z.ZodString>; productName: z.ZodNullable<z.ZodString>; sku: z.ZodNullable<z.ZodString>; }, z.core.$strip>`
`selectedOptionSchema`	const	`z.ZodObject<{ name: z.ZodString; value: z.ZodString; }, z.core.$strip>`
`SellingPlanGroup`	type	`{ options: { name: string; values: string[]; }[]; sellingPlans: { id: string; name: string; optionValues: { value: string; name?: string; }[]; priceAdjustments: { value: number; valueType: "percentage" \| "fixedAmount" \| "price"; }[]; description?: string; appId?: string; price?: string; externalId?: string; }[]; appId?: string; }`
`sellingPlanGroupSchema`	const	—
`sellingPlanOptionValueSchema`	const	`z.ZodObject<{ name: z.ZodOptional<z.ZodString>; value: z.ZodString; }, z.core.$strip>`
`sellingPlanPriceAdjustmentSchema`	const	`z.ZodObject<{ value: z.ZodNumber; valueType: z.ZodEnum<{ percentage: "percentage"; fixedAmount: "fixedAmount"; price: "price"; }>; }, z.core.$strip>`
`sellingPlanSchema`	const	—
`ShopifyMetaobjectLoaderOutput`	type	`{ id: string; type: string; handle: string; fields: { key: string; type: string; value?: string; }[]; updatedAt?: string; }`
`shopifyMetaobjectLoaderOutputSchema`	const	`z.ZodObject<{ id: z.ZodString; type: z.ZodString; handle: z.ZodString; updatedAt: z.ZodNullable<z.ZodString>; fields: z.ZodArray<z.ZodObject<{ key: z.ZodString; type: z.ZodString; value: z.ZodNullable<z.ZodString>; }, z.core.$strip>>; }, z.core.$strip>`
`ShopifyMetaobjectsLoaderOutput`	type	`{ metaobjects: { id: string; type: string; handle: string; fields: { key: string; type: string; value?: string; }[]; updatedAt?: string; }[]; pageInfo: { hasNextPage: boolean; endCursor?: string; }; }`
`shopifyMetaobjectsLoaderOutputSchema`	const	—
`StatsigExperimentAssignment`	type	`{ experimentName: string; value: Record<string, unknown>; reason: string; groupName?: string; ruleId?: string; }`
`statsigExperimentLoaderOutputSchema`	const	`z.ZodObject<{ experimentName: z.ZodString; groupName: z.ZodNullable<z.ZodString>; ruleId: z.ZodNullable<z.ZodString>; value: z.ZodRecord<z.ZodString, z.ZodUnknown>; reason: z.ZodString; }, z.core.$strip>`
`StorefrontMetaobject`	type	`{ id: string; type: string; handle: string; fields: { key: string; type: string; value?: string; }[]; updatedAt?: string; }`
`storefrontMetaobjectSchema`	const	`z.ZodObject<{ id: z.ZodString; type: z.ZodString; handle: z.ZodString; updatedAt: z.ZodNullable<z.ZodString>; fields: z.ZodArray<z.ZodObject<{ key: z.ZodString; type: z.ZodString; value: z.ZodNullable<z.ZodString>; }, z.core.$strip>>; }, z.core.$strip>`
`variantSchema`	const	—
`videoSchema`	const	—
`videoSourceSchema`	const	`z.ZodObject<{ url: z.ZodString; mimeType: z.ZodString; format: z.ZodString; width: z.ZodNullable<z.ZodNumber>; height: z.ZodNullable<z.ZodNumber>; }, z.core.$strip>`
`yotpoProductReviewAggregateLoaderOutputSchema`	const	`z.ZodObject<{ averageScore: z.ZodNumber; totalReviews: z.ZodNumber; starDistribution: z.ZodRecord<z.ZodString, z.ZodNumber>; }, z.core.$strip>`
`yotpoProductReviewsLoaderOutputSchema`	const	`z.ZodObject<{ reviews: z.ZodArray<z.ZodObject<{ id: z.ZodString; title: z.ZodNullable<z.ZodString>; content: z.ZodNullable<z.ZodString>; score: z.ZodNullable<z.ZodNumber>; createdAt: z.ZodNullable<z.ZodString>; verifiedBuyer: z.ZodBoolean; reviewerName: z.ZodNullable<z.ZodString>; }, z.core.$strip>>; }, z.core.$strip>`
`yotpoReviewLoaderItemSchema`	const	`z.ZodObject<{ id: z.ZodString; title: z.ZodNullable<z.ZodString>; content: z.ZodNullable<z.ZodString>; score: z.ZodNullable<z.ZodNumber>; createdAt: z.ZodNullable<z.ZodString>; verifiedBuyer: z.ZodBoolean; reviewerName: z.ZodNullable<z.ZodString>; }, z.core.$strip>`

`loaders/product-loader-args`

@replohq/sdk/loaders/product-loader-args

`buildProductLoaderArgs`

Builds the single object used as BOTH the React Query key and the loader payload. They must stay identical: PrefetchedLoaders seeds the cache under [loaderKey, args], so an arg sent to the loader but missing from the key (or vice versa) silently misses the prefetch — the client refetches without it and the page renders incomplete data instead of erroring. Keys left undefined drop out of React Query’s key hash, so omitting a field here hashes the same as a prefetch that never passed it.

import { buildProductLoaderArgs } from "@replohq/sdk/loaders/product-loader-args";

buildProductLoaderArgs: ({ handle, productId, productMetafieldIdentifiers, variantMetafieldIdentifiers, language, country, }: ProductLoaderArgs) => ProductLoaderArgs

Also exported

Export	Kind	Type
`MetafieldIdentifier`	type	`{ namespace: string; key: string; }`
`ProductLoaderArgs`	type	`{ handle?: string; productId?: string; productMetafieldIdentifiers?: MetafieldIdentifier[]; variantMetafieldIdentifiers?: MetafieldIdentifier[]; language?: string; country?: string; }`

`loaders/collection-loader-args`

@replohq/sdk/loaders/collection-loader-args

`buildCollectionLoaderArgs`

Builds the single object used as BOTH the React Query key and the loader payload. They must stay identical: PrefetchedLoaders seeds the cache under [loaderKey, args], so an arg sent to the loader but missing from the key (or vice versa) silently misses the prefetch. Keys left undefined drop out of React Query’s key hash, so omitting a field here hashes the same as a prefetch that never passed it.

import { buildCollectionLoaderArgs } from "@replohq/sdk/loaders/collection-loader-args";

buildCollectionLoaderArgs: ({ handle, collectionGid, language, country, }: CollectionLoaderArgs) => CollectionLoaderArgs

Also exported

Export	Kind	Type
`CollectionLoaderArgs`	type	`{ handle?: string; collectionGid?: string; language?: string; country?: string; }`

`loaders/collection-products-loader-args`

@replohq/sdk/loaders/collection-products-loader-args

`buildCollectionProductsLoaderArgs`

Builds the single object used as BOTH the React Query key and the loader payload. They must stay identical: PrefetchedLoaders seeds the cache under [loaderKey, args], so an arg sent to the loader but missing from the key (or vice versa) silently misses the prefetch. Keys left undefined drop out of React Query’s key hash, so omitting a field here hashes the same as a prefetch that never passed it.

import { buildCollectionProductsLoaderArgs } from "@replohq/sdk/loaders/collection-products-loader-args";

buildCollectionProductsLoaderArgs: ({ collectionGid, first, after, language, country, }: CollectionProductsLoaderArgs) => CollectionProductsLoaderArgs

Also exported

Export	Kind	Type
`CollectionProductsLoaderArgs`	type	`{ collectionGid: string; first?: number; after?: string; language?: string; country?: string; }`

Overview

Reference

Data loaders

`loaders/collection-loader`

`loaders/collection-products-loader`

`loaders/contentful-entries-loader`

`loaders/contentful-entry-loader`

`loaders/judgeme-review-aggregate-loader`

`loaders/judgeme-reviews-loader`

`loaders/levanta-product-loader`

`loaders/loox-review-aggregate-loader`

`loaders/loox-reviews-loader`

`loaders/metaobject-loader`

`loaders/metaobjects-loader`

`loaders/okendo-review-aggregate-loader`

`loaders/okendo-reviews-loader`

`loaders/product-loader`

`loaders/rebuy-recommendations-loader`

`loaders/reviews-io-review-aggregate-loader`

`loaders/reviews-io-reviews-loader`

`loaders/smile-earning-rules-loader`

`loaders/smile-rewards-loader`

`loaders/smile-vip-tiers-loader`

`loaders/statsig-experiment-loader`

`loaders/yotpo-review-aggregate-loader`

`loaders/yotpo-reviews-loader`

`loaders/prefetch-loaders`

`PrefetchedLoaders`

`loaders/invoke-loader-server`

`invokeLoaderServer`

`loaders/loader-keys`

`DATA_LOADER_KEYS`

`loaders/loader-schemas`

`loaders/product-loader-args`

`buildProductLoaderArgs`

`loaders/collection-loader-args`

`buildCollectionLoaderArgs`

`loaders/collection-products-loader-args`

`buildCollectionProductsLoaderArgs`

​loaders/collection-loader

​loaders/collection-products-loader

​loaders/contentful-entries-loader

​loaders/contentful-entry-loader

​loaders/judgeme-review-aggregate-loader

​loaders/judgeme-reviews-loader

​loaders/levanta-product-loader

​loaders/loox-review-aggregate-loader

​loaders/loox-reviews-loader

​loaders/metaobject-loader

​loaders/metaobjects-loader

​loaders/okendo-review-aggregate-loader

​loaders/okendo-reviews-loader

​loaders/product-loader

​loaders/rebuy-recommendations-loader

​loaders/reviews-io-review-aggregate-loader

​loaders/reviews-io-reviews-loader

​loaders/smile-earning-rules-loader

​loaders/smile-rewards-loader

​loaders/smile-vip-tiers-loader

​loaders/statsig-experiment-loader

​loaders/yotpo-review-aggregate-loader

​loaders/yotpo-reviews-loader

​loaders/prefetch-loaders

​PrefetchedLoaders

​loaders/invoke-loader-server

​invokeLoaderServer

​loaders/loader-keys

​DATA_LOADER_KEYS

​loaders/loader-schemas

​loaders/product-loader-args

​buildProductLoaderArgs

​loaders/collection-loader-args

​buildCollectionLoaderArgs

​loaders/collection-products-loader-args

​buildCollectionProductsLoaderArgs

`loaders/collection-loader`

`loaders/collection-products-loader`

`loaders/contentful-entries-loader`

`loaders/contentful-entry-loader`

`loaders/judgeme-review-aggregate-loader`

`loaders/judgeme-reviews-loader`

`loaders/levanta-product-loader`

`loaders/loox-review-aggregate-loader`

`loaders/loox-reviews-loader`

`loaders/metaobject-loader`

`loaders/metaobjects-loader`

`loaders/okendo-review-aggregate-loader`

`loaders/okendo-reviews-loader`

`loaders/product-loader`

`loaders/rebuy-recommendations-loader`

`loaders/reviews-io-review-aggregate-loader`

`loaders/reviews-io-reviews-loader`

`loaders/smile-earning-rules-loader`

`loaders/smile-rewards-loader`

`loaders/smile-vip-tiers-loader`

`loaders/statsig-experiment-loader`

`loaders/yotpo-review-aggregate-loader`

`loaders/yotpo-reviews-loader`

`loaders/prefetch-loaders`

`PrefetchedLoaders`

`loaders/invoke-loader-server`

`invokeLoaderServer`

`loaders/loader-keys`

`DATA_LOADER_KEYS`

`loaders/loader-schemas`

`loaders/product-loader-args`

`buildProductLoaderArgs`

`loaders/collection-loader-args`

`buildCollectionLoaderArgs`

`loaders/collection-products-loader-args`

`buildCollectionProductsLoaderArgs`