Shipment

class Firstred\PostNL\Entity\Shipment
Parent:

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

Properties

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

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, 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:

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Shipment::getAddresses()
Returns:

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

public Firstred\PostNL\Entity\Shipment::setAddresses($Addresses)
Parameters:
Returns:

static

public Firstred\PostNL\Entity\Shipment::getAmounts()
Returns:

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

public Firstred\PostNL\Entity\Shipment::setAmounts($Amounts)
Parameters:
Returns:

static

public Firstred\PostNL\Entity\Shipment::getBarcode()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setBarcode($Barcode)
Parameters:
  • $Barcode (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getContacts()
Returns:

\Firstred\PostNL\Entity\Contact | null

public Firstred\PostNL\Entity\Shipment::setContacts($Contacts)
Parameters:
  • $Contacts (array | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getContent()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setContent($Content)
Parameters:
  • $Content (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getCostCenter()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setCostCenter($CostCenter)
Parameters:
  • $CostCenter (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getCustomerOrderNumber()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setCustomerOrderNumber($CustomerOrderNumber)
Parameters:
  • $CustomerOrderNumber (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getCustomer()
Returns:

\Firstred\PostNL\Entity\Customer | null

public Firstred\PostNL\Entity\Shipment::setCustomer($Customer)
Parameters:
Returns:

static

public Firstred\PostNL\Entity\Shipment::getCustoms()
Returns:

\Firstred\PostNL\Entity\Customs | null

public Firstred\PostNL\Entity\Shipment::setCustoms($Customs)
Parameters:
Returns:

static

public Firstred\PostNL\Entity\Shipment::getStatusCode()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setStatusCode($StatusCode)
Parameters:
  • $StatusCode (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getPhaseCode()
Returns:

int | null

public Firstred\PostNL\Entity\Shipment::setPhaseCode($PhaseCode)
Parameters:
  • $PhaseCode (int | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getDateFrom()
Returns:

\DateTimeInterface | null

public Firstred\PostNL\Entity\Shipment::setDateFrom($DateFrom)
Parameters:
  • $DateFrom (DateTimeInterface | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getDateTo()
Returns:

\DateTimeInterface | null

public Firstred\PostNL\Entity\Shipment::setDateTo($DateTo)
Parameters:
  • $DateTo (DateTimeInterface | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getDeliveryAddress()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setDeliveryAddress($DeliveryAddress)
Parameters:
  • $DeliveryAddress (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getDimension()
Returns:

\Firstred\PostNL\Entity\Dimension | null

public Firstred\PostNL\Entity\Shipment::setDimension($Dimension)
Parameters:
Returns:

static

public Firstred\PostNL\Entity\Shipment::getDownPartnerBarcode()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setDownPartnerBarcode($DownPartnerBarcode)
Parameters:
  • $DownPartnerBarcode (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getDownPartnerID()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setDownPartnerID($DownPartnerID)
Parameters:
  • $DownPartnerID (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getDownPartnerLocation()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setDownPartnerLocation($DownPartnerLocation)
Parameters:
  • $DownPartnerLocation (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getEvents()
Returns:

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

public Firstred\PostNL\Entity\Shipment::setEvents($Events)
Parameters:
Returns:

static

public Firstred\PostNL\Entity\Shipment::getGroups()
Returns:

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

public Firstred\PostNL\Entity\Shipment::setGroups($Groups)
Parameters:
Returns:

static

public Firstred\PostNL\Entity\Shipment::getIDExpiration()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setIDExpiration($IDExpiration)
Parameters:
  • $IDExpiration (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getIDNumber()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setIDNumber($IDNumber)
Parameters:
  • $IDNumber (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getIDType()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setIDType($IDType)
Parameters:
  • $IDType (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getOldStatuses()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setOldStatuses($OldStatuses)
Parameters:
  • $OldStatuses (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getProductCodeCollect()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setProductCodeCollect($ProductCodeCollect)
Parameters:
  • $ProductCodeCollect (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getProductCodeDelivery()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setProductCodeDelivery($ProductCodeDelivery)
Parameters:
  • $ProductCodeDelivery (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getProductOptions()
Returns:

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

public Firstred\PostNL\Entity\Shipment::setProductOptions($ProductOptions)
Parameters:
Returns:

static

public Firstred\PostNL\Entity\Shipment::getReceiverDateOfBirth()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setReceiverDateOfBirth($ReceiverDateOfBirth)
Parameters:
  • $ReceiverDateOfBirth (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getReference()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setReference($Reference)
Parameters:
  • $Reference (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getReferenceCollect()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setReferenceCollect($ReferenceCollect)
Parameters:
  • $ReferenceCollect (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getRemark()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setRemark($Remark)
Parameters:
  • $Remark (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getReturnBarcode()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setReturnBarcode($ReturnBarcode)
Parameters:
  • $ReturnBarcode (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getReturnReference()
Returns:

string | null

public Firstred\PostNL\Entity\Shipment::setReturnReference($ReturnReference)
Parameters:
  • $ReturnReference (string | null)

Returns:

static

public Firstred\PostNL\Entity\Shipment::getCollectionTimeStampEnd()
Returns:

\DateTimeInterface | null

public Firstred\PostNL\Entity\Shipment::getCollectionTimeStampStart()
Returns:

\DateTimeInterface | null

public Firstred\PostNL\Entity\Shipment::getDeliveryTimeStampStart()
Returns:

\DateTimeInterface | null

public Firstred\PostNL\Entity\Shipment::getDeliveryTimeStampEnd()
Returns:

\DateTimeInterface | null

public Firstred\PostNL\Entity\Shipment::getDeliveryDate()
Returns:

\DateTimeInterface | null

public Firstred\PostNL\Entity\Shipment::setCollectionTimeStampStart(string|\\DateTimeInterface|null $CollectionTimeStampStart=null)
Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Since:

1.2.0

public Firstred\PostNL\Entity\Shipment::setCollectionTimeStampEnd(string|\\DateTimeInterface|null $CollectionTimeStampEnd=null)
Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Since:

1.2.0

public Firstred\PostNL\Entity\Shipment::setDeliveryTimeStampStart(string|\\DateTimeInterface|null $DeliveryTimeStampStart=null)
Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Since:

1.2.0

public Firstred\PostNL\Entity\Shipment::setDeliveryTimeStampEnd(string|\\DateTimeInterface|null $DeliveryTimeStampEnd=null)
Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Since:

1.2.0

public Firstred\PostNL\Entity\Shipment::setDeliveryDate(string|\\DateTimeInterface|null $DeliveryDate=null)
Throws:

\Firstred\PostNL\Exception\InvalidArgumentException

Since:

1.2.0