# virtual.fit

> Integration guides and reference documentation for the virtual.fit virtual fitting room.

## Docs

- [virtual.fit documentation](https://docs.virtual.fit/index.md): Add the virtual.fit fitting room to Shopify or any custom storefront.
- [Quickstart](https://docs.virtual.fit/quickstart.md): Choose Shopify or Custom JavaScript and complete your first virtual.fit try-on.
- [How virtual.fit works](https://docs.virtual.fit/getting-started/how-it-works.md): Understand product readiness, the shopper journey, and the information each integration supplies.
- [Launch checklist](https://docs.virtual.fit/getting-started/launch-checklist.md): Verify product eligibility, shopper behavior, analytics, accessibility, and rollback before launch.
- [Install on Shopify](https://docs.virtual.fit/shopify/install.md): Connect Shopify, activate the virtual.fit app embed, and verify your first product page.
- [Configure Shopify](https://docs.virtual.fit/shopify/configure.md): Configure storefront appearance, customer access, limits, and shopper copy.
- [Prepare Shopify products](https://docs.virtual.fit/shopify/products.md): Review product preparation, Active status, recommendation readiness, and garment images.
- [Troubleshoot Shopify](https://docs.virtual.fit/shopify/troubleshooting.md): Resolve Shopify installation, preparation, theme embed, and storefront issues.
- [Custom JavaScript quickstart](https://docs.virtual.fit/custom-js/quickstart.md): Install the hosted virtual.fit loader on a custom or headless storefront.
- [Sync the catalog](https://docs.virtual.fit/custom-js/catalog.md): Sync custom storefront products, variants, prices, inventory, media, and size charts.
- [Resolve product URLs](https://docs.virtual.fit/custom-js/product-resolution.md): Map custom storefront URLs to enabled virtual.fit catalog products.
- [Loader configuration](https://docs.virtual.fit/custom-js/configuration.md): Configure placement, product context, customer access, terms, and data attributes.
- [Browser API](https://docs.virtual.fit/custom-js/browser-api.md): Reference the virtual.fit initialization, context, identity, consent, and tracking commands.
- [Commerce events](https://docs.virtual.fit/custom-js/commerce-events.md): Track cart, checkout, and purchase outcomes for Custom JavaScript storefront analytics.
- [Styling, labels, and terms](https://docs.virtual.fit/custom-js/styling-and-copy.md): Match virtual.fit to your storefront and configure shopper-facing text and terms.
- [Troubleshoot Custom JavaScript](https://docs.virtual.fit/custom-js/troubleshooting.md): Resolve origin, catalog, product matching, mount, SPA, styling, and analytics issues.
- [Product recommendations](https://docs.virtual.fit/recommendations/overview.md): Recommend related products for the fitting room, product pages, and carts.
- [Recommendations API](https://docs.virtual.fit/recommendations/api.md): Rank similar, complete-the-look, and likely-purchase recommendations from your backend.
- [Analytics and results](https://docs.virtual.fit/operations/analytics-and-results.md): Read the virtual.fit funnel, compare products, and review generated results.
- [Privacy and consent](https://docs.virtual.fit/operations/privacy-and-consent.md): Configure shopper notices, photo handling, retention, and analytics consent for virtual.fit.
- [Create or update a product](https://docs.virtual.fit/reference/catalog-upsert.md): Create a catalog product or progressively patch its current data.
- [Sync product reviews](https://docs.virtual.fit/reference/catalog-reviews.md): Optionally sync complete customer review records and fit evidence.
- [Get storefront fit evidence](https://docs.virtual.fit/reference/storefront-fit-evidence.md): Read a compact rating and fit summary for a Custom JavaScript product.
- [List storefront reviews](https://docs.virtual.fit/reference/storefront-product-reviews.md): Read full, paginated review evidence for a Custom JavaScript product.
- [Import catalog CSV](https://docs.virtual.fit/reference/catalog-import.md): Import current products and exact variant rows from a CSV file.
- [Delete a product](https://docs.virtual.fit/reference/catalog-delete-product.md): Permanently remove a synced product and its managed images from the catalog.
- [Enable or disable a product](https://docs.virtual.fit/reference/catalog-enable-product.md): Change whether a synced product is available in the fitting room without deleting it.
- [Delete a variant](https://docs.virtual.fit/reference/catalog-delete-variant.md): Remove one exact source variant while keeping the product.
- [Recommend products](https://docs.virtual.fit/reference/recommend-products.md): Return compact, render-ready product and selected-variant recommendations.
- [Catalog product input](https://docs.virtual.fit/reference/schemas/catalog-product.md): Product-level fields for current JSON catalog writes.
- [Catalog image](https://docs.virtual.fit/reference/schemas/catalog-image.md): Shared product media and view metadata.
- [Catalog option](https://docs.virtual.fit/reference/schemas/catalog-option.md): Choice axes, controlled sizing metadata, values, and swatches.
- [Catalog variant](https://docs.virtual.fit/reference/schemas/catalog-variant.md): One exact purchasable option combination with price and inventory.
- [Catalog size chart](https://docs.virtual.fit/reference/schemas/catalog-size-chart.md): A reusable product-wide or option-scoped size-chart reference.
- [Recommendation item](https://docs.virtual.fit/reference/schemas/recommendation-item.md): Compact product and selected-target fields returned for display.
- [AGENTS](https://docs.virtual.fit/AGENTS.md)

## OpenAPI Specs

- [openapi](https://docs.virtual.fit/openapi.yaml)

## Optional

- [virtual.fit](https://virtual.fit)
- [Support](https://virtual.fit/support)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.