PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / offerGetters

Variable: offerGetters ​

const offerGetters: object

Defined in: getters/offerGetters.ts:86

Type Declaration ​

getBillingAddress() ​

getBillingAddress: (offer) => Address | null

Parameters ​

offer ​

Offer

Returns ​

Address | null

getItemsCountInOffer() ​

getItemsCountInOffer: (items) => number

Parameters ​

items ​

OrderItem[]

Returns ​

number

getOfferEmail() ​

getOfferEmail: (offer) => string

Parameters ​

offer ​

Offer

Returns ​

string

getOfferItemOriginalPrice() ​

getOfferItemOriginalPrice: (offerItem) => number

Parameters ​

offerItem ​

OrderItem

Returns ​

number

getOfferItemOriginalPriceWithQuantity() ​

getOfferItemOriginalPriceWithQuantity: (item) => number

Parameters ​

item ​

OrderItem

Returns ​

number

getOfferItemQty() ​

getOfferItemQty: (item) => number

Parameters ​

item ​

OrderItem

Returns ​

number

getOfferItemsCount() ​

getOfferItemsCount: (offer) => number

Parameters ​

offer ​

Offer

Returns ​

number

getOfferItemVariationName() ​

getOfferItemVariationName: (variation) => string

Parameters ​

variation ​

Product

Returns ​

string

getPaymentMethodIconPath() ​

getPaymentMethodIconPath: (offer) => string

Parameters ​

offer ​

Offer

Returns ​

string

getPaymentMethodName() ​

getPaymentMethodName: (offer) => string

Parameters ​

offer ​

Offer

Returns ​

string

getShippingAddress() ​

getShippingAddress: (offer) => Address | null

Parameters ​

offer ​

Offer

Returns ​

Address | null

getShippingMethodCosts() ​

getShippingMethodCosts: (offer) => number

Parameters ​

offer ​

Offer

Returns ​

number

getShippingMethodName() ​

getShippingMethodName: (offer) => string

Parameters ​

offer ​

Offer

Returns ​

string

getValidUntil() ​

getValidUntil: (offer, locale) => string | null

Parameters ​

offer ​

Offer

locale ​

string = 'en'

Returns ​

string | null

isTypeOffer() ​

isTypeOffer: (offer) => boolean

Parameters ​

offer ​

Offer

Returns ​

boolean