Class: OrderItemListCancel

Request~OrderItemListCancel(clientnullable, ordernullable)

Handles API Request OrderItemList_Cancel. Scope: Store.

Constructor

new OrderItemListCancel(clientnullable, ordernullable)

OrderItemListCancel Constructor.

OrderItemListCancel Constructor.

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

Methods

addLineId(lineId) → {OrderItemListCancel}

Add Line_IDs.

Add Line_IDs.

Parameters:
Name Type Description
lineId number
Source:
Returns:
Type
OrderItemListCancel

addOrderItem(orderItem) → {OrderItemListCancel}

Add OrderItem model.

Add OrderItem model.

Parameters:
Name Type Description
orderItem OrderItem
Source:
Throws:
Error
Returns:
Type
OrderItemListCancel

createResponse() → {Response}

Create a response object from the response data.

Create a response object from the response data.

Source:
Returns:
Type
Response

getLineIds() → {Array}

Get Line_IDs.

Get Line_IDs.

Source:
Returns:
Type
Array

getOrderId() → {number}

Get Order_ID.

Get Order_ID.

Source:
Returns:
Type
number

getReason() → {string}

Get Reason.

Get Reason.

Source:
Returns:
Type
string

setOrderId(orderId) → {OrderItemListCancel}

Set Order_ID.

Set Order_ID.

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

setReason(reason) → {OrderItemListCancel}

Set Reason.

Set Reason.

Parameters:
Name Type Description
reason string
Source:
Returns:
Type
OrderItemListCancel

toObject() → {Object}

Reduce the request to a an object.

Reduce the request to a an object.

Source:
Returns:
Type
Object