Integration Guide
Connect the Mimeeq configurator to any commerce platform using embeds and Mimeeq APIs. Learn to handle Add to Cart, fetch prices and create cart products.
Integrate the Mimeeq configurator with platforms like WooCommerce, Wix, PrestaShop, X-Cart, Magento, BigCommerce and others. This guide covers embedding the configurator, handling the Add to Cart event and calling Mimeeq APIs from your backend.
Integration steps
Embed the configurator code
Copy the embed code for a single product, a product group or the full product list. Select a template with the Basket Support toggle enabled and choose the HTML sub-option.
Place the embed code snippet where you want the configurator to appear, such as inline on a page, in a pop-up or in an overlay panel. The choice is yours.
Explore the options in the Mimeeq dashboard's embed templates, like rendering in a modal, selecting UI elements or using a custom UI.
For detailed guidance, see:
Handle the Add to Cart event
When a customer finalises their configuration and clicks Add to Cart, specific data is returned in a payload. For details on the event and data structure, see Selected configuration events.
To test an example payload, open the CodePen example and click Add to Cart.
Key fields to note:
"shortCode": "UTUW6S",
"configurationCode": "SeatFinishes-b3&BaseFinishes-a7&OwnMaterial-&UploadCustomerMaterial-",
"productId": "PROD-839943b5-d722-477e-8031-0da8a42ed473",
"qty": 1,
"code": "HA_1",
"productName": "Hilko Armchair by Leloux - Add Own Material",
"collectionId": "",
"selectedOptions": {
"Seat Finishes": "Crown Velvet 30",
"Base Finishes": "Black",
"Own Material": "Inactive"
},
"isModular": false,
"embedShortCode": "U1X94N",
"sku": "PRODUCT-GP1/MET//",
"publicPriceListGroups": "cf9f6f0b-e295-45c2-b0fb-a1cf05e0a20c",
"image": "base64(64379 chars)"Call the APIs for product details and pricing
Use the returned short code and quantity, along with your unique API key, to make secure backend API calls.
For pricing information, use /get-product-price-info. See the Product Price Info API.
For product details, use /get-product-info. See the Product Info API.
With this data, you can send the price, product description and image to your cart, product catalogue, ERP system or other relevant systems.
Example process for a store like Shopify
In platforms like Shopify, real products or variants need to be created for the integration.
When the Add to Cart button is clicked, the frontend queries the backend app to create a product in the commerce system.
The app passes the configuration to the Mimeeq APIs, retrieves pricing, and then creates the product using this information.
Once the product is ready, as per the commerce cart API response, the frontend adds this product to the cart.
The specific flow depends on the limitations and constraints of the commerce platform.
Using the returned data on your host site
Here are some suggestions for using the data effectively:
Check if the unique SKU exists in your product catalogue.
Update the price if necessary.
Add the updated product to your commerce catalogue or cart.
Pass a formatted product description to the catalogue.
Alternatively, create a one-time custom product directly in the cart, depending on your system's API structure and security conditions.
Suggested SKU code format
For unique identification, create a custom product code combining the variant code and short code in this format: {CODE}-{SHORTCODE}.
Need help?
For any assistance or queries, contact Mimeeq support.
Related articles
Was this helpful?