Skip to main content

Interface: FinishEventPayload

Properties​

action​

action: "addToCart" | "select"

Type of action. Can be addToCart or select.

code​

code: string

Unique product code.

collectionId?​

optional collectionId: string

ID of shop collection to be used while adding product to cart.

configurationCode?​

optional configurationCode: string

Current configuration code.

customerId​

customerId: string

Current customer id.

Deprecated​

elements?​

optional elements: FinishModularElement[]

List of elements on modular

embedInstanceId?​

optional embedInstanceId: string

Unique ID of embed instance from which event was triggered

embedShortCode​

embedShortCode: string

Product embed short code. Can be used to display product once more.

image?​

optional image: string

Base64 image. In basket variant it will be jpeg file with width of 1000px. Otherwise, 1200px wide png. Only on 3d.

incrementalQty​

incrementalQty: number

Incremental quantity. It defines step for quantity selector

isModular?​

optional isModular: boolean

If true, product is modular.

mqq​

mqq: number

Minimum quantity product can be ordered with

productId​

productId: string

Id of the product.

productName​

productName: string

Product name in current language.

publicPriceListGroups?​

optional publicPriceListGroups: string

Public price list group ID. If provided this price list was used for getting prices for products

qty​

qty: number

Selected qty.

selectedOptions?​

optional selectedOptions: Record<string, string>

Map of selected options per each block in current language. Hidden options are filtered out. For full list of options or list of images refer to selectedOptionsList key.

selectedOptionsList?​

optional selectedOptionsList: SelectedOptionSimple[]

List of all selected options. It contains full list of selected options without any filtering.

shortCode​

shortCode: string

Scene short code. Returned only if modular product.

Since version 6.7.0 it's returned for all products. In case of modular product it's still scene short code. For other products it's current configuration short code. Please use this value instead of calling getShortcode method.

sku?​

optional sku: string

Selected configuration SKU. Do not apply to modular product.

variantCode​

variantCode: string

Actually selected variant code.

viewId?​

optional viewId: string

Selected view id. Only 2d.