JSDoc: Class: OrderShipment

Class: OrderShipment

Model~OrderShipment(data) → {void}

OrderShipment data model.

Constructor

new OrderShipment(data) → {void}

OrderShipment Constructor.

Parameters:

Name	Type	Description
`data`	Object

Source:

models.js, line 4627

Returns:

Type: void

Members

(static, constant) ORDER_SHIPMENT_STATUS_PENDING

Constant ORDER_SHIPMENT_STATUS_PENDING

Source:

models.js, line 4637

(static, constant) ORDER_SHIPMENT_STATUS_PICKING

Constant ORDER_SHIPMENT_STATUS_PICKING

Source:

models.js, line 4647

(static, constant) ORDER_SHIPMENT_STATUS_SHIPPED

Constant ORDER_SHIPMENT_STATUS_SHIPPED

Source:

models.js, line 4657

Methods

getBatchId() → {number}

Get batch_id.

Source:

models.js, line 4681

Returns:

Type: number

getCode() → {string}

Get code.

Source:

models.js, line 4673

Returns:

Type: string

getCost() → {number}

Get cost.

Source:

models.js, line 4753

Returns:

Type: number

getFormattedCost() → {string}

Get formatted_cost.

Source:

models.js, line 4761

Returns:

Type: string

getId() → {number}

Get id.

Source:

models.js, line 4665

Returns:

Type: number

getLabelCount() → {number}

Get labelcount.

Source:

models.js, line 4705

Returns:

Type: number

getOrderId() → {number}

Get order_id.

Source:

models.js, line 4689

Returns:

Type: number

getShipDate() → {number}

Get ship_date.

Source:

models.js, line 4713

Returns:

Type: number

getStatus() → {number}

Get status.

Source:

models.js, line 4697

Returns:

Type: number

getTrackingLink() → {string}

Get tracklink.

Source:

models.js, line 4737

Returns:

Type: string

getTrackingNumber() → {string}

Get tracknum.

Source:

models.js, line 4721

Returns:

Type: string

getTrackingType() → {string}

Get tracktype.

Source:

models.js, line 4729

Returns:

Type: string

getWeight() → {number}

Get weight.

Source:

models.js, line 4745

Returns:

Type: number

setBatchId(batchId) → {OrderShipment}

Set batch_id.

Parameters:

Name	Type	Description
`batchId`	number

Source:

models.js, line 4788

Returns:

Type: OrderShipment

setCode(code) → {OrderShipment}

Set code.

Parameters:

Name	Type	Description
`code`	string

Source:

models.js, line 4779

Returns:

Type: OrderShipment

setCost(cost) → {OrderShipment}

Set cost.

Parameters:

Name	Type	Description
`cost`	number

Source:

models.js, line 4869

Returns:

Type: OrderShipment

setId(id) → {OrderShipment}

Set id.

Parameters:

Name	Type	Description
`id`	number

Source:

models.js, line 4770

Returns:

Type: OrderShipment

setLabelCount(labelCount) → {OrderShipment}

Set labelcount.

Parameters:

Name	Type	Description
`labelCount`	number

Source:

models.js, line 4815

Returns:

Type: OrderShipment

setOrderId(orderId) → {OrderShipment}

Set order_id.

Parameters:

Name	Type	Description
`orderId`	number

Source:

models.js, line 4797

Returns:

Type: OrderShipment

setShipDate(shipDate) → {OrderShipment}

Set ship_date.

Parameters:

Name	Type	Description
`shipDate`	number

Source:

models.js, line 4824

Returns:

Type: OrderShipment

setStatus(status) → {OrderShipment}

Set status.

Parameters:

Name	Type	Description
`status`	number

Source:

models.js, line 4806

Returns:

Type: OrderShipment

setTrackingLink(trackingLink) → {OrderShipment}

Set tracklink.

Parameters:

Name	Type	Description
`trackingLink`	string

Source:

models.js, line 4851

Returns:

Type: OrderShipment

setTrackingNumber(trackingNumber) → {OrderShipment}

Set tracknum.

Parameters:

Name	Type	Description
`trackingNumber`	string

Source:

models.js, line 4833

Returns:

Type: OrderShipment

setTrackingType(trackingType) → {OrderShipment}

Set tracktype.

Parameters:

Name	Type	Description
`trackingType`	string

Source:

models.js, line 4842

Returns:

Type: OrderShipment

setWeight(weight) → {OrderShipment}

Set weight.

Parameters:

Name	Type	Description
`weight`	number

Source:

models.js, line 4860

Returns:

Type: OrderShipment