Address

class Firstred\PostNL\Entity\Address

Class Address.

Parent: Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

public __construct($AddressType, $FirstName, $Name, $CompanyName, $Street, $HouseNr, $HouseNrExt, $Zipcode, $City, $Countrycode, $Area, $BuildingName, $Department, $Doorcode, $Floor, $Region, $Remark, $StreetHouseNrExt)
public setZipcode($Zipcode)
public setAddressType($AddressType)

Properties

public property Firstred\PostNL\Entity\Address::$defaultProperties

Type: string[][]

protected static property Firstred\PostNL\Entity\Address::$AddressType

Type

string | null PostNL internal applications validate the receiver address. In case the spelling of addresses should be different according to our PostNL information, the address details will be corrected. This can be noticed in Track & Trace.

Please note that the webservice will not add address details. Street and City fields will only be printed when they are in the call towards the labeling webservice.

The element Address type is a code in the request. Possible values are:

Code Description 01 Receiver 02 Sender 03 Alternative sender address 04 Collection address (In the orders need to be collected first) 08 Return address* 09 Drop off location (for use with Pick up at PostNL location)

> * When using the ‘label in the box return label’, it is mandatory to use an > `Antwoordnummer` in AddressType 08. > This cannot be a regular address

The following rules apply: If there is no Address specified with AddressType = 02, the data from Customer/Address will be added to the list as AddressType 02. If there is no Customer/Address, the message will be rejected.

At least one other AddressType must be specified, other than AddressType 02 In most cases this will be AddressType 01, the receiver address.

protected static property Firstred\PostNL\Entity\Address::$Area

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$Buildingname

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$City

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$CompanyName

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$Countrycode

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$Department

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$Doorcode

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$FirstName

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$Floor

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$HouseNr

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$HouseNrExt

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$StreetHouseNrExt

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$Name

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$Region

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$Remark

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$Street

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$Zipcode

Type: string | null

protected static property Firstred\PostNL\Entity\Address::$other

Type: array | null Array with optional properties

Methods

public Firstred\PostNL\Entity\Address::__construct($AddressType=null, $FirstName=null, $Name=null, $CompanyName=null, $Street=null, $HouseNr=null, $HouseNrExt=null, $Zipcode=null, $City=null, $Countrycode=null, $Area=null, $BuildingName=null, $Department=null, $Doorcode=null, $Floor=null, $Region=null, $Remark=null, $StreetHouseNrExt=null)

Parameters

$AddressType (string | null)
$FirstName (string | null)
$Name (string | null)
$CompanyName (string | null)
$Street (string | null)
$HouseNr (string | null)
$HouseNrExt (string | null)
$Zipcode (string | null)
$City (string | null)
$Countrycode (string | null)
$Area (string | null)
$BuildingName (string | null)
$Department (string | null)
$Doorcode (string | null)
$Floor (string | null)
$Region (string | null)
$Remark (string | null)
$StreetHouseNrExt (string | null)

public Firstred\PostNL\Entity\Address::setZipcode($Zipcode=null)

Set postcode.

Parameters

$Zipcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::setAddressType($AddressType=null)

Set the AddressType.

Parameters

$AddressType (int | string | null)

Returns

static