PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / productPropertyGetters

Variable: productPropertyGetters ​

const productPropertyGetters: object

Defined in: getters/productPropertyGetters.ts:363

Type Declaration ​

getGroup ​

getGroup: (id, propertyGroups) => VariationPropertyGroup | null

Parameters ​

id ​

number

propertyGroups ​

VariationPropertyGroup[]

Returns ​

VariationPropertyGroup | null

getGroupDescription ​

getGroupDescription: (propertyGroup) => string

Parameters ​

propertyGroup ​

VariationPropertyGroup

Returns ​

string

getGroupId ​

getGroupId: (propertyGroup) => number

Parameters ​

propertyGroup ​

VariationProperty

Returns ​

number

getGroupName ​

getGroupName: (propertyGroup) => string

Parameters ​

propertyGroup ​

VariationPropertyGroup

Returns ​

string

getOrderPropertiesGroups ​

getOrderPropertiesGroups: (product) => OrderPropertiesGroups

Parameters ​

product ​

Product

Returns ​

OrderPropertiesGroups

getOrderPropertyDescription ​

getOrderPropertyDescription: (property) => string

Parameters ​

property ​

ProductProperty

Returns ​

string

getOrderPropertyGroupDescription ​

getOrderPropertyGroupDescription: (propertyGroup) => string

Parameters ​

propertyGroup ​

OrderPropertiesGroup

Returns ​

string

getOrderPropertyGroupName ​

getOrderPropertyGroupName: (propertyGroup) => string

Parameters ​

propertyGroup ​

OrderPropertiesGroup

Returns ​

string

getOrderPropertyId ​

getOrderPropertyId: (property) => number

Parameters ​

property ​

ProductProperty

Returns ​

number

getOrderPropertyLabel ​

getOrderPropertyLabel: (property) => OrderPropertyLabel

Parameters ​

property ​

ProductProperty

Returns ​

OrderPropertyLabel

getOrderPropertyName ​

getOrderPropertyName: (property) => string

Parameters ​

property ​

ProductProperty

Returns ​

string

getOrderPropertySurcharge ​

getOrderPropertySurcharge: (property) => number

Parameters ​

property ​

ProductProperty

Returns ​

number

getOrderPropertyValueType ​

getOrderPropertyValueType: (property) => string

Parameters ​

property ​

ProductProperty

Returns ​

string

getProductProperty ​

getProductProperty: (id, productProperties) => ProductProperty | null

Parameters ​

id ​

number

productProperties ​

ProductProperty[]

Returns ​

ProductProperty | null

getProperties ​

getProperties: (propertyGroup) => VariationProperty[]

Parameters ​

propertyGroup ​

VariationPropertyGroup

Returns ​

VariationProperty[]

getProperty ​

getProperty: (id, propertyGroups) => VariationProperty | null

Parameters ​

id ​

number

propertyGroups ​

VariationPropertyGroup[]

Returns ​

VariationProperty | null

getPropertyCast ​

getPropertyCast: (property) => string

Parameters ​

property ​

VariationProperty

Returns ​

string

getPropertyDownloadLink: (property) => string

Parameters ​

property ​

VariationProperty

Returns ​

string

getPropertyFromGroup ​

getPropertyFromGroup: (id, propertyGroup) => VariationProperty | null

Parameters ​

id ​

number

propertyGroup ​

VariationPropertyGroup

Returns ​

VariationProperty | null

getPropertyId ​

getPropertyId: (property) => number

Parameters ​

property ​

VariationProperty

Returns ​

number

getPropertyName ​

getPropertyName: (property) => string

Parameters ​

property ​

VariationProperty

Returns ​

string

getPropertyNameDescription ​

getPropertyNameDescription: (property) => string

Parameters ​

property ​

VariationProperty

Returns ​

string

getPropertyValue ​

getPropertyValue: (property) => string

Parameters ​

property ​

VariationProperty

Returns ​

string

getPropertyValueDescription ​

getPropertyValueDescription: (property) => string

Parameters ​

property ​

VariationProperty

Returns ​

string

getPropertyValueId ​

getPropertyValueId: (property) => number

Parameters ​

