.. rst-class:: phpdoctorst .. role:: php(code) :language: php Shipment ======== .. php:namespace:: Firstred\PostNL\Entity .. php:class:: Shipment :Parent: :php:class:`Firstred\\PostNL\\Entity\\AbstractEntity` Summary ------- Methods ~~~~~~~ * :php:meth:`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\)` * :php:meth:`public getAddresses\(\)` * :php:meth:`public setAddresses\($Addresses\)` * :php:meth:`public getAmounts\(\)` * :php:meth:`public setAmounts\($Amounts\)` * :php:meth:`public getBarcode\(\)` * :php:meth:`public setBarcode\($Barcode\)` * :php:meth:`public getContacts\(\)` * :php:meth:`public setContacts\($Contacts\)` * :php:meth:`public getContent\(\)` * :php:meth:`public setContent\($Content\)` * :php:meth:`public getCostCenter\(\)` * :php:meth:`public setCostCenter\($CostCenter\)` * :php:meth:`public getCustomerOrderNumber\(\)` * :php:meth:`public setCustomerOrderNumber\($CustomerOrderNumber\)` * :php:meth:`public getCustomer\(\)` * :php:meth:`public setCustomer\($Customer\)` * :php:meth:`public getCustoms\(\)` * :php:meth:`public setCustoms\($Customs\)` * :php:meth:`public getStatusCode\(\)` * :php:meth:`public setStatusCode\($StatusCode\)` * :php:meth:`public getPhaseCode\(\)` * :php:meth:`public setPhaseCode\($PhaseCode\)` * :php:meth:`public getDateFrom\(\)` * :php:meth:`public setDateFrom\($DateFrom\)` * :php:meth:`public getDateTo\(\)` * :php:meth:`public setDateTo\($DateTo\)` * :php:meth:`public getDeliveryAddress\(\)` * :php:meth:`public setDeliveryAddress\($DeliveryAddress\)` * :php:meth:`public getDimension\(\)` * :php:meth:`public setDimension\($Dimension\)` * :php:meth:`public getDownPartnerBarcode\(\)` * :php:meth:`public setDownPartnerBarcode\($DownPartnerBarcode\)` * :php:meth:`public getDownPartnerID\(\)` * :php:meth:`public setDownPartnerID\($DownPartnerID\)` * :php:meth:`public getDownPartnerLocation\(\)` * :php:meth:`public setDownPartnerLocation\($DownPartnerLocation\)` * :php:meth:`public getEvents\(\)` * :php:meth:`public setEvents\($Events\)` * :php:meth:`public getGroups\(\)` * :php:meth:`public setGroups\($Groups\)` * :php:meth:`public getIDExpiration\(\)` * :php:meth:`public setIDExpiration\($IDExpiration\)` * :php:meth:`public getIDNumber\(\)` * :php:meth:`public setIDNumber\($IDNumber\)` * :php:meth:`public getIDType\(\)` * :php:meth:`public setIDType\($IDType\)` * :php:meth:`public getOldStatuses\(\)` * :php:meth:`public setOldStatuses\($OldStatuses\)` * :php:meth:`public getProductCodeCollect\(\)` * :php:meth:`public setProductCodeCollect\($ProductCodeCollect\)` * :php:meth:`public getProductCodeDelivery\(\)` * :php:meth:`public setProductCodeDelivery\($ProductCodeDelivery\)` * :php:meth:`public getProductOptions\(\)` * :php:meth:`public setProductOptions\($ProductOptions\)` * :php:meth:`public getReceiverDateOfBirth\(\)` * :php:meth:`public setReceiverDateOfBirth\($ReceiverDateOfBirth\)` * :php:meth:`public getReference\(\)` * :php:meth:`public setReference\($Reference\)` * :php:meth:`public getReferenceCollect\(\)` * :php:meth:`public setReferenceCollect\($ReferenceCollect\)` * :php:meth:`public getRemark\(\)` * :php:meth:`public setRemark\($Remark\)` * :php:meth:`public getReturnBarcode\(\)` * :php:meth:`public setReturnBarcode\($ReturnBarcode\)` * :php:meth:`public getReturnReference\(\)` * :php:meth:`public setReturnReference\($ReturnReference\)` * :php:meth:`public getCollectionTimeStampEnd\(\)` * :php:meth:`public getCollectionTimeStampStart\(\)` * :php:meth:`public getDeliveryTimeStampStart\(\)` * :php:meth:`public getDeliveryTimeStampEnd\(\)` * :php:meth:`public getDeliveryDate\(\)` * :php:meth:`public setCollectionTimeStampStart\($CollectionTimeStampStart\)` * :php:meth:`public setCollectionTimeStampEnd\($CollectionTimeStampEnd\)` * :php:meth:`public setDeliveryTimeStampStart\($DeliveryTimeStampStart\)` * :php:meth:`public setDeliveryTimeStampEnd\($DeliveryTimeStampEnd\)` * :php:meth:`public setDeliveryDate\($DeliveryDate\)` Properties ---------- .. php:attr:: protected static Addresses :Type: :any:`\\Firstred\\PostNL\\Entity\\Address\[\] ` | null .. php:attr:: protected static Amounts :Type: :any:`\\Firstred\\PostNL\\Entity\\Amount\[\] ` | null .. php:attr:: protected static Barcode :Type: string | null .. php:attr:: protected static CollectionTimeStampEnd :Type: :any:`\\DateTimeInterface ` | null .. php:attr:: protected static CollectionTimeStampStart :Type: :any:`\\DateTimeInterface ` | null .. php:attr:: protected static Contacts :Type: :any:`\\Firstred\\PostNL\\Entity\\Contact\[\] ` | null .. php:attr:: protected static Content :Type: string | null .. php:attr:: protected static CostCenter :Type: string | null .. php:attr:: protected static CustomerOrderNumber :Type: string | null .. php:attr:: protected static Customer :Type: :any:`\\Firstred\\PostNL\\Entity\\Customer ` | null .. php:attr:: protected static Customs :Type: :any:`\\Firstred\\PostNL\\Entity\\Customs ` | null .. php:attr:: protected static StatusCode :Type: string | null .. php:attr:: protected static PhaseCode :Type: int | null .. php:attr:: protected static DateFrom :Type: :any:`\\DateTimeInterface ` | null .. php:attr:: protected static DateTo :Type: :any:`\\DateTimeInterface ` | null .. php:attr:: protected static DeliveryAddress :Type: string | null .. php:attr:: protected static DeliveryTimeStampStart :Type: :any:`\\DateTimeInterface ` | null .. php:attr:: protected static DeliveryTimeStampEnd :Type: :any:`\\DateTimeInterface ` | null .. php:attr:: protected static DeliveryDate :Type: :any:`\\DateTimeInterface ` | null .. php:attr:: protected static Dimension :Type: :any:`\\Firstred\\PostNL\\Entity\\Dimension ` | null .. php:attr:: protected static DownPartnerBarcode :Type: string | null .. php:attr:: protected static DownPartnerID :Type: string | null .. php:attr:: protected static DownPartnerLocation :Type: string | null .. php:attr:: protected static Events :Type: :any:`\\Firstred\\PostNL\\Entity\\Event\[\] ` | null .. php:attr:: protected static Groups :Type: :any:`\\Firstred\\PostNL\\Entity\\Group\[\] ` | null .. php:attr:: protected static IDExpiration :Type: string | null .. php:attr:: protected static IDNumber :Type: string | null .. php:attr:: protected static IDType :Type: string | null .. php:attr:: protected static OldStatuses :Type: string | null .. php:attr:: protected static ProductCodeCollect :Type: string | null .. php:attr:: protected static ProductCodeDelivery :Type: string | null .. php:attr:: protected static ProductOptions :Type: :any:`\\Firstred\\PostNL\\Entity\\ProductOption\[\] ` | null .. php:attr:: protected static ReceiverDateOfBirth :Type: string | null .. php:attr:: protected static Reference :Type: string | null .. php:attr:: protected static ReferenceCollect :Type: string | null .. php:attr:: protected static Remark :Type: string | null .. php:attr:: protected static ReturnBarcode :Type: string | null .. php:attr:: protected static ReturnReference :Type: string | null Methods ------- .. rst-class:: public .. php:method:: public __construct( $Addresses=null, $Amounts=null, $Barcode=null, $Contacts=null, $Content=null, string|\\DateTimeInterface|null $CollectionTimeStampEnd=null, string|\\DateTimeInterface|null $CollectionTimeStampStart=null, $CostCenter=null, $Customer=null, $CustomerOrderNumber=null, $Customs=null, $DeliveryAddress=null, string|\\DateTimeInterface|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, string|\\DateTimeInterface|null $DeliveryTimeStampStart=null, string|\\DateTimeInterface|null $DeliveryTimeStampEnd=null) :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` .. rst-class:: public .. php:method:: public getAddresses() :Returns: :any:`\\Firstred\\PostNL\\Entity\\Address\[\] ` | null .. rst-class:: public .. php:method:: public setAddresses( $Addresses) :Parameters: * **$Addresses** (:any:`Firstred\\PostNL\\Entity\\Address\[\] ` | null) :Returns: static .. rst-class:: public .. php:method:: public getAmounts() :Returns: :any:`\\Firstred\\PostNL\\Entity\\Amount\[\] ` | null .. rst-class:: public .. php:method:: public setAmounts( $Amounts) :Parameters: * **$Amounts** (:any:`Firstred\\PostNL\\Entity\\Amount\[\] ` | null) :Returns: static .. rst-class:: public .. php:method:: public getBarcode() :Returns: string | null .. rst-class:: public .. php:method:: public setBarcode( $Barcode) :Parameters: * **$Barcode** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getContacts() :Returns: :any:`\\Firstred\\PostNL\\Entity\\Contact ` | null .. rst-class:: public .. php:method:: public setContacts( $Contacts) :Parameters: * **$Contacts** (array | null) :Returns: static .. rst-class:: public .. php:method:: public getContent() :Returns: string | null .. rst-class:: public .. php:method:: public setContent( $Content) :Parameters: * **$Content** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getCostCenter() :Returns: string | null .. rst-class:: public .. php:method:: public setCostCenter( $CostCenter) :Parameters: * **$CostCenter** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getCustomerOrderNumber() :Returns: string | null .. rst-class:: public .. php:method:: public setCustomerOrderNumber( $CustomerOrderNumber) :Parameters: * **$CustomerOrderNumber** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getCustomer() :Returns: :any:`\\Firstred\\PostNL\\Entity\\Customer ` | null .. rst-class:: public .. php:method:: public setCustomer( $Customer) :Parameters: * **$Customer** (:any:`Firstred\\PostNL\\Entity\\Customer ` | null) :Returns: static .. rst-class:: public .. php:method:: public getCustoms() :Returns: :any:`\\Firstred\\PostNL\\Entity\\Customs ` | null .. rst-class:: public .. php:method:: public setCustoms( $Customs) :Parameters: * **$Customs** (:any:`Firstred\\PostNL\\Entity\\Customs ` | null) :Returns: static .. rst-class:: public .. php:method:: public getStatusCode() :Returns: string | null .. rst-class:: public .. php:method:: public setStatusCode( $StatusCode) :Parameters: * **$StatusCode** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getPhaseCode() :Returns: int | null .. rst-class:: public .. php:method:: public setPhaseCode( $PhaseCode) :Parameters: * **$PhaseCode** (int | null) :Returns: static .. rst-class:: public .. php:method:: public getDateFrom() :Returns: :any:`\\DateTimeInterface ` | null .. rst-class:: public .. php:method:: public setDateFrom( $DateFrom) :Parameters: * **$DateFrom** (:any:`DateTimeInterface ` | null) :Returns: static .. rst-class:: public .. php:method:: public getDateTo() :Returns: :any:`\\DateTimeInterface ` | null .. rst-class:: public .. php:method:: public setDateTo( $DateTo) :Parameters: * **$DateTo** (:any:`DateTimeInterface ` | null) :Returns: static .. rst-class:: public .. php:method:: public getDeliveryAddress() :Returns: string | null .. rst-class:: public .. php:method:: public setDeliveryAddress( $DeliveryAddress) :Parameters: * **$DeliveryAddress** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getDimension() :Returns: :any:`\\Firstred\\PostNL\\Entity\\Dimension ` | null .. rst-class:: public .. php:method:: public setDimension( $Dimension) :Parameters: * **$Dimension** (:any:`Firstred\\PostNL\\Entity\\Dimension ` | null) :Returns: static .. rst-class:: public .. php:method:: public getDownPartnerBarcode() :Returns: string | null .. rst-class:: public .. php:method:: public setDownPartnerBarcode( $DownPartnerBarcode) :Parameters: * **$DownPartnerBarcode** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getDownPartnerID() :Returns: string | null .. rst-class:: public .. php:method:: public setDownPartnerID( $DownPartnerID) :Parameters: * **$DownPartnerID** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getDownPartnerLocation() :Returns: string | null .. rst-class:: public .. php:method:: public setDownPartnerLocation( $DownPartnerLocation) :Parameters: * **$DownPartnerLocation** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getEvents() :Returns: :any:`\\Firstred\\PostNL\\Entity\\Event\[\] ` | null .. rst-class:: public .. php:method:: public setEvents( $Events) :Parameters: * **$Events** (:any:`Firstred\\PostNL\\Entity\\Event\[\] ` | null) :Returns: static .. rst-class:: public .. php:method:: public getGroups() :Returns: :any:`\\Firstred\\PostNL\\Entity\\Group\[\] ` | null .. rst-class:: public .. php:method:: public setGroups( $Groups) :Parameters: * **$Groups** (:any:`Firstred\\PostNL\\Entity\\Group\[\] ` | null) :Returns: static .. rst-class:: public .. php:method:: public getIDExpiration() :Returns: string | null .. rst-class:: public .. php:method:: public setIDExpiration( $IDExpiration) :Parameters: * **$IDExpiration** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getIDNumber() :Returns: string | null .. rst-class:: public .. php:method:: public setIDNumber( $IDNumber) :Parameters: * **$IDNumber** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getIDType() :Returns: string | null .. rst-class:: public .. php:method:: public setIDType( $IDType) :Parameters: * **$IDType** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getOldStatuses() :Returns: string | null .. rst-class:: public .. php:method:: public setOldStatuses( $OldStatuses) :Parameters: * **$OldStatuses** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getProductCodeCollect() :Returns: string | null .. rst-class:: public .. php:method:: public setProductCodeCollect( $ProductCodeCollect) :Parameters: * **$ProductCodeCollect** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getProductCodeDelivery() :Returns: string | null .. rst-class:: public .. php:method:: public setProductCodeDelivery( $ProductCodeDelivery) :Parameters: * **$ProductCodeDelivery** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getProductOptions() :Returns: :any:`\\Firstred\\PostNL\\Entity\\ProductOption\[\] ` | null .. rst-class:: public .. php:method:: public setProductOptions( $ProductOptions) :Parameters: * **$ProductOptions** (:any:`Firstred\\PostNL\\Entity\\ProductOption\[\] ` | null) :Returns: static .. rst-class:: public .. php:method:: public getReceiverDateOfBirth() :Returns: string | null .. rst-class:: public .. php:method:: public setReceiverDateOfBirth( $ReceiverDateOfBirth) :Parameters: * **$ReceiverDateOfBirth** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getReference() :Returns: string | null .. rst-class:: public .. php:method:: public setReference( $Reference) :Parameters: * **$Reference** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getReferenceCollect() :Returns: string | null .. rst-class:: public .. php:method:: public setReferenceCollect( $ReferenceCollect) :Parameters: * **$ReferenceCollect** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getRemark() :Returns: string | null .. rst-class:: public .. php:method:: public setRemark( $Remark) :Parameters: * **$Remark** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getReturnBarcode() :Returns: string | null .. rst-class:: public .. php:method:: public setReturnBarcode( $ReturnBarcode) :Parameters: * **$ReturnBarcode** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getReturnReference() :Returns: string | null .. rst-class:: public .. php:method:: public setReturnReference( $ReturnReference) :Parameters: * **$ReturnReference** (string | null) :Returns: static .. rst-class:: public .. php:method:: public getCollectionTimeStampEnd() :Returns: :any:`\\DateTimeInterface ` | null .. rst-class:: public .. php:method:: public getCollectionTimeStampStart() :Returns: :any:`\\DateTimeInterface ` | null .. rst-class:: public .. php:method:: public getDeliveryTimeStampStart() :Returns: :any:`\\DateTimeInterface ` | null .. rst-class:: public .. php:method:: public getDeliveryTimeStampEnd() :Returns: :any:`\\DateTimeInterface ` | null .. rst-class:: public .. php:method:: public getDeliveryDate() :Returns: :any:`\\DateTimeInterface ` | null .. rst-class:: public .. php:method:: public setCollectionTimeStampStart(string|\\DateTimeInterface|null $CollectionTimeStampStart=null) :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public setCollectionTimeStampEnd(string|\\DateTimeInterface|null $CollectionTimeStampEnd=null) :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public setDeliveryTimeStampStart(string|\\DateTimeInterface|null $DeliveryTimeStampStart=null) :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public setDeliveryTimeStampEnd(string|\\DateTimeInterface|null $DeliveryTimeStampEnd=null) :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Since: 1.2.0 .. rst-class:: public .. php:method:: public setDeliveryDate(string|\\DateTimeInterface|null $DeliveryDate=null) :Throws: :any:`\\Firstred\\PostNL\\Exception\\InvalidArgumentException ` :Since: 1.2.0