> 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/woocommerce/admin-settings.md).

# WooCommerce Admin Settings

Get every Mimeeq for WooCommerce setting right the first time. Reference for API keys, cart configuration, product naming templates, sync and alerts.

Every screen under **WP Admin → Mimeeq**, and what each setting does, in plain terms.

{% hint style="info" %}
A paid Mimeeq account is required for any of this to work.
{% endhint %}

The **Mimeeq** menu has several pages, each covering a different part of the setup:

<table><thead><tr><th width="69.765625">#</th><th width="223.83984375">Page</th><th>What it's for</th></tr></thead><tbody><tr><td>1</td><td><strong>Dashboard</strong></td><td>Overview and setup checklist</td></tr><tr><td>2</td><td><strong>API Settings</strong></td><td>Connecting to your Mimeeq account</td></tr><tr><td>3</td><td><strong>Primary Settings</strong></td><td>How configured products are created and named</td></tr><tr><td>4</td><td><strong>Button Settings</strong></td><td>The look of the default "open configurator" button</td></tr><tr><td>5</td><td><strong>Notifications</strong></td><td>Email alerts for technical problems</td></tr><tr><td>6</td><td><strong>Extension Settings</strong></td><td>Advanced cart behaviour and currency mapping</td></tr><tr><td>7</td><td><strong>Products Sync</strong></td><td>Bulk-importing products from Mimeeq</td></tr><tr><td>8</td><td><strong>Error Recovery Center</strong></td><td>Log of technical problems customers ran into</td></tr></tbody></table>

***

## API settings

**Location:** WP Admin → Mimeeq → API Settings

<table><thead><tr><th width="59.12109375">#</th><th width="236.265625">Setting</th><th>What it does</th></tr></thead><tbody><tr><td>1</td><td><strong>Enable Integration</strong></td><td>Turns the whole plugin's WooCommerce integration on or off</td></tr><tr><td>2</td><td><strong>API URL</strong></td><td>Where the plugin talks to Mimeeq (leave as default unless told otherwise)</td></tr><tr><td>3</td><td><strong>API Key</strong></td><td>Your personal key from your Mimeeq account — required</td></tr><tr><td>4</td><td><strong>Pricing API URL (optional)</strong></td><td>Only needed if Mimeeq gave you a separate address for price lookups</td></tr><tr><td>5</td><td><strong>Load embed script from cdn.mimeeq.com</strong></td><td>Advanced, optional. Off by default. Turning it on always fetches the very latest version of the 3D viewer from Mimeeq's servers instead of the copy bundled with the plugin</td></tr></tbody></table>

{% stepper %}
{% step %}

### Find your API key

1. Log in to your Mimeeq account
2. Open your account/settings area
3. Copy the API Key shown there
   {% endstep %}

{% step %}

### Enter it in WordPress

1. Go to **WP Admin → Mimeeq → API Settings**
2. Paste the key into the **API Key** field
3. Click **Save Changes**

![API Settings screen with the API Key field](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FYkpeoqfM5BuPMUM4dwQv%2F02-admin-settings-01-api-key-s_updu2c.png?alt=media)
{% endstep %}
{% endstepper %}

***

## Primary settings

**Location:** WP Admin → Mimeeq → Primary Settings

### Cart configuration

This section controls what happens the moment a customer finishes configuring a product and adds it to their cart.

<table><thead><tr><th width="60.58203125">#</th><th width="156.37890625">Setting</th><th>What it does</th><th>Choices</th></tr></thead><tbody><tr><td>1</td><td><strong>Cart product creation method</strong></td><td>How WooCommerce represents the configured item</td><td><strong>Create new product</strong> (recommended) — a fresh, one-off product is created for that exact configuration. <strong>Create product variant</strong> — adds it as a variant of an existing product instead (requires Products Sync to be set up first)</td></tr><tr><td>2</td><td><strong>After add to cart action</strong></td><td>What the customer sees right after adding to cart</td><td><strong>Redirect to cart</strong> (recommended), <strong>Close modal</strong> or <strong>Do nothing</strong></td></tr><tr><td>3</td><td><strong>Zero price product handling</strong></td><td>What happens if Mimeeq can't work out a price</td><td><strong>Block adding to cart</strong> (recommended) — the customer can't proceed. <strong>Allow adding to cart</strong> — it's added anyway, at no charge</td></tr><tr><td>4</td><td><strong>Price list group (Mimeeq)</strong></td><td>An optional Mimeeq price list ID to use for backend price lookups, if you use Mimeeq's price lists</td><td>Text field — leave blank if you're not using this</td></tr><tr><td>5</td><td><strong>Separate mapping per Mimeeq embed template</strong></td><td>Only relevant with <strong>Create product variant</strong> — keeps a separate WooCommerce mapping for each embed template</td><td>On / Off</td></tr></tbody></table>

