Shipment

class Firstred\PostNL\Entity\Shipment

Class Shipment.

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Addresses, $Amounts, $Barcode, $Contacts, $Content, $CollectionTimeStampEnd, $CollectionTimeStampStart, $CostCenter, $Customer, $CustomerOrderNumber, $Customs, $DeliveryAddress, $DeliveryDate, $Dimension, $DownPartnerBarcode, $DownPartnerID, $DownPartnerLocation, $Events, $Groups, $IDExpiration, $IDNumber, $IDType, $OldStatuses, $ProductCodeCollect, $ProductCodeDelivery, $ProductOptions, $ReceiverDateOfBirth, $Reference, $ReferenceCollect, $Remark, $ReturnBarcode, $ReturnReference, $StatusCode, $PhaseCode, $DateFrom, $DateTo, $DeliveryTimeStampStart, $DeliveryTimeStampEnd)

• public setCollectionTimeStampStart($CollectionTimeStampStart)

• public setCollectionTimeStampEnd($CollectionTimeStampEnd)

• public setDeliveryTimeStampStart($DeliveryTimeStampStart)

• public setDeliveryTimeStampEnd($DeliveryTimeStampEnd)

• public setDeliveryDate($DeliveryDate)

• public xmlSerialize($writer)

Properties

public property Firstred\PostNL\Entity\Shipment::$defaultProperties

Type

string[][]

protected static property Firstred\PostNL\Entity\Shipment::$Addresses

Type

\Firstred\PostNL\Entity\Address[] | null

protected static property Firstred\PostNL\Entity\Shipment::$Amounts

Type

\Firstred\PostNL\Entity\Amount[] | null

protected static property Firstred\PostNL\Entity\Shipment::$Barcode

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$CollectionTimeStampEnd

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Shipment::$CollectionTimeStampStart

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Shipment::$Contacts

Type

\Firstred\PostNL\Entity\Contact[] | null

protected static property Firstred\PostNL\Entity\Shipment::$Content

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$CostCenter

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$CustomerOrderNumber

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$Customer

Type

\Firstred\PostNL\Entity\Customer | null

protected static property Firstred\PostNL\Entity\Shipment::$Customs

Type

\Firstred\PostNL\Entity\Customs | null

protected static property Firstred\PostNL\Entity\Shipment::$StatusCode

Type

string |null$StatusCode

protected static property Firstred\PostNL\Entity\Shipment::$PhaseCode

Type

int | null

protected static property Firstred\PostNL\Entity\Shipment::$DateFrom

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Shipment::$DateTo

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Shipment::$DeliveryAddress

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$DeliveryTimeStampStart

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Shipment::$DeliveryTimeStampEnd

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Shipment::$DeliveryDate

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Shipment::$Dimension

Type

\Firstred\PostNL\Entity\Dimension | null

protected static property Firstred\PostNL\Entity\Shipment::$DownPartnerBarcode

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$DownPartnerID

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$DownPartnerLocation

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$Events

Type

\Firstred\PostNL\Entity\Event[] | null

protected static property Firstred\PostNL\Entity\Shipment::$Groups

Type

\Firstred\PostNL\Entity\Group[] | null

protected static property Firstred\PostNL\Entity\Shipment::$IDExpiration

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$IDNumber

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$IDType

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$OldStatuses

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$ProductCodeCollect

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$ProductCodeDelivery

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$ProductOptions

Type

\Firstred\PostNL\Entity\ProductOption[] | null

protected static property Firstred\PostNL\Entity\Shipment::$ReceiverDateOfBirth

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$Reference

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$ReferenceCollect

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$Remark

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$ReturnBarcode

Type

string | null

protected static property Firstred\PostNL\Entity\Shipment::$ReturnReference

Type

string | null

Methods

public Firstred\PostNL\Entity\Shipment::__construct($Addresses=null, $Amounts=null, $Barcode=null, $Contacts=null, $Content=null, $CollectionTimeStampEnd=null, $CollectionTimeStampStart=null, $CostCenter=null, $Customer=null, $CustomerOrderNumber=null, $Customs=null, $DeliveryAddress=null, $DeliveryDate=null, $Dimension=null, $DownPartnerBarcode=null, $DownPartnerID=null, $DownPartnerLocation=null, $Events=null, $Groups=null, $IDExpiration=null, $IDNumber=null, $IDType=null, $OldStatuses=null, $ProductCodeCollect=null, $ProductCodeDelivery=null, $ProductOptions=null, $ReceiverDateOfBirth=null, $Reference=null, $ReferenceCollect=null, $Remark=null, $ReturnBarcode=null, $ReturnReference=null, $StatusCode=null, $PhaseCode=null, $DateFrom=null, $DateTo=null, $DeliveryTimeStampStart=null, $DeliveryTimeStampEnd=null)

Shipment constructor.

Parameters

• $Addresses (Firstred\PostNL\Entity\Address[] | null)

• $Amounts (array | null)

• $Barcode (string | null)

• $Contacts (Firstred\PostNL\Entity\Contact[] | null)

• $Content (string | null)

• $CollectionTimeStampEnd (string | \DateTimeInterface | null)

• $CollectionTimeStampStart (string | \DateTimeInterface | null)

• $CostCenter (string | null)

• $Customer (Firstred\PostNL\Entity\Customer | null)

• $CustomerOrderNumber (string | null)

• $Customs (Firstred\PostNL\Entity\Customs | null)

• $DeliveryAddress (string | null)

• $DeliveryDate (string | \DateTimeInterface | null)

• $Dimension (Firstred\PostNL\Entity\Dimension | null)

• $DownPartnerBarcode (string | null)

• $DownPartnerID (string | null)

• $DownPartnerLocation (string | null)

• $Events (Firstred\PostNL\Entity\Event[] | null)

• $Groups (Firstred\PostNL\Entity\Group[] | null)

• $IDExpiration (string | null)

• $IDNumber (string | null)

• $IDType (string | null)

• $OldStatuses (array | null)

• $ProductCodeCollect (string | null)

• $ProductCodeDelivery (string | null)

• $ProductOptions (Firstred\PostNL\Entity\ProductOption[] | null)

• $ReceiverDateOfBirth (string | null)

• $Reference (string | null)

• $ReferenceCollect (string | null)

• $Remark (string | null)

• $ReturnBarcode (string | null)

• $ReturnReference (string | null)

• $StatusCode (string | null)

• $PhaseCode (int | null)

• $DateFrom (string | null)

• $DateTo (string | null)

• $DeliveryTimeStampStart (string | \DateTimeInterface | null)

• $DeliveryTimeStampEnd (string | \DateTimeInterface | null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Shipment::setCollectionTimeStampStart($CollectionTimeStampStart=null)

Parameters

• $CollectionTimeStampStart (string | \DateTimeInterface | null)

Returns

static

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Shipment::setCollectionTimeStampEnd($CollectionTimeStampEnd=null)

Parameters

• $CollectionTimeStampEnd (string | \DateTimeInterface | null)

Returns

static

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Shipment::setDeliveryTimeStampStart($DeliveryTimeStampStart=null)

Parameters

• $DeliveryTimeStampStart (string | \DateTimeInterface | null)

Returns

static

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Shipment::setDeliveryTimeStampEnd($DeliveryTimeStampEnd=null)

Parameters

• $DeliveryTimeStampEnd (string | \DateTimeInterface | null)

Returns

static

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Shipment::setDeliveryDate($DeliveryDate=null)

Parameters

• $DeliveryDate (string | \DateTimeInterface | null)

Returns

static

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Shipment::xmlSerialize($writer)

Return a serializable array for the XMLWriter.

Parameters

• $writer (Sabre\Xml\Writer)

Returns

void