Shopify App - Admin Settings
Please note to use our Shopify integration you require a Mimeeq Account, if you do not have one, please reach out to us
In the following section you will learn how to configure the mimeeq shopify app settings from the admin panel
If you have not done so already. Install the Mimeeq App from the App Shopify App Store
Locate your API key which can be found under Admin Panel / Setting / Account Settings and click copy
Configure the other app settings according the following list
To use a variable wrap it in curly brackets, for example {sku}
Some things are always added to the newly or updated created product or variant such as image and price, for ease we have made a full list below:
There are a few ways to connect your products to Mimeeq depending if you have enabled "Create new product" or "Create product variant"
Below we cover each of the options
The easiest way to get up and running is to sync products from Mimeeq to your shopify, this will create a new product for each configurator in mimeeq
please note only products that are public and with visibility yes will be synced
to sync products from mimeeq do the following
If you have previously synced products and made changes to them, clicking sync all products will override your previous changes we recommend only syncing new products in which case we will only sync products that were not previously synced
When you sync products to mimeeq they will be set up with all the information in the metafields ready to use in your store front.
If you want to add the data manually in case you already have your shell products created in Shopify then you will need to do the following depending on which version you have picked.
In the case you create a new product for each product added, then you will simply need to copy the embed short code into the correct meta field
Lets say you want to have multiple starting points in your store, for example you have 3 popular materials, and you decide to create a entry in your store for each.
In this scenario you want to do then is make sure that when someone loads the configurator it will load with that material selected.
to achieve this you need to copy the long or short configuration code to the corresponding metafield based on the below logic.
Standard Configurators = Mimeeq configuration code (Metafield)
Modular Configurators = Mimeeq Configuration Shortcode (Metafield)
You can copy a configuration code from in the product admin inside mimeeq, click preview, make your design, click more options and then click copy config code.
In the case you create a variant, then you will need to create a mapping so mimeeq knows where the new variant should be created
Whats nice is that you do not need to create the variant on the product that launches the configurator, it can be a seperate product that you keep just for the custom designs]
To create the mapping do the following:
only one mimeeq product can be mapped to one Shopify product, this only applies when the create variant option is used
Since shopify at the time this article was created has a 100 variant limit we need to make sure that we do not exceed this
To work around this limitation we keep track of every variant we are creating using the following logic
We create a new variant for every unique configuration
We reuse the variant if the configuration is the same and the price has not changed
If the price changes we delete the old variant and add a new one
When we reach 99 variants we add the new one and delete the oldest modified variant to make room for the next one
If you manually delete variants then you should use the update variant mappings from the actions menu so we can read the new list of variants
Once you have configured the app settings in the shopify admin it time to add the app to theme
Check out this article for how to configure your store front options
Shopify App Theme Extension - Configure your Store Front
In the following section you will learn how to configure the mimeeq shopify app settings from the admin panel
1. Install the Mimeeq Shopify App
If you have not done so already. Install the Mimeeq App from the App Shopify App Store
2. Add Your Mimeeq API Key
Locate your API key which can be found under Admin Panel / Setting / Account Settings and click copy
| Add API | Click Save |
|---|---|
 |  |
3. Configure the App Settings
Configure the other app settings according the following list
| Name | Details |
|---|---|
| Cart product creation method | Pick between creating a new product for each custom configuration that the customer adds to the cart or creating a variant of an existing product |
| Add to cart action | there are 3 options to pick from, redirect to cart, do nothing, or close model |
| Additional Variables to pass to the Cart | we always pass the specification based on the options the customer has chosen however you can additionally pass an extra 3 parameters, SKU Code, Code and Short Code, a description for these can be found in the footer of our app |
| Product Template | this is the product template to use when a new product is created during the add to cart process (only applicable if "create new product" option is selected as the product creation type). |
| Product name template | This allows you to format the title of the newly created product using the dynamic variables (only applicable if "create new product" option is selected as the product creation type). |
| product description template | here you can define the format of the newly created product description using the dynamic variables (only applicable if "create new product" option is selected as the product creation type). |
| Tags to be added to newly created products | pick tags you want to be added to newly created products (only applicable if "create new product" option is selected as the product creation type). |
Below is a table explaining the dynamic Variables
To use a variable wrap it in curly brackets, for example {sku}
| Name | Details |
|---|---|
| specification | breakdown of the selected options for example for a chair that has 2 options, fabric and base type, this will list those options along with the selected paremeter |
| productName | Display name of the product variant in the mimeeq application |
| sku | dynamic sku code created for the specific configuration |
| code | variant code for the product in the mimeeq app |
| shortcode | a short unique code based on the specification which is autogenerated by mimeeq |
Table Showing which properties are passed to the new product or variant
Some things are always added to the newly or updated created product or variant such as image and price, for ease we have made a full list below:
| Name | Details | Default Setting | Configured in App Settings |
|---|---|---|---|
| Name | The name of the product is created based on the settings pattern | -- | ✅ |
| Description | the description is set based on the pattern provided | -- | ✅ |
| Image | The image of the final configured product | ✅ | -- |
| Sale Price | We pass the cost price to the newly created product | ✅ | -- |
| Cost Price | We pass the cost price to the newly created product, even if you have all costs as zero in Mimeeq | ✅ | -- |
| Weight | If you have configured weights using Item Master the total weight will be passed | ✅ | -- |
| Tags | As per the above settings tags are passed | -- | ✅ |
| Product Template | Product template will be set as per the app settings | -- | ✅ |
4. Connecting your products with Mimeeq
There are a few ways to connect your products to Mimeeq depending if you have enabled "Create new product" or "Create product variant"
Below we cover each of the options
Sync Products from Mimeeq (Easiest Way Recommended)
The easiest way to get up and running is to sync products from Mimeeq to your shopify, this will create a new product for each configurator in mimeeq
please note only products that are public and with visibility yes will be synced
to sync products from mimeeq do the following
| Product Sync Part 1 | Product Sync Part 1 |
|---|---|
 |  |
