Skip to main content

Interface: MountARPagePayload

Configuration for mounting an Augmented Reality (AR) landing page.

This interface extends the core embed configuration with properties specific to AR experiences. It controls how 3D models are presented in AR, providing settings for model identification, scaling, and device compatibility handling.

AR experiences allow users to visualize products in their real-world environment using compatible mobile devices, enhancing the shopping experience by showing true-to-scale representations of products in context.

Extends​

Properties​

allowScaling?​

optional allowScaling: boolean

Enables model scaling in AR.

When true, users can resize the 3D model in their AR experience. This allows for flexible placement in different environments. When false, models appear at their actual physical scale.

appUrl?​

optional appUrl: string

Base URL for the application.

Used to provide a return path when exiting the AR experience. This should be the URL to the main application hosting the embed.

arShortCode?​

optional arShortCode: string

AR shortcode that identifies the 3D model to load.

This code is specific to AR experiences and links to the properly optimized 3D model files (USDZ for iOS, GLB for Android) that represent the configured product. AR shortcodes are generated when a product configuration is prepared for AR viewing.

baseURL?​

optional baseURL: string

Base URL for API requests.

This specifies the endpoint for all API communications from the embed. If not provided, the system will use the default API URL from the embed environment.

Inherited from​

EmbedPayloadPartial.baseURL

CDNPath?​

optional CDNPath: string

Path to the CDN for static assets.

This URL is used to load images, 3D models, and other static resources required by the configurator. If not provided, the system will use the default CDN path from the embed environment.

Inherited from​

EmbedPayloadPartial.CDNPath

customerId​

customerId: string

Identifier for the customer account.

This specifies which customer's products and configurations will be available in the embed. Each customer has their own isolated data and settings.

Inherited from​

EmbedPayloadPartial.customerId

elementId?​

optional elementId: string

Deprecated​

Use uid with data-mimeeq-short-code attributes instead ID of HTML element in which to mount the embed

Inherited from​

EmbedPayloadPartial.elementId

incompatible?​

optional incompatible: boolean

Indicates whether to show the incompatible device view.

When true, displays a message informing users that their device doesn't support AR functionality. This is useful for graceful degradation on unsupported browsers or devices.

locale​

locale: string

Language code for the embed UI.

This sets the language used throughout the interface, including labels, button text, and error messages. Uses standard language codes like 'en', 'fr', 'de'.

Inherited from​

EmbedPayloadPartial.locale

onEventDispatch?​

optional onEventDispatch: EventDispatchCallback<any>

Callback function for handling events from the embed.

This function is called whenever a significant event occurs within the configurator, such as option selection, configuration changes, or user actions. It allows the hosting application to respond to these events.

Inherited from​

EmbedPayloadPartial.onEventDispatch

renderOnMount​

renderOnMount: boolean

Controls whether the embed renders immediately.

When true, the AR interface will render as soon as it's mounted. When false, rendering must be triggered manually via the API.

uid​

uid: string

Unique identifier for this embed instance.

This ID is used to identify a specific embed configuration and is typically the shortcode for the embed. The system will mount the embed into an HTML element with a data-mimeeq-shortcode attribute matching this value.

Each embed on a page should have a unique UID to prevent conflicts.

Inherited from​

EmbedPayloadPartial.uid

withModal?​

optional withModal: boolean

Displays the AR experience in a modal overlay.

When true, the AR interface appears in a modal dialog rather than inline on the page. This creates a focused experience that temporarily overlays the main content.

withWatcher?​

optional withWatcher: boolean

Enables sandbox logic for development and testing.

When true, the embed runs in a sandboxed mode with additional monitoring and development features. This should generally be false in production.

Inherited from​

EmbedPayloadPartial.withWatcher