Skip to main content

Interface: ARShortcodeData

Represents data related to an Augmented Reality (AR) Shortcode. This interface defines the structure of AR data associated with a product shortcode, including information about model paths, product details, and file sizes.

Properties​

completeSubscription?​

optional completeSubscription: Promise<null | ArGenerationResult>

Subscription for ar model generation completion

conversionStatus?​

optional conversionStatus: "FAILED" | "COMPLETED"

createdDate​

createdDate: number

Timestamp indicating the creation date of the AR data

glbPath?​

optional glbPath: string

Relative path to GLB model file

glbSize?​

optional glbSize: number

Size of glb file

isModular​

isModular: boolean

If true, product is modular

lastModifiedDate​

lastModifiedDate: number

Timestamp indicating the last modification date of the AR data.

modularShortCode?​

optional modularShortCode: string

Scene shortcode for which model were generated if modular

modularVariantCode?​

optional modularVariantCode: string

Variant code for which modular model were generated

name​

name: string | Translatable<string>

Product name object (or string) with translations

productId​

productId: string

Product ID

s3Path​

s3Path: string

Relative path to shortcode thumbnail

shortCode​

shortCode: string

AR short code

url​

url: string

Full URL to page from which shortcode was generated

usdzPath?​

optional usdzPath: string

Relative path to USDZ model file

usdzSize​

usdzSize: number

Size of usdz file

variantCode​

variantCode: string

Variant code for which model were generated