API Documentation
\
MerchantAPI
Http
ListQuery
Model
MultiCall
Request
Response

\MerchantAPI\ModelOrderShipment

Data model for OrderShipment.

Summary

Methods
Properties
Constants
__construct()
setField()
getField()
hasField()
removeField()
getData()
hasData()
getId()
getCode()
getBatchId()
getOrderId()
getStatus()
getLabelCount()
getShipDate()
getTrackingNumber()
getTrackingType()
getTrackingLink()
getWeight()
getCost()
getFormattedCost()
setId()
setCode()
setBatchId()
setOrderId()
setStatus()
setLabelCount()
setShipDate()
setTrackingNumber()
setTrackingType()
setTrackingLink()
setWeight()
setCost()
No public properties found
ORDER_SHIPMENT_STATUS_PENDING
ORDER_SHIPMENT_STATUS_PICKING
ORDER_SHIPMENT_STATUS_SHIPPED
No protected methods found
$data
N/A
No private methods found
No private properties found
N/A

Constants

ORDER_SHIPMENT_STATUS_PENDING

ORDER_SHIPMENT_STATUS_PENDING

ORDER_SHIPMENT_STATUS_PICKING

ORDER_SHIPMENT_STATUS_PICKING

ORDER_SHIPMENT_STATUS_SHIPPED

ORDER_SHIPMENT_STATUS_SHIPPED

Properties

$data

$data : array

Type

array

Methods

__construct()

__construct(array  $data = array())

Constructor.

Parameters

array $data
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

setField()

setField(  $key,   $value) : $this

Set a a data value by key.

Parameters

$key
$value
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

getField()

getField(  $key,   $defaultValue = null) : mixed

Get a data value by key.

Parameters

$key
$defaultValue
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

mixed

hasField()

hasField(  $key) : boolean

Check if the data has a field by key.

Parameters

$key
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

boolean

removeField()

removeField(  $key) : $this

Remove a data value by key.

Parameters

$key
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

getData()

getData() : array

Get the data array.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

array

hasData()

hasData() : boolean

Check if data array is populated with anything.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

boolean

getId()

getId() : integer

Get id.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

integer

getCode()

getCode() : string

Get code.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

string

getBatchId()

getBatchId() : integer

Get batch_id.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

integer

getOrderId()

getOrderId() : integer

Get order_id.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

integer

getStatus()

getStatus() : integer

Get status.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

integer

getLabelCount()

getLabelCount() : integer

Get labelcount.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

integer

getShipDate()

getShipDate() : integer

Get ship_date.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

integer

getTrackingNumber()

getTrackingNumber() : string

Get tracknum.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

string

getTrackingType()

getTrackingType() : string

Get tracktype.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

string

getTrackingLink()

getTrackingLink() : string

Get tracklink.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

string

getWeight()

getWeight() : float

Get weight.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

float

getCost()

getCost() : float

Get cost.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

float

getFormattedCost()

getFormattedCost() : string

Get formatted_cost.

Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

string

setId()

setId(  $id) : $this

Set id.

Parameters

$id
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setCode()

setCode(  $code) : $this

Set code.

Parameters

$code
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setBatchId()

setBatchId(  $batchId) : $this

Set batch_id.

Parameters

$batchId
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setOrderId()

setOrderId(  $orderId) : $this

Set order_id.

Parameters

$orderId
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setStatus()

setStatus(  $status) : $this

Set status.

Parameters

$status
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setLabelCount()

setLabelCount(  $labelCount) : $this

Set labelcount.

Parameters

$labelCount
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setShipDate()

setShipDate(  $shipDate) : $this

Set ship_date.

Parameters

$shipDate
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setTrackingNumber()

setTrackingNumber(  $trackingNumber) : $this

Set tracknum.

Parameters

$trackingNumber
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setTrackingType()

setTrackingType(  $trackingType) : $this

Set tracktype.

Parameters

$trackingType
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setTrackingLink()

setTrackingLink(  $trackingLink) : $this

Set tracklink.

Parameters

$trackingLink
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setWeight()

setWeight(  $weight) : $this

Set weight.

Parameters

$weight
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this

setCost()

setCost(  $cost) : $this

Set cost.

Parameters

$cost
Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293 Warning: count(): Parameter must be an array or an object that implements Countable in phar:///Users/gidriss/miva/tools/api-sdk/sdk-tools/phpDocumentor.phar/vendor/twig/twig/lib/Twig/Extension/Core.php on line 1293

Returns

$this