IkasProduct

idstring

namestring

typeIkasProductType

Type of the product. Refer to the IkasProductType reference.

descriptionstring

shortDescriptionstring

metaDataIkasHTMLMetaData | null

Meta data info of the product. Refer to the IkasHTMLMetaData reference for more info.

brandIkasBrand | null

Brand of the product. Refer to the IkasBrand reference for more info.

categoriesIkasCategory[]

Categories of the product. Refer to the IkasCategory reference for more info.

tagsIkasTag[]

Tags of the product. Refer to the IkasProductTag reference for more info.

variantsIkasProductVariant[]

Variants of the product. Refer to the IkasProductVariant reference for more info.

variantTypesIkasProductVariantType[]

Variant types of the product. Refer to the IkasProductVariantType reference for more info.

attributesIkasProductAttributeValue[]

Attributes of the product. Refer to the IkasProductAttributeValue reference for more info.

productOptionSetIdstring | null

baseUnitIkasProductBaseUnit | null

Refer to the IkasProductBaseUnit reference for more info.

productOptionSetIkasProductOptionSet | null

Refer to the IkasProductOptionSet reference for more info.

campaignsIkasProductCampaign[] | null

Refer to the IkasProductCampaign reference for more info.

selectedVariantValuesIkasVariantValue[]

Refer to the IkasVariantValue reference for more info.

hasVariantboolean

hasStockboolean

hasValidProductOptionValuesboolean

hrefstring

productHrefstring

mainVariantTypeIkasVariantType | undefined

Refer to the IkasVariantType reference for more info.

mainVariantValueIkasVariantValue | undefined

Refer to the IkasVariantValue reference for more info.

selectedVariantIkasProductVariant

Refer to the IkasProductVariant reference for more info.

displayedVariantTypesIkasDisplayedVariantType[]

Refer to the IkasDisplayedVariantType reference for more info.

isCustomerReviewEnabledboolean

isCustomerReviewLoginRequiredboolean

isAddToCartEnabledboolean

groupedAttributeValuesIkasProductAttributeMap[]

Refer to the IkasProductAttributeMap reference for more info.

selectedVariantUnitPriceTextstring | undefined

selectVariantValuefunction

function selectVariantValue(variantValue: IkasVariantValue): void

variantValue

:

IkasVariantValue

getVariantUnitPriceTextfunction

Returns a unit price string that can be directly displayed on your theme.

function getVariantUnitPriceText(variant: IkasProductVariant): void

variant

:

IkasProductVariant

getCampaignsfunction

Returns campaigns for the product.

async function getCampaigns(): Promise<IkasProductCampaign[] | undefined>

getCustomerReviewsfunction

Returns customer reviews for the product.

async function getCustomerReviews(params?: { limit?: number; page?: number }): Promise<IkasCustomerReviewList>

params

:

{ limit?: number; page?: number }

getProductOptionSetfunction

Get product option set for the product. Products of an IkasProductList initally have their productOptionSet value set to null. Specific IkasProduct instances of product pages on the other hand, already have their productOptionSet value set. You should only use this function for product list items and other non-specific product instances.

async function getProductOptionSet(): Promise<boolean>