Skip to main content

Interface: ARShortcodeData

Represents complete metadata and resource information for an Augmented Reality experience.

This interface defines the comprehensive data structure for AR experiences in the product configurator, including file paths to 3D models, metadata about the product being visualized, and status information about model conversion. It serves as the central data model supporting AR functionality across mobile devices (iOS and Android).

ARShortcodeData enables seamless product visualization in real-world environments, allowing customers to better understand product dimensions, appearance, and fit within their spaces, which can significantly increase purchase confidence and reduce returns.

Properties​

conversionStatus?​

optional conversionStatus: "FAILED" | "COMPLETED"

Current status of the model conversion process.

  • 'COMPLETED': The conversion process has finished successfully, and AR models are ready.
  • 'FAILED': The conversion process encountered an error and could not complete.

This status helps applications determine whether AR functionality can be offered and what messaging to show users about AR availability.

createdDate​

createdDate: number

Timestamp indicating when this AR data was initially created.

This timestamp helps track the creation history of AR assets and can be used for caching policies and determining if assets need refreshing.

Format: Unix timestamp in milliseconds.

glbPath?​

optional glbPath: string

Relative path to the GLB model file for this AR experience.

GLB (GL Binary) is a binary file format for 3D models used with WebGL and AR implementations on Android devices. This path points to the optimized GLB file that has been specifically prepared for AR viewing.

This property may be undefined if the conversion process is still in progress or if it failed to complete successfully.

glbSize?​

optional glbSize: number

Size of the GLB file in bytes.

This information helps client applications prepare appropriate loading indicators, estimate download times, and manage bandwidth usage. It's particularly important for mobile devices where data usage may be limited.

isModular​

isModular: boolean

Indicates whether this product has a modular structure.

When true, this product consists of multiple configurable components that can be arranged in different ways. Modular products require special handling in AR to ensure that all components maintain their correct spatial relationships.

Modular AR experiences typically have larger file sizes and more complex rendering requirements than standard products.

lastModifiedDate​

lastModifiedDate: number

Timestamp indicating when this AR data was last updated.

Used to track when changes were made to the AR experience, which is critical for ensuring that users see the most current version of product visualizations.

Format: Unix timestamp in milliseconds.

modularShortCode?​

optional modularShortCode: string

Scene shortcode reference for modular products.

For modular products, this identifies the specific scene arrangement that was used to generate the AR models. This ensures that complex arrangements of components are preserved accurately in the AR experience.

modularVariantCode?​

optional modularVariantCode: string

Variant code for modular configurations.

For modular products, this identifies the specific modular variant that was used when generating AR models. This may differ from the main variantCode when dealing with complex modular configurations.

name​

name: string | Translatable<string>

Product name with optional multi-language support.

This displays as the title of the AR experience in user interfaces and helps users identify which product they're viewing. For internationalized applications, this may be a translatable object with language codes as keys.

productId​

productId: string

Unique identifier for the product this AR experience represents.

This ID connects the AR experience to its corresponding product in the catalog, enabling systems to retrieve additional product information, pricing, and availability details when needed.

s3Path​

s3Path: string

Relative path to the thumbnail image for this AR experience.

This image is displayed in AR viewers, product listings, and sharing interfaces to provide a preview of what the AR experience will show. A high-quality thumbnail increases the likelihood of users engaging with the AR functionality.

shortCode​

shortCode: string

Unique code that identifies this specific AR visualization.

This code can be used in URLs, QR codes, and API calls to directly access this specific AR experience without needing to reconfigure the product. It's the primary identifier used in AR-related operations.

url​

url: string

Full URL to the page from which this AR shortcode was generated.

This URL allows users to return to the product configuration page after viewing it in AR, enabling a seamless transition between configuration and visualization experiences. It also supports analytics tracking of AR usage.

usdzPath?​

optional usdzPath: string

Relative path to the USDZ model file for this AR experience.

USDZ is Apple's AR file format used on iOS devices. This path points to the optimized USDZ file that has been specifically prepared for AR viewing on iPhones and iPads. The property may be undefined if the conversion process is still in progress.

usdzSize​

usdzSize: number

Size of the USDZ file in bytes.

Similar to glbSize, this helps iOS applications manage the user experience around downloading and displaying AR content. Providing accurate file size information allows for better progress indicators and data management.

variantCode​

variantCode: string

Specific product variant code for which this AR model was generated.

For configurable products, this identifies exactly which configuration is represented in the AR models. This ensures that what customers see in AR matches precisely what they've configured on the website.