PlentyONE Shop Docs

Appearance

@plentymarkets/shop-api / orderGetters

Variable: orderGetters ​

const orderGetters: object

Defined in: getters/orderGetters.ts:805

Type Declaration ​

getAccessKey ​

getAccessKey: (order) => string

Parameters ​

order ​

Order

Returns ​

string

getAdditionalCostsWithoutTax ​

getAdditionalCostsWithoutTax: (order) => OrderItemOrderProperty[]

Parameters ​

order ​

Order

Returns ​

OrderItemOrderProperty[]

getAdditionalCostsWithTax ​

getAdditionalCostsWithTax: (order) => OrderItemOrderProperty[]

Parameters ​

order ​

Order

Returns ​

OrderItemOrderProperty[]

getBillingAddress ​

getBillingAddress: (order) => AddressData | null

Parameters ​

order ​

Order

Returns ​

AddressData | null

getById ​

getById: (orders, id) => Order | null

Parameters ​

orders ​

Order[]

id ​

string

Returns ​

Order | null

getCouponType ​

getCouponType: (totals) => string

Parameters ​

totals ​

OrderTotals

Returns ​

string

getCouponValue ​

getCouponValue: (totals) => number

Parameters ​

totals ​

OrderTotals

Returns ​

number

getCurrency ​

getCurrency: (order) => string

Parameters ​

order ​

Order

Returns ​

string

getDate ​

getDate: (order, locale) => string

Parameters ​

order ​

Order

locale? ​

string = 'en'

Returns ​

string

getDocuments ​

getDocuments: (order) => OrderDocument[]

Parameters ​

order ​

Order

Returns ​

OrderDocument[]

getFormattedPrice ​

getFormattedPrice: (price) => string

Parameters ​

price ​

number

Returns ​

string

getId ​

getId: (order) => string

Parameters ​

order ​

Order

Returns ​

string

getItemName ​

getItemName: (item) => string

Parameters ​

item ​

OrderItem

Returns ​

string

getItemNetPrice ​

getItemNetPrice: (item) => number

Parameters ​

item ​

OrderItem

Returns ​

number

getItemNetPriceByCurrency ​

getItemNetPriceByCurrency: (item, currency) => number | null

Parameters ​

item ​

OrderItem

currency ​

string

Returns ​

number | null

getItemOrderProperties ​

getItemOrderProperties: (item) => OrderItemOrderProperty[]

Parameters ​

item ​

OrderItem

Returns ​

OrderItemOrderProperty[]

getItemOrderPropertyFileUrl ​

getItemOrderPropertyFileUrl: (property) => string

Parameters ​

property ​

OrderItemOrderProperty

Returns ​

string

getItemOrderPropertyName ​

getItemOrderPropertyName: (property) => string

Parameters ​

property ​

OrderItemOrderProperty

Returns ​

string

getItemOrderPropertyType ​

getItemOrderPropertyType: (property) => string

Parameters ​

property ​

OrderItemOrderProperty

Returns ​

string

getItemOrderPropertyValue ​

getItemOrderPropertyValue: (property) => string

Parameters ​

property ​

OrderItemOrderProperty

Returns ​

string

getItemPrice ​

getItemPrice: (item) => number

Parameters ​

item ​

OrderItem

Returns ​

number

getItemPriceByCurrency ​

getItemPriceByCurrency: (item, currency) => number | null

Parameters ​

item ​

OrderItem

currency ​

string

Returns ​

number | null

getItemQty ​

getItemQty: (item) => number

Parameters ​

item ​

OrderItem

Returns ​

number

getItemReturnableQty ​

getItemReturnableQty: (item) => number

Parameters ​

item ​

OrderItem

Returns ​

number

getItems ​

getItems: (order) => OrderItem[]

Parameters ​

order ​

Order

Returns ​

OrderItem[]

getItemShortDescription ​

getItemShortDescription: (order, item) => string

Parameters ​

order ​

Order

item ​

OrderItem

Returns ​

string

getItemSku ​

getItemSku: (item) => string

Parameters ​

item ​

OrderItem

Returns ​

string

getItemVariationId ​

getItemVariationId: (item) => number

Parameters ​

item ​

OrderItem

Returns ​

number

getOpenAmount ​

