> 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/getting-started.md). # Getting Started Set up Mimeeq for WooCommerce: install the plugin, add your API key, sync products, and add 3D configurators to your pages. Step-by-step guide. ## What Is This Plugin? Mimeeq lets your customers customize a product in 3D — right on your product page — before adding it to their cart. Think of a chair where the shopper picks the fabric, the wood color, and the base style, and watches it change in real time. This plugin connects that 3D configurator to your WordPress site and your WooCommerce store. **Before you start:** you need an active Mimeeq account with an API Key. This plugin doesn't create 3D configurators itself — it connects your WordPress site to configurators you've already built in your Mimeeq account. *** ## What the Plugin Does * Shows the interactive 3D configurator on product pages (or any page you like) * Automatically creates a WooCommerce product for whatever the customer configured, with the right price * Carries the customer's choices, price, and any extra fees through to the cart and the final order * Supports selling several configured items together as one bundle * Works with WPML for stores that sell in more than one language or currency * Keeps a log of technical problems customers run into (the **Error Recovery Center**) * Can email your team when something goes wrong * Adds ready-to-use blocks for the WordPress block editor (Gutenberg) and for Elementor *** ## Table of Contents 1. [Installing the Plugin](#id-1.-installing-the-plugin) 2. [Adding Your API Key](#id-2.-adding-your-api-key) 3. [Key Settings to Check](#id-3.-key-settings-to-check) 4. [Connecting Your Products to Mimeeq](#id-4.-connecting-your-products-to-mimeeq) 5. [Turning On Email Alerts](#id-5.-turning-on-email-alerts) 6. [Adding the Configurator to a Page](#id-6.-adding-the-configurator-to-a-page) *** ## 1. Installing the Plugin ### Option A: From WordPress.org (recommended, once published) 1. Go to **WP Admin → Plugins → Add New** 2. Search for "Mimeeq" 3. Click **Install**, then **Activate** ### Option B: Uploading the Plugin File Yourself 1. Get the plugin ZIP file (from Mimeeq or your developer) 2. Go to **WP Admin → Plugins → Add New → Upload Plugin** 3. Choose the ZIP file and click **Install Now** 4. Click **Activate Plugin** Once it's active, you'll see a new **Mimeeq** entry in your WordPress admin menu (on the left-hand side). *** ## 2. Adding Your API Key The API Key is what connects your WordPress site to your Mimeeq account — without it, nothing else in this plugin will work. ![Screenshot: Mimeeq welcome dashboard](https://621103948-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsqWfi8ifBhTdkvf1vOlY%2Fuploads%2FUfpJsKlHsCcGr2pRkLhQ%2F01-getting-started-01-welcome-_a9ej5.png?alt=media) **Step 1 — Find your key in Mimeeq:** 1. Log in to your Mimeeq account 2. Go to your account/settings area 3. Copy the API Key shown there **Step 2 — Paste it into WordPress:** 1. Go to **WP Admin → Mimeeq → API Settings** 2. Paste the key into the **API Key** field 3. Click **Save Changes** *** ## 3. Key Settings to Check You don't have to touch every setting — most stores work fine with the defaults. For the full list with explanations, see [Admin Settings](/commerce-and-integrations/woocommerce/admin-settings.md). The ones worth knowing about early on: * **Cart Configuration** (on the Primary Settings page) — controls how a customer's configuration turns into a WooCommerce product * **Dynamic Field Settings** — controls the name, description, and SKU given to those products * **Currency mapping** — only relevant if your store sells in more than one currency or language (see [Multi-Currency & Multi-Market](/commerce-and-integrations/woocommerce/multi-currency-wpml.md)) *** ## 4. Connecting Your Products to Mimeeq Every product that should show a 3D configurator needs to know which configurator to load. There are two ways to set this up: ### Option A: Set It Up by Hand, One Product at a Time 1. Open a WooCommerce product for editing 2. Find the **Mimeeq** tab in the Product Data section 3. Enter the **Product shortcode** and **Template ID** you got from your Mimeeq account 4. Save the product ### Option B: Sync Many Products at Once 1. Go to **WP Admin → Mimeeq → Products Sync** 2. Choose how to sync: * **"Add only new and active products"** (recommended) — adds anything new, leaves what you've already set up alone * **"Override all (update existing)"** — replaces everything, including any manual changes you made 3. Click **Synchronize Products** and wait for it to finish > ⚠️ **Careful with "Override all"** — it will overwrite any product details you've already changed by hand. Only products marked active/public in your Mimeeq account will be brought in this way. *** ## 5. Turning On Email Alerts If you'd like your team to get an email when a customer runs into a technical problem (like the configurator failing to load), set that up under **WP Admin → Mimeeq → Notifications**. Full details in [Error Notification Emails](/commerce-and-integrations/woocommerce/error-notifications.md). *** ## 6. Adding the Configurator to a Page Once your settings and products are ready, the last step is putting the configurator somewhere your customers can actually see it. You can do this with: * **Gutenberg blocks** — the standard WordPress page/post editor, drag-and-drop * **Elementor widgets** — if your site uses the Elementor page builder * **Shortcodes** — a simple text snippet, useful on older pages that don't use the block editor Full walkthrough in [Gutenberg Blocks & Elementor Widgets](/commerce-and-integrations/woocommerce/storefront-setup.md). *** ## Related Articles * [Admin Settings](/commerce-and-integrations/woocommerce/admin-settings.md) * [Gutenberg Blocks & Elementor Widgets](/commerce-and-integrations/woocommerce/storefront-setup.md) * [Error Recovery Center](/commerce-and-integrations/woocommerce/error-recovery.md) * [Version Updates](/commerce-and-integrations/woocommerce/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/woocommerce/getting-started.md?ask=&goal= ``` `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.