PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / productPriceGetters

Variable: productPriceGetters ​

const productPriceGetters: object

Defined in: getters/productPriceGetters.ts:110

Type Declaration ​

getCheapestGraduatedPrice ​

getCheapestGraduatedPrice: (product) => number

Parameters ​

product ​

Product

Returns ​

number

getCheapestGraduatedPriceFormatted ​

getCheapestGraduatedPriceFormatted: (product) => string

Parameters ​

product ​

Product

Returns ​

string

getCrossedPrice ​

getCrossedPrice: (product) => number | null

Parameters ​

product ​

Product

Returns ​

number | null

getCrossedPriceFormatted ​

getCrossedPriceFormatted: (product) => string

Parameters ​

product ​

Product

Returns ​

string

getDefaultBasePrice ​

getDefaultBasePrice: (product) => string

Parameters ​

product ​

Product

Returns ​

string

getDefaultBaseSinglePrice ​

getDefaultBaseSinglePrice: (product) => number

Parameters ​

product ​

Product

Returns ​

number

getGraduatedList ​

getGraduatedList: (product) => GraduatedPriceList[]

Parameters ​

product ​

Product

Returns ​

GraduatedPriceList[]

getGraduatedPriceByQuantity ​

getGraduatedPriceByQuantity: (product, quantity) => Default | null

Parameters ​

product ​

Product

quantity ​

number

Returns ​

Default | null

getGraduatedPrices ​

getGraduatedPrices: (product) => Default[]

Parameters ​

product ​

Product

Returns ​

Default[]

getLowestPrice ​

getLowestPrice: (product) => number | null

Parameters ​

product ​

Product

Returns ​

number | null

getPrice ​

getPrice: (product) => number | null

Parameters ​

product ​

Product

Returns ​

number | null

getPriceFormatted ​

getPriceFormatted: (product) => string

Parameters ​

product ​

Product

Returns ​

string

getRegularPriceCurrency ​

getRegularPriceCurrency: (product) => string

Parameters ​

product ​

Product

Returns ​

string

getSpecialOffer ​

getSpecialOffer: (product) => number | null

Parameters ​

product ​

Product

Returns ​

number | null

getSpecialOfferFormatted ​

getSpecialOfferFormatted: (product) => string

Parameters ​

product ​

Product

Returns ​

string

getSpecialPriceCurrency ​

getSpecialPriceCurrency: (product) => string

Parameters ​

product ​

Product

Returns ​

string

showPricePerUnit ​

showPricePerUnit: (product) => boolean

Parameters ​

product ​

Product

Returns ​

boolean