Class: OrderItemAdd

Request~OrderItemAdd(clientnullable, ordernullable)

Handles API Request OrderItem_Add. Scope: Store.

Constructor

new OrderItemAdd(clientnullable, ordernullable)

OrderItemAdd Constructor.

OrderItemAdd Constructor.

Parameters:
Name Type Attributes Default Description
client Client <nullable>
order Order <nullable>
null
Source:
See:

Methods

addOption(option) → {OrderItemAdd}

Add Options.

Add Options.

Parameters:
Name Type Description
option OrderItemOption
Source:
Throws:
Error
Returns:
Type
OrderItemAdd

addOptions(options) → {OrderItemAdd}

Add many OrderItemOption.

Add many OrderItemOption.

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

createResponse() → {Response}

Create a response object from the response data.

Create a response object from the response data.

Source:
Returns:
Type
Response

getCode() → {string}

Get Code.

Get Code.

Source:
Returns:
Type
string

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

getSku() → {string}

Get Sku.

Get Sku.

Source:
Returns:
Type
string

getTaxable() → {boolean}

Get Taxable.

Get Taxable.

Source:
Returns:
Type
boolean

getWeight() → {number}

Get Weight.

Get Weight.

Source:
Returns:
Type
number

setCode(code) → {OrderItemAdd}

Set Code.

Set Code.

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

setName(name) → {OrderItemAdd}

Set Name.

Set Name.

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

setOptions(options) → {OrderItemAdd}

Set Options.

Set Options.

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

setOrderId(orderId) → {OrderItemAdd}

Set Order_ID.

Set Order_ID.

Parameters:
Name Type Description
orderId number
Source:
Returns:
Type
OrderItemAdd

setPrice(price) → {OrderItemAdd}

Set Price.

Set Price.

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

setQuantity(quantity) → {OrderItemAdd}

Set Quantity.

Set Quantity.

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

setSku(sku) → {OrderItemAdd}

Set Sku.

Set Sku.

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

setTaxable(taxable) → {OrderItemAdd}

Set Taxable.

Set Taxable.

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

setWeight(weight) → {OrderItemAdd}

Set Weight.

Set Weight.

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

toObject() → {Object}

Reduce the request to a an object.

Reduce the request to a an object.

Source:
Returns:
Type
Object