Class: OrderItem

Model~OrderItem(data) → {void}

OrderItem data model.

Constructor

new OrderItem(data) → {void}

OrderItem Constructor.

OrderItem Constructor.

Parameters:
Name Type Description
data Object
Source:
Returns:
Type
void

Members

(static, constant) ORDER_ITEM_STATUS_BACKORDERED

Constant ORDER_ITEM_STATUS_BACKORDERED

.

Constant ORDER_ITEM_STATUS_BACKORDERED

Source:

(static, constant) ORDER_ITEM_STATUS_CANCELLED

Constant ORDER_ITEM_STATUS_CANCELLED

.

Constant ORDER_ITEM_STATUS_CANCELLED

Source:

(static, constant) ORDER_ITEM_STATUS_DIGITAL_DOWNLOADED

Constant ORDER_ITEM_STATUS_DIGITAL_DOWNLOADED

.

Constant ORDER_ITEM_STATUS_DIGITAL_DOWNLOADED

Source:

(static, constant) ORDER_ITEM_STATUS_DIGITAL_NOT_DOWNLOADED

Constant ORDER_ITEM_STATUS_DIGITAL_NOT_DOWNLOADED

.

Constant ORDER_ITEM_STATUS_DIGITAL_NOT_DOWNLOADED

Source:

(static, constant) ORDER_ITEM_STATUS_GIFT_CERT_NOT_REDEEMED

Constant ORDER_ITEM_STATUS_GIFT_CERT_NOT_REDEEMED

.

Constant ORDER_ITEM_STATUS_GIFT_CERT_NOT_REDEEMED

Source:

(static, constant) ORDER_ITEM_STATUS_GIFT_CERT_REDEEMED

Constant ORDER_ITEM_STATUS_GIFT_CERT_REDEEMED

.

Constant ORDER_ITEM_STATUS_GIFT_CERT_REDEEMED

Source:

(static, constant) ORDER_ITEM_STATUS_PARTIALLY_SHIPPED

Constant ORDER_ITEM_STATUS_PARTIALLY_SHIPPED

.

Constant ORDER_ITEM_STATUS_PARTIALLY_SHIPPED

Source:

(static, constant) ORDER_ITEM_STATUS_PENDING

Constant ORDER_ITEM_STATUS_PENDING

.

Constant ORDER_ITEM_STATUS_PENDING

Source:

(static, constant) ORDER_ITEM_STATUS_PROCESSING

Constant ORDER_ITEM_STATUS_PROCESSING

.

Constant ORDER_ITEM_STATUS_PROCESSING

Source:

(static, constant) ORDER_ITEM_STATUS_RETURNED

Constant ORDER_ITEM_STATUS_RETURNED

.

Constant ORDER_ITEM_STATUS_RETURNED

Source:

(static, constant) ORDER_ITEM_STATUS_RMA_ISSUED

Constant ORDER_ITEM_STATUS_RMA_ISSUED

.

Constant ORDER_ITEM_STATUS_RMA_ISSUED

Source:

(static, constant) ORDER_ITEM_STATUS_SHIPPED

Constant ORDER_ITEM_STATUS_SHIPPED

.

Constant ORDER_ITEM_STATUS_SHIPPED

Source:

Methods

addOption(option) → {OrderItem}

Add a OrderItemOption.

Add a OrderItemOption.

Parameters:
Name Type Description
option OrderItemOption
Source:
Returns:
Type
OrderItem

getBasePrice() → {number}

Get base_price.

Get base_price.

Source:
Returns:
Type
number

getCode() → {string}

Get code.

Get code.

Source:
Returns:
Type
string

getDateInStock() → {number}

Get dt_instock.

Get dt_instock.

Source:
Returns:
Type
number

getDiscounts() → {Array.<OrderItemDiscount>}

Get discounts.

Get discounts.

Source:
Returns:
Type
Array.<OrderItemDiscount>

getLineId() → {number}

Get line_id.

Get line_id.

Source:
Returns:
Type
number

getName() → {string}

Get name.

Get name.

Source:
Returns:
Type
string

getOptions() → {Array.<OrderItemOption>}

Get options.

Get options.

Source:
Returns:
Type
Array.<OrderItemOption>

