@plentymarkets/shop-api / productGetters

Variable: productGetters

const productGetters: object

Type declaration

canBeAddedToCartFromCategoryPage()

canBeAddedToCartFromCategoryPage: (product) => boolean

Parameters

• product: Product

Returns

boolean

getAgenciesAvailabilityCLass()

getAgenciesAvailabilityCLass: (product) => string

Parameters

• product: Product

Returns

string

getAttributes()

getAttributes: (products) => ProductAttributeValue[][][]

Parameters

• products: Product[]

Returns

ProductAttributeValue[][][]

getAvailabilityAverageDays()

getAvailabilityAverageDays: (product) => number

Parameters

• product: Product

Returns

number

getAvailabilityBackgroundColor()

getAvailabilityBackgroundColor: (product) => string

Parameters

• product: Product

Returns

string

getAvailabilityId()

getAvailabilityId: (product) => number

Parameters

• product: Product

Returns

number

getAvailabilityName()

getAvailabilityName: (product) => string

Parameters

• product: Product

Returns

string

getAvailabilityTextColor()

getAvailabilityTextColor: (product) => string

Parameters

• product: Product

Returns

string

getAverageRating()

getAverageRating: (product, roundOption?) => number

Parameters

• product: Product

• roundOption?: "half" | "tenth"

Returns

number

getCategoryIds()

getCategoryIds: (product) => string[]

Parameters

• product: Product

Returns

string[]

getCategoryUrlPath()

getCategoryUrlPath: (product, categories) => string

Parameters

• product: Product

• categories: CategoryTreeItem[]

Returns

string

getCheapestGraduatedPrice()

getCheapestGraduatedPrice: (product) => number = productPriceGetters.getCheapestGraduatedPrice

Parameters

• product: Product

Returns

number

getCoverImage()

getCoverImage: (product) => string

Parameters

• product: Product

Returns

string

getCoverImagePreview()

getCoverImagePreview: (product) => string

Parameters

• product: Product

Returns

string

getCrossedPrice()

getCrossedPrice: (product) => number = productPriceGetters.getCrossedPrice

Parameters

• product: Product

Returns

number

getDefaultBasePrice()

getDefaultBasePrice: (product) => string = productPriceGetters.getDefaultBasePrice

Parameters

• product: Product

Returns

string

getDefaultBaseSinglePrice()

getDefaultBaseSinglePrice: (product) => number = productPriceGetters.getDefaultBaseSinglePrice

Parameters

• product: Product

Returns

number

getDescription()

getDescription: (product) => string

Parameters

• product: Product

Returns

string

getFirstImage()

getFirstImage: (product) => AgnosticImage

Parameters

• product: Product

Returns

AgnosticImage

getFormattedPrice()

getFormattedPrice: (price) => string = productPriceGetters.getFormattedPrice

Parameters

• price: number

string

Returns

string

number

Deprecated

will be removed in 1.0

getFullImage()

getFullImage: (product) => string

Parameters

• product: Product

Returns

string

getGallery()

getGallery: (product) => ImagesData[] | []

Parameters

• product: Product

Returns

ImagesData[] | []

getGraduatedList()

getGraduatedList: (product) => GraduatedPriceList[] = productPriceGetters.getGraduatedList

Parameters

• product: Product

Returns

GraduatedPriceList[]

getGraduatedPriceByQuantity()

getGraduatedPriceByQuantity: (product, quantity) => Default = productPriceGetters.getGraduatedPriceByQuantity

Parameters

• product: Product

• quantity: number

Returns

Default

getGraduatedPrices()

getGraduatedPrices: (product) => Default[] = productPriceGetters.getGraduatedPrices

Parameters

• product: Product

Returns

Default[]

getHeightMM()

getHeightMM: (product) => number

Parameters

• product: Product

Returns

number

getId()

getId: (product) => string

Parameters

• product: Product

Returns

string

getImageHeight()

getImageHeight: (product) => number

Parameters

• product: Product

Returns

number

getImageWidth()

getImageWidth: (product) => number

Parameters

• product: Product

Returns

number

getItemId()

getItemId: (product) => string

Parameters

• product: Product

Returns

string

getLengthMM()

getLengthMM: (product) => number

Parameters

• product: Product

Returns

number

