For the complete documentation index, see llms.txt. This page is also available as Markdown.

Shopify Admin Settings

Connect Mimeeq to your Shopify store and control how configured products reach the cart. Learn to set up your API key, cart and pricing settings, and product sync.

Configure the Mimeeq Shopify app from your Shopify admin panel. This guide covers the API key, configuration settings, product connection and notifications.


Install the Mimeeq Shopify app

If you haven't already done so, install the Mimeeq App from the Shopify App Store.

When you first open the Mimeeq App, you'll see a welcome dashboard. Notification banners remind you to add your API key and configure email notifications. Four quick setup steps guide you through the essential configuration:

  1. API Key: connect your Mimeeq account to Shopify

  2. Configuration Settings: configure core functionality

  3. Products Sync: synchronise your products with Mimeeq

  4. Notifications: set up notification preferences

Mimeeq App welcome dashboard with notification banners and the four quick setup cards

Configure your API key

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

1

Copy your API key from Mimeeq

  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.

API Keys tab in the Mimeeq Admin Panel with the copy icon next to an Embed API key
2

Add the API key in the Mimeeq App

  1. In the Mimeeq App dashboard, click the API Key card or navigate to it from the menu.

  2. Click Edit.

  3. Paste your API key into the field.

  4. Click Save.

API Key page in the Mimeeq Shopify App with the key field and Save button

Configure configuration settings

Click Configuration Settings in the Quick Setup section or navigate to it from the menu. The settings are organised 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: 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 the 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 an error message and prevents adding; Allow adding to cart: allows zero-price items (use only if setting prices manually later)

Cart configuration settings in the Mimeeq Shopify App

Add to cart configuration

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

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 catalogues with Mimeeq price lists.

How it works:

  1. Each Shopify catalogue 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 mapping Shopify catalogues to price list groups

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 into the Price List input field.

Pricing configuration settings with the Price List Group ID field

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 with SKU, template and tag fields

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

This information is always passed automatically 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

✅

--

Tags

As configured in settings

--

✅

Product Template

As selected in settings

--

✅


Connect your products with Mimeeq

You can connect Mimeeq product configurations to your Shopify products in two ways. Map them manually if the products already exist in Shopify, or sync them from Mimeeq if you're starting a new store.

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

If you use the Create new product method

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.

Mimeeq Embed Shortcode field in a Shopify product's metafields

If you use the Create product variant method

Create a mapping so Mimeeq knows where to create the new variants.

  1. Open the 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).

    More actions menu on a Shopify product with the Create product mapping option
  4. Enter the Product ID, which you copy from Mimeeq.

  5. Save the mapping.

Product mapping dialog with the Mimeeq Product ID field

If you're starting with a new store, syncing from Mimeeq is faster. This creates new products which you can edit later, with all the mapping already in place.

  1. Navigate to Products Sync from the Quick Setup section or menu.

  2. Select your synchronisation mode:

    • Add only new and active products (Recommended): only syncs products not previously synced

    • Override all: overwrites any changes made since the last sync

  3. Click Synchronise products.

  4. Wait for the sync to complete.

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

Products Sync page with synchronisation mode options and the Synchronise products button

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. Each one loads 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.

When customers click that 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


Configure notifications

Set up notification preferences to stay informed about errors. For detailed instructions, see Shopify Error Notifications.

Notifications page in the Mimeeq Shopify App

Add Mimeeq to your storefront

After configuring the app settings, add the Mimeeq configurator to your storefront theme. See Shopify Theme Extension.


Last updated

Was this helpful?