Constructor
new OrderItem(data) → {void}
OrderItem Constructor.
OrderItem Constructor.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object |
Returns:
- Type
- void
Members
(static, constant) ORDER_ITEM_STATUS_BACKORDERED
Constant ORDER_ITEM_STATUS_BACKORDERED
.Constant ORDER_ITEM_STATUS_BACKORDERED
(static, constant) ORDER_ITEM_STATUS_CANCELLED
Constant ORDER_ITEM_STATUS_CANCELLED
.Constant ORDER_ITEM_STATUS_CANCELLED
(static, constant) ORDER_ITEM_STATUS_DIGITAL_DOWNLOADED
Constant ORDER_ITEM_STATUS_DIGITAL_DOWNLOADED
.Constant ORDER_ITEM_STATUS_DIGITAL_DOWNLOADED
(static, constant) ORDER_ITEM_STATUS_DIGITAL_NOT_DOWNLOADED
Constant ORDER_ITEM_STATUS_DIGITAL_NOT_DOWNLOADED
.Constant ORDER_ITEM_STATUS_DIGITAL_NOT_DOWNLOADED
(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
(static, constant) ORDER_ITEM_STATUS_GIFT_CERT_REDEEMED
Constant ORDER_ITEM_STATUS_GIFT_CERT_REDEEMED
.Constant ORDER_ITEM_STATUS_GIFT_CERT_REDEEMED
(static, constant) ORDER_ITEM_STATUS_PARTIALLY_SHIPPED
Constant ORDER_ITEM_STATUS_PARTIALLY_SHIPPED
.Constant ORDER_ITEM_STATUS_PARTIALLY_SHIPPED
(static, constant) ORDER_ITEM_STATUS_PENDING
Constant ORDER_ITEM_STATUS_PENDING
.Constant ORDER_ITEM_STATUS_PENDING
(static, constant) ORDER_ITEM_STATUS_PROCESSING
Constant ORDER_ITEM_STATUS_PROCESSING
.Constant ORDER_ITEM_STATUS_PROCESSING
(static, constant) ORDER_ITEM_STATUS_RETURNED
Constant ORDER_ITEM_STATUS_RETURNED
.Constant ORDER_ITEM_STATUS_RETURNED
(static, constant) ORDER_ITEM_STATUS_RMA_ISSUED
Constant ORDER_ITEM_STATUS_RMA_ISSUED
.Constant ORDER_ITEM_STATUS_RMA_ISSUED
(static, constant) ORDER_ITEM_STATUS_SHIPPED
Constant ORDER_ITEM_STATUS_SHIPPED
.Constant ORDER_ITEM_STATUS_SHIPPED
Methods
addOption(option) → {OrderItem}
Add a OrderItemOption.
Add a OrderItemOption.
Parameters:
| Name | Type | Description |
|---|---|---|
option |
OrderItemOption |
Returns:
- Type
- OrderItem
getBasePrice() → {number}
Get base_price.
Get base_price.
Returns:
- Type
- number
getCode() → {string}
Get code.
Get code.
Returns:
- Type
- string
getDateInStock() → {number}
Get dt_instock.
Get dt_instock.
Returns:
- Type
- number
getDiscounts() → {Array.<OrderItemDiscount>}
Get discounts.
Get discounts.
Returns:
- Type
- Array.<OrderItemDiscount>
getLineId() → {number}
Get line_id.
Get line_id.
Returns:
- Type
- number
getName() → {string}
Get name.
Get name.
Returns:
- Type
- string
getOptions() → {Array.<OrderItemOption>}
Get options.
Get options.
Returns:
- Type
- Array.<OrderItemOption>
getOrderId() → {number}
Get order_id.
Get order_id.
Returns:
- Type
- number
getPrice() → {number}
Get price.
Get price.
Returns:
- Type
- number
getQuantity() → {number}
Get quantity.
Get quantity.
Returns:
- Type
- number
getRetail() → {number}
Get retail.
Get retail.
Returns:
- Type
- number
getRmaCode() → {string}
Get rma_code.
Get rma_code.
Returns:
- Type
- string
getRmaDataTimeIssued() → {number}
Get rma_dt_issued.
Get rma_dt_issued.
Returns:
- Type
- number
getRmaDateTimeReceived() → {number}
Get rma_dt_recvd.
Get rma_dt_recvd.
Returns:
- Type
- number
getRmaId() → {number}
Get rma_id.
Get rma_id.
Returns:
- Type
- number
getShipment() → {OrderShipment|*}
Get shipment.
Get shipment.
Returns:
- Type
- OrderShipment | *
getSku() → {string}
Get sku.
Get sku.
Returns:
- Type
- string
getStatus() → {number}
Get status.
Get status.
Returns:
- Type
- number
getSubscription() → {OrderItemSubscription|*}
Get subscription.
Get subscription.
Returns:
- Type
- OrderItemSubscription | *
getSubscriptionId() → {number}
Get subscrp_id.
Get subscrp_id.
Returns:
- Type
- number
getSubscriptionTermId() → {number}
Get subterm_id.
Get subterm_id.
Returns:
- Type
- number
getTaxable() → {boolean}
Get taxable.
Get taxable.
Returns:
- Type
- boolean
getTotal() → {number}
Get total.
Get total.
Returns:
- Type
- number
getTrackingNumber() → {string}
Get tracknum.
Get tracknum.
Returns:
- Type
- string
getTrackingType() → {string}
Get tracktype.
Get tracktype.
Returns:
- Type
- string
getUpsold() → {boolean}
Get upsold.
Get upsold.
Returns:
- Type
- boolean
getWeight() → {number}
Get weight.
Get weight.
Returns:
- Type
- number
setCode(code) → {OrderItem}
Set code.
Set code.
Parameters:
| Name | Type | Description |
|---|---|---|
code |
string |
Returns:
- Type
- OrderItem
setName(name) → {OrderItem}
Set name.
Set name.
Parameters:
| Name | Type | Description |
|---|---|---|
name |
string |
Returns:
- Type
- OrderItem
setOptions(options) → {OrderItem}
Set options.
Set options.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
Array.<OrderItemOption> |
Throws:
Returns:
- Type
- OrderItem
setPrice(price) → {OrderItem}
Set price.
Set price.
Parameters:
| Name | Type | Description |
|---|---|---|
price |
number |
Returns:
- Type
- OrderItem
setQuantity(quantity) → {OrderItem}
Set quantity.
Set quantity.
Parameters:
| Name | Type | Description |
|---|---|---|
quantity |
number |
Returns:
- Type
- OrderItem
setSku(sku) → {OrderItem}
Set sku.
Set sku.
Parameters:
| Name | Type | Description |
|---|---|---|
sku |
string |
Returns:
- Type
- OrderItem
setStatus(status) → {OrderItem}
Set status.
Set status.
Parameters:
| Name | Type | Description |
|---|---|---|
status |
number |
Returns:
- Type
- OrderItem
setTaxable(taxable) → {OrderItem}
Set taxable.
Set taxable.
Parameters:
| Name | Type | Description |
|---|---|---|
taxable |
boolean |
Returns:
- Type
- OrderItem
setTrackingNumber(trackingNumber) → {OrderItem}
Set tracknum.
Set tracknum.
Parameters:
| Name | Type | Description |
|---|---|---|
trackingNumber |
string |
Returns:
- Type
- OrderItem
setTrackingType(trackingType) → {OrderItem}
Set tracktype.
Set tracktype.
Parameters:
| Name | Type | Description |
|---|---|---|
trackingType |
string |
Returns:
- Type
- OrderItem
setUpsold(upsold) → {OrderItem}
Set upsold.
Set upsold.
Parameters:
| Name | Type | Description |
|---|---|---|
upsold |
boolean |
Returns:
- Type
- OrderItem
setWeight(weight) → {OrderItem}
Set weight.
Set weight.
Parameters:
| Name | Type | Description |
|---|---|---|
weight |
number |
Returns:
- Type
- OrderItem