| there are 2 options to pick from, 1. sync new products (recommended) and 2. Sync all products (caution this will override any changes you have made since the last time the products were synced | Click Sync and wait while the sync process happens, you can leave this screen and come back later if you have a lot of products, it takes around 1 second per product |
If you have previously synced products and made changes to them, clicking sync all products will override your previous changes we recommend only syncing new products in which case we will only sync products that were not previously synced
When you sync products to mimeeq they will be set up with all the information in the metafields ready to use in your store front.
If you want to add the data manually in case you already have your shell products created in Shopify then you will need to do the following depending on which version you have picked.
Adding Meta Data for Mimeeq products when using the Create New Product Method
In the case you create a new product for each product added, then you will simply need to copy the embed short code into the correct meta field
| Add Data to Metafields | Add Data to Metafields |
|---|---|
 |  |
| Scroll to the end of the product and click metafields for the product | find the field with embed shortcode, copy this from the mimeeq app and paste here |
What other metafields are there and how we use them
| Metafield Name | Purpose |
|---|---|
| Mimeeq Configuration Shortcode | This field will be populated when the product is created (after adding to the cart, its telling the configurator the short code for this specific configuration, the short code can be used in APi calls, for modular this shortcode will also ensure that the correct scene is loaded when you click the item from the cart |
| Mimeeq Embed Shortcode | This is the embed shortcode you copy from the Mimeeq app, it tells us which configurator to load for this product / Variant |
| Mimeeq configuration code | This is the long configuration code that defines the product configuration, its not used for modular configurators |
| Mimeeq Product ID | 🚫 This field is depreciated since 04/07/23 and not required, if you see this in your metafields you can delete it leave it, it is no longer used by the mimeeq app and for installs after 04/07/23 this will not be present |
How to set a different starting configuration for a product
Lets say you want to have multiple starting points in your store, for example you have 3 popular materials, and you decide to create a entry in your store for each.
In this scenario you want to do then is make sure that when someone loads the configurator it will load with that material selected.
to achieve this you need to copy the long or short configuration code to the corresponding metafield based on the below logic.
Standard Configurators = Mimeeq configuration code (Metafield)
Modular Configurators = Mimeeq Configuration Shortcode (Metafield)
You can copy a configuration code from in the product admin inside mimeeq, click preview, make your design, click more options and then click copy config code.
Manually Mapping Mimeeq products when using the Create Variant Method
In the case you create a variant, then you will need to create a mapping so mimeeq knows where the new variant should be created
Whats nice is that you do not need to create the variant on the product that launches the configurator, it can be a seperate product that you keep just for the custom designs]
To create the mapping do the following:
| More Actions / Create Product Mapping | Paste Mimeeq Product ID |
|---|---|
 |  |
| In the top rightof the product card click more actions and select create product mapping by the mimeeq icon | you will be taken to a screen where you can create enter the product id which you copy from mimeeq, this will map this product to the mimeeq product telling us where we should create the variants |
only one mimeeq product can be mapped to one Shopify product, this only applies when the create variant option is used
How Mimeeq keeps track of the number of Variants created
Since shopify at the time this article was created has a 100 variant limit we need to make sure that we do not exceed this
To work around this limitation we keep track of every variant we are creating using the following logic
We create a new variant for every unique configuration
We reuse the variant if the configuration is the same and the price has not changed
If the price changes we delete the old variant and add a new one
When we reach 99 variants we add the new one and delete the oldest modified variant to make room for the next one
If you manually delete variants then you should use the update variant mappings from the actions menu so we can read the new list of variants
Add the Mimeeq App to your Store Front
Once you have configured the app settings in the shopify admin it time to add the app to theme
Check out this article for how to configure your store front options
Shopify App Theme Extension - Configure your Store Front
Updated on: 17/07/2024
Thank you!