Skip to main content

🚀 Usage

This guide explains how to retrieve product variant images using the Medusa SDK. The Product Variant Images plugin integrates natively with Medusa's existing data fetching mechanisms, so no additional API endpoints are required on the storefront.

1. Retrieve Product with Variant Images​

To include product variant images when fetching a product, simply add variants.product_variant_images to the fields array in your SDK call.

const retrievedProduct = await sdk.store.products.retrieve("prod_...", {
  fields: ["id", "title", "variants.id", "variants.title", "variants.product_variant_images"],
});

2. List Products with Variant Images​

To include product variant images when listing products, add variants.product_variant_images to the fields array in your SDK call.

const productsList = await sdk.store.products.list({
  fields: ["id", "title", "variants.id", "variants.title", "variants.product_variant_images"],
});