Skip to main content

Interface: InterfaceBasketConfig

Configuration settings for the basket/cart functionality.

This interface defines how the shopping basket behaves within the configurator, controlling which cart-related features are enabled, paths for navigation actions, and integration settings for e-commerce platforms. These settings determine how configured products can be added to carts and how users interact with the basket.

Properties​

cart?​

optional cart: boolean

When true, displays the Mimeeq Basket interface.

The Mimeeq Basket provides a built-in shopping cart UI component that tracks configured products for purchase.

cartAtFinish?​

optional cartAtFinish: boolean

When true, displays an 'Add to cart' button instead of a 'Finish' button.

This changes the primary action button for standard products to emphasize the cart functionality rather than just completing the configuration.

cartAtFinishModular?​

optional cartAtFinishModular: boolean

When true, displays an 'Add to cart' button instead of a 'Finish' button for modular products.

Similar to cartAtFinish, but specifically for modular products which may have different finishing workflows.

collectionId?​

optional collectionId: string

ID of the collection to use when adding products to the cart.

This ID is returned as part of the 'Add to cart' event and can be used by external systems to identify which collection or category should receive the configured product.

embedTemplateId?​

optional embedTemplateId: string

ID of the currently active embed template.

The embed template ID serves several important purposes:

  1. It tracks which configuration of the configurator is being used
  2. It determines which price list group should be used for calculating prices, as embed templates can have specific public price groups assigned to them
  3. It enables different pricing scenarios (e.g., sale vs. rental prices) across different embeds of the same product

This allows for template-specific pricing strategies where the same product can have different pricing models in different contexts.

exploreProductsLocation?​

optional exploreProductsLocation: string

Path to redirect users after clicking the 'Explore' button in Mimeeq Basket.

This URL defines where users should go when they want to continue shopping or exploring products from the basket interface.

isBasket?​

optional isBasket: boolean

When true, the configurator operates in basket mode.

In basket mode, configuration actions are oriented toward adding items to a shopping cart rather than just exploring configurations.

priceListGroup?​

optional priceListGroup: string

Name of the Public Price List Group to use when retrieving public prices.

This setting determines which price list should be used for calculating prices for public/guest users who don't have customer-specific pricing.

viewBasketOnlineLocation?​

optional viewBasketOnlineLocation: string

Path to redirect users after clicking the 'View Online' button in Mimeeq Basket.

This URL defines where users should go when they want to view their basket in an online shopping interface or proceed to checkout.