Skip to main content
API docs by Redocly

Mimeeq API (1.0.0)

E-mail: [email protected] License: Apache 2.0

The Mimeeq REST API provides programmatic access to product configuration data, pricing, and metadata from the Mimeeq 3D product configurator platform. Use it to integrate configured product information into your ecommerce systems, order management workflows, or custom applications.

Find out more about Mimeeq Configurator

What you can do

  • Retrieve product configuration details — get the full configuration breakdown (selected options, BOM, SKU) for any configured product using its short code
  • Calculate prices — fetch real-time pricing for a configuration based on your price lists, customer accounts, or embed templates
  • List products — get a catalog of all products available to your API key, including metadata like status, type, and preview images
  • Generate short codes — create persistent short codes for specific product configurations, useful for sharing or storing configurations

Authorization

All endpoints require an API key passed in the X-API-KEY header. You can generate API keys from the Mimeeq admin panel. See the Authorization Guide for setup instructions.

Short Codes

Several endpoints use short codes to identify product configurations. Mimeeq generates different types of short codes depending on the context — configuration short codes, scene short codes (for modular products), and embed short codes. The API accepts configuration short codes and scene short codes. See Short Codes for details on the different types and how to obtain them.

Product Modes

Mimeeq supports three product modes, and the API response structure varies accordingly. See Product Types for a detailed overview.

  • Standard (VARIANT) — a single product with configurable options. Returns configuration, BOM, and optional bundle settings.
  • Modular (MODULAR) — a composed scene of multiple products snapped or placed together. Returns a list of components, each with their own configuration. Pricing returns per-component breakdowns.
  • Component (COMPONENT) — a building block used within modular products. Appears in product listings but doesn't have its own embed short code.

Error Handling

The API uses standard HTTP status codes. Error responses include a JSON body with message, code, and payload fields. Common errors:

  • 401 — Invalid or missing API key
  • 400 — Validation error (missing or malformed parameters). The payload array contains field-level details.
  • 500 — Unexpected server error

Pricing endpoints may return 200 with zeroed prices and an errors array when required pricing parameters are missing. This is intentional — always check for the presence of errors in the response.

Rate Limits

The API enforces a default rate limit of 10,000 requests per second with a burst capacity of 5,000 concurrent requests. If you exceed these limits, the API returns 429 Too Many Requests.

Product

Endpoints for retrieving product information, pricing, and generating short codes

Get product price by short code

Returns calculated pricing for a product configuration identified by its short code. The response structure depends on the product mode:

  • Standard/hybrid products return a ProductPriceStandardResponse with total price, quantity break levels, item masters, and optional per-group breakdowns
  • Modular products return a ProductPriceModularResponse with per-component pricing

Pricing source (required): You must provide exactly one of publicListGroup, priceListIds, companyId, or templateId to specify which price data to use. These parameters are mutually exclusive — to compare prices across different sources, make separate requests.

Partial results: If required pricing parameters are missing, the endpoint returns 200 with zeroed prices and an errors array explaining what's missing. This is intentional for backward compatibility — always check for the errors field. If all parameters are provided the following priority is applied:

  1. companyId
  2. priceListIds
  3. priceListGroup
  4. templateId
  5. lang

Custom pricing: If you use your own pricing system instead of Mimeeq's built-in pricing, see Custom Pricing Integration for the client-side approach using mimeeqApp.utils.setPrice().

Authorizations:
ApiKeyAuth
query Parameters
shortCode
required
string

Configuration short code (for standard/hybrid products) or scene short code (for modular products). Embed short codes are not accepted — see Short Codes for the distinction.

quantity
number

Number of units to calculate pricing for. Affects total price and may trigger quantity break pricing levels.

lang
string

Language code for localized content. Falls back to the customer's default language if not provided.

priceListGroup
string

ID of a Public Price List Group to use for pricing. The system returns the cheapest price across all price lists in the group.

priceListIds
string

Comma-separated list of specific Price List IDs to use. The system returns the cheapest price across the provided lists.

companyId
string

Company ID to calculate pricing for. Uses all price lists assigned to the company and returns the cheapest result.

templateId
string

Embed Template ID. Uses the Public Price List Group assigned to the template for pricing. See Embed Templates for how templates control pricing and display settings.

priceType
string
Enum: "RRP" "SALE" "COST"

Price type to return. Required when using companyId or priceListIds. Determines which price tier is returned (cost, retail, or sale price).

vatType
string
Enum: "INCL_VAT" "EXCL_VAT"

Whether returned prices should include or exclude VAT. Falls back to the default setting from the customer's public price list if not provided.

Responses

get/get-product-price-info
Request samples
curl --request GET \
  --url 'https://mimeeqapi.com/get-product-price-info?shortCode=SOME_STRING_VALUE&quantity=SOME_NUMBER_VALUE&lang=SOME_STRING_VALUE&priceListGroup=SOME_STRING_VALUE&priceListIds=SOME_STRING_VALUE&companyId=SOME_STRING_VALUE&templateId=SOME_STRING_VALUE&priceType=SOME_STRING_VALUE&vatType=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'
Response samples
application/json
Example
{
  • "price": 310,
  • "unitPrice": 310,
  • "currency": "EUR",
  • "deliveryTime": 0,
  • "totalWeight": 0,
  • "unitWeight": 0,
  • "weightUnit": "kg",
  • "vatType": "INCL_VAT",
  • "levels": [
    ],
  • "itemMasters": [
    ],
  • "pricesPerGroup": [
    ],
  • "errors": [
    ],
  • "components": [
    ]
}

Find product info by short code

Returns the full configuration details for a product identified by its short code. This includes selected options across all configuration blocks, the Bill of Materials, SKU, and commerce bundle settings.

The response structure varies by product mode:

  • Standard (VARIANT) — returns configuration options, BOM, SKU, and optional bundle settings at the top level
  • Modular (MODULAR) — returns a components array where each entry is a fully configured product with its own options, SKU, short code, and placement type

Use this endpoint to retrieve what the user configured — option selections, generated codes, and manufacturing data. For pricing, use /get-product-price-info instead.

This endpoint returns the same configuration data available in the mimeeq-add-to-cart event payload, but accessible server-side via short code. Useful for order confirmation pages, backend validation, or systems that need to reconstruct configuration details after the browser session ends.

Authorizations:
ApiKeyAuth
query Parameters
shortCode
required
string

Configuration short code (for standard/hybrid products) or scene short code (for modular products). Embed short codes are not accepted — see Short Codes for the distinction.

quantity
number
Deprecated

Quantity parameter. Deprecated — quantity no longer affects the product info response. Use /get-product-price-info for quantity-dependent pricing.

lang
string

Language code for localized content (product names, option names). Falls back to the customer's default language if not provided.

Responses

get/get-product-info
Request samples
curl --request GET \
  --url 'https://mimeeqapi.com/get-product-info?shortCode=SOME_STRING_VALUE&quantity=SOME_NUMBER_VALUE&lang=SOME_STRING_VALUE' \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'
Response samples
application/json
{
  • "name": "l'atelier by paper republic",
  • "code": "L_ATELIER_PAPER_REPUBLIC",
  • "description": "string",
  • "configuration": [
    ],
  • "defaultImage": "https://cdn.mimeeq.com/c_td6/3d35489f-f277-4c56-9fc6-89d7d4d2f604.png",
  • "SKU": "",
  • "bom": [
    ],
  • "bundleSettings": {
    },
  • "status": "ACTIVE",
  • "mode": "MODULAR",
  • "embedShortCode": "TZE4OX",
  • "deliveryInfo": "string",
  • "components": [
    ],
  • "modularBundleSettings": {
    }
}

Get the list of products

Returns a list of all products accessible to the authenticated API key. This includes both owned products and products shared from other customers. Use this for building product catalogs, galleries, or admin interfaces.

The response includes summary metadata for each product — names, images, status, mode, and identifiers — but not full configuration details. To get the detailed configuration of a specific product, use /get-product-info with the product's embed short code or a configuration short code.

Products with mode COMPONENT are building blocks for modular scenes and won't have an embedShortCode.

Authorizations:
ApiKeyAuth

Responses

get/get-products-general-info
Request samples
curl --request GET \
  --url https://mimeeqapi.com/get-products-general-info \
  --header 'X-API-KEY: REPLACE_KEY_VALUE'
Response samples
application/json
[
  • {
    }
]

Generate a short code for a product configuration

Generates a unique, persistent short code for a specific product configuration. This is the server-side equivalent of the getShortcode Web API utility — use this endpoint when you need to generate short codes outside the browser context (e.g., from a backend service).

The short code can be used with /get-product-info and /get-product-price-info to retrieve configuration details and pricing, or to reconstruct the configuration in the embedded configurator.

This is useful for saving configurations to external systems (e.g., cart items, wishlists, order records) where you need a compact identifier that can reload the exact configuration later.

Authorizations:
ApiKeyAuth
Request Body schema: application/json
required
productId
required
string

The product ID to generate a short code for (e.g., PROD-cea07359-5a49-4c8c-9557-9a091aeff8b1)

configurationCode
required
string

The full configuration code string encoding all selected options (e.g., SeatFinishes-a3&LegFinishes-a2)

Responses

post/generate-product-short-code
Request samples
application/json
{
  • "productId": "PROD-cea07359-5a49-4c8c-9557-9a091aeff8b1",
  • "configurationCode": "SeatFinishes-a3&LegFinishes-a2"
}
Response samples
application/json
{
  • "shortCode": "2W1PQZ"
}