🧾 GetCollectionOptions.options Type
The options field of getCollection() lets you customize how metafields are processed and returned using a shared MetafieldTransformFn type. This gives you full control over formatting and data transformation logic on a per-layer basis: collections, products, and variants.
type MetafieldTransformFn = (
raw: Record<string, Record<string, string>>,
casted: Record<string, any>,
definitions: ResolvedMetafieldInfo[]
) => Record<string, any> | Promise<Record<string, any>>;
type GetCollectionOptions = {
collectionHandle: string;
includeProducts?: boolean;
limit?: number;
cursor?: string;
reverse?: boolean;
sortKey?:
| "TITLE"
| "PRICE"
| "BEST_SELLING"
| "CREATED"
| "ID"
| "MANUAL"
| "RELEVANCE";
filters?: (
| { available?: boolean }
| { variantOption?: { name: string; value: string } }
| { productMetafield: { namespace: string; key: string; value: string } }
| { productTag: string }
| { productType: string }
| { collection?: string }
| { price: { min?: number; max?: number } }
)[];
productMetafields?: CustomMetafieldDefinition[];
collectionMetafields?: CustomMetafieldDefinition[];
variantMetafields?: CustomMetafieldDefinition[];
options?: {
camelizeKeys?: boolean;
resolveFiles?: boolean;
renderRichTextAsHtml?: boolean;
transformCollectionMetafields?: MetafieldTransformFn;
transformProductMetafields?: MetafieldTransformFn;
transformVariantMetafields?: MetafieldTransformFn;
};
};
🐫 camelizeKeys
If true, all metafield keys will be transformed from namespace.key to camelCase format:
camelizeKeys: true;
// "custom.weight" becomes "customWeight"
Useful when returning the result directly to JavaScript clients or frontend frameworks like React or Vue.
🗂️ resolveFiles
Automatically resolve metafields of type file_reference into detailed file objects:
resolveFiles: true;
You’ll get objects like:
{
originalSrc: "https://cdn.shopify.com/...",
altText: "My uploaded image"
}
Applies to all metafields — collection, product, and variant levels.
📝 renderRichTextAsHtml
Renders rich_text metafields into HTML strings:
renderRichTextAsHtml: true;
If disabled, raw structured rich text will be returned for custom rendering.
🧠 transformCollectionMetafields
Allows you to process and enrich collection-level metafields before returning:
transformCollectionMetafields: (raw, casted, definitions) => ({
...casted,
displayTitle: casted["custom.title"]?.toUpperCase(),
});
Useful for display-related formatting, merging references, or handling fallback logic.
🧠 transformProductMetafields
Same shape, applied to product-level metafields:
transformProductMetafields: (raw, casted, defs) => ({
...casted,
badge: `${casted["custom.brand"]} - ${casted["custom.country"]}`,
});
You can use this to dynamically generate summaries or map metafields into new keys.
🧬 transformVariantMetafields
Custom transformer for each variant’s metafields:
transformVariantMetafields: async (raw, casted, defs) => ({
...casted,
label: `${casted["custom.color"]} (${casted["custom.size"]})`,
});
Async-safe — you can fetch other entities or use external APIs.
✅ Next: Result Types →
Description
Type definition for the options object used in getCollection.