> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/configurator/embeds-and-translations/embed-types.md).

# Embed Types

Learn the different embed formats available in Mimeeq and how to generate embed codes for each type.

Embeds are snippets of code that you place on your website to display Mimeeq 3D configurators or product catalogues. Each embed type serves a specific purpose — from single product pages to full catalogues, authentication, and favourites. All embeds reference an embed template, which gives you centralised control over styling, behaviour, and settings across your site.

## Embed Types Overview

**Configurator Embeds**

| Embed Type                    | Description                                       | Purpose                                                | Indexable |
| ----------------------------- | ------------------------------------------------- | ------------------------------------------------------ | --------- |
| Standard Product Configurator | Embeds one specific standard configurator         | Most common for e-commerce sites, single product pages | ✅         |
| Modular Product Configurator  | Embeds one specific modular configurator          | Most common for e-commerce sites, single product pages | ✅         |
| Product List                  | Embeds catalogue of all your active configurators | Product catalogues                                     | ❌         |
| Product Group                 | Embeds grouped product configurators              | Product catalogues, category pages                     | ❌         |

{% hint style="warning" %}
Standard and Modular Product Configurators are the most commonly used types, especially for e-commerce customers, as they benefit from CDN caching and provide the best performance. Product lists (including group lists) do not use CDN caching and load more slowly due to fetching multiple products dynamically.
{% endhint %}

**Other Embeds**

<table><thead><tr><th width="210.91015625">Embed Type</th><th>Description</th></tr></thead><tbody><tr><td>Basket Embed</td><td>Embeds the Mimeeq Basket as part of another embed (product menu, configurator) or as a standalone element on any page of your website.</td></tr><tr><td>Authentication Embed</td><td>Adds user login and registration functionality directly to your website. Enables features such as saved favourites and the Mimeeq Basket.</td></tr><tr><td>Favourites List</td><td>Embeds a user's saved item configurations. Requires user authentication.</td></tr></tbody></table>

## How to Generate Embed Codes

### Standard Product Configurator

The Standard Configurator Embed displays a single configurable product. This is ideal for dedicated product pages where you want to showcase one specific item with all its configuration options.

**How to Generate:**

1. Navigate to the specific standard configurator in Mimeeq Admin
2. Click **Copy Embed Code** on the configurator page
3. Select your Embed Template
4. Configure language and price group settings (overrides Embed Template default settings)
5. Copy the embed code

![Standard Product Configurator Example](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FbAObUbCXIk9zfkKo9lSW%2Fembed-single-embed-new_1ff0az.png?alt=media)

### Modular Product Configurator

The Modular Configurator Embed displays a single modular configurable product. By default, modular configurators open in a modal overlay to provide a full-screen experience, but you can change this in Embed Template Settings.

**How to Generate:**

1. Navigate to the specific modular configurator in Mimeeq Admin
2. Click **Copy Embed Code** on the configurator page
3. Select your Embed Template
4. Configure language and price group settings (overrides Embed Template default settings)
5. Copy the embed code

![Modular Product Configurator Example](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FFfe0OOPNJLBD3Lo3RF9a%2Fembed-modular-embed-new_dp4h5q.png?alt=media)

### Product List

The Product List Embed displays a catalogue of all your active products. Commonly used for showcasing your entire product range.

**Key Features:**

* Displays all active products
* Supports filtering by categories and search
* Includes sorting options (A–Z, Z–A)
* Adjustable tile sizes (large or small)
* Optional favourites functionality

**How to Generate:**

1. Navigate to your product list in Mimeeq Admin
2. Click **Copy Embed Code**
3. Select your Embed Template
4. Optionally specify language and price group (overrides Embed Template default settings)
5. Copy the embed code

![Product List Embed Example](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FDt6VgetjM2Hi0CrNHbpD%2Fembed-product-list_1gkql0i.png?alt=media)

{% hint style="warning" %}
Product Lists automatically include all publicly active products. Product Groups require products to be added manually, giving you full control over what appears on your website. We recommend using Product Groups for most use cases.
{% endhint %}

### Product Group

The Product Group Embed displays a specific group of products. Ideal for category pages.

**How to Generate:**

1. Navigate to **Settings → Data → Product Groups**
2. Create a product group (e.g., "Armchairs")
3. Open the product group, set Status to **Active**, and add products
4. Click **Copy Embed Code**
5. Select your Embed Template
6. Optionally specify language and price group (overrides Embed Template default settings)
7. Copy the embed code

![Product Group Embed Example](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FBTrcw7D5aePFVXKHSQWq%2Fembed-product-group_145xlkv.png?alt=media)

### Basket Embed

The Mimeeq Basket can function independently on any page of your website, not just product pages. Read the Mimeeq Basket System article for detailed configuration and embedding instructions.

### Authentication Embed

The Authentication Embed adds user login and registration functionality directly to your website. This enables features such as saved favourites and the Mimeeq Basket.

**What the Auth Embed Includes**

* User login form
* New user registration
* Password recovery option
* Automatic session management

**When authentication is enabled:**

* Users can save favourite products and configurations to their account
* Display user-specific pricing based on account settings
* Show specific products or features only to authenticated users
* Show the Basket only for logged-in users

**How to Generate:**

1. Navigate to **Settings → Code → Login Code** in Mimeeq Admin
2. Ensure authentication is enabled for your account
3. Click **Copy Embed Code**
4. Select your language
5. Optionally override theme settings (button background colour and button text colour)
6. Copy the embed code

![Auth Embed Example (Login Modal)](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FnbXtae4BugXBQSKoZvxg%2Fembed-login_m2xh9c.png?alt=media)

### Favourites List

The Favourites Embed displays products that logged-in users have marked as favourites. It can be embedded as a dedicated page or within a Product List Embed.

**Option 1: Dedicated Favourites Embed**

1. Navigate to **Settings → Code → Favorites Code** in Mimeeq Admin
2. Select your Embed Template
3. Configure language and price group settings (overrides Embed Template default settings)
4. Copy the embed code

**Option 2: Favourites within Product List**

1. When creating a Product List embed, ensure authentication is enabled
2. In your Embed Template Settings, make sure **Hide Favourites** is disabled
3. Logged-in users will automatically see a favourites section in the product list controls
4. Users can mark products as favourites directly from the product list

![Favourites within Product List Example](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2Fh39ozMhzY0O5DmD3Qr3W%2Fembed-favourites_j7lnxk.png?alt=media)

## Embed Template Settings

Each embed references a template that controls its layout, behaviour, and appearance. For a full breakdown of all available settings, see Embed Template Settings.

## Embedding Code on Your Website

After generating your embed code, add it to your website using one of two formats.

### Code Structure

Every embed consists of two parts:

```
<!-- Container with short code --> 
<div data-mimeeq-product="SHORT_CODE"></div> 

<!-- Script loader --> 
<script src="https://mimeeq-embed-url.js"></script>
```

**1. Shortcode**

The shortcode is a unique identifier (e.g., `GP9V9M`) that references your specific product or product list configuration.

**Example use case:** Store different shortcodes in your CMS and insert them dynamically based on which category page a user visits, without changing the HTML structure.

**2. Full HTML Snippet**

The snippet is a complete HTML code block (typically 2–3 lines) that includes the Mimeeq script and your configuration parameters.

**Example use case:** Use the full snippet for static website implementations when embedding single products or product lists.

![Embed Code Snippet Example](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FbmA7R4yjAUrQU1yt3h5F%2Fembed-modal_1j91xu3.png?alt=media)

### Basic Embedding Process

1. Copy the embed code from Mimeeq Admin
2. Paste it into your website:
   * For shortcodes: insert into your CMS's dynamic content field
   * For full snippets: paste directly into your HTML where you want the configurator to appear
3. Verify the embed by loading your webpage — the Mimeeq configurator should appear according to your template settings


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.mimeeq.com/configurator/embeds-and-translations/embed-types.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.