getOpenAmount: (totals) => number | null

Parameters ​

totals ​

OrderTotals

Returns ​

number | null

getOrderAgainAvailability ​

getOrderAgainAvailability: (orderItem) => Availability | null

Parameters ​

orderItem ​

OrderItem

Returns ​

Availability | null

getOrderAgainAvailabilityAverageDays ​

getOrderAgainAvailabilityAverageDays: (orderItem) => number

Parameters ​

orderItem ​

OrderItem

Returns ​

number

getOrderAgainAvailabilityBackgroundColor ​

getOrderAgainAvailabilityBackgroundColor: (orderItem) => string

Parameters ​

orderItem ​

OrderItem

Returns ​

string

getOrderAgainAvailabilityClass ​

getOrderAgainAvailabilityClass: (orderItem) => string

Parameters ​

orderItem ​

OrderItem

Returns ​

string

getOrderAgainAvailabilityName ​

getOrderAgainAvailabilityName: (orderItem) => string

Parameters ​

orderItem ​

OrderItem

Returns ​

string

getOrderAgainAvailabilityTextColor ​

getOrderAgainAvailabilityTextColor: (orderItem) => string

Parameters ​

orderItem ​

OrderItem

Returns ​

string

getOrderAgainInformationPrice ​

getOrderAgainInformationPrice: (orderItem) => number

Parameters ​

orderItem ​

OrderItem

Returns ​

number

getOrderAgainOrderItemStock ​

getOrderAgainOrderItemStock: (orderItem) => number

Parameters ​

orderItem ​

OrderItem

Returns ​

number

getOrderAgainOrderPropertiesPrice ​

getOrderAgainOrderPropertiesPrice: (orderItem) => number

Parameters ​

orderItem ​

OrderItem

Returns ​

number

getOrderAgainOrderProperty ​

getOrderAgainOrderProperty: (orderItem, property) => ProductProperty | null

Parameters ​

orderItem ​

OrderItem

property ​

OrderItemOrderProperty

Returns ​

ProductProperty | null

getOrderAgainOrderPropertySurcharge ​

getOrderAgainOrderPropertySurcharge: (orderItem, property) => number

Parameters ​

orderItem ​

OrderItem

property ​

OrderItemOrderProperty

Returns ​

number

getOrderAgainPropertyValue ​

getOrderAgainPropertyValue: (property) => string

Parameters ​

property ​

OrderItemOrderProperty

Returns ​

string

getOrderAgainSortedChangedItems ​

getOrderAgainSortedChangedItems: (order) => OrderItem[]

Parameters ​

order ​

Order

Returns ​

OrderItem[]

getOrderAttributes ​

getOrderAttributes: (order) => OrderItemAttribute[]

Parameters ​

order ​

OrderItem

Returns ​

OrderItemAttribute[]

getOrderContactWish ​

getOrderContactWish: (order) => string | null

Parameters ​

order ​

Order

Returns ​

string | null

getOrderCustomerSign ​

getOrderCustomerSign: (order) => string | null

Parameters ​

order ​

Order

Returns ​

string | null

getOrderEmail ​

getOrderEmail: (order) => string

Parameters ​

order ​

Order

Returns ​

string

getOrderItemAttributeName ​

getOrderItemAttributeName: (attribute) => string | null

Parameters ​

attribute ​

OrderItemAttribute

Returns ​

string | null

getOrderItemAttributeValue ​

getOrderItemAttributeValue: (attribute) => string | null

Parameters ​

attribute ​

OrderItemAttribute

Returns ​

string | null

getOrderItemLink: (order, productId) => string

Parameters ​

order ​

Order

productId ​

number

Returns ​

string

getOrderItemOrderPropertyName ​

getOrderItemOrderPropertyName: (item) => string

Parameters ​

item ​

OrderItemOrderProperty

Returns ​

string

getOrderItemOrderPropertyNetSurcharge ​

getOrderItemOrderPropertyNetSurcharge: (item) => number

Parameters ​

item ​

OrderItemOrderProperty

Returns ​

number

getOrderItemOrderPropertySurcharge ​

getOrderItemOrderPropertySurcharge: (item) => number

Parameters ​

item ​

OrderItemOrderProperty

Returns ​

number

getOrderPaymentBankDetails ​

getOrderPaymentBankDetails: (order) => OrderPaymentBankDetails | null

Parameters ​

order ​

Order

Returns ​

OrderPaymentBankDetails | null

getOrderPaymentBankDetailsAccountNumber ​

getOrderPaymentBankDetailsAccountNumber: (bankDetails) => string

Parameters ​

bankDetails ​

OrderPaymentBankDetails

Returns ​

string

getOrderPaymentBankDetailsBankCode ​

getOrderPaymentBankDetailsBankCode: (bankDetails) => string

Parameters ​

bankDetails ​

OrderPaymentBankDetails

Returns ​

string

getOrderPaymentBankDetailsBankName ​

getOrderPaymentBankDetailsBankName: (bankDetails) => string

Parameters ​

bankDetails ​

OrderPaymentBankDetails

Returns ​

string

getOrderPaymentBankDetailsHolder ​

getOrderPaymentBankDetailsHolder: (bankDetails) => string

Parameters ​

bankDetails ​

OrderPaymentBankDetails

Returns ​

string

getOrderPaymentBankDetailsIban ​

getOrderPaymentBankDetailsIban: (bankDetails) => string

Parameters ​

bankDetails ​

OrderPaymentBankDetails

Returns ​

string

getOrderPaymentBankDetailsSwift ​

getOrderPaymentBankDetailsSwift: (bankDetails) => string

Parameters ​

bankDetails ​

OrderPaymentBankDetails

Returns ​

string

getOrderReferenceOriginId ​

getOrderReferenceOriginId: (order) => string | undefined

Parameters ​

order ​

Order

Returns ​

string | undefined

getOrdersTotal ​

getOrdersTotal: (orders) => number

Parameters ​

orders ​

GetOrdersResponse

Returns ​

number

getOrderTrackingNumbers ​

getOrderTrackingNumbers: (order) => string[]

Parameters ​

order ​

Order

Returns ​

string[]

getOrderTrackingUrl ​

getOrderTrackingUrl: (order) => string

Parameters ​

order ​

Order

Returns ​

string

getOrderVariationFirstImage ​

getOrderVariationFirstImage: (order, item) => ImagesData

Parameters ​

order ​

Order

item ​

OrderItem

Returns ​

ImagesData

getOrderVariationImage ​

getOrderVariationImage: (order, item) => string

Parameters ​

order ​

Order

item ​

OrderItem

Returns ​

string

getOrderVariationPath ​

getOrderVariationPath: (order, item) => string

Parameters ​

order ​

Order

item ​

OrderItem

Returns ​

string

getOrderVatRate ​

getOrderVatRate: (vat) => number

Parameters ​

vat ​

OrderTotalsVat

Returns ​

number

getOrderVats ​

getOrderVats: (order) => OrderTotalsVat[]

Parameters ​

order ​

Order

Returns ​

OrderTotalsVat[]

getOrderVatValue ​

getOrderVatValue: (vat) => number

Parameters ​

vat ​

OrderTotalsVat

Returns ​

number

getOriginalItemNetPrice ​

getOriginalItemNetPrice: (item) => number

Parameters ​

item ​

OrderItem

Returns ​

number

getOriginalItemPrice ​

getOriginalItemPrice: (item) => number

Parameters ​

item ​

OrderItem

Returns ​

number

getOriginalOrderVats ​

getOriginalOrderVats: (order) => OrderTotalsVat[]

Parameters ​

order ​

Order

Returns ​

OrderTotalsVat[]

getOriginalShippingCost ​

getOriginalShippingCost: (order) => number

Parameters ​

order ​

Order

Returns ​

number

getOriginalShippingCostNet ​

getOriginalShippingCostNet: (order) => number

Parameters ​

order ​

Order

Returns ​

number

getPagination ​

getPagination: (orders) => AgnosticPagination

Parameters ​

orders ​

GetOrdersResponse

Returns ​

AgnosticPagination

getPaidAmount ​

getPaidAmount: (totals) => number

Parameters ​

totals ​

OrderTotals

Returns ​

number

getPaymentMethodName ​

getPaymentMethodName: (order) => string

Parameters ​

order ​

Order

Returns ​

string

getPaymentStatus ​

getPaymentStatus: (order) => string

Parameters ​

order ​

Order

Returns ​

string

getPaymentStatusKey ​

getPaymentStatusKey: (order) => string

Parameters ​

order ​

Order

Returns ​

string

getPreferredDeliveryServices ​

getPreferredDeliveryServices: (order) => {[key: string]: string; } | null

Parameters ​

order ​

Order

Returns ​

{[key: string]: string; } | null

getPrice ​

getPrice: (order) => number

Parameters ​

order ​

Order

Returns ​

number

getShippingAddress ​

getShippingAddress: (order) => AddressData | null

Parameters ​

order ​

Order

Returns ​

AddressData | null

getShippingAmount ​

getShippingAmount: (totals) => number

Parameters ​

totals ​

OrderTotals

Returns ​

number

getShippingAmountNet ​

getShippingAmountNet: (totals) => number

Parameters ​

totals ​

OrderTotals

Returns ​

number

getShippingCost ​

getShippingCost: (order) => number

Parameters ​

order ​

Order

Returns ​

number

getShippingCostNet ​

getShippingCostNet: (order) => number

Parameters ​

order ​

Order

Returns ​

number

getShippingDate ​

getShippingDate: (order, locale) => string | null

Parameters ​

order ​

Order

locale? ​

string = ''

Returns ​

string | null

getShippingProfileName ​

getShippingProfileName: (order) => string

Parameters ​

order ​

Order

Returns ​

string

getShippingProvider ​

getShippingProvider: (order) => string

Parameters ​

order ​

Order

Returns ​

string

getStatus ​

getStatus: (order) => string

Parameters ​

order ​

Order

Returns ​

string

getSubTotal ​

getSubTotal: (totals) => number

Parameters ​

totals ​

OrderTotals

Returns ​

number

getSubTotalNet ​

getSubTotalNet: (totals) => number

Parameters ​

totals ​

OrderTotals

Returns ​

number

getTotal ​

getTotal: (totals) => number

Parameters ​

totals ​

OrderTotals

Returns ​

number

getTotalNet ​

getTotalNet: (totals) => number

Parameters ​

totals ​

OrderTotals

Returns ​

number

getTotals ​

getTotals: (order) => OrderTotals

Parameters ​

order ​

Order

Returns ​

OrderTotals

getVatAmount ​

getVatAmount: (totals) => number

Parameters ​

totals ​

OrderTotals

Returns ​

number

getVatRate ​

getVatRate: (totals) => number

Parameters ​

totals ​

OrderTotals

Returns ​

number

hasAllOrderPropertiesAvailable ​

hasAllOrderPropertiesAvailable: (orderItem) => boolean

Parameters ​

orderItem ​

OrderItem

Returns ​

boolean

hasOrderAgainChangedItems ​

hasOrderAgainChangedItems: (order) => boolean

Parameters ​

order ​

Order

Returns ​

boolean

hasReturnableItems ​

hasReturnableItems: (order) => boolean

Parameters ​

order ​

Order

Returns ​

boolean

isBundleComponents ​

isBundleComponents: (orderItem) => boolean

Parameters ​

orderItem ​

OrderItem

Returns ​

boolean

isBundleItem ​

isBundleItem: (orderItem) => boolean

Parameters ​

orderItem ​

OrderItem

Returns ​

boolean

isCouponItem ​

isCouponItem: (orderItem) => boolean

Parameters ​

orderItem ​

OrderItem

Returns ​

boolean

isItemOrderPropertyFile ​

isItemOrderPropertyFile: (property) => boolean

Parameters ​

property ​

OrderItemOrderProperty

Returns ​

boolean

isItemSalableAndActive ​

isItemSalableAndActive: (order, orderItem) => boolean

Parameters ​

order ​

Order

orderItem ​

OrderItem

Returns ​

boolean

isReturn ​

isReturn: (order) => boolean

Parameters ​

order ​

Order

Returns ​

boolean

isReturnable ​

isReturnable: (order) => boolean

Parameters ​

order ​

Order

Returns ​

boolean

showItemOrderPropertyValue ​

showItemOrderPropertyValue: (property) => boolean

Parameters ​

property ​

OrderItemOrderProperty

Returns ​

boolean