property ​

VariationProperty

Returns ​

number

groupsHasRequiredOrderProperties ​

groupsHasRequiredOrderProperties: (groups) => boolean

Parameters ​

groups ​

OrderPropertiesGroups

Returns ​

boolean

hasGroup ​

hasGroup: (id, propertyGroups) => boolean

Parameters ​

id ​

number

propertyGroups ​

VariationPropertyGroup[]

Returns ​

boolean

hasOrderProperties ​

hasOrderProperties: (product) => boolean

Parameters ​

product ​

Product

Returns ​

boolean

hasOrderPropertiesGroupsTooltips ​

hasOrderPropertiesGroupsTooltips: (orderPropertiesGroups) => boolean

Parameters ​

orderPropertiesGroups ​

OrderPropertiesGroups

Returns ​

boolean

hasOrderPropertyDescription ​

hasOrderPropertyDescription: (property) => boolean

Parameters ​

property ​

ProductProperty

Returns ​

boolean

hasProperty ​

hasProperty: (id, propertyGroups) => boolean

Parameters ​

id ​

number

propertyGroups ​

VariationPropertyGroup[]

Returns ​

boolean

hasPropertyVat ​

hasPropertyVat: (forOrderProperty, property) => boolean

Parameters ​

forOrderProperty ​

boolean

property ​

ProductProperty

Returns ​

boolean

isHTML ​

isHTML: (property) => boolean

Parameters ​

property ​

VariationProperty

Returns ​

boolean

isImage ​

isImage: (property) => boolean

Parameters ​

property ​

VariationProperty

Returns ​

boolean

isJpegFile ​

isJpegFile: (property) => boolean

Parameters ​

property ​

VariationProperty

Returns ​

boolean

isMP4File ​

isMP4File: (property) => boolean

Parameters ​

property ​

VariationProperty

Returns ​

boolean

isMultiline ​

isMultiline: (property) => boolean

Parameters ​

property ​

ProductProperty

Returns ​

boolean

isOrderProperty ​

isOrderProperty: (property) => boolean

Parameters ​

property ​

ProductProperty

Returns ​

boolean

isOrderPropertyCheckbox ​

isOrderPropertyCheckbox: (property) => boolean

Parameters ​

property ​

ProductProperty

Returns ​

boolean

isOrderPropertyFile ​

isOrderPropertyFile: (property) => boolean

Parameters ​

property ​

ProductProperty

Returns ​

boolean

isOrderPropertyFloat ​

isOrderPropertyFloat: (property) => boolean

Parameters ​

property ​

ProductProperty

Returns ​

boolean

isOrderPropertyHidden ​

isOrderPropertyHidden: (property) => boolean

Parameters ​

property ​

ProductProperty

Returns ​

boolean

isOrderPropertyInput ​

isOrderPropertyInput: (property) => boolean

Parameters ​

property ​

ProductProperty

Returns ​

boolean

isOrderPropertyInt ​

isOrderPropertyInt: (property) => boolean

Parameters ​

property ​

ProductProperty

Returns ​

boolean

isOrderPropertyPreSelected ​

isOrderPropertyPreSelected: (property) => boolean

Parameters ​

property ​

ProductProperty

Returns ​

boolean

isOrderPropertyRequired ​

isOrderPropertyRequired: (property) => boolean

Parameters ​

property ​

ProductProperty

Returns ​

boolean

isOrderPropertySelection ​

isOrderPropertySelection: (property) => boolean

Parameters ​

property ​

ProductProperty

Returns ​

boolean

isOrderPropertyText ​

isOrderPropertyText: (property) => boolean

Parameters ​

property ​

ProductProperty

Returns ​

boolean

isPropertyShownAsAdditionalCosts ​

isPropertyShownAsAdditionalCosts: (forOrderProperty, property) => boolean

Parameters ​

forOrderProperty ​

boolean

property ​

ProductProperty

Returns ​

boolean

isText ​

isText: (property) => boolean

Parameters ​

property ​

VariationProperty

Returns ​

boolean

isWebpFile ​

isWebpFile: (property) => boolean

Parameters ​

property ​

VariationProperty

Returns ​

boolean