getLowestPrice()

getLowestPrice: (product) => number = productPriceGetters.getLowestPrice

Parameters

• product: Product

Returns

number

getManufacturer()

getManufacturer: (product) => Manufacturer

Parameters

• product: Product

Returns

Manufacturer

getMaxRating()

getMaxRating: (product) => number

Parameters

• product: Product

Returns

number

getMetaDescription()

getMetaDescription: (product) => string

Parameters

• product: Product

Returns

string

getMetaKeywords()

getMetaKeywords: (product) => string

Parameters

• product: Product

Returns

string

getMiddleImage()

getMiddleImage: (product) => string

Parameters

• product: Product

Returns

string

getMinimumOrderQuantity()

getMinimumOrderQuantity: (product) => number

Parameters

• product: Product

Returns

number

getName()

getName: (product) => string

Parameters

• product: Product

Returns

string

getParentCategoryId()

getParentCategoryId: (product) => number

Parameters

• product: Product

Returns

number

getPreviewImage()

getPreviewImage: (product) => string

Parameters

• product: Product

Returns

string

getPrice()

getPrice: (product) => number = productPriceGetters.getPrice

Parameters

• product: Product

Returns

number

getPropertyById()

getPropertyById: (id, product) => VariationProperty

Parameters

• id: number

• product: Product

Returns

VariationProperty

getPropertyGroupById()

getPropertyGroupById: (id, product) => VariationPropertyGroup

Parameters

• id: number

• product: Product

Returns

VariationPropertyGroup

getPropertyGroups()

getPropertyGroups: (product) => VariationPropertyGroup[]

Parameters

• product: Product

Returns

VariationPropertyGroup[]

getRegularPriceCurrency()

getRegularPriceCurrency: (product) => string = productPriceGetters.getRegularPriceCurrency

Parameters

• product: Product

Returns

string

getSecondPreviewImage()

getSecondPreviewImage: (product) => string

Parameters

• product: Product

Returns

string

getShortDescription()

getShortDescription: (product) => string

Parameters

• product: Product

Returns

string

getSlug()

getSlug: (product) => string

Parameters

• product: Product

Returns

string

getSpecialOffer()

getSpecialOffer: (product) => number = productPriceGetters.getSpecialOffer

Parameters

• product: Product

Returns

number

getSpecialPriceCurrency()

getSpecialPriceCurrency: (product) => string = productPriceGetters.getSpecialPriceCurrency

Parameters

• product: Product

Returns

string

getTechnicalData()

getTechnicalData: (product) => string

Parameters

• product: Product

Returns

string

getTitle()

getTitle: (product) => string

Parameters

• product: Product

Returns

string

getTotalReviews()

getTotalReviews: (product) => number

Parameters

• product: Product

Returns

number

getUnitContent()

getUnitContent: (product) => number

Parameters

• product: Product

Returns

number

getUnitName()

getUnitName: (product) => string

Parameters

• product: Product

Returns

string

getUnits()

getUnits: (products) => Record<number, string>

Parameters

• products: Product[]

Returns

Record<number, string>

getUrlPath()

getUrlPath: (product) => string

Parameters

• product: Product

Returns

string

getVariariationById()

getVariariationById: (product, variationId) => VariationMapProductVariation | null

Parameters

• product: Product

• variationId: number

Returns

VariationMapProductVariation | null

getVariationAvailableUntil()

getVariationAvailableUntil: (product) => unknown

Parameters

• product: Product

Returns

unknown

getVariationId()

getVariationId: (product) => number

Parameters

• product: Product

Returns

number

getVariationIdForAttributes()

getVariationIdForAttributes: (product, selectedAttributId, unitCombinationId) => number

Parameters

• product: Product

• selectedAttributId: string

• unitCombinationId: string

Returns

number

getWeightG()

getWeightG: (product) => number

Parameters

• product: Product

Returns

number

getWidthMM()

getWidthMM: (product) => number

Parameters

• product: Product

Returns

number

isSalable()

isSalable: (product) => boolean

Parameters

• product: Product

Returns

boolean

showPricePerUnit()

showPricePerUnit: (product) => boolean = productPriceGetters.showPricePerUnit

Parameters

• product: Product

Returns

boolean

Defined in

getters/productGetters.ts:383