PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / cartGetters

Variable: cartGetters ​

const cartGetters: object

Defined in: getters/cartGetters.ts:302

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

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) => null | number

Parameters ​

cart ​

Cart

Returns ​

null | number

getCustomerShippingAddressId() ​

getCustomerShippingAddressId: (cart) => null | number

Parameters ​

cart ​

Cart

Returns ​

null | number

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) => null | number

Parameters ​

item ​

CartItem

Returns ​

null | number

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) => null | number

Parameters ​

cart ​

Cart

shippingMethodId ​

number

Returns ​

null | number

getOrderPropertiesAdditionalCostsWithVat() ​

getOrderPropertiesAdditionalCostsWithVat: (cart) => BasketItemOrderParam[]

Parameters ​

cart ​

Cart

Returns ​

BasketItemOrderParam[]

getOrderPropertiesWithoutVat() ​

getOrderPropertiesWithoutVat: (cart) => BasketItemOrderParam[]

Parameters ​

cart ​

Cart

Returns ​

BasketItemOrderParam[]

getProductPath() ​

getProductPath: (item) => string

Parameters ​

item ​

CartItem

Returns ​

string

getPropertyFromCartItem() ​

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

Parameters ​

item ​

CartItem

propertyId ​

number

Returns ​

null | ProductProperty

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) => null | Product

Parameters ​

item ​

CartItem

Returns ​

null | Product

getVariationBundleComponents() ​

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

Parameters ​

item ​

CartItem

Returns ​

null | ProductBundleComponent[]

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