Documentation

SDK 2.0 · START HERE

SDK 2.0 overview

Understand the product capabilities and choose the right integration path.

Choose the layer you need

The product release, installable SDK and hosted fitting room are separate layers. “SDK 2.0” names the product release; it does not instruct developers to install version 2 of the Web SDK. These guides target @spreeai/web-sdk@3.0.0.

LayerPurposeVersion or controls
SDK 2.0Product capabilities: try-on views, comparison, styling and fit.Product release name
Web SDKAuthenticate and embed the hosted experience on your storefront.npm package v3.0.0
Hosted fitting roomSPREEAI-managed shopper experience loaded by the integration.Managed independently; confirm approved capabilities
Shopify AppCatalog connection, product enablement, feature switches and theme blocks.App settings and published theme

Capability map

CapabilityShopify pathWeb SDK path
Additional viewsBack, Three-quarter and Side switches in Feature Settings.No corresponding per-view flag in the released render options. Confirm hosted availability with SPREEAI.
CompareFeature switch plus Compare block or Fitting Room shortcut.No public Compare button method in the returned SDK. Confirm the custom integration path.
Build a lookFeature switch and Fitting Room shortcut; merchant outfits are managed separately.Pass multiple garments to request a matching available outfit. This is distinct from a dedicated Build a look launcher.
Size-aware fitIndependent feature switch and Find your size block.enableSizingRecommendation requests sizing inside try-on. Confirm supported product data and account availability.
Size / price displayManaged by the app experience.showSizes, showPrices and per-garment display data.

Choose a starting point

Source references

Search page titles and content. Escape closes search.

Choose your language.