@plentymarkets/shop-api / cartGetters
Variable: cartGetters ​
const
cartGetters:object
Type declaration ​
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
getBasketItemOrderParamType() ​
getBasketItemOrderParamType: (
item
) =>string
Parameters ​
• item: BasketItemOrderParam
Returns ​
string
getBasketItemOrderParamValue() ​
getBasketItemOrderParamValue: (
item
) =>string
Parameters ​
• item: BasketItemOrderParam
Returns ​
string
getBasketItemOrderParams() ​
getBasketItemOrderParams: (
item
) =>BasketItemOrderParam
[]
Parameters ​
• item: CartItem
Returns ​
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
) =>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
) =>AgnosticPrice
|null
Parameters ​
• item: CartItem
Returns ​
AgnosticPrice
| null
getItemQty() ​
getItemQty: (
item
) =>number
Parameters ​
• item: CartItem
Returns ​
number
getItemSku() ​
getItemSku: (
item
) =>string
Parameters ​
• item: CartItem
Returns ​
string
getItems() ​
getItems: (
cart
) =>CartItem
[]
Parameters ​
• cart: Cart
Returns ​
CartItem
[]
getOrderPropertiesAdditionalCostsWithVat() ​
getOrderPropertiesAdditionalCostsWithVat: (
cart
) =>BasketItemOrderParam
[]
Parameters ​
• cart: Cart
Returns ​
getOrderPropertiesWithoutVat() ​
getOrderPropertiesWithoutVat: (
cart
) =>BasketItemOrderParam
[]
Parameters ​
• cart: Cart
Returns ​
getProductPath() ​
getProductPath: (
item
) =>string
Parameters ​
• item: CartItem
Returns ​
string
getPropertyFromCartItem() ​
getPropertyFromCartItem: (
item
,propertyId
) =>ProductProperty
|null
Parameters ​
• item: CartItem
• propertyId: number
Returns ​
ProductProperty
| null
getRegularItemPrice() ​
getRegularItemPrice: (
item
) =>number
Parameters ​
• item: CartItem
Returns ​
number
getShippingAmount() ​
getShippingAmount: (
total
) =>number
Parameters ​
• total: PlentyAgnosticTotals
Returns ​
number
getShippingPrice() ​
getShippingPrice: (
cart
) =>number
Parameters ​
• cart: Cart
Returns ​
number
getSpecialItemPrice() ​
getSpecialItemPrice: (
item
) =>number
Parameters ​
• item: CartItem
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
getTotalVatAmount() ​
getTotalVatAmount: (
totalVat
) =>number
Parameters ​
• totalVat: TotalVat
Returns ​
number
getTotalVatValue() ​
getTotalVatValue: (
totalVat
) =>number
Parameters ​
• totalVat: TotalVat
Returns ​
number
getTotals() ​
getTotals: (
cart
) =>AgnosticTotals
Parameters ​
• cart: Cart
Returns ​
AgnosticTotals
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