# Mimeeq Help Centre

## Using Mimeeq

- [Welcome to Mimeeq](https://help.mimeeq.com/welcome-to-mimeeq.md): Everything you need to set up, configure, and embed your product configurator.
- [Getting started](https://help.mimeeq.com/configurator/getting-started.md): Set up and manage the Mimeeq Configurator, from product types to browser support.
- [Admin Panel Overview](https://help.mimeeq.com/configurator/getting-started/admin-panel-overview.md): Find your way around the Admin Panel. Learn what each main section is for, what the Products list shows and how to switch to the Business Panel.
- [Product Types](https://help.mimeeq.com/configurator/getting-started/product-types-and-limits.md): Choose between Standard, Component, Modular and Hybrid Modular products, and understand how reusable products work together.
- [Product Categories](https://help.mimeeq.com/configurator/getting-started/product-categories.md): Keep products easy to find in the Business Panel and in embedded product lists. Learn how to create categories and sub-categories and assign products.
- [Default Configuration](https://help.mimeeq.com/configurator/getting-started/default-configuration.md): Show customers the right product set-up as soon as the configurator loads. Learn how to set and save a default configuration from Preview.
- [Modular Shortcuts](https://help.mimeeq.com/configurator/getting-started/shortcuts.md): Work faster in the Modular Configurator. Learn the keyboard shortcuts for saving, exporting, zooming, cloning and managing items.
- [WebGL Support](https://help.mimeeq.com/configurator/getting-started/webgl-support.md): Make sure the Mimeeq 3D configurator loads in your browser. Learn how to check and enable WebGL in Chrome, Firefox, Edge and Safari.
- [Product setup](https://help.mimeeq.com/configurator/product-setup.md): Set product information, availability and presentation.
- [General product settings](https://help.mimeeq.com/configurator/product-setup/general-product-settings.md): Set product names, availability, access, categorisation and preview images in the General tab.
- [Product connections](https://help.mimeeq.com/configurator/product-setup/product-connections.md): See what depends on a product before you change or remove it. Learn how to check partner sharing, connected configurators and price lists in scope.
- [Options & widgets](https://help.mimeeq.com/configurator/options-and-widgets.md): Set up option blocks, widgets, fonts, and visibility controls for your configurators.
- [Local & Global Templates](https://help.mimeeq.com/configurator/options-and-widgets/local-and-global-templates.md): Keep widget settings consistent across configurators from one place. Learn when to use Global Templates or Local Settings and how to apply each.
- [Button Widget](https://help.mimeeq.com/configurator/options-and-widgets/button-widget.md): Add clickable buttons that reset options, guide customers step by step or fire JavaScript events. Learn how to add and style the Button widget.
- [Filter Widget](https://help.mimeeq.com/configurator/options-and-widgets/filter-widget.md): Help customers find the right material fast in large collections. Learn how to create filters, tag your options and set up the Filter Widget.
- [Thumbnail Widget](https://help.mimeeq.com/configurator/options-and-widgets/thumbnail-widget.md): Show fabrics, materials and finishes as a clear visual grid. Learn how to set up the Thumbnail Widget and customise its layout, captions and style.
- [Colour Picker Widget](https://help.mimeeq.com/configurator/options-and-widgets/colour-picker-widget.md): Let customers personalise products with any colour or quick presets. Learn how to set up the Colour Picker Widget and connect it to your 3D meshes.
- [Print on Demand](https://help.mimeeq.com/configurator/options-and-widgets/print-on-demand.md): Let customers put their own logos and images on your products and preview them in 3D and AR. Learn how to set up print areas, prepare files and download designs.
- [Custom Fonts](https://help.mimeeq.com/configurator/options-and-widgets/custom-fonts.md): Use your brand fonts in engraving options and PDFs. Learn how to upload custom fonts, create font groups and choose fonts for products and PDFs.
- [Hiding Options](https://help.mimeeq.com/configurator/options-and-widgets/hiding-options.md): Keep your configurator clean while hidden logic drives pricing and specifications. Learn when to hide options from the option panel, specifications or both.
- [Configurator Tabs](https://help.mimeeq.com/configurator/options-and-widgets/tabs.md): Give customers extra product details right below the 3D view. Learn how to add text, popular configurations, finishes, galleries and download tabs.
- [Rules](https://help.mimeeq.com/configurator/rules.md): Create configurator rules with triggers and actions that control options, materials, and product behaviour.
- [Rules Overview](https://help.mimeeq.com/configurator/rules/overview.md): Learn how to create dynamic product configurations using Mimeeq's triggers and actions system.
- [Triggers Overview](https://help.mimeeq.com/configurator/rules/triggers.md): Browse every trigger type available in the configurator, with use cases and inclusion logic explained.
- [Actions Overview](https://help.mimeeq.com/configurator/rules/actions.md): A reference for all actions available in the Mimeeq configurator — camera, scene, mesh, materials, options, UI, and dimension controls.
- [Unselect Options](https://help.mimeeq.com/configurator/rules/actions/unselect-options.md): Clear selections automatically with reset buttons or mutually exclusive options. Learn how to set up the Unselect Options action and the option setting it needs.
- [Material Override Parameters](https://help.mimeeq.com/configurator/rules/actions/material-override.md): Change colours, textures and other material properties without creating extra materials. Learn how to set up the Override Material Parameters action.
- [Billboard Mode for Meshes](https://help.mimeeq.com/configurator/rules/actions/billboard-mode.md): Keep signs, labels and interactive meshes facing the camera from any angle. Learn how to set up billboard mode and which billboard type to choose.
- [Embeds & translations](https://help.mimeeq.com/configurator/embeds-and-translations.md): Learn how to embed the Mimeeq configurator on your website, platform, or custom storefront. Configure embed types to match your integration method, adjust template settings to control the layout and b
- [Embed Types](https://help.mimeeq.com/configurator/embeds-and-translations/embed-types.md): Learn the different embed formats available in Mimeeq and how to generate embed codes for each type.
- [Embed Template Settings](https://help.mimeeq.com/configurator/embeds-and-translations/template-settings.md): Configure layout, behaviour, UI elements, and advanced settings for your embed templates.
- [Translations](https://help.mimeeq.com/configurator/embeds-and-translations/translations.md): Manage and customise the interface text shown to customers across all your embed types. Learn how translation sets work, how to edit them, and how to assign them to embed templates.
- [Dimensions & exports](https://help.mimeeq.com/configurator/dimensions-and-exports.md): Configure dimension overlays on the 3D canvas and set up export options for PDF generation and dynamic file downloads.
- [Dimension Overlay](https://help.mimeeq.com/configurator/dimensions-and-exports/dimension-overlay.md): Configure the Dimension Overlay in Mimeeq — covering global settings, product-level overrides, custom point-to-point measurements, and dimension rules for standard and modular products.
- [PDF Export](https://help.mimeeq.com/configurator/dimensions-and-exports/pdf-export.md): Learn how to enable PDF export in Mimeeq, customise what appears in the PDF, and configure branding, pricing, and product details from your Embed Template settings.
- [Dynamic Downloads](https://help.mimeeq.com/configurator/dimensions-and-exports/dynamic-downloads.md): Show customers the files that match their exact configuration. Learn how to set up Dynamic Mode in the Downloads tab and organise files so the right CAD models and specs appear.
- [Sharing products](https://help.mimeeq.com/configurator/sharing-products.md): Share product configurations with customers or partners using Mimeeq's built-in sharing tools.
- [Sharing as Owner](https://help.mimeeq.com/configurator/sharing-products/sharing-as-owner.md): Share your products with partners who use Mimeeq. Learn how to connect a partner company, create a shared product group and choose which products they receive.
- [Sharing as Partner](https://help.mimeeq.com/configurator/sharing-products/sharing-as-partner.md): Receive products that an owner shares with you in Mimeeq. Learn where to find your customer sharing key and how to add shared products to your account.
- [3D assets](https://help.mimeeq.com/configurator/3d-assets.md): Prepare and optimise 3D models and assets for use in the Mimeeq configurator.
- [3D Asset Requirements](https://help.mimeeq.com/configurator/3d-assets/asset-requirements.md): Build 3D models that load fast and look sharp in the Mimeeq configurator. Learn the supported formats, mesh limits, AO map setup and texture rules.
- [Photo & Video References](https://help.mimeeq.com/configurator/3d-assets/photo-and-video-references.md): Good reference photos and videos help us model your products accurately. Learn which images, details, dimensions and videos to send.
- [Blender Setup](https://help.mimeeq.com/configurator/3d-assets/blender-setup.md): Set up your Blender file so Mimeeq scripts can bake AO maps, compress models and create AR versions for you. Learn the collection, naming and UV rules.
- [Modular Products in Blender](https://help.mimeeq.com/configurator/3d-assets/modular-products-in-blender.md): Build modules that snap, collide and measure correctly in Mimeeq modular configurators. Learn to set up snaps, collisions and dimension boxes in Blender.
- [Advanced customisation](https://help.mimeeq.com/configurator/advanced-customisation.md): Extend configurator behaviour with a custom UI, JavaScript API, and morph targets.
- [Custom UI Requirements](https://help.mimeeq.com/configurator/advanced-customisation/custom-ui-requirements.md): Give Mimeeq everything needed to build your custom configurator interface. Learn which design files, component states, user flows and PDF details to provide.
- [JavaScript API](https://help.mimeeq.com/configurator/advanced-customisation/javascript-api.md): Control the Mimeeq configurator from your own code and add custom logic. Learn how to run a headless canvas and drive rules with external values like quantity.
- [Morph Targets](https://help.mimeeq.com/configurator/advanced-customisation/morph-targets.md): Let customers resize a 3D product smoothly with a slider. Learn how to prepare Blender shape keys, set up slider widgets and connect them to morph targets.
- [Shopify](https://help.mimeeq.com/commerce-and-integrations/shopify.md): Set up the Mimeeq Shopify app, add configurators to your storefront, and manage pricing, carts and errors.
- [Shopify Admin Settings](https://help.mimeeq.com/commerce-and-integrations/shopify/admin-settings.md): 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.
- [Shopify Theme Extension](https://help.mimeeq.com/commerce-and-integrations/shopify/theme-extension.md): Add Mimeeq configurators, buttons and error handling to your Shopify storefront. Learn to set up each Mimeeq app block in the Shopify theme editor.
- [Shopify Multi-Currency & Markets](https://help.mimeeq.com/commerce-and-integrations/shopify/multi-currency-and-markets.md): Show customers accurate prices in every Shopify market. Learn to set up exchange-rate pricing or multi-market price list mappings for your configurator.
- [Shopify Discount Codes](https://help.mimeeq.com/commerce-and-integrations/shopify/discount-codes.md): Run promotions on configured products without changing their base price. Learn to apply Shopify discount codes to Mimeeq products and bundles.
- [Shopify Error Recovery Center](https://help.mimeeq.com/commerce-and-integrations/shopify/error-recovery.md): Track configurator and cart errors in one place and follow up with affected customers. Learn to filter, export and resolve errors in the Error Recovery Center.
- [Custom Custom Field Mappings](https://help.mimeeq.com/commerce-and-integrations/shopify/custom-field-mappings.md): Send product metadata beyond SKU and price to Shopify or WooCommerce without custom development. Learn to set up field mappings, formulas and validation.
- [Shopify Error Notifications](https://help.mimeeq.com/commerce-and-integrations/shopify/error-notifications.md): Get an email alert as soon as customers hit a configurator or cart error. Learn how critical alerts and optional diagnostics work and how to set them up.
- [Shopify Add to Cart Methods](https://help.mimeeq.com/commerce-and-integrations/shopify/add-to-cart.md): Control how configured products reach the Shopify cart, from single products to bundles. Learn to set up each add-to-cart method for standard and modular products.
- [Shopify FAQ](https://help.mimeeq.com/commerce-and-integrations/shopify/faq.md): Get quick answers about using Mimeeq with Shopify. Learn about licences, translations, pricing, tax, currencies, cart images, discounts, styling and page speed.
- [WooCommerce](https://help.mimeeq.com/commerce-and-integrations/woocommerce.md): Sell configurable products with live 3D previews in WooCommerce. Install the plugin, add configurators to your pages, and manage pricing, bundles, coupons and errors.
- [WooCommerce Getting Started](https://help.mimeeq.com/commerce-and-integrations/woocommerce/getting-started.md): Show 3D configurators in your WooCommerce store. Learn how to install the plugin, add your API key, sync products and add the configurator to a page.
- [WooCommerce Admin Settings](https://help.mimeeq.com/commerce-and-integrations/woocommerce/admin-settings.md): Get every Mimeeq for WooCommerce setting right the first time. Reference for API keys, cart configuration, product naming templates, sync and alerts.
- [WooCommerce Storefront Setup](https://help.mimeeq.com/commerce-and-integrations/woocommerce/storefront-setup.md): Put the Mimeeq 3D configurator in front of your shoppers. Learn to use Gutenberg blocks, Elementor widgets, shortcodes and configurator buttons.
- [WooCommerce Add to Cart Methods](https://help.mimeeq.com/commerce-and-integrations/woocommerce/add-to-cart.md): Sell bundles and modular products through your WooCommerce cart. Learn how Mimeeq turns configurations into cart items and where each method is set up.
- [WooCommerce Custom Field Mappings](https://help.mimeeq.com/commerce-and-integrations/woocommerce/custom-field-mappings.md): Store extra configuration data on your WooCommerce products without code. Learn where mappings are set up, how values work and why fields get a prefix.
- [WooCommerce Multi-Currency (WPML)](https://help.mimeeq.com/commerce-and-integrations/woocommerce/multi-currency-wpml.md): Price each market your way with WPML. Learn when to use automatic conversion or a fixed Mimeeq price list, and how to map each currency.
- [WooCommerce Error Notifications](https://help.mimeeq.com/commerce-and-integrations/woocommerce/error-notifications.md): Hear about configurator and cart problems before customers complain. Learn which errors trigger an email and how to route each type to the right people.
- [WooCommerce Discount Codes](https://help.mimeeq.com/commerce-and-integrations/woocommerce/discount-codes.md): Run WooCommerce coupons on your configured products. Learn to target Mimeeq products with the mimeeq-custom tag and how discounts behave with bundles.
- [WooCommerce Error Recovery](https://help.mimeeq.com/commerce-and-integrations/woocommerce/error-recovery.md): Spot and fix configurator and cart problems customers hit. Learn what the Error Recovery Center logs, what each entry shows and how to resolve issues.
- [WooCommerce FAQ](https://help.mimeeq.com/commerce-and-integrations/woocommerce/faq.md): Get quick answers about Mimeeq for WooCommerce. Covers pricing, tax, currencies, discount codes, private products, customisation and page speed.
- [Mimeeq Basket](https://help.mimeeq.com/commerce-and-integrations/mimeeq-basket.md): Set up the Mimeeq Basket to collect orders and quote requests, customise its emails and pricing, and turn submissions into quotes.
- [Basket Overview](https://help.mimeeq.com/commerce-and-integrations/mimeeq-basket/overview.md): Collect orders, quote requests and inquiries with the Mimeeq Basket. See how it works and find guides to set it up, embed it and manage submissions.
- [Basket Settings](https://help.mimeeq.com/commerce-and-integrations/mimeeq-basket/basket-settings.md): Control what your Basket shows and who receives submissions. Learn how to set primary details, choose form fields and add recipient emails.
- [Basket Emails & PDFs](https://help.mimeeq.com/commerce-and-integrations/mimeeq-basket/basket-emails-and-pdfs.md): Make every Basket email and PDF match your brand and language. Learn how submission emails work and how to use variables and static labels.
- [Basket Pricing Rules](https://help.mimeeq.com/commerce-and-integrations/mimeeq-basket/pricing-rules.md): Apply discounts and extra charges to the Basket total automatically. Learn how to set rule scope, conditions and actions, and manage your pricing rules.
- [Basket Website Embed](https://help.mimeeq.com/commerce-and-integrations/mimeeq-basket/basket-website-embed.md): Add the Mimeeq Basket to your website with an embed template or standalone code. Learn each setting and how to translate the Basket interface.
- [Basket Submissions & Quotes](https://help.mimeeq.com/commerce-and-integrations/mimeeq-basket/basket-submissions-and-quotes.md): Turn Basket submissions into sales quotes. Learn how to review submitted and abandoned baskets and add them to new or existing quotes.
- [Custom Commerce](https://help.mimeeq.com/commerce-and-integrations/custom-commerce.md): Connect Mimeeq to a custom ecommerce solution or capture configurations with a third-party form.
- [Integration Guide](https://help.mimeeq.com/commerce-and-integrations/custom-commerce/integration-guide.md): 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.
- [Third-Party Forms](https://help.mimeeq.com/commerce-and-integrations/custom-commerce/third-party-forms.md): Send configurator selections straight into third-party forms with no back-end code. Learn to listen for the Add to Cart event and pre-fill a Zapier Interfaces form.
- [Pricing Setup](https://help.mimeeq.com/pricing-and-codes/pricing-setup.md): Set up currencies, markets, price lists and item data to control how prices are calculated in Mimeeq.
- [Pricing Overview](https://help.mimeeq.com/pricing-and-codes/pricing-setup/pricing-overview.md): Control how prices are calculated for every market and customer. Learn to set up currencies, markets, market cost prices, price lists, quantity breaks and public price groups.
- [Item Master](https://help.mimeeq.com/pricing-and-codes/pricing-setup/item-master.md): Keep delivery times, weights and dimensions for every item code in one place. Learn which fields Item Master stores and how they feed delivery estimates and Shopify.
- [CSV Templates](https://help.mimeeq.com/pricing-and-codes/pricing-setup/csv-templates.md): Import item data and market cost prices in bulk from a CSV file. Learn where to download the templates, which fields to fill in and how each import option works.
- [Price Codes & Promotions](https://help.mimeeq.com/pricing-and-codes/price-codes-and-promotions.md): Set up one-time charges, order quantity rules, promotional prices and extra price codes for your products.
- [One-Time Prices](https://help.mimeeq.com/pricing-and-codes/price-codes-and-promotions/one-time-prices.md): Add fixed charges that stay the same however many units a customer orders. Learn how the Ignore Product Quantity toggle works and when to use it.
- [MOQ & IOC](https://help.mimeeq.com/pricing-and-codes/price-codes-and-promotions/moq-and-ioc.md): Control how many units customers can order with minimum and incremental order quantities. Learn what MOQ and IOC do and how to combine them.
- [Promotional Prices](https://help.mimeeq.com/pricing-and-codes/price-codes-and-promotions/promotional-prices.md): Show customers their savings with a crossed-out compare price. Learn how to set up promotional price lists and how Mimeeq chooses which price to display.
- [Pricing API](https://help.mimeeq.com/pricing-and-codes/price-codes-and-promotions/pricing-api.md): Show special prices for logged-in users, companies or promotions in the configurator. Learn the ways to request prices from the Pricing API and set them in your embed.
- [Additional Price Codes](https://help.mimeeq.com/pricing-and-codes/price-codes-and-promotions/additional-price-codes.md): Show shoppers how each option changes the price, such as +$100 for arms. Learn how to set up additional price codes and turn on price difference display.
- [Low-Poly Models](https://help.mimeeq.com/augmented-reality/low-poly-models.md): Keep AR models light and quick to load on Apple devices. Learn when to use a low-poly model and how to add one to new or existing products.
- [AR-Only Materials](https://help.mimeeq.com/augmented-reality/ar-only-materials.md): Keep detailed browser materials while showing accurate colours in AR. Learn how to assign an alternative AR material in option sets and override rules.
- [Unsupported AR Parameters](https://help.mimeeq.com/augmented-reality/unsupported-parameters.md): Avoid materials that look wrong in AR. Learn which material parameters WebAR does not support and how to work around opacity textures and bump level.
- [Users & contacts](https://help.mimeeq.com/users-and-permissions/users-and-contacts.md): Invite team members and partners, and manage companies and contacts in bulk.
- [Invite Team Members](https://help.mimeeq.com/users-and-permissions/users-and-contacts/invite-team-members.md): Give colleagues access to your Mimeeq dashboard. Learn how to add a team member, assign them a role and send the invite.
- [Invite Partners](https://help.mimeeq.com/users-and-permissions/users-and-contacts/invite-partners.md): Let clients view prices and save favourite collections from your embedded content. Learn how to invite a contact as a client user and track their status.
- [Import & Export](https://help.mimeeq.com/users-and-permissions/users-and-contacts/import-and-export.md): Add or update companies and contacts in bulk instead of one by one. Learn how to prepare CSV files, import and export data, and fix common errors.
- [Access & login](https://help.mimeeq.com/users-and-permissions/access-and-login.md): Add customer login to your website and restrict configurators to selected company groups.
- [Authentication](https://help.mimeeq.com/users-and-permissions/access-and-login/authentication.md): Let customers log in to see private prices, saved configurations and their profile. Learn how to add the Mimeeq login code, login links and redirects.
- [Restricted Access](https://help.mimeeq.com/users-and-permissions/access-and-login/restricted-access.md): Show selected configurators only to the customer groups you choose. Learn how to set up company groups, add companies and restrict product access.
- [Usage Dashboard](https://help.mimeeq.com/platform/usage-dashboard.md): Keep configurator usage within your plan limit. Learn how to track sessions, export usage reports, set up usage alerts and review other account limits.
- [Trash](https://help.mimeeq.com/platform/trash.md): Recover deleted items instead of losing them for good. Learn how to move items to Trash, restore them within 31 days and delete them permanently.
- [Revisions](https://help.mimeeq.com/platform/revisions.md): Undo unwanted changes by rolling back to an earlier version. Learn how to view change history, restore a revision and what gets restored per module.
- [Custom Fields](https://help.mimeeq.com/platform/custom-fields.md): Set up custom fields to collect order details in Baskets and store extra product data in Option Sets.
- [Custom Fields Overview](https://help.mimeeq.com/platform/custom-fields/custom-fields.md): Capture extra order details and store specialised product data. Learn the field types, where to use them, and how to edit or delete fields.
- [Checkbox Field](https://help.mimeeq.com/platform/custom-fields/checkbox-field.md): Collect simple Yes/No answers from customers in the Basket. Learn how to create a checkbox field and how it appears on the Basket form.
- [Single-Select Field](https://help.mimeeq.com/platform/custom-fields/single-select-field.md): Let customers choose from a list you define, such as delivery options. Learn how to create a single-select field and how it appears in the Basket.
- [Single-Line Text Field](https://help.mimeeq.com/platform/custom-fields/single-line-text-field.md): Collect short text in the Basket or store it on Option Sets for SKU and price codes. Learn how to create a single-line text field.
- [Multi-Line Text Field](https://help.mimeeq.com/platform/custom-fields/multi-line-text-field.md): Collect longer text such as order notes or delivery preferences in the Basket. Learn how to create a multi-line text field.
- [Number Field](https://help.mimeeq.com/platform/custom-fields/number-field.md): Collect or store numeric values such as quantities or reference numbers. Learn how to create a number field with limits and validation.
- [Translatable Text Field](https://help.mimeeq.com/platform/custom-fields/translatable-text-field.md): Store Option Set text with translations for every language. Learn how to create a translatable text field and add translations.
- [Overview](https://help.mimeeq.com/mimeeq-ai-studio/overview.md): Create professional product visuals with AI, straight from your real product data. Learn which tools Mimeeq AI Studio includes and how media and credits work.
- [Scene Generator](https://help.mimeeq.com/mimeeq-ai-studio/scene-generator.md): Place your configured products in realistic lifestyle scenes without a photoshoot. Learn how to add objects, define the scene, adjust settings and estimate credits.
- [Packshot Generator](https://help.mimeeq.com/mimeeq-ai-studio/packshot-generator.md): Turn any product capture or photo into a clean, studio-quality packshot. Learn how to add your product, adjust settings and see what each image costs in credits.
- [Media Management](https://help.mimeeq.com/mimeeq-ai-studio/media-management.md): Every file you capture, upload or generate is saved automatically. Learn how Project Media and the Media Library help you find, reuse and download your assets.
- [Credit System](https://help.mimeeq.com/mimeeq-ai-studio/credit-system.md): Credits let your whole team generate AI visuals from one shared balance. Learn how credits are used, how to top up your balance and how to manage billing.
- [Overview](https://help.mimeeq.com/developer-guides/overview.md): Build on Mimeeq with embeds, events and APIs. Learn what the developer documentation covers and where to start for your integration.
- [API Keys](https://help.mimeeq.com/developer-guides/api-keys.md): Connect your own systems to Mimeeq securely. Learn what the Embed and Admin APIs do, how to create keys and how to monitor API requests.
- [Cart Validation Script](https://help.mimeeq.com/developer-guides/cart-validation-script.md): Stop Shopify customers seeing blank prices or images for custom products in the cart. Learn what the script does, how it works and how to adapt it.
- [Custom UI](https://help.mimeeq.com/developer-guides/custom-ui.md): Build your own interface around the Mimeeq 3D configurator. Learn how to set up, develop locally, deploy through the admin panel and build a custom AR flow.
- [Performance](https://help.mimeeq.com/developer-guides/performance.md): Give customers fast, smooth 3D configurators anywhere in the world. Learn how Mimeeq uses HTTP/3, code splitting, compression and a global CDN.
- [Events & Tracking](https://help.mimeeq.com/developer-guides/events-and-tracking.md): Build your own analytics from configurator activity. Learn what Mimeeq events are, how to use them and how to link them to logged-in users.
- [Webhooks](https://help.mimeeq.com/developer-guides/webhooks.md): Send real-time Mimeeq data straight to your own systems. Learn how to create and test webhooks, read the payload and connect Zapier or Power Automate.
- [Custom Loader](https://help.mimeeq.com/developer-guides/custom-loader.md): Show your own branded loading animation while the configurator starts. See working CodePen examples and a breakdown of the code you need.
- [SSL Errors](https://help.mimeeq.com/troubleshooting/ssl-errors.md): Get back into the Mimeeq configurator quickly when your browser shows an SSL error. Learn what causes NET::ERR\_CERT\_AUTHORITY\_INVALID and how to fix it.

## API

- [Welcome to the Mimeeq API](https://help.mimeeq.com/api/welcome-to-the-mimeeq-api.md): Start building with the Mimeeq Admin API: explore resources, set up authentication, and make your first request.
- [Start here](https://help.mimeeq.com/api/start-here.md)
- [Authentication](https://help.mimeeq.com/api/authentication.md)
- [Response shape](https://help.mimeeq.com/api/response-shape.md)
- [Pagination](https://help.mimeeq.com/api/pagination.md)
- [Errors](https://help.mimeeq.com/api/errors.md)
- [Deleting resources](https://help.mimeeq.com/api/deleting-resources.md)
- [Reading API schemas](https://help.mimeeq.com/api/reading-api-schemas.md)
- [Rate limits](https://help.mimeeq.com/api/rate-limits.md)
- [Carts](https://help.mimeeq.com/api/carts.md)
- [List Carts](https://help.mimeeq.com/api/carts/list-carts.md)
- [Get Cart](https://help.mimeeq.com/api/carts/get-cart.md)
- [Companies](https://help.mimeeq.com/api/companies.md)
- [List Companies](https://help.mimeeq.com/api/companies/list-companies.md)
- [Create Company](https://help.mimeeq.com/api/companies/create-company.md)
- [Get Company](https://help.mimeeq.com/api/companies/get-company.md)
- [Update Company](https://help.mimeeq.com/api/companies/update-company.md)
- [List Company Notes](https://help.mimeeq.com/api/companies/list-company-notes.md)
- [Update Company Price Lists](https://help.mimeeq.com/api/companies/update-company-price-lists.md)
- [Contacts](https://help.mimeeq.com/api/contacts.md)
- [List Contacts](https://help.mimeeq.com/api/contacts/list-contacts.md)
- [Create Contact](https://help.mimeeq.com/api/contacts/create-contact.md)
- [Get Contact](https://help.mimeeq.com/api/contacts/get-contact.md)
- [Update Contact](https://help.mimeeq.com/api/contacts/update-contact.md)
- [Customer](https://help.mimeeq.com/api/customer.md)
- [List Customer](https://help.mimeeq.com/api/customer/list-customer.md)
- [Update Customer Contact](https://help.mimeeq.com/api/customer/update-customer-contact.md)
- [Update Customer Languages](https://help.mimeeq.com/api/customer/update-customer-languages.md)
- [Update Customer Pricing](https://help.mimeeq.com/api/customer/update-customer-pricing.md)
- [Custom Fields](https://help.mimeeq.com/api/custom-fields.md)
- [List Custom Fields](https://help.mimeeq.com/api/custom-fields/list-custom-fields.md)
- [Create Custom Field](https://help.mimeeq.com/api/custom-fields/create-custom-field.md)
- [Get Custom Field](https://help.mimeeq.com/api/custom-fields/get-custom-field.md)
- [Update Custom Field](https://help.mimeeq.com/api/custom-fields/update-custom-field.md)
- [Delete Custom Field](https://help.mimeeq.com/api/custom-fields/delete-custom-field.md)
- [Users](https://help.mimeeq.com/api/users.md)
- [List Users](https://help.mimeeq.com/api/users/list-users.md)
- [Get User](https://help.mimeeq.com/api/users/get-user.md)
- [Set User Status](https://help.mimeeq.com/api/users/set-user-status.md)
- [Invitations](https://help.mimeeq.com/api/invitations.md)
- [List Invitations](https://help.mimeeq.com/api/invitations/list-invitations.md)
- [Create Invitation](https://help.mimeeq.com/api/invitations/create-invitation.md)
- [Delete Invitation](https://help.mimeeq.com/api/invitations/delete-invitation.md)
- [Roles](https://help.mimeeq.com/api/roles.md)
- [List Roles](https://help.mimeeq.com/api/roles/list-roles.md)
- [Create Role](https://help.mimeeq.com/api/roles/create-role.md)
- [List Role Permissions](https://help.mimeeq.com/api/roles/list-role-permissions.md)
- [Get Role](https://help.mimeeq.com/api/roles/get-role.md)
- [Update Role](https://help.mimeeq.com/api/roles/update-role.md)
- [Global Option Sets](https://help.mimeeq.com/api/global-option-sets.md)
- [List Global Option Sets](https://help.mimeeq.com/api/global-option-sets/list-global-option-sets.md)
- [Create Global Option Set](https://help.mimeeq.com/api/global-option-sets/create-global-option-set.md)
- [Get Global Option Set](https://help.mimeeq.com/api/global-option-sets/get-global-option-set.md)
- [Update Global Option Set](https://help.mimeeq.com/api/global-option-sets/update-global-option-set.md)
- [Add or Update Global Option Set Options](https://help.mimeeq.com/api/global-option-sets/add-or-update-global-option-set-options.md)
- [Update Global Option Set Options](https://help.mimeeq.com/api/global-option-sets/update-global-option-set-options.md)
- [Remove Global Option Set Options](https://help.mimeeq.com/api/global-option-sets/remove-global-option-set-options.md)
- [Duplicate Global Option Set](https://help.mimeeq.com/api/global-option-sets/duplicate-global-option-set.md)
- [Collection Sets](https://help.mimeeq.com/api/collection-sets.md)
- [List Collection Sets](https://help.mimeeq.com/api/collection-sets/list-collection-sets.md)
- [Create Collection Set](https://help.mimeeq.com/api/collection-sets/create-collection-set.md)
- [Get Collection Set](https://help.mimeeq.com/api/collection-sets/get-collection-set.md)
- [Update Collection Set](https://help.mimeeq.com/api/collection-sets/update-collection-set.md)
- [Add Collection Set Option Sets](https://help.mimeeq.com/api/collection-sets/add-collection-set-option-sets.md)
- [Update Collection Set Option Sets](https://help.mimeeq.com/api/collection-sets/update-collection-set-option-sets.md)
- [Remove Collection Set Option Sets](https://help.mimeeq.com/api/collection-sets/remove-collection-set-option-sets.md)
- [Duplicate Collection Set](https://help.mimeeq.com/api/collection-sets/duplicate-collection-set.md)
- [Galleries](https://help.mimeeq.com/api/galleries.md)
- [List Galleries](https://help.mimeeq.com/api/galleries/list-galleries.md)
- [Create Gallery](https://help.mimeeq.com/api/galleries/create-gallery.md)
- [Get Gallery](https://help.mimeeq.com/api/galleries/get-gallery.md)
- [Update Gallery](https://help.mimeeq.com/api/galleries/update-gallery.md)
- [Add or Update Gallery Items](https://help.mimeeq.com/api/galleries/add-or-update-gallery-items.md)
- [Update Gallery Items](https://help.mimeeq.com/api/galleries/update-gallery-items.md)
- [Remove Gallery Items](https://help.mimeeq.com/api/galleries/remove-gallery-items.md)
- [Item Masters](https://help.mimeeq.com/api/item-masters.md)
- [List Item Masters](https://help.mimeeq.com/api/item-masters/list-item-masters.md)
- [Create Item Master](https://help.mimeeq.com/api/item-masters/create-item-master.md)
- [Bulk upsert Item Masters](https://help.mimeeq.com/api/item-masters/bulk-upsert-item-masters.md)
- [Get Item Master](https://help.mimeeq.com/api/item-masters/get-item-master.md)
- [Update Item Master](https://help.mimeeq.com/api/item-masters/update-item-master.md)
- [Market Cost Prices](https://help.mimeeq.com/api/market-cost-prices.md)
- [List Market Cost Prices](https://help.mimeeq.com/api/market-cost-prices/list-market-cost-prices.md)
- [Create Market Cost Price](https://help.mimeeq.com/api/market-cost-prices/create-market-cost-price.md)
- [Bulk upsert Market Cost Prices](https://help.mimeeq.com/api/market-cost-prices/bulk-upsert-market-cost-prices.md)
- [Update Market Cost Price](https://help.mimeeq.com/api/market-cost-prices/update-market-cost-price.md)
- [Price Lists](https://help.mimeeq.com/api/price-lists.md)
- [List Price Lists](https://help.mimeeq.com/api/price-lists/list-price-lists.md)
- [Create Price List](https://help.mimeeq.com/api/price-lists/create-price-list.md)
- [Get Price List](https://help.mimeeq.com/api/price-lists/get-price-list.md)
- [Update Price List](https://help.mimeeq.com/api/price-lists/update-price-list.md)
- [Update Price List Prices](https://help.mimeeq.com/api/price-lists/update-price-list-prices.md)
- [Product Groups](https://help.mimeeq.com/api/product-groups.md)
- [List Product Groups](https://help.mimeeq.com/api/product-groups/list-product-groups.md)
- [Create Product Group](https://help.mimeeq.com/api/product-groups/create-product-group.md)
- [Get Product Group](https://help.mimeeq.com/api/product-groups/get-product-group.md)
- [Update Product Group](https://help.mimeeq.com/api/product-groups/update-product-group.md)
- [Add Product Group Products](https://help.mimeeq.com/api/product-groups/add-product-group-products.md)
- [Update Product Group Products](https://help.mimeeq.com/api/product-groups/update-product-group-products.md)
- [Remove Product Group Products](https://help.mimeeq.com/api/product-groups/remove-product-group-products.md)
- [Add Product Group Companies](https://help.mimeeq.com/api/product-groups/add-product-group-companies.md)
- [Update Product Group Companies](https://help.mimeeq.com/api/product-groups/update-product-group-companies.md)
- [Remove Product Group Companies](https://help.mimeeq.com/api/product-groups/remove-product-group-companies.md)
- [Duplicate Product Group](https://help.mimeeq.com/api/product-groups/duplicate-product-group.md)
- [Product Categories](https://help.mimeeq.com/api/product-categories.md)
- [List Product Categories](https://help.mimeeq.com/api/product-categories/list-product-categories.md)
- [Create Product Category](https://help.mimeeq.com/api/product-categories/create-product-category.md)
- [Get Product Category](https://help.mimeeq.com/api/product-categories/get-product-category.md)
- [Update Product Category](https://help.mimeeq.com/api/product-categories/update-product-category.md)
- [Add Product Category Products](https://help.mimeeq.com/api/product-categories/add-product-category-products.md)
- [Update Product Category Products](https://help.mimeeq.com/api/product-categories/update-product-category-products.md)
- [Remove Product Category Products](https://help.mimeeq.com/api/product-categories/remove-product-category-products.md)
- [Products](https://help.mimeeq.com/api/products.md)
- [List Products](https://help.mimeeq.com/api/products/list-products.md)
- [List Related Products](https://help.mimeeq.com/api/products/list-related-products.md)
- [Get Product](https://help.mimeeq.com/api/products/get-product.md)
- [Files](https://help.mimeeq.com/api/files.md)
- [List Files](https://help.mimeeq.com/api/files/list-files.md)
- [Create Directory](https://help.mimeeq.com/api/files/create-directory.md)
- [Delete File](https://help.mimeeq.com/api/files/delete-file.md)
- [Rename File or Directory](https://help.mimeeq.com/api/files/rename-file-or-directory.md)
- [Move Files or Directories](https://help.mimeeq.com/api/files/move-files-or-directories.md)
- [Copy Files or Directories](https://help.mimeeq.com/api/files/copy-files-or-directories.md)
- [Download PoD Assets](https://help.mimeeq.com/api/files/download-pod-assets.md)
- [Upload File](https://help.mimeeq.com/api/files/upload-file.md)
- [Download Files as ZIP](https://help.mimeeq.com/api/files/download-files-as-zip.md)
- [Search Files](https://help.mimeeq.com/api/files/search-files.md)
- [Get File Details](https://help.mimeeq.com/api/files/get-file-details.md)
- [Quotations](https://help.mimeeq.com/api/quotations.md)
- [List Quotations](https://help.mimeeq.com/api/quotations/list-quotations.md)
- [List Quotation Owners](https://help.mimeeq.com/api/quotations/list-quotation-owners.md)
- [List Quotation Settings](https://help.mimeeq.com/api/quotations/list-quotation-settings.md)
- [Get Quotation](https://help.mimeeq.com/api/quotations/get-quotation.md)
- [Set Quotation Status](https://help.mimeeq.com/api/quotations/set-quotation-status.md)
- [Set Quotation Stage](https://help.mimeeq.com/api/quotations/set-quotation-stage.md)
- [List Quotation Versions](https://help.mimeeq.com/api/quotations/list-quotation-versions.md)
- [Get Quotation Version](https://help.mimeeq.com/api/quotations/get-quotation-version.md)
- [List Quotation Notes](https://help.mimeeq.com/api/quotations/list-quotation-notes.md)
- [Models](https://help.mimeeq.com/api/models.md)

## Changelog

- [Changelog](https://help.mimeeq.com/changelog/overview.md): Follow new features, improvements and fixes across the Mimeeq app, its ecommerce integrations and the public API.
- [2026](https://help.mimeeq.com/changelog/mimeeq-app/2026.md): New features, improvements and fixes in the Mimeeq app in 2026.
- [2025](https://help.mimeeq.com/changelog/mimeeq-app/2025.md): New features, improvements and fixes in the Mimeeq app in 2025.
- [2024 and earlier](https://help.mimeeq.com/changelog/mimeeq-app/2024-and-earlier.md): Earlier Mimeeq app releases, from November 2022 to February 2024.
- [2026](https://help.mimeeq.com/changelog/shopify/2026.md): New features, improvements and fixes in the Mimeeq Shopify plugin in 2026.
- [2025](https://help.mimeeq.com/changelog/shopify/2025.md): New features, improvements and fixes in the Mimeeq Shopify plugin in 2025.
- [2024 and earlier](https://help.mimeeq.com/changelog/shopify/2024-and-earlier.md): Earlier releases of the Mimeeq Shopify plugin, from version 2.0 to 3.3.
- [2026](https://help.mimeeq.com/changelog/woocommerce/2026.md): New features, improvements and fixes in the Mimeeq WooCommerce plugin in 2026.
- [2026](https://help.mimeeq.com/changelog/api/2026.md): New features, improvements and fixes in the Mimeeq public API in 2026.


---

# 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
This site has an agentic ask interface you may use to query the documentation dynamically 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/index.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.