![Cart Configuration section in Primary Settings](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FHFBz6cx5Ul1zz1DNvB9E%2F02-admin-settings-02-cart-conf_3zn220.png?alt=media)

**A note on product visibility:** every product the plugin creates from a customer's configuration is automatically kept **private** — it won't show up in your shop's product listings, search results or sitemap. Customers only ever reach it through their own cart or order. This isn't something you need to configure; it happens automatically so your product catalogue doesn't fill up with one-off items.

{% hint style="info" %}
If a price can't be determined, the failed attempt is recorded automatically — see [Error Recovery](/commerce-and-integrations/woocommerce/error-recovery.md).
{% endhint %}

### Dynamic field settings

These settings control the name, description and SKU given to newly created products, using simple placeholders that get swapped for real values.

<table><thead><tr><th width="73.44140625">#</th><th width="255.0625">Setting</th><th>What it does</th></tr></thead><tbody><tr><td>1</td><td><strong>What information to include with orders</strong></td><td>Checkboxes: include the SKU, the variant code and/or the short code with each order</td></tr><tr><td>2</td><td><strong>SKU Template</strong></td><td>Pattern used to generate the product's SKU</td></tr><tr><td>3</td><td><strong>Cart product name template</strong></td><td>Pattern used to generate the product's name</td></tr><tr><td>4</td><td><strong>Cart product description template</strong></td><td>Pattern used to generate the product's description</td></tr><tr><td>5</td><td><strong>Product Tags</strong></td><td>Tags automatically applied to every configured product. Defaults to <code>mimeeq-custom</code> — you don't have to set this yourself unless you want to change or add to it</td></tr><tr><td>6</td><td><strong>Product template</strong></td><td>Default WooCommerce product template new products are based on</td></tr></tbody></table>

**Placeholders you can use in any of the templates above:**

<table><thead><tr><th width="59.59375">#</th><th width="217.66015625">Placeholder</th><th>What it becomes</th></tr></thead><tbody><tr><td>1</td><td><code>{specification}</code></td><td>A readable list of what the customer chose (recommended for descriptions)</td></tr><tr><td>2</td><td><code>{productName}</code></td><td>The product's display name inside Mimeeq</td></tr><tr><td>3</td><td><code>{sku}</code></td><td>The generated SKU for this exact configuration</td></tr><tr><td>4</td><td><code>{shortcode}</code></td><td>A short unique code based on the configuration</td></tr><tr><td>5</td><td><code>{code}</code></td><td>The variant code Mimeeq uses internally</td></tr></tbody></table>

**Example:** the default name template is `{productName} - Design Ref: {shortcode}`, which turns into something like *"Lounge Chair - Design Ref: FLYCPX"*.

***

## Connecting WooCommerce products to Mimeeq

Every product that should show a configurator needs to know which one to load. Two ways to do this:

{% tabs %}
{% tab title="Set it up by hand" %}

1. Open a WooCommerce product for editing
2. Go to the **Mimeeq** tab in the **Product Data** section
3. Fill in the fields below

<table><thead><tr><th width="66.1015625">#</th><th>Field</th><th width="79.01953125">Required?</th><th>Purpose</th></tr></thead><tbody><tr><td>1</td><td><strong>Product shortcode</strong></td><td>Yes</td><td>Identifies which Mimeeq configurator to load</td></tr><tr><td>2</td><td><strong>Template ID</strong></td><td>Yes</td><td>Identifies which embed template to use</td></tr><tr><td>3</td><td><strong>Configuration Code</strong></td><td>No</td><td>Starts the configurator on a specific saved configuration instead of the default one</td></tr><tr><td>4</td><td><strong>Scene Shortcode</strong></td><td>No</td><td>For modular/multi-part products — starts on a specific scene</td></tr><tr><td>5</td><td><strong>Public Price List</strong></td><td>No</td><td>Overrides which Mimeeq price list this one product uses</td></tr></tbody></table>

![Mimeeq tab in the WooCommerce product editor](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FyaVQymkQ2zjafeIwZlY7%2F02-admin-settings-03-product-m_hwgmwj.png?alt=media)

