Class: OrderShipmentListUpdate

Request~OrderShipmentListUpdate(clientnullable)

Handles API Request OrderShipmentList_Update. Scope: Store.

Constructor

new OrderShipmentListUpdate(clientnullable)

OrderShipmentListUpdate Constructor.

OrderShipmentListUpdate Constructor.

Parameters:
Name Type Attributes Description
client Client <nullable>
Source:
See:

Methods

addShipmentUpdate(shipmentUpdate) → {OrderShipmentListUpdate}

Add Shipment_Updates.

Add Shipment_Updates.

Parameters:
Name Type Description
shipmentUpdate OrderShipmentUpdate
Source:
Throws:
Error
Returns:
Type
OrderShipmentListUpdate

addShipmentUpdates(shipmentUpdates) → {OrderShipmentListUpdate}

Add many OrderShipmentUpdate.

Add many OrderShipmentUpdate.

Parameters:
Name Type Description
shipmentUpdates Array.<OrderShipmentUpdate>
Source:
Throws:
Error
Returns:
Type
OrderShipmentListUpdate

createResponse() → {Response}

Create a response object from the response data.

Create a response object from the response data.

Source:
Returns:
Type
Response

getShipmentUpdates() → {Array.<OrderShipmentUpdate>}

Get Shipment_Updates.

Get Shipment_Updates.

Source:
Returns:
Type
Array.<OrderShipmentUpdate>

setShipmentUpdates(shipmentUpdates) → {OrderShipmentListUpdate}

Set Shipment_Updates.

Set Shipment_Updates.

Parameters:
Name Type Description
shipmentUpdates Array.<OrderShipmentUpdate>
Source:
Throws:
Error
Returns:
Type
OrderShipmentListUpdate

toObject() → {Object}

Reduce the request to a an object.

Reduce the request to a an object.

Source:
Returns:
Type
Object