@plentymarkets/shop-api / orderGetters

Variable: orderGetters

const orderGetters: object

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

getCouponValue()

getCouponValue: (totals) => number

Parameters

• totals: OrderTotals

Returns

number

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

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

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

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

Parameters

• orderItem: OrderItem

• property: OrderItemOrderProperty

Returns

ProductProperty

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[]

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()

getOrderItemLink: (order, productId) => string

Parameters

• order: Order

• productId: number

Returns

string

getOrderItemOrderPropertyName()

getOrderItemOrderPropertyName: (item) => string

Parameters

• item: OrderItemOrderProperty

Returns

string

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

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

getPagination()

getPagination: (orders) => AgnosticPagination

Parameters

• orders: GetOrdersResponse

Returns

AgnosticPagination

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

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

getShippingCost()

getShippingCost: (order) => number | null

Parameters

• order: Order

Returns

number | null

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

getTotal()

getTotal: (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

Defined in

getters/orderGetters.ts:637