Skip to main content

Interface: ArGenerationResult

Represents the outcome of an AR model generation process.

This interface encapsulates the results of converting product configuration data into AR-ready 3D models. It includes file paths to the generated models and status information about the conversion process. This data is crucial for applications to determine whether AR visualization is available and how to access the required model files.

Successful AR generation enables businesses to offer immersive product experiences that can increase customer engagement, reduce purchase uncertainty, and decrease return rates.

Properties​

conversionStatus​

conversionStatus: "FAILED" | "COMPLETED"

Status of the model conversion process.

  • 'COMPLETED': Conversion was successful, and AR models are ready for use.
  • 'FAILED': Conversion encountered an error and could not be completed.

Applications should check this status before attempting to use the AR models and provide appropriate messaging to users based on whether AR is available.

glbPath​

glbPath: string

Relative path to the generated GLB model file.

This path points to the optimized GLB (GL Binary) 3D model that's ready for AR viewing on Android devices and WebAR implementations. The path is typically relative to a base CDN or storage URL configured in the application.

Systems should verify that this file exists before offering AR functionality to Android users or WebAR experiences.

shortCode​

shortCode: string

Unique shortcode identifier for this AR visualization.

This code can be used in URLs, QR codes, and API calls to directly access this specific AR experience. It serves as the primary reference for this particular AR model set across the system.

The shortcode enables sharing and accessing AR experiences without requiring users to reconfigure products each time.

usdzPath​

usdzPath: string

Relative path to the generated USDZ model file.

This path points to the optimized USDZ file that's ready for AR viewing on iOS devices. USDZ is Apple's AR file format used in ARKit applications and iOS Quick Look.

Systems should verify that this file exists before offering AR functionality to iOS users. On iOS, this file is typically opened directly by the operating system's AR viewer.