**Setting a specific starting configuration:** if you'd like the configurator to open with particular options already selected (instead of its defaults), get the corresponding code from your Mimeeq account and paste it into **Configuration Code** (or, for modular products, into **Scene Shortcode**).
{% endtab %}

{% tab title="Sync many products at once" %}
**Location:** WP Admin → Mimeeq → Products Sync

{% hint style="warning" %}
**Override all** will overwrite any product details you've already changed by hand. Use it with care.
{% endhint %}

1. Choose a sync mode:
   * **Add only new and active products** (recommended): brings in anything new without touching what you've already set up
   * **Override all (update existing)**: replaces everything, including manual changes
2. Click **Synchronize Products** and wait for it to complete

![Products Sync screen with sync mode options](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2F8kZE6MpAn2o1bFTM4Ei1%2F02-admin-settings-04-product-s_ynofdq.png?alt=media)

Only products marked active/public in your Mimeeq account are brought in. If you're using the **Create product variant** method from Primary Settings, this sync is also what creates the underlying WooCommerce product that variants get attached to — the matching itself is entirely automatic; there's no extra step to map a specific product by hand.
{% endtab %}
{% endtabs %}

***

## Button settings

**Location:** WP Admin → Mimeeq → Button Settings

Sets the default look (colour, shape, icon, animation) for the "open configurator" button used across your site. Any individual button block can override these defaults — see [WooCommerce Storefront Setup](/commerce-and-integrations/woocommerce/storefront-setup.md).

***

## Extension settings

**Location:** WP Admin → Mimeeq → Extension Settings

<table><thead><tr><th width="64.94140625">#</th><th width="234.82421875">Setting</th><th>What it does</th></tr></thead><tbody><tr><td>1</td><td><strong>Enable advanced add-to-cart functionality for configured products</strong></td><td>Turns on support for more complex configurations — custom bundles, multi-part (modular) products and grouped items — as set up on the Mimeeq side. Leave off for simple, single-product configurators</td></tr><tr><td>2</td><td><strong>Enable back-to-configurator link for cart items</strong></td><td>Lets customers click their item in the cart to go back and adjust the configuration before checking out</td></tr><tr><td>3</td><td><strong>Default Product Category</strong></td><td>A WooCommerce category automatically applied to newly created products</td></tr><tr><td>4</td><td><strong>Currency / Price List Mapping</strong></td><td>A table matching each currency/language to a Mimeeq price list — see <a href="/commerce-and-integrations/woocommerce/multi-currency-wpml.md">Multi-Currency (WPML)</a></td></tr></tbody></table>

***

## Notifications

**Location:** WP Admin → Mimeeq → Notifications

Set up which email addresses get alerted when customers run into technical problems. Full details in [Error Notifications](/commerce-and-integrations/woocommerce/error-notifications.md).

***

## Error Recovery Center

**Location:** WP Admin → Mimeeq → Error Recovery Center

A log of technical problems automatically recorded as they happen (configurator failing to load, price errors and similar). See [Error Recovery](/commerce-and-integrations/woocommerce/error-recovery.md) for the full picture of what's tracked.

***

## Adding Mimeeq to your storefront

Once your settings and products are ready, add the configurator to your pages. See [WooCommerce Storefront Setup](/commerce-and-integrations/woocommerce/storefront-setup.md).

***

## Related articles

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>WooCommerce Getting Started</strong></td><td>Install the plugin, add your API key and sync products.</td><td><a href="/commerce-and-integrations/woocommerce/getting-started.md">WooCommerce Getting Started</a></td></tr><tr><td><strong>WooCommerce Storefront Setup</strong></td><td>Add the configurator with Gutenberg blocks, Elementor or shortcodes.</td><td><a href="/commerce-and-integrations/woocommerce/storefront-setup.md">WooCommerce Storefront Setup</a></td></tr><tr><td><strong>Multi-Currency (WPML)</strong></td><td>Set prices per currency and market with WPML.</td><td><a href="/commerce-and-integrations/woocommerce/multi-currency-wpml.md">WooCommerce Multi-Currency (WPML)</a></td></tr><tr><td><strong>Custom Field Mappings</strong></td><td>Map configuration data to WooCommerce product custom fields.</td><td><a href="/commerce-and-integrations/woocommerce/custom-field-mappings.md">WooCommerce Custom Field Mappings</a></td></tr></tbody></table>


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://help.mimeeq.com/commerce-and-integrations/woocommerce/admin-settings.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.