getOrderId() → {number}

Get order_id.

Get order_id.

Source:
Returns:
Type
number

getPrice() → {number}

Get price.

Get price.

Source:
Returns:
Type
number

getQuantity() → {number}

Get quantity.

Get quantity.

Source:
Returns:
Type
number

getRetail() → {number}

Get retail.

Get retail.

Source:
Returns:
Type
number

getRmaCode() → {string}

Get rma_code.

Get rma_code.

Source:
Returns:
Type
string

getRmaDataTimeIssued() → {number}

Get rma_dt_issued.

Get rma_dt_issued.

Source:
Returns:
Type
number

getRmaDateTimeReceived() → {number}

Get rma_dt_recvd.

Get rma_dt_recvd.

Source:
Returns:
Type
number

getRmaId() → {number}

Get rma_id.

Get rma_id.

Source:
Returns:
Type
number

getShipment() → {OrderShipment|*}

Get shipment.

Get shipment.

Source:
Returns:
Type
OrderShipment | *

getSku() → {string}

Get sku.

Get sku.

Source:
Returns:
Type
string

getStatus() → {number}

Get status.

Get status.

Source:
Returns:
Type
number

getSubscription() → {OrderItemSubscription|*}

Get subscription.

Get subscription.

Source:
Returns:
Type
OrderItemSubscription | *

getSubscriptionId() → {number}

Get subscrp_id.

Get subscrp_id.

Source:
Returns:
Type
number

getSubscriptionTermId() → {number}

Get subterm_id.

Get subterm_id.

Source:
Returns:
Type
number

getTaxable() → {boolean}

Get taxable.

Get taxable.

Source:
Returns:
Type
boolean

getTotal() → {number}

Get total.

Get total.

Source:
Returns:
Type
number

getTrackingNumber() → {string}

Get tracknum.

Get tracknum.

Source:
Returns:
Type
string

getTrackingType() → {string}

Get tracktype.

Get tracktype.

Source:
Returns:
Type
string

getUpsold() → {boolean}

Get upsold.

Get upsold.

Source:
Returns:
Type
boolean

getWeight() → {number}

Get weight.

Get weight.

Source:
Returns:
Type
number

setCode(code) → {OrderItem}

Set code.

Set code.

Parameters:
Name Type Description
code string
Source:
Returns:
Type
OrderItem

setName(name) → {OrderItem}

Set name.

Set name.

Parameters:
Name Type Description
name string
Source:
Returns:
Type
OrderItem

setOptions(options) → {OrderItem}

Set options.

Set options.

Parameters:
Name Type Description
options Array.<OrderItemOption>
Source:
Throws:
Error
Returns:
Type
OrderItem

setPrice(price) → {OrderItem}

Set price.

Set price.

Parameters:
Name Type Description
price number
Source:
Returns:
Type
OrderItem

setQuantity(quantity) → {OrderItem}

Set quantity.

Set quantity.

Parameters:
Name Type Description
quantity number
Source:
Returns:
Type
OrderItem

setSku(sku) → {OrderItem}

Set sku.

Set sku.

Parameters:
Name Type Description
sku string
Source:
Returns:
Type
OrderItem

setStatus(status) → {OrderItem}

Set status.

Set status.

Parameters:
Name Type Description
status number
Source:
Returns:
Type
OrderItem

setTaxable(taxable) → {OrderItem}

Set taxable.

Set taxable.

Parameters:
Name Type Description
taxable boolean
Source:
Returns:
Type
OrderItem

setTrackingNumber(trackingNumber) → {OrderItem}

Set tracknum.

Set tracknum.

Parameters:
Name Type Description
trackingNumber string
Source:
Returns:
Type
OrderItem

setTrackingType(trackingType) → {OrderItem}

Set tracktype.

Set tracktype.

Parameters:
Name Type Description
trackingType string
Source:
Returns:
Type
OrderItem

setUpsold(upsold) → {OrderItem}

Set upsold.

Set upsold.

Parameters:
Name Type Description
upsold boolean
Source:
Returns:
Type
OrderItem

setWeight(weight) → {OrderItem}

Set weight.

Set weight.

Parameters:
Name Type Description
weight number
Source:
Returns:
Type
OrderItem

toObject()

Source: