Skip to main content

Interface: BasketSettings

Configuration for the shopping basket functionality.

This interface controls how the shopping basket behaves within the configurator, defining paths, button placements, and integration settings for e-commerce systems. These settings determine how configured products can be added to carts and how users interact with the basket.

A well-configured basket creates a seamless path from product configuration to purchase, enhancing conversion rates and user satisfaction.

Properties​

basketForLoggedInOnly?​

optional basketForLoggedInOnly: boolean

Restricts basket functionality to authenticated users only.

When true, the basket functionality is only available to users who are logged in. Anonymous users will not see the basket interface or add-to-cart options. This is useful for B2B scenarios or when purchases require an account.

Default: false

cart?​

optional cart: boolean

Enables the Mimeeq Basket interface.

When true, the Mimeeq Basket provides a built-in shopping cart UI component that tracks configured products for purchase. When false, 'Add to cart' events are dispatched to be handled by an external cart system.

Default: false

cartAtFinish?​

optional cartAtFinish: boolean

Displays an 'Add to cart' button instead of a 'Finish' button.

When true, the primary action button for standard products is labeled "Add to Cart" rather than "Finish". This emphasizes the e-commerce functionality and clarifies the action's purpose.

Default: false

cartAtFinishModular?​

optional cartAtFinishModular: boolean

Displays an 'Add to cart' button instead of a 'Finish' button for modular products.

When true, the primary action button for modular products is labeled "Add to Cart" rather than "Finish". This provides consistent terminology across both standard and modular products.

Default: false

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.

This is particularly useful for integration with e-commerce platforms that organize products into collections or categories.

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 across different embeds of the same product

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. It should typically point to a product catalog or category page.

Example: "/products" or "/catalog"

isBasket​

isBasket: boolean

Enables basket mode for the configurator.

When true, the configurator operates in basket mode, where configuration actions are oriented toward adding items to a shopping cart rather than just exploring configurations.

Default: false

priceListGroup?​

optional priceListGroup: string

Name of the Public Price List Group to use for pricing.

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

This allows for different pricing scenarios across different embeds of the same product, such as sale prices vs. regular prices.

useCustomPricing?​

optional useCustomPricing: boolean

Enables custom pricing logic instead of Mimeeq's pricing system.

When true, the configurator will not fetch prices from Mimeeq's pricing engine and will instead expect prices to be provided via the API. This allows for integration with external pricing systems or custom pricing logic.

Default: false

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. It should typically point to a cart or checkout page in your e-commerce system.

Example: "/cart" or "/checkout"