PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / cartGetters

Variable: cartGetters ​

const cartGetters: object

Defined in: getters/cartGetters.ts:321

Type Declaration ​

getBasketAmountNet ​

getBasketAmountNet: (cart) => number

Parameters ​

cart ​

Cart

Returns ​

number

getBasketItemOrderParamBasketItemId ​

getBasketItemOrderParamBasketItemId: (item) => number

Parameters ​

item ​

BasketItemOrderParam

Returns ​

number

getBasketItemOrderParamName ​

getBasketItemOrderParamName: (item) => string

Parameters ​

item ​

BasketItemOrderParam

Returns ​

string

getBasketItemOrderParamPrice ​

getBasketItemOrderParamPrice: (item) => number

Parameters ​

item ​

BasketItemOrderParam

Returns ​

number

getBasketItemOrderParamPropertyId ​

getBasketItemOrderParamPropertyId: (item) => string

Parameters ​

item ​

BasketItemOrderParam

Returns ​

string

getBasketItemOrderParams ​

getBasketItemOrderParams: (item) => BasketItemOrderParam[]

Parameters ​

item ​

CartItem

Returns ​

BasketItemOrderParam[]

getBasketItemOrderParamType ​

getBasketItemOrderParamType: (item) => string

Parameters ​

item ​

BasketItemOrderParam

Returns ​

string

getBasketItemOrderParamValue ​

getBasketItemOrderParamValue: (item) => string

Parameters ​

item ​

BasketItemOrderParam

Returns ​

string

getCartItemPrice ​

getCartItemPrice: (item) => number

Parameters ​

item ​

CartItem

Returns ​

number

getCouponCampaignType ​

getCouponCampaignType: (cart) => string

Parameters ​

cart ​

Cart

Returns ​

string

getCouponCode ​

getCouponCode: (cart) => string

Parameters ​

cart ​

Cart

Returns ​

string

getCouponDiscount ​

getCouponDiscount: (cart) => number

Parameters ​

cart ​

Cart

Returns ​

number

getCoupons ​

getCoupons: (cart) => AgnosticCoupon[]

Parameters ​

cart ​

Cart

Returns ​

AgnosticCoupon[]

getCurrency ​

getCurrency: (cart) => string

Parameters ​

cart ​

Cart

Returns ​

string

getCustomerInvoiceAddressId ​

getCustomerInvoiceAddressId: (cart) => number | null

Parameters ​

cart ​

Cart

Returns ​

number | null

getCustomerShippingAddressId ​

getCustomerShippingAddressId: (cart) => number | null

Parameters ​

cart ​

Cart

Returns ​

number | null

getDiscounts ​

getDiscounts: (cart) => AgnosticDiscount[]

Parameters ​

cart ​

Cart

Returns ​

AgnosticDiscount[]

getFormattedPrice ​

getFormattedPrice: (price) => string

Parameters ​

price ​

number

Returns ​

string

getItemAttributes ​

getItemAttributes: (item) => AgnosticAttribute[]

Parameters ​

item ​

CartItem

Returns ​

AgnosticAttribute[]

getItemId ​

getItemId: (item) => number

Parameters ​

item ​

CartItem

Returns ​

number

getItemImage ​

getItemImage: (item) => string

Parameters ​

item ​

CartItem

Returns ​

string

getItemName ​

getItemName: (item) => string

Parameters ​

item ​

CartItem

Returns ​

string

getItemPrice ​

getItemPrice: (item) => number | null

Parameters ​

item ​

CartItem

Returns ​

number | null

getItemQty ​

getItemQty: (item) => number

Parameters ​

item ​

CartItem

Returns ​

number

getItems ​

getItems: (cart) => CartItem[]

Parameters ​

cart ​

Cart

Returns ​

CartItem[]

getItemSku ​

getItemSku: (item) => string

Parameters ​

item ​

CartItem

Returns ​

string

getItemSumNet ​

getItemSumNet: (cart) => number

Parameters ​

cart ​

Cart

Returns ​

number

getMaxDeliveryDays ​

getMaxDeliveryDays: (cart, shippingMethodId) => number | null

Parameters ​

cart ​

Cart

shippingMethodId ​

number

Returns ​

number | null

getOpenAmount ​

getOpenAmount: (cart) => number | null

Parameters ​

cart ​

Cart

Returns ​

number | null

getOrderPropertiesAdditionalCostsWithVat ​

getOrderPropertiesAdditionalCostsWithVat: (cart) => BasketItemOrderParam[]

Parameters ​

cart ​

Cart

Returns ​

BasketItemOrderParam[]

getOrderPropertiesWithoutVat ​

getOrderPropertiesWithoutVat: (cart) => BasketItemOrderParam[]

Parameters ​

cart ​

Cart

Returns ​

BasketItemOrderParam[]

getProductPath ​

getProductPath: (item, useCallistoPattern) => string

Parameters ​

item ​

CartItem

useCallistoPattern? ​

boolean = false

Returns ​

string

getPropertyFromCartItem ​

getPropertyFromCartItem: (item, propertyId) => ProductProperty | null

Parameters ​

item ​

CartItem

propertyId ​

number

Returns ​

ProductProperty | null

getShippingAmount ​

getShippingAmount: (total) => number

Parameters ​

total ​

PlentyAgnosticTotals

Returns ​

number

getShippingAmountNet ​

getShippingAmountNet: (cart) => number

Parameters ​

cart ​

Cart

Returns ​

number

getShippingCountryId ​

getShippingCountryId: (cart?) => number

Parameters ​

cart? ​

Cart

Returns ​

number

getShippingPrice ​

getShippingPrice: (cart) => number

Parameters ​

cart ​

Cart

Returns ​

number

getShopCountryId ​

getShopCountryId: (cart?) => number

Parameters ​

cart? ​

Cart

Returns ​

number

getSubTotal ​

getSubTotal: (total) => number

Parameters ​

total ​

AgnosticTotals

Returns ​

number

getToBePayed ​

getToBePayed: (total) => number

Parameters ​

total ​

PlentyAgnosticTotals

Returns ​

number

getTotal ​

getTotal: (total) => number

Parameters ​

total ​

AgnosticTotals

Returns ​

number

getTotalItems ​

getTotalItems: (cart) => number

Parameters ​

cart ​

Cart

Returns ​

number

getTotals ​

getTotals: (cart) => AgnosticTotals

Parameters ​

cart ​

Cart

Returns ​

AgnosticTotals

getTotalVatAmount ​

getTotalVatAmount: (totalVat) => number

Parameters ​

totalVat ​

TotalVat

Returns ​

number

getTotalVatValue ​

getTotalVatValue: (totalVat) => number

Parameters ​

totalVat ​

TotalVat

Returns ​

number

getVariation ​

getVariation: (item) => Product | null

Parameters ​

item ​

CartItem

Returns ​

Product | null

getVariationBundleComponents ​

getVariationBundleComponents: (item) => ProductBundleComponent[] | null

Parameters ​

item ​

CartItem

Returns ​

ProductBundleComponent[] | null

getVariationId ​

getVariationId: (item) => number

Parameters ​

item ​

CartItem

Returns ​

number

getVatAmount ​

getVatAmount: (total) => number

Parameters ​

total ​

PlentyAgnosticTotals

Returns ​

number

getVatValue ​

getVatValue: (total) => number

Parameters ​

total ​

PlentyAgnosticTotals

Returns ​

number