> 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/commerce-and-integrations/shopify/admin-settings.md).

# Admin Settings

A comprehensive guide to configuring the Mimeeq Shopify app, including API key setup, product synchronization, cart settings, pricing options, and storefront integration for 3D product configurators.

## Content

This guide will walk you through configuring the Mimeeq Shopify app settings from your admin panel.

1. [Step 1: Install the Mimeeq Shopify App](#step-1-install-the-mimeeq-shopify-app)
2. [Step 2: Configure Your API Key](#step-2-configure-your-api-key)
3. [Step 3: Configure Configuration Settings](#step-3-configure-configuration-settings)
4. [Step 4: Connect Your Products with Mimeeq](#step-4-connect-your-products-with-mimeeq)
5. [Step 5: Configure Notifications](#step-5-configure-notifications)
6. [Add Mimeeq to Your Storefront](#add-mimeeq-to-your-storefront)

{% hint style="warning" %}
🛠️ To use our Shopify integration, you need a paid Mimeeq account. If you don't have one, please reach out to us and we'll help you set it up.
{% endhint %}

## Step 1: Install the Mimeeq Shopify App

If you haven't already done so, install the [Mimeeq App from the Shopify App Store](https://apps.shopify.com/mimeeq-3d-configurator). When you first access the Mimeeq App, you'll see a welcome dashboard with notification banners reminding you to add your API key and configure email notifications, along with four quick setup steps that guide you through the essential configuration process:

1. **API Key** - connect your Mimeeq account to Shopify
2. **Configuration Settings** - configure core functionality
3. **Products Sync** - synchronize your products with Mimeeq
4. **Notifications** - set up notification preferences

![Mimeeq Dashboard](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FNLCQQoYvRl7KNQei4YMF%2Fshopify-help-v1-new_1wkm5ww.png?alt=media)

## Step 2: Configure Your API Key

The API key allows Shopify to connect with the Mimeeq service on your behalf.

#### Where to Find Your API Key

1. Go to your Mimeeq Admin Panel
2. Navigate to **Settings → Customer settings → API Management**
3. Click the **API Keys** tab
4. Scroll down to the **Embed API Keys** section
5. Click the **copy icon** next to your key

![Where to Find Your API Key](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FT05jynhNVJcWVQIk53Of%2Fshopify-api_l4tntb.webp?alt=media)

#### How to Add Your API Key

1. In the Mimeeq App dashboard, click on the **API Key** card or navigate to it from the menu
2. Click the **Edit** button
3. Paste your API key into the field
4. Click **Save**

![How to Add API Key](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FMfFOPkILe20brubPb8Qe%2Fshopify-help-api-new_1ew4o6z.png?alt=media)

## Step 3: Configure Configuration Settings

Click on Configuration Settings from the Quick Setup section or navigate to it from the menu. The settings are organized into several sections:

#### Cart Configuration

| Setting                      | Description                                                                        | Options                                                                                                                                                                                                  |
| ---------------------------- | ---------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Cart product creation method | Choose how configured products are handled when customers add them to cart         | **Create new product** (Recommended) - each configuration becomes a separate product; **Create product variant** - adds configurations as variants to existing products                                  |
| Product status               | Set the initial status for new products created from configurations                | **Unlisted** (Recommended) - products are created as unlisted and only accessible via direct link; **Active Products** are visible in your store's sales channels and markets immediately after creation |
| After Add to Cart Action     | What happens after a customer successfully adds a configured product to their cart | **Redirect to Cart** (Recommended) - takes customer to their cart; **Close Modal** - closes the configurator window; **Do Nothing** - keeps the configurator open                                        |
| Zero Price Product Handling  | Control what happens when a configured product has no price set                    | **Block adding to cart** (Recommended) - shows error message and prevents adding; **Allow adding to cart** - allows zero-price items (use only if setting prices manually later)                         |

{% hint style="warning" %}
**‼️ Important:** Zero price errors are automatically reported via email notifications and recorded in the [Error Recovery Center](/commerce-and-integrations/shopify/error-recovery.md). When blocking zero-price products, customers are presented with a modal where they can leave their contact information.
{% endhint %}

![Cart Configuration Settings](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2Fy5QOCoB78Ilx6G6JXkkV%2Fshopify-help-primary-new_uzzal6.png?alt=media)

### Add to Cart Configuration

Enable advanced add-to-cart functionality for configured products. When enabled, this feature allows you to use Shopify's Custom Defined Logic for handling configured products, including custom products, single variants, and product bundles.

{% hint style="warning" %}
Important: Add to Cart Configuration must first be set up at the Mimeeq app level to use this feature. See our [Bundle Configuration Guide](/commerce-and-integrations/shopify/add-to-cart.md) for detailed setup instructions.
{% endhint %}

| Setting                                      | Description                                                                                                                    | Options                                                                                                                                                                             |
| -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Add to cart configuration                    | Activates Shopify's Custom Defined Logic for your store                                                                        | Yes — enables custom products, single variants, and product bundles for configured products, depending on your Mimeeq app configuration; No — disables Shopify custom defined logic |
| Enable back-to-configurator link for bundles | Adds a link to the cart item that lets customers return to the configurator to review or edit their bundle before checking out | Checkbox — only available when Add to cart configuration is set to Yes                                                                                                              |

### Multi-Market Pricing

Selling in different countries with different prices? This feature ensures customers see the right prices for their region by matching Shopify catalogs with Mimeeq price lists.

**How it works:**

1. Each Shopify catalog connects to a specific Mimeeq Public Price List Group
2. When customers from different markets visit, they see their regional pricing
3. The system automatically applies the correct prices at checkout

![Multi-Market Pricing Settings](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2F2Sjlhf7zjeI4agkiTcz4%2Fshopify-help-primary2-multi-ma_bo3tcs.png?alt=media)

#### Pricing Configuration

| Setting                                    | Description                                                                                                                                                                                | Options                                                                                                |
| ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------ |
| Market-Specific Pricing                    | Override configuration pricing with market-specific rates when customers add items to cart                                                                                                 | Price List Group ID field                                                                              |
| Create New Product for Each Embed Template | When using multiple embed templates for different markets, enable this to create separate products for each template. **Note:** This option is disabled when using market-specific pricing | **Yes** - creates separate products for each template; **No** - uses the same product across templates |

**How to find your Price List Group ID:**

1. Go to your Mimeeq Admin Panel → Settings → Pricing
2. Find your market-specific price list
3. Copy the Group ID and paste it to Price List Input Field

![Pricing Configuration Settings](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FCTsJb1QF8D3j6gT5wVdz%2Fshopify-help-primary2-new_d01xyd.png?alt=media)

#### Dynamic Fields Settings

| Setting                            | Description                                                                                                                                                                         |
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Information to Include with Orders | Select which product details to include with cart items (specification is always included by default)                                                                               |
| SKU                                | Define how SKUs are populated for configured products. Accepts dynamic variables                                                                                                    |
| Product Template                   | Default theme product page template assigned to newly created products. *Only applicable if "Create New Product" option is selected as the Product Creation Type.*                  |
| Cart Product Name Template         | Format pattern for the title of newly created products. Accepts dynamic variables. *Only applicable if "Create New Product" option is selected as the Product Creation Type.*       |
| Cart Product Description Template  | Format pattern for the description of newly created products. Accepts dynamic variables. *Only applicable if "Create New Product" option is selected as the Product Creation Type.* |
| Tags                               | Tags automatically added to new configured products. *Only applicable if "Create New Product" option is selected as the Product Creation Type.*                                     |

![Dynamic Fields Settings](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2Fcu4o9lJUJAc6LAUYfOF7%2Fshopify-help-primary3-new_9ypw0j.png?alt=media)

#### Available Variables

Use these variables in your templates by wrapping them in curly brackets (e.g., **{productName}**):

| Variable        | Description                                                                                                                                                        |
| --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| {specification} | Breakdown of the selected options. For example, for a chair with 2 options (fabric and base type), this will list those options along with the selected parameters |
| {productName}   | Display name of the product in the Mimeeq app                                                                                                                      |
| {sku}           | Dynamic SKU code created for the specific configuration                                                                                                            |
| {shortCode}     | Short unique code based on the specification (autogenerated by Mimeeq)                                                                                             |
| {code}          | Variant code for the product in the Mimeeq app                                                                                                                     |

### Properties Passed to Products

Here's what information is always automatically passed to newly created products or variants:

| Name             | Details                                                                                      | Default Setting | Configured in App Settings |
| ---------------- | -------------------------------------------------------------------------------------------- | --------------- | -------------------------- |
| Name             | Product name based on template pattern                                                       | --              | ✅                          |
| Description      | Description based on template pattern                                                        | --              | ✅                          |
| Image            | Final configured product image                                                               | ✅               | --                         |
| Sale Price       | Calculated price from configuration                                                          | ✅               | --                         |
| Cost Price       | Cost price (even if zero in Mimeeq)                                                          | ✅               | --                         |
| Weight           | Total weight if configured in [Item Master](/pricing-and-codes/pricing-setup/item-master.md) | ✅               | --                         |
| Tags             | As configured in settings                                                                    | --              | ✅                          |
| Product Template | As selected in settings                                                                      | --              | ✅                          |

{% hint style="info" %}
💡 The properties above are passed automatically with every configured product. If you need to send additional data — such as product metafields, variant metafields, or standard Shopify product properties — you can set this up using [Ecommerce Custom Field Mappings](/commerce-and-integrations/shopify/custom-field-mappings.md). This lets you map configuration-specific values (including dynamic option data) directly to your Shopify records without any custom development.
{% endhint %}

## Step 4: Connect Your Products with Mimeeq

When connecting product configurations from Mimeeq to your Shopify products, there are two methods you can use:

#### Method 1: Manual Product Setup (For Existing Products)

If your products already exist in Shopify and you want to map the configurator to a product page with Shopify that you've already created, you would need to do this manually.

#### Manually Mapping Mimeeq Products When Using the Create New Product Method

If you're using the "Create new product" method, you'll need to add the embed shortcode to your existing Shopify products:

1. Navigate to the product in Shopify
2. Scroll to the bottom and click **Product metafields**
3. Find the "Mimeeq Embed Shortcode" field
4. Copy the embed shortcode from your Mimeeq app and paste it here

![Add Mimeeq Embed Shortcode](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FwVHKolANWFCljpJIPE87%2Fshopify-help-1011_k64s83.png?alt=media)

#### Manually Mapping Mimeeq Products When Using the Create Variant Method

If you're using the "Create product variant" method, you'll need to create a mapping so Mimeeq knows where to create the new variants:

{% hint style="info" %}
Tip: You don't need to create variants on the product that launches the configurator - it can be a separate product that you keep just for custom designs.
{% endhint %}

1. Open product page in Shopify where you want variants to be created
2. Click **More actions** (three dots) in the top right
3. Select **Create product mapping** (Mimeeq icon)

![Create / Update product mapping](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2Fa8NxjTzeFpRG9SSANPNv%2Fshopify-help-7_12pl1a1.png?alt=media)

4. Enter the Product ID which you copy from Mimeeq
5. Save the mapping

{% hint style="warning" %}
Note: Only one Mimeeq product can be mapped to one Shopify product when using the create variant option.
{% endhint %}

![Product Mapping](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FVTV9WXJgW9vz2XM1Lwtk%2Fshopify-help-8-new_ih4i91.png?alt=media)

#### Method 2: Sync Products from Mimeeq (For New Stores)

If you're starting with a new store, a faster way is to use the sync from Mimeeq. This will create new products which you can edit later, but all the mapping will already be in place.

{% hint style="warning" %}
Note: Only products that are public and have visibility set to "Yes" will be synced.
{% endhint %}

**How to Sync Products**

1. Navigate to **Products Sync** from the Quick Setup section or menu
2. Select your synchronization mode:\*\* \*\*

* **Add only new and active products** (Recommended) - only syncs products not previously synced
* **Override all** - overwrites any changes made since last sync

3. Click **Synchronise products**
4. Wait for the sync to complete

{% hint style="warning" %}
Caution: If you've previously synced products and made changes to them in Shopify, selecting "Sync all products" will override your changes. We recommend using "Add only new and active products" to preserve your modifications.
{% endhint %}

When you sync products from Mimeeq, they'll be set up with all the information in the metafields ready to use in your storefront.

![How to Sync Products](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FfcPu0FwsH6Orq4Htkzfz%2Fshopify-help-v2-new_1nxr95o.png?alt=media)

### Understanding Metafields

| Metafield Name                 | Purpose                                                                                                                                                                                                                                                       |
| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Mimeeq Embed Shortcode         | The embed shortcode you copy from the Mimeeq app. It tells the system which configurator to load for this product/variant.                                                                                                                                    |
| Mimeeq Configuration Shortcode | Automatically populated after a product is added to cart. Stores the shortcode for the specific configuration, which can be used in API calls. For modular configurators, this ensures the correct scene loads when customers click the item from their cart. |
| Mimeeq Configuration Code      | The long configuration code that defines the product configuration. Not used for modular configurators                                                                                                                                                        |
| Mimeeq Product ID              | 🚫 Deprecated since 04/07/23 and not required. If you see this in your metafields, you can delete it or leave it. No longer used by the Mimeeq app. For installs after 04/07/23, this field won't be present.                                                 |

### Setting Different Starting Configurations

You can create multiple entry points in your store with different starting configurations. For example, if you offer a chair in three popular materials, you can create separate product listings that each load the configurator with a specific material pre-selected.

**How to Set a Starting Configuration**

1. Go to the product in Mimeeq Admin
2. Click **Preview**
3. Configure the product with your desired starting options
4. Click **More Options** → **Copy Config Code**
5. **For Standard Configurators:** Paste the code into the "Mimeeq Configuration Code" metafield
6. **For Modular Configurators:** Paste the code into the "Mimeeq Configuration Shortcode" metafield

This ensures that when customers click on that specific product listing, the configurator loads with your pre-selected options already applied.

### Managing Variant Limits

Shopify has a 100-variant limit per product. Mimeeq manages this automatically by:

* Creating new variants for unique configurations
* Reusing variants when configurations and prices match
* Deleting and recreating variants when prices change
* At 99 variants, removing the oldest modified variant to make room for new ones

{% hint style="warning" %}
Tip: If you manually delete variants, use Update variant mappings from the actions menu to refresh the variant list.
{% endhint %}

## Step 5: Configure Notifications

Set up notification preferences to stay informed about errors. For detailed instructions, see our separate guide: [How to Set Up Error Notification Emails](/commerce-and-integrations/shopify/error-notifications.md).

![Notification Settings](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FiWp2NVMZPdrGb3mF1ZtM%2Fshopify-notification3-v2-new_u8ukhw.png?alt=media)

## Add Mimeeq to Your Storefront

After configuring the app settings, you'll need to add the Mimeeq configurator to your storefront theme. See our guide: [Shopify App Theme Extension - Configure Your Storefront](/commerce-and-integrations/shopify/theme-extension.md)

## Related Help Articles

* [Error Recovery Center Guide](/commerce-and-integrations/shopify/error-recovery.md)
* [Shopify App Theme Extension - Configure your Store Front](/commerce-and-integrations/shopify/theme-extension.md)
* [Shopify Latest Version Updates](/commerce-and-integrations/shopify/changelog.md)


---

# 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/commerce-and-integrations/shopify/admin-settings.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.