Class: DisplayLineItem

order.DisplayLineItem()

new DisplayLineItem()

Source:

Methods

(static) DisplayLineItem#getAlternateName() → {Null|String}

Get the field value Alternate name of the line item
Source:
Returns:
Type
Null | String

(static) DisplayLineItem#getBinName() → {Null|String}

Get the field value
Source:
Returns:
Type
Null | String

(static) DisplayLineItem#getDiscountAmount() → {Null|String}

Get the field value
Source:
Returns:
Type
Null | String

(static) DisplayLineItem#getDiscounts() → {Array.<order.DisplayDiscount>}

Get the field value
Source:
Returns:
An array of
Type
Array.<order.DisplayDiscount>

(static) DisplayLineItem#getExchanged() → {Boolean}

Get the field value
Source:
Returns:
Type
Boolean

(static) DisplayLineItem#getExchangedAmount() → {Null|String}

Get the field value Formatted exchanged amount
Source:
Returns:
Type
Null | String

(static) DisplayLineItem#getId() → {String}

Get the field value Unique identifier
Source:
Returns:
Type
String

(static) DisplayLineItem#getModifications() → {Array.<order.DisplayModification>}

Get the field value
Source:
Returns:
An array of
Type
Array.<order.DisplayModification>

(static) DisplayLineItem#getName() → {Null|String}

Get the field value Line item name
Source:
Returns:
Type
Null | String

(static) DisplayLineItem#getNote() → {Null|String}

Get the field value
Source:
Returns:
Type
Null | String

(static) DisplayLineItem#getOrderId() → {String}

Get the field value The order with which the line item is associated
Source:
Returns:
Type
String

(static) DisplayLineItem#getPercent() → {Null|String}

Get the field value
Source:
Returns:
Type
Null | String

(static) DisplayLineItem#getPrice() → {String}

Get the field value Formatted total price of the line item
Source:
Returns:
Type
String

(static) DisplayLineItem#getPrinted() → {Boolean}

Get the field value
Source:
Returns:
Type
Boolean

(static) DisplayLineItem#getQuantity() → {Null|String}

Get the field value Formatted quantity
Source:
Returns:
Type
Null | String

(static) DisplayLineItem#getRefunded() → {Boolean}

Get the field value
Source:
Returns:
Type
Boolean

(static) DisplayLineItem#getRefundedAmount() → {Null|String}

Get the field value Formatted refunded amount
Source:
Returns:
Type
Null | String

(static) DisplayLineItem#getUnitPrice() → {String}

Get the field value Formatted unit price in cases if applicable
Source:
Returns:
Type
String

(static) DisplayLineItem#getUnitQuantity() → {Null|String}

Get the field value Formatted unit quantity - such as 10 @ $1.99/oz
Source:
Returns:
Type
Null | String

(static) DisplayLineItem#getUserData() → {Null|String}

Get the field value
Source:
Returns:
Type
Null | String

(static) DisplayLineItem#setAlternateName(alternateName)

Set the field value Alternate name of the line item
Parameters:
Name Type Description
alternateName Null | String
Source:

(static) DisplayLineItem#setBinName(binName)

Set the field value
Parameters:
Name Type Description
binName Null | String
Source:

(static) DisplayLineItem#setDiscountAmount(discountAmount)

Set the field value
Parameters:
Name Type Description
discountAmount Null | String
Source:

(static) DisplayLineItem#setDiscounts(discounts)

Set the field value
Parameters:
Name Type Description
discounts Array.<order.DisplayDiscount> An array of
Source:

(static) DisplayLineItem#setExchanged(exchanged)

Set the field value
Parameters:
Name Type Description
exchanged Boolean
Source:

(static) DisplayLineItem#setExchangedAmount(exchangedAmount)

Set the field value Formatted exchanged amount
Parameters:
Name Type Description
exchangedAmount Null | String
Source:

(static) DisplayLineItem#setId(id)

Set the field value Unique identifier
Parameters:
Name Type Description
id String
Source:

(static) DisplayLineItem#setModifications(modifications)

Set the field value
Parameters:
Name Type Description
modifications Array.<order.DisplayModification> An array of
Source:

(static) DisplayLineItem#setName(name)

Set the field value Line item name
Parameters:
Name Type Description
name Null | String
Source:

(static) DisplayLineItem#setNote(note)

Set the field value
Parameters:
Name Type Description
note Null | String
Source:

(static) DisplayLineItem#setOrderId(orderId)

Set the field value The order with which the line item is associated
Parameters:
Name Type Description
orderId String
Source:

(static) DisplayLineItem#setPercent(percent)

Set the field value
Parameters:
Name Type Description
percent Null | String
Source:

(static) DisplayLineItem#setPrice(price)

Set the field value Formatted total price of the line item
Parameters:
Name Type Description
price String
Source:

(static) DisplayLineItem#setPrinted(printed)

Set the field value
Parameters:
Name Type Description
printed Boolean
Source:

(static) DisplayLineItem#setQuantity(quantity)

Set the field value Formatted quantity
Parameters:
Name Type Description
quantity Null | String
Source:

(static) DisplayLineItem#setRefunded(refunded)

Set the field value
Parameters:
Name Type Description
refunded Boolean
Source:

(static) DisplayLineItem#setRefundedAmount(refundedAmount)

Set the field value Formatted refunded amount
Parameters:
Name Type Description
refundedAmount Null | String
Source:

(static) DisplayLineItem#setUnitPrice(unitPrice)

Set the field value Formatted unit price in cases if applicable
Parameters:
Name Type Description
unitPrice String
Source:

(static) DisplayLineItem#setUnitQuantity(unitQuantity)

Set the field value Formatted unit quantity - such as 10 @ $1.99/oz
Parameters:
Name Type Description
unitQuantity Null | String
Source:

(static) DisplayLineItem#setUserData(userData)

Set the field value
Parameters:
Name Type Description
userData Null | String
Source: