PostNL PHP bindings Documentation
Transcript of PostNL PHP bindings Documentation
PostNL PHP bindings DocumentationRelease 1.2.0
Read the Docs
Jan 06, 2022
CONTENTS
1 Developer Guide 31.1 Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1.1 Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31.1.2 License . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41.1.3 Contributing . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
1.2 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.2.1 Install through Composer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51.2.2 Install the latest development build through composer . . . . . . . . . . . . . . . . . . . 6
1.3 Authentication . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.3.1 Passing all credentials . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61.3.2 Authorization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
1.4 Quickstart . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101.4.1 Requesting timeframes, locations and the delivery date at once . . . . . . . . . . . . . . 101.4.2 Creating a (merged) shipment label . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151.4.3 Tracking a shipment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 19
1.5 Delivery options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191.5.1 Checkout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201.5.2 Deliverydate webservice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201.5.3 Timeframe webservice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221.5.4 Location webservice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22
1.6 Send and track shipments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241.6.1 Barcode webservice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241.6.2 Labelling webservice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 251.6.3 Shipping webservice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 291.6.4 Confirming webservice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 331.6.5 Shippingstatus webservice . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34
1.7 Exception handling . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 371.8 Formats . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38
1.8.1 Dates, Times and DateTimes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 381.8.2 SOAP object structure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
1.9 HTTP Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391.9.1 Setting the HTTP client manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 391.9.2 Setting the HTTP client with HTTPlug . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
1.10 Caching . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 401.11 Logging . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 411.12 Advanced usage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
1.12.1 Object instantiation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 421.12.2 Building requests manually . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
1.13 Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441.13.1 Namespaces . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 441.13.2 Classes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 355
1.14 Authors . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3961.14.1 Maintainers: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3961.14.2 Contributors: . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 397
i
PHP Namespace Index 399
Index 401
ii
PostNL PHP bindings Documentation, Release 1.2.0
These PHP API bindings aim to make it easier to connect to PostNL’s CIF API, used for displaying delivery options,printing shipment labels and retrieving actual shipment statuses.
• The goal is to have a simple interface for connecting with either the SOAP or REST API, while still beingable to follow the official API documentation.
• Abstracts away direct requests to the API, allowing you to focus on the code itself. The object structure isbased on the SOAP API .
• Can merge PDF labels (both A6 and A4) and automatically handles concurrent requests when necessary,making batch processing a lot easier.
• Follows PHP standards, some of them are:
– PSR-7 interfaces for requests and responses. Build and process functions are pro-vided for every service so you can create your own mix of batch requests. See theFirstred\PostNL\PostNL::getTimeframesAndNearestLocations method for an example.
– PSR-6 caching, so you can use your favorite cache for caching API responses. Chapter Caching.
– PSR-3 logging. You can log the requests and responses for debugging purposes. More info on the pageLogging.
– PSR-18 HTTP Clients or HTTPlug clients.
• Framework agnostic. You can use this library with any framework.
• A custom HTTP client interface so you can use the HTTP client of your choice. Using the Guzzle or SymfonyHTTP client is strongly recommended. Any HTTPlug client can be used by installing the related packages.See the HTTP Client chapter for more information.
$postnl = new PostNL(...);$timeframes = $postnl->getTimeframes(
(new GetTimeframes())->setTimeframe([Timeframe::create([
'CountryCode' => 'NL','StartDate' => date('d-m-Y', strtotime('+1 day')),'EndDate' => date('d-m-Y', strtotime('+14 days')),'HouseNr' => 42,'PostalCode' => '2132WT','SundaySorting' => true,'Options' => ['Daytime', 'Evening'],
])]));var_dump($timeframes);
CONTENTS 1
PostNL PHP bindings Documentation, Release 1.2.0
2 CONTENTS
CHAPTER
ONE
DEVELOPER GUIDE
1.1 Overview
1.1.1 Requirements
Nowadays there are two APIs you can choose from: SOAP or REST. PostNL’s REST API provides all of thefunctionality and is currently the recommended way to connect.
REST API Requirements
1. PHP 5.6 or higher (up to and including 8.0)
2. JSON extension
3. An HTTP Client such as Symfony’s HTTP Client (PostNL lib v1.3.0 or higher) or Guzzle (or at least havethe PHP cURL extension installed)
4. opcache.save_comments set to 1
SOAP API Requirements
1. PHP 5.6 or higher (up to and including 8.0)
2. JSON extension (both the Shipping webservice and Shipping Status webservice can only be handled by theREST API)
3. XMLWriter extension
4. XMLReader extension
5. An HTTP Client such as Symfony’s HTTP Client (PostNL lib v1.3.0 or higher) or Guzzle (or at least havethe PHP cURL extension installed)
6. opcache.save_comments set to 1
Warning: Enabling the OPCache and setting opcache.save_comments to 0 will break this library since itdepends on PHPDoc comments.
You can quickly check your current settings with this snippet:
echo "OPCache is ".opcache_enabled() ? "enabled\n" : "disabled\n";echo "opcache.save_comments is set to ".ini_get('opcache.save_comments') ? '1' : '0→˓';
3
PostNL PHP bindings Documentation, Release 1.2.0
Note: You can install any HTTP Client that is supported by the HTTPlug project. See chapter HTTP Client formore information.
Note: If you use the Guzzle client, you do not need to have the cURL extension installed. As an alternative,you can enable allow_url_fopen in your system’s php.ini. The included Guzzle version can work with the PHPstream wrapper to handle HTTP requests. For more information check out Guzzle’s documentation.
1.1.2 License
Licensed using the MIT license.
The MIT License (MIT).
Copyright (c) 2017-2021 Michael Dekker (https://github.com/firstred)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software andassociated documentation files (the “Software”), to deal in the Software without restriction, includingwithout limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sellcopies of the Software, and to permit persons to whom the Software is furnished to do so, subject tothe following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantialportions of the Software.
THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESSOR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABIL-ITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENTSHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAM-AGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTH-ERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THEUSE OR OTHER DEALINGS IN THE SOFTWARE.
1.1.3 Contributing
Guidelines
1. This library supports PSR-1, PSR-2, PSR-3, PSR-4, PSR-6, PSR-7 and PSR-18.
2. The library is meant to be lean, fast and sticks to the standards of the SOAP API. This means that not everyfeature request can be accepted. When in doubt, please open an issue first.
3. The PostNL library has a minimum PHP version requirement of PHP 5.6. Pull requests must not require aPHP version greater than PHP 5.6.
4. All pull requests must include unit tests to ensure the change works as expected and to prevent regressions.
4 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Running the tests
In order to contribute, you’ll need to checkout the source from GitHub and install the dependencies using Composer:
git clone https://github.com/firstred/postnl-api-php.gitcd postnl-api-php && composer install
This library is unit tested with PHPUnit. Run the tests using the included PHPUnit version:
composer test
Note: You’ll need to use PHP 7.3 or newer in order to perform the tests.
Building the documentation
The documentation is automatically built and hosted on readthedocs.io. You can build a local HTML copy byinstalling Sphinx and running
pip install -r docs/requirements.txt
to install the requirements, followed by
sphinx-build -b html docs builddir
to build the HTML output in the directory builddir.
1.2 Installation
The recommended way to install the PostNL library is through Composer. Composer is a dependency managementtool for PHP that allows you to declare the dependencies your project needs and installs them into your project.
This chapter assumes that you meet all the requirements as described in the Overview chapter.
Install composer with the instructions on this page: https://getcomposer.org/download/
1.2.1 Install through Composer
Install the PostNL library:
composer require firstred/postnl-api-php
You can optionally add the well-known Guzzle HTTP client as a dependency using composer:
composer require guzzlehttp/guzzle
This library will prefer the Guzzle client and automatically start using it instead of the built-in cURL-client.
Note: After installing, you need to require Composer’s autoloader somewhere in your project, which is not nec-essary if you are using a framework such as Laravel or Symfony, for example.
You can require the autoloader as follows (assuming the vendor/ dir is relative to your current directory):
require_once 'vendor/autoload.php';
1.2. Installation 5
PostNL PHP bindings Documentation, Release 1.2.0
You can find out more on how to install Composer, configure autoloading, and other best-practices for definingdependencies at getcomposer.org.
1.2.2 Install the latest development build through composer
During your development, you can keep up with the latest changes on the master branch by setting the versionrequirement for this library to dev-1.2.x.
{"require": {"firstred/postnl-api-php": "dev-1.2.x"
}}
Note: You will likely have to change the min-stability setting:
https://getcomposer.org/doc/04-schema.md#minimum-stability
1.3 Authentication
The PostNL API requires an API key to authenticate. You can request one via MijnPostNL.
If you do not already have a PostNL account, be sure to check out this page: https://developer.postnl.nl/request-api-key/
Note: The API key is automatically attached to the Firstred\PostNL\Entity\SOAP\UsernameToken object(SOAP) or apikey HTTP header (REST). You do not have to manually add the API key with every request.
1.3.1 Passing all credentials
Besides having to provide an API key, you will have to pass information about your business. These credentialswill have to be passed with a Firstred\PostNL\Entity\Customer object when creating a new Firstred\PostNL\PostNL instance.
Note: The Firstred\PostNL\PostNL class is the main class of this library. It handles all functionality you willneed from a developer’s perspective. After instantiating a new Firstred\PostNL\PostNL object you will haveeverything you need to communicate with the PostNL API. Everything else (caching, HTTP Clients, logging, etc.)is optional.
In order to get started with the API, the following credentials are important:
6 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Required credentials
API key
Required: TrueThe API key
Customer code
Required: TrueThe customer code is a code that usually consists of 4 letters and appears in domestic 3S-codes.
Customer number
Required: TrueThe customer number is a number that usually consists of 8 digits.
AddressA filled Firstred\PostNL\Entity\Address object with at least the following information:
AddressType
Required: TrueDefault: 02The address type should be 02, which means the address belongs to the sender.
City
Required: TrueCity
CompanyName
Required: TrueThe company name
HouseNr
Required: TrueThe house number
Street
Required: TrueStreet name
Zipcode
Required: TrueThe postcode. Be aware that the API might sometimes refer to a postcode as postcode, postal code orzipcode.
Collection location
Required: TrueDefault: 123456I must admit that to this day I still do not have a single clue what this value means. It could refer to yourlocal drop-off location (if you use one). If your PostNL account manager can provide you with a collectionlocation number please use that one.
I usually fill out 123456 and it seems to work just fine.
Globalpack barcode type
Required: FalseThe barcode type to use for international shipments. This field is optional if you do not ship outside the EU.
This field usually consists of 2 letters.
1.3. Authentication 7
PostNL PHP bindings Documentation, Release 1.2.0
Globalpack customer code
Required: FalseThe barcode type to use for international shipments. This field is optional if you do not ship outside the EU.
This field usually consists of 4 digits.
When you have all the required information, you are ready to configure the library. It can be configured as follows:
Note: Example configuration. All the credential come together in the Firstred\PostNL\Entity\Customerand main Firstred\PostNL\PostNL class.
$apiKey = 'qjsdjufhjasudhfaSDFasdifh324';$customer = (new Customer())
->setCollectionLocation('123456')->setCustomerCode('DEVC')->setCustomerNumber('11223344')->setContactPerson('Test')->setAddress(Address::create([
'AddressType' => '02','City' => 'Hoofddorp','CompanyName' => 'PostNL','Countrycode' => 'NL','HouseNr' => '42','Street' => 'Siriusdreef','Zipcode' => '2132WT',
]))->setGlobalPackBarcodeType('AB')->setGlobalPackCustomerCode('1234');
$postnl = new PostNL($customer, // The filled Customer object$apiKey, // The API keyfalse, // Sandbox = false, meaning we are now using the live␣
→˓environmentPostNL::MODE_REST // We are going to use the REST API (default)
);
You might have noticed that several different ways have been used to instantiate an object. More information aboutthis can be found in the Object instantiation section.
The PostNL client constructor accepts a few options:
customer
Required: TrueThe Firstred\PostNL\Entity\Customer object that is used to configure the client and let PostNL knowwho is requesting the data.
// Create a new customer$client = new Customer::create(['CollectionLocation' => '123456', // Your collection␣
→˓location'CustomerCode' => 'DEVC', // Your Customer Code'CustomerNumber' => '11223344', // Your Customer Number'GlobalPackBarcodeType('CX'), // Add your GlobalPack␣
→˓information if you need'GlobalPackCustomerCode('1234'), // to create␣
→˓international shipment labels(continues on next page)
8 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
(continued from previous page)
'ContactPerson' => 'Sander','Address' => Address::create([
'AddressType' => '02', // This address will be␣→˓shown on the labels
'City' => 'Hoofddorp','CompanyName' => 'PostNL','Countrycode' => 'NL','HouseNr' => '42','Street' => 'Siriusdreef','Zipcode' => '2132WT',
]),'Email' => '[email protected]','Name' => 'Michael',
]);
apiKeyThe API key to use. Note that if you want to switch from the legacy API to the new SOAP and REST APIyou will have to request a new key.
If you want to connect to the legacy API, you should pass a Firstred\PostNL\Entity\SOAP\UsernameToken with your username and token set:
$usernameToken = new UsernameToken('username', 'token');
You can request an API key for the sandbox environment on this page: https://developer.postnl.nl/content/request-api-key For a live key you should contact your PostNL account manager.
sandbox
Required: TrueIndicate whether you’d like to connect to the sandbox environment. When false the library uses the liveendpoints.
mode
Required: TrueThis library provides three ways to connect to the API:
• Firstred\PostNL\PostNL::MODE_REST: REST mode
• Firstred\PostNL\PostNL::MODE_SOAP: SOAP mode
• Firstred\PostNL\PostNL::MODE_LEGACY: Legacy mode – This is the previous SOAP API, which,at the moment of writing, has been disabled.
1.3.2 Authorization
You may not be authorized to access all services. Contact your PostNL account manager to find out what’s availableto you.
1.3. Authentication 9
PostNL PHP bindings Documentation, Release 1.2.0
1.4 Quickstart
This page provides a quick introduction to this library and a few quick copy/paste examples which you can adjustto your likings.
This section assumes that you have installed the library and are fully authenticated.
If you do not have the library installed, head over to the Installation page. If you do not know what to pass to themain Firstred\PostNL\PostNL class, please refer to the chapter Authentication first.
You can do requests over the API by creating the request objects and passing them to one of the functions in themain Firstred\PostNL\PostNL class.
Creating request objects may seem a bit counter-intuitive at first, but this makes it a lot easier to follow the requestexamples from the official API documentation and quickly figure out what each field does.
Using an IDE with code completion is strongly recommended.
1.4.1 Requesting timeframes, locations and the delivery date at once
You can request the timeframes, locations and delivery date at once to quickly retrieve all the available deliveryoptions.
Note: For more details on how to retrieve delivery options, consult the Delivery options chapter.
Here’s how it is done from scratch:
PHP 5/7
PHP 8
<?php
use Firstred\PostNL\Entity\CutOffTime;use Firstred\PostNL\Entity\Location;use Firstred\PostNL\Entity\Message\Message;use Firstred\PostNL\Entity\Request\GetDeliveryDate;use Firstred\PostNL\Entity\Request\GetNearestLocations;use Firstred\PostNL\Entity\Request\GetTimeframes;use Firstred\PostNL\Entity\Timeframe;use Firstred\PostNL\PostNL;use Firstred\PostNL\Entity\Customer;use Firstred\PostNL\Entity\Address;
require_once __DIR__.'/vendor/autoload.php';
// Your PostNL credentials$customer = Customer::create([
'CollectionLocation' => '123456','CustomerCode' => 'DEVC','CustomerNumber' => '11223344','ContactPerson' => 'Sander','Address' => Address::create([
'AddressType' => '02','City' => 'Hoofddorp','CompanyName' => 'PostNL','Countrycode' => 'NL','HouseNr' => '42',
(continues on next page)
10 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
(continued from previous page)
'Street' => 'Siriusdreef','Zipcode' => '2132WT',
]),'Email' => '[email protected]','Name' => 'Michael',
]);
$apikey = 'YOUR_API_KEY_HERE';$sandbox = true;
$postnl = new PostNL($customer, $apikey, $sandbox, PostNL::MODE_REST);
$mondayDelivery = true;$deliveryDaysWindow = 7; // Amount of days to show ahead$dropoffDelay = 0; // Amount of days to delay delivery
// Configure the cut-off window for every day, 1 = Monday, 7 = Sunday$cutoffTime = '15:00:00';$dropoffDays = [1 => true, 2 => true, 3 => true, 4 => true, 5 => true, 6 => false, 7␣→˓=> false];foreach (range(1, 7) as $day) {
if ($dropoffDays[$day]) {$cutOffTimes[] = new CutOffTime(
str_pad($day, 2, '0', STR_PAD_LEFT),date('H:i:00', strtotime($cutoffTime)),true
);}
}
$response = $postnl->getTimeframesAndNearestLocations((new GetTimeframes())
->setTimeframe([(new Timeframe())
->setCountryCode('NL')->setEndDate(date('d-m-Y', strtotime(" +{$deliveryDaysWindow} days +{
→˓$dropoffDelay} days")))->setHouseNr('66')->setOptions(['Morning', 'Daytime'])->setPostalCode('2132WT')->setStartDate(date('d-m-Y', strtotime("+1 days")))->setSundaySorting(!empty($mondayDelivery) && date('w', strtotime("+{
→˓$dropoffDelay} days")))]),
(new GetNearestLocations())->setCountrycode('NL')->setLocation(
(new Location())->setAllowSundaySorting(!empty($mondayDelivery))->setDeliveryOptions(['PG'])->setOptions(['Daytime'])->setHouseNr('66')->setPostalcode('2132WT')
),(new GetDeliveryDate())
->setGetDeliveryDate(
(continues on next page)
1.4. Quickstart 11
PostNL PHP bindings Documentation, Release 1.2.0
(continued from previous page)
(new GetDeliveryDate())->setAllowSundaySorting(!empty($mondayDelivery))->setCountryCode('NL')->setCutOffTimes($cutOffTimes)->setHouseNr('12')->setOptions(['Daytime', 'Evening'])->setPostalCode('2132WT')->setShippingDate(date('d-m-Y H:i:s'))->setShippingDuration(strval(1 + (int) $dropoffDelay))
)->setMessage(new Message())
);
<?php
use Firstred\PostNL\Entity\Label;use Firstred\PostNL\PostNL;use Firstred\PostNL\Entity\Customer;use Firstred\PostNL\Entity\Address;use Firstred\PostNL\Entity\Shipment;use Firstred\PostNL\Entity\Dimension;
require_once __DIR__.'/vendor/autoload.php';
// Your PostNL credentials$customer = new Customer(
CustomerNumber: '11223344',CustomerCode: 'DEVC',CollectionLocation: '123456',ContactPerson: 'Sander',Email: '[email protected]',Name: 'Michael',Address: new Address(
AddressType: '02',CompanyName: 'PostNL',Street: 'Siriusdreef',HouseNr: '42',Zipcode: '2132WT',City: 'Hoofddorp',Countrycode: 'NL',
),);
$apikey = 'YOUR_API_KEY_HERE';$sandbox = true;
$postnl = new PostNL(customer: $customer,apiKey: $apikey,sandbox: $sandbox,mode: PostNL::MODE_REST,
);
$mondayDelivery = true;$deliveryDaysWindow = 7; // Amount of days to show ahead$dropoffDelay = 0; // Amount of days to delay delivery
(continues on next page)
12 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
(continued from previous page)
// Configure the cut-off window for every day, 1 = Monday, 7 = Sunday$cutoffTime = '15:00:00';$dropoffDays = [1 => true, 2 => true, 3 => true, 4 => true, 5 => true, 6 => false, 7␣→˓=> false];foreach (range(1, 7) as $day) {
if ($dropoffDays[$day]) {$cutOffTimes[] = new CutOffTime(
str_pad($day, 2, '0', STR_PAD_LEFT),date('H:i:00', strtotime($cutoffTime)),true
);}
}
$response = $postnl->getTimeframesAndNearestLocations((new GetTimeframes())
->setTimeframe([(new Timeframe())
->setCountryCode('NL')->setEndDate(date('d-m-Y', strtotime(" +{$deliveryDaysWindow} days +{
→˓$dropoffDelay} days")))->setHouseNr('66')->setOptions(['Morning', 'Daytime'])->setPostalCode('2132WT')->setStartDate(date('d-m-Y', strtotime("+1 days")))->setSundaySorting(!empty($mondayDelivery) && date('w', strtotime("+{
→˓$dropoffDelay} days")))]),
(new GetNearestLocations())->setCountrycode('NL')->setLocation(
(new Location())->setAllowSundaySorting(!empty($mondayDelivery))->setDeliveryOptions(['PG'])->setOptions(['Daytime'])->setHouseNr('66')->setPostalcode('2132WT')
),(new GetDeliveryDate())
->setGetDeliveryDate((new GetDeliveryDate())
->setAllowSundaySorting(!empty($mondayDelivery))->setCountryCode('NL')->setCutOffTimes($cutOffTimes)->setHouseNr('12')->setOptions(['Daytime', 'Evening'])->setPostalCode('2132WT')->setShippingDate(date('d-m-Y H:i:s'))->setShippingDuration(strval(1 + (int) $dropoffDelay))
)->setMessage(new Message())
);
The response variable will be an associative array containing the timeframes, nearest locations and delivery date.It has the following keys:
1.4. Quickstart 13
PostNL PHP bindings Documentation, Release 1.2.0
timeframesThis is a :php:class:‘FirstredPostNLEntityResponseResponseTimeframes‘ object containing all the timeframes. You can iterate over all the available timeframesas follows.
.. code-block:: php
foreach (𝑟𝑒𝑠𝑝𝑜𝑛𝑠𝑒[′𝑡𝑖𝑚𝑒𝑓𝑟𝑎𝑚𝑒𝑠′]𝑎𝑠timeframe) 𝑑𝑎𝑡𝑒 =timeframe->getDate()->format(’Y-m-d’);
// Note that a timeframe object might have multiple embedded timeframes. // This might happen when yourequest both ‘Daytime‘ and ‘Evening‘ timeframes 𝑓𝑟𝑜𝑚 =timeframe->getTimeframes()[0]->getFrom();𝑡𝑜 =timeframe->getTimeframes()[0]->getTo();
echo "𝑑𝑎𝑡𝑒− 𝑓𝑟𝑜𝑚 :from, to: 𝑡𝑜”;
// Output: 2020-03-03 - from: 12:15:00, to: 14:00:00
.. note::
Note that the API usually groups timeframes by date, but is not guaranteed to do so, so do not rely on it!
The embedded timeframes contain the actual timeframes on that particular day.
The response format is the same for both the SOAP and REST API andis described on this page: https://developer.postnl.nl/browse-apis/delivery-options/timeframe-webservice/testtool-rest/#/Timeframe/get_calculate_timeframes
Note: Dates and times returned by the library always use the same format for consistency andtherefore may differ from the API. Please refer to the Formats chapter for more information.
locationsThe pickup locations can be found in the Firstred\PostNL\Entity\Response\GetNearestLocationsResponse object.
You can iterate over the found locations as follows:
foreach ($response['locations']->getGetLocationsResult()->getResponseLocation()␣→˓as $location) {
var_dump($location);}
delivery_dateThe delivery date that was found, returned in a Firstred\PostNL\Entity\Response\GetDeliveryDateResponse object.
You can print the date as follows:
echo $response['delivery_date']->getDeliveryDate()->format('d-m-Y');
14 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
1.4.2 Creating a (merged) shipment label
This section describes how you can create two labels and have them merged into a single PDF automatically.
Note: If you’d like to know more about all the methods you can use to create labels, see the Send and trackshipments chapter.
Example code:
use Firstred\PostNL\Entity\Label;use Firstred\PostNL\PostNL;use Firstred\PostNL\Entity\Customer;use Firstred\PostNL\Entity\Address;use Firstred\PostNL\Entity\Shipment;use Firstred\PostNL\Entity\Dimension;
require_once __DIR__.'/vendor/autoload.php';
// Your PostNL credentials$customer = Customer::create([
'CollectionLocation' => '123456','CustomerCode' => 'DEVC','CustomerNumber' => '11223344','ContactPerson' => 'Sander','Address' => Address::create([
'AddressType' => '02','City' => 'Hoofddorp','CompanyName' => 'PostNL','Countrycode' => 'NL','HouseNr' => '42','Street' => 'Siriusdreef','Zipcode' => '2132WT',
]),'Email' => '[email protected]','Name' => 'Michael',
]);
$apikey = 'YOUR_API_KEY_HERE';$sandbox = true;
$postnl = new PostNL($customer, $apikey, $sandbox, PostNL::MODE_SOAP);
$barcodes = $postnl->generateBarcodesByCountryCodes(['NL' => 2]);
$shipments = [Shipment::create([
'Addresses' => [Address::create([
'AddressType' => '01','City' => 'Utrecht','Countrycode' => 'NL','FirstName' => 'Peter','HouseNr' => '9','HouseNrExt' => 'a bis','Name' => 'de Ruijter','Street' => 'Bilderdijkstraat',
(continues on next page)
1.4. Quickstart 15
PostNL PHP bindings Documentation, Release 1.2.0
(continued from previous page)
'Zipcode' => '3521VA',]),
],'Barcode' => $barcodes['NL'][0],'Dimension' => new Dimension('1000'),'ProductCodeDelivery' => '3085',
]),Shipment::create([
'Addresses' => [Address::create([
'AddressType' => '01','City' => 'Utrecht','Countrycode' => 'NL','FirstName' => 'Peter','HouseNr' => '9','HouseNrExt' => 'a bis','Name' => 'de Ruijter','Street' => 'Bilderdijkstraat','Zipcode' => '3521VA',
]),],'Barcode' => $barcodes['NL'][1],'Dimension' => new Dimension('1000'),'ProductCodeDelivery' => '3085',
]),];
$label = $postnl->generateLabels($shipments,'GraphicFile|PDF', // Printertype (only PDFs can be merged -- no need to use the␣
→˓Merged types)true, // Confirm immediatelytrue, // MergeLabel::FORMAT_A4, // Format -- this merges multiple A6 labels onto an A4[
1 => true,2 => true,3 => true,4 => true,
] // Positions);
file_put_contents('labels.pdf', $label);
This will write a labels.pdf file that looks like this:
16 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
If you’d rather have the user download a label, you can set the Content-Disposition header:
$label = ...;
header('Content-Type: application/pdf');header('Content-Disposition: attachment; filename="label.pdf"');echo $label;exit;
Note: Your framework might already provide a way to output files. Here are a few examples for several popularPHP frameworks:
Symfony
Laravel
<?php
use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;use Symfony\Component\HttpFoundation\Response;use Symfony\Component\HttpFoundation\ResponseHeaderBag;
class CreateShipmentController extends AbstractController{
public function downloadLabelAction(){
// Provide a name for your file with extension$filename = 'label.pdf';
// Create the label(continues on next page)
1.4. Quickstart 17
PostNL PHP bindings Documentation, Release 1.2.0
(continued from previous page)
$label = ...;
// Return a response with a specific content$response = new Response($label);
// Create the disposition of the file$disposition = $response->headers->makeDisposition(
ResponseHeaderBag::DISPOSITION_ATTACHMENT,$filename
);
// Set the content type and disposition$response->headers->set('Content-Type', 'application/pdf');$response->headers->set('Content-Disposition', $disposition);
// Dispatch requestreturn $response;
}}
Source: https://ourcodeworld.com/articles/read/329/how-to-send-a-file-as-response-from-a-controller-in-symfony-3
<?php
namespace App\Http\Controllers;
use Illuminate\Http\Request;
class DownloadLabelController extends Controller{
public function downloadLabelAction(Request $request) {// Create the label$label = ...;
return response()->header('Content-Type', 'application/pdf')->header('Content-Disposition', 'attachment; filename="label.pdf"');
}}
Source: https://laravel.com/docs/8.x/controllersSource: https://gist.github.com/diegofelix/8863402
18 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
1.4.3 Tracking a shipment
You can track a single shipment by calling Firstred\PostNL\PostNL::getShippingStatusByBarcode withthe barcode of the shipment.
It accepts the following parameters:
barcodeThe actual barcode, for example: 3SABCD1837238723.
completeWhether the method should return a complete status update. A complete status update contains the shipmenthistory as well.
Code example:
PHP 5/7
PHP 8
$postnl = new PostNL(...);
$currentStatusResponse = $postnl->getShippingStatusByBarcode('3SABCD1837238723', // Barcodefalse // Return just the current status (complete = false)
);
$postnl = new PostNL(...);
$currentStatusResponse = $postnl->getShippingStatusByBarcode(barcode: '3SABCD1837238723',complete: false,
);
1.5 Delivery options
The PostNL API allows you to retrieve a list of predicted timeframes and a list of possible pickup locations. Fortimeframes you will have to use a certain date range and to get the nearest pickup locations you can use an addressor geolocation.
There are two ways to gather timeframes and pickup locations. You can
1. combine the delivery date, timeframe and location webservices
2. or use the checkout service.
The checkout service is currently not supported, but this library contains an easy interface to combine the threeseparate services listed in this section and provides the same functionality, if not more.
This section lists all the ways in which you can retrieve delivery options, using three webservices. It is possible torequest:
1. Delivery dates (when a shipment could arrive, given the current shipping date)
2. Shipping dates (when a shipment should be dispatched, given the predicted delivery date)
3. Timeframes
4. Nearest locations
5. Nearest locations by coordinates
1.5. Delivery options 19
PostNL PHP bindings Documentation, Release 1.2.0
1.5.1 Checkout
On an e-commerce checkout page you will probably want to show timeframes and/or pickup locations based onthe current day and cut-off window. This library provides an interface to easily combine the three webservicesrequired to show all the delivery options. It will simultaneously contact the three webservices and request a list oftimeframes and pickup locations based on the given input.
An example of how the interface can be used can be found in the section Requesting timeframes, locations and thedelivery date at once, part of the Quickstart chapter.
1.5.2 Deliverydate webservice
Note:PostNL API documentation for this service:https://developer.postnl.nl/apis/deliverydate-webservice
Use the delivery date webservice to determine the delivery and shipping date. You can use this service to calculatethe dates ‘live’ and to make sure you do not promise your customers any timeframes that are no longer available.
Delivery dates
Here’s how you can retrieve the closest delivery date:
$cutoffTime = '15:00:00';$dropoffDays = [1 => true, 2 => true, 3 => true, 4 => true, 5 => true, 6 => false, 7␣→˓=> false];foreach (range(1, 7) as $day) {
if (isset($dropoffDays[$day])) {$cutOffTimes[] = new CutOffTime(
str_pad($day, 2, '0', STR_PAD_LEFT),date('H:i:00', strtotime($cutoffTime)),true
);}
}$deliveryDate = $postnl->getDeliveryDate(
(new GetDeliveryDate())->setGetDeliveryDate(
(new GetDeliveryDate())->setAllowSundaySorting(false)->setCountryCode('NL')->setCutOffTimes($cutOffTimes)->setHouseNr('66')->setOptions(['Morning', 'Daytime'])->setPostalCode('2132WT')->setShippingDate(date('d-m-Y H:i:s'))->setShippingDuration('1')
));
The result will be a GetDeliveryDateResponse. Calling getDeliveryDate on this object will return the delivery dateas a string in the d-m-Y H:i:s PHP date format.
The function accepts the following arguments
20 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
getDeliveryDate
Required: TrueThe Firstred\PostNL\Entity\Request\GetDeliveryDate request object. See the API documenta-tion for the possibilities. As shown in the example you will need to provide as many details as possible toget accurate availability information.
Shipping dates
The Shipping Date service almost works in the same way as the Delivery Date service, except this time you providethe actual delivery date in order to calculate the closest shipping date.
$cutoffTime = '15:00:00';$dropoffDays = [1 => true, 2 => true, 3 => true, 4 => true, 5 => true, 6 => false, 7␣→˓=> false];foreach (range(1, 7) as $day) {
if (isset($dropoffDays[$day])) {$cutOffTimes[] = new CutOffTime(
str_pad($day, 2, '0', STR_PAD_LEFT),date('H:i:00', strtotime($cutoffTime)),true
);}
}$deliveryDate = $postnl->getDeliveryDate(
(new GetDeliveryDate())->setGetDeliveryDate(
(new GetDeliveryDate())->setAllowSundaySorting(false)->setCountryCode('NL')->setCutOffTimes($cutOffTimes)->setHouseNr('66')->setOptions(['Morning', 'Daytime'])->setPostalCode('2132WT')->setShippingDate(date('d-m-Y H:i:s'))->setShippingDuration('1')
));
The function accepts the following arguments
getSentDate
Required: TrueThe Firstred\PostNL\Entity\Request\GetSentDate request object. See the API documentation forthe possibilities. As shown in the example you will need to provide as many details as possible to get accurateavailability information.
1.5. Delivery options 21
PostNL PHP bindings Documentation, Release 1.2.0
1.5.3 Timeframe webservice
Note:PostNL API documentation for this service:https://developer.postnl.nl/apis/timeframe-webservice
Timeframes
$deliveryDaysWindow = 7;$dropoffDelay = 0;
$timeframes = $postnl->getTimeframes(new GetTimeframes())->setTimeframe([
(new Timeframe())->setCountryCode('NL')->setEndDate(date('d-m-Y', strtotime(" +{$deliveryDaysWindow} days +{
→˓$dropoffDelay} days")))->setHouseNr('66')->setOptions(['Daytime', 'Evening'])->setPostalCode('2132WT')->setStartDate(date('d-m-Y', strtotime(" +1 day +{$dropoffDelay} days")))->setSundaySorting(false)
]));
timeframes
Required: TrueThe Firstred\PostNL\Entity\Request\GetTimeframes request object. See the API documentationfor more details.
1.5.4 Location webservice
Note:PostNL API documentation for this service:https://developer.postnl.nl/apis/location-webservice
The location service allows you to retrieve a list of locations for the given postcode or coordinates.
Nearest locations
Here’s an example of how you can retrieve the nearest location by postcode:
$postnl->getNearestLocations((new GetNearestLocations())
->setCountrycode('NL')->setLocation(
(new Location())->setAllowSundaySorting(false)->setDeliveryOptions(['PG'])
(continues on next page)
22 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
(continued from previous page)
->setOptions(['Daytime'])->setHouseNr('66')->setPostalcode('2132WT')
));
getNearestLocations
Required: TrueThe Firstred\PostNL\Entity\Request\GetNearestLocations request object. See the API docu-mentation for more details.
Nearest locations by coordinates
You can also get the locations by specifying a bounding box. One can be drawn by providing the North-West andSouth-East corner of the box:
$postnl->getLocationsInArea((new GetLocationsInArea())
->setCountrycode('NL')->setLocation(
(new Location())->setAllowSundaySorting(false)->setDeliveryDate(date('d-m-Y', strtotime('+1 day')))->setDeliveryOptions([
'PG',])->setOptions([
'Daytime',])->setCoordinatesNorthWest(
(new CoordinatesNorthWest())->setLatitude((string) 52.156439)->setLongitude((string) 5.015643)
)->setCoordinatesSouthEast(
(new CoordinatesNorthWest())->setLatitude((string) 52.017473)->setLongitude((string) 5.065254)
))
);
This function accepts the arguments:
locationsInArea
Required: TrueThe Firstred\PostNL\Entity\Request\GetLocationsInArea request object. See the API documen-tation for more details.
1.5. Delivery options 23
PostNL PHP bindings Documentation, Release 1.2.0
1.6 Send and track shipments
Sending shipments can be done in one of two ways:
1. Using the Shipping webservice
2. Using the Barcode, Labelling and Confirming webservice
This library supports both methods. In this sections we’ll go through all the available webservices.
1.6.1 Barcode webservice
Note:PostNL API documentation for this service:https://developer.postnl.nl/apis/barcode-webservice/overview
The barcode service allows you to generate barcodes for your shipment labels. Usually you would reserve anamount of barcodes, generate shipping labels and eventually confirm those labels. According to PostNL, this flowis necessary for a higher delivery success rate.
Generate a single barcode
You can generate a single barcode for domestic shipments as follows:
$postnl->generateBarcode();
This will generate a 3S barcode meant for domestic shipments only.
The method Firstred\PostNL\PostNL::generateBarcode accepts the following arguments:
type
Required: FalseDefault: 3SThe barcode type. This is 2S/3S for the Netherlands and EU Pack Special shipments. For other destinationsthis is your GlobalPack barcode type. For more info, check the PostNL barcode service page.
range
Required: FalseDefault: nullFor domestic and EU shipments this is your customer code. Otherwise, your GlobalPack customer code.
serie
Required: FalseDefault: nullThis is the barcode range for your shipment(s). Check the PostNL barcode service page for the ranges thatare available.
eps
Required: FalseDefault: falseIndicates whether this is an EU Pack Special shipment.
24 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Generate a barcode by country code
It is possible to generate a barcode by country code. This will let the library figure out what type, range, serie touse.
Example:
$postnl->generateBarcodeByCountryCode('BE');
This will generate a 3S barcode meant for domestic shipments only.
The method Firstred\PostNL\PostNL::generateBarcodeByCountryCode accepts the following arguments:
iso
Required: TrueThe two letter country ISO-3166 alpha-2 code. Make sure you use UPPERCASE. List of ISO-3166 codes:https://www.iban.com/country-codes
Generate multiple barcodes by using country codes
You can generate a whole batch of barcodes at once by providing country codes and the amounts you would liketo generate.
Example:
$postnl->generatesBarcodeByCountryCodes(['NL' => 2, 'DE' => 3]);
The method Firstred\PostNL\PostNL::generateBarcodesByCountryCodes will return a list of barcodes:
['NL' => [
'3SDEVC11111111111','3SDEVC22222222222',
],'DE' => [
'3SDEVC111111111','3SDEVC222222222','3SDEVC333333333',
],];
The function accepts the following argument:
type
Required: TrueThis must be an associative array with country codes as key and the amount of barcodes you’d like to generateper country as the value.
1.6.2 Labelling webservice
Note:PostNL API documentation for this service:https://developer.postnl.nl/apis/labelling-webservice
The labelling service allows you to create shipment labels and optionally confirm the shipments. The library has abuilt-in way to merge labels automatically, so you can request labels for multiple shipments at once.
1.6. Send and track shipments 25
PostNL PHP bindings Documentation, Release 1.2.0
Generate a single label
The following example generates a single shipment label for a domestic shipment:
$postnl = new PostNL(...);$postnl->generateLabel(
Shipment::create()->setAddresses([
Address::create(['AddressType' => '01','City' => 'Utrecht','Countrycode' => 'NL','FirstName' => 'Peter','HouseNr' => '9','HouseNrExt' => 'a bis','Name' => 'de Ruijter','Street' => 'Bilderdijkstraat','Zipcode' => '3521VA',
]),Address::create([
'AddressType' => '02','City' => 'Hoofddorp','CompanyName' => 'PostNL','Countrycode' => 'NL','HouseNr' => '42','Street' => 'Siriusdreef','Zipcode' => '2132WT',
]),])->setBarcode($barcode)->setDeliveryAddress('01')->setDimension(new Dimension('2000'))->setProductCodeDelivery('3085'),
'GraphicFile|PDF',false
);
This will create a standard shipment (product code 3085). You can access the label (base64 encoded PDF) thisway:
$pdf = base64_decode($label->getResponseShipments()[0]->getLabels()[0]->getContent());
This function accepts the following arguments:
shipment
Required: TrueThe Firstred\PostNL\Entity\Shipment object. Visit the PostNL API documentation to find outwhat a Firstred\PostNL\Entity\Shipment object consists of. The Firstred\PostNL\Entity\Shipment object is based on the SOAP API: https://developer.postnl.nl/browse-apis/send-and-track/labelling-webservice/documentation-soap/
printerType
Required: TrueDefault: GraphicFile|PDFThe list of supported printer types can be found on this page: https://developer.postnl.nl/browse-apis/send-and-track/labelling-webservice/documentation-soap/
confirm
26 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Required: FalseDefault: trueIndicates whether the shipment should immediately be confirmed.
Generate multiple shipment labels
The following example shows how a label can be merged:
$shipments = [Shipment::create([
'Addresses' => [Address::create([
'AddressType' => '01','City' => 'Utrecht','Countrycode' => 'NL','FirstName' => 'Peter','HouseNr' => '9','HouseNrExt' => 'a bis','Name' => 'de Ruijter','Street' => 'Bilderdijkstraat','Zipcode' => '3521VA',
]),],'Barcode' => $barcodes['NL'][0],'Dimension' => new Dimension('1000'),'ProductCodeDelivery' => '3085',
]),Shipment::create([
'Addresses' => [Address::create([
'AddressType' => '01','City' => 'Utrecht','Countrycode' => 'NL','FirstName' => 'Peter','HouseNr' => '9','HouseNrExt' => 'a bis','Name' => 'de Ruijter','Street' => 'Bilderdijkstraat','Zipcode' => '3521VA',
]),],'Barcode' => $barcodes['NL'][1],'Dimension' => new Dimension('1000'),'ProductCodeDelivery' => '3085',
]),];
$label = $postnl->generateLabels($shipments,'GraphicFile|PDF', // Printertype (only PDFs can be merged -- no need to use the␣
→˓Merged types)true, // Confirm immediatelytrue, // MergeLabel::FORMAT_A4, // Format -- this merges multiple A6 labels onto an A4[
1 => true,(continues on next page)
1.6. Send and track shipments 27
PostNL PHP bindings Documentation, Release 1.2.0
(continued from previous page)
2 => true,3 => true,4 => true,
] // Positions);
file_put_contents('labels.pdf', $label);
By setting the merge flag it will automatically merge the labels into a PDF string.
The function accepts the following arguments:
shipments
Required: TrueAn array with Firstred\PostNL\Entity\Shipment objects. Visit the PostNL API documentation to findout what a Firstred\PostNL\Entity\Shipment object consists of. The Firstred\PostNL\Entity\Shipment object is based on the SOAP API: https://developer.postnl.nl/browse-apis/send-and-track/labelling-webservice/documentation-soap/
printerType
Required: FalseDefault: GraphicFile|PDFThe list of supported printer types can be found on this page: https://developer.postnl.nl/browse-apis/send-and-track/labelling-webservice/documentation-soap/
confirm
Required: FalseDefault: trueIndicates whether the shipment should immediately be confirmed.
merge
Required: FalseDefault: falseThis will merge the labels and make the function return a pdf string of the merged label.
format
Required: FalseDefault: Firstred\PostNL\PostNL::FORMAT_A4This sets the paper format (can be Firstred\PostNL\PostNL::FORMAT_A4 orFirstred\PostNL\PostNL::FORMAT_A6).
positions
Required: FalseDefault: [1 => true, 2 => true, 3 => true, 4 => true]
This will set the positions of the labels. The following image shows the available positions, use true or falseto resp. enable or disable a position:
28 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
1.6.3 Shipping webservice
Note:PostNL API documentation for this service:https://developer.postnl.nl/browse-apis/send-and-track/shipping-webservice/
The shipping service combines all the functionality of the labeling, confirming, barcode and easy return service.The service is only available as REST.
Send a single shipment
The following example sends a single domestic shipment:
$postnl = new PostNL(...);$postnl->sendShipment(
Shipment::create()->setAddresses([
Address::create(['AddressType' => '01','City' => 'Utrecht','Countrycode' => 'NL','FirstName' => 'Peter','HouseNr' => '9','HouseNrExt' => 'a bis','Name' => 'de Ruijter','Street' => 'Bilderdijkstraat','Zipcode' => '3521VA',
]),Address::create([
(continues on next page)
1.6. Send and track shipments 29
PostNL PHP bindings Documentation, Release 1.2.0
(continued from previous page)
'AddressType' => '02','City' => 'Hoofddorp','CompanyName' => 'PostNL','Countrycode' => 'NL','HouseNr' => '42','Street' => 'Siriusdreef','Zipcode' => '2132WT',
]),])->setDeliveryAddress('01')->setDimension(new Dimension('2000'))->setProductCodeDelivery('3085'),
'GraphicFile|PDF',false
);
This will create a standard shipment (product code 3085). You can access the label (base64 encoded PDF) thisway:
$pdf = base64_decode($shipping->getResponseShipments()[0]->getLabels()[0]->→˓getContent());
This function accepts the following arguments:
shipment
Required: TrueThe Firstred\PostNL\Entity\Shipment object. Visit the PostNL API documentation to find out whata Shipment object consists of.
printertype
Required: FalseDefault: GraphicFile|PDFThe list of supported printer types can be found on this page: https://developer.postnl.nl/browse-apis/send-and-track/shipping-webservice/documentation/
confirm
Required: FalseDefault: trueIndicates whether the shipment should immediately be confirmed.
Send multiple shipments
The following example shows how labels of multiple shipment labels can be merged:
$shipments = [Shipment::create([
'Addresses' => [Address::create([
'AddressType' => '01','City' => 'Utrecht','Countrycode' => 'NL','FirstName' => 'Peter','HouseNr' => '9','HouseNrExt' => 'a bis','Name' => 'de Ruijter',
(continues on next page)
30 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
(continued from previous page)
'Street' => 'Bilderdijkstraat','Zipcode' => '3521VA',
]),],'Dimension' => new Dimension('1000'),'ProductCodeDelivery' => '3085',
]),Shipment::create([
'Addresses' => [Address::create([
'AddressType' => '01','City' => 'Utrecht','Countrycode' => 'NL','FirstName' => 'Peter','HouseNr' => '9','HouseNrExt' => 'a bis','Name' => 'de Ruijter','Street' => 'Bilderdijkstraat','Zipcode' => '3521VA',
]),],'Dimension' => new Dimension('1000'),'ProductCodeDelivery' => '3085',
]),];
$label = $postnl->generateShippings($shipments,'GraphicFile|PDF', // Printertype (only PDFs can be merged -- no need to use the␣
→˓Merged types)true, // Confirm immediatelytrue, // MergeLabel::FORMAT_A4, // Format -- this merges multiple A6 labels onto an A4[
1 => true,2 => true,3 => true,4 => true,
] // Positions);
file_put_contents('labels.pdf', $label);
By setting the merge flag it will automatically merge the labels into a PDF string.
The function accepts the following arguments:
shipments
Required: TrueAn array with Firstred\Entity\Shipment objects. Visit the PostNL API documentation to find out whata Shipment object consists of.
printertype
Required: FalseDefault: GraphicFile|PDFThe list of supported printer types can be found on this page: https://developer.postnl.nl/browse-apis/send-and-track/shipping-webservice/documentation/
1.6. Send and track shipments 31
PostNL PHP bindings Documentation, Release 1.2.0
confirm
Required: FalseDefault: trueIndicates whether the shipment should immediately be confirmed.
merge
Required: FalseDefault: falseThis will merge the labels and make the function return a pdf string of the merged label.
format
Required: FalseDefault: Firstred\PostNL\PostNL::FORMAT_A4This sets the paper format (can be Firstred\PostNL\PostNL::FORMAT_A4 or Firstred\PostNL\PostNL::FORMAT_A6).
positions
Required: FalseDefault: [1 => true, 2 => true, 3 => true, 4 => true]
This will set the positions of the labels. The following image shows the available positions, use true orfalse to resp. enable or disable a position:
32 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
1.6.4 Confirming webservice
Note:PostNL API documentation for this service:https://developer.postnl.nl/apis/confirming-webservice
You can confirm shipments that have previously not been confirmed. Shipments can be confirmed after both theLabelling webservice or the Shipping webservice.
The available methods are Firstred\PostNL\PostNL::confirmShipment and Firstred\PostNL\PostNL::confirmShipments. The first method accepts a single Firstred\PostNL\Entity\Shipment objectwhereas the latter accepts an array of :php:class:`Firstred\PostNL\Entity\Shipment`s.
Example code:
$postnl = new PostNL(...);
$confirmedShipment = $postnl->confirmShipment((new Shipment())
->setAddresses([Address::create([
'AddressType' => '01','City' => 'Utrecht','Countrycode' => 'NL','FirstName' => 'Peter','HouseNr' => '9','HouseNrExt' => 'a bis','Name' => 'de Ruijter','Street' => 'Bilderdijkstraat','Zipcode' => '3521VA',
]),Address::create([
'AddressType' => '02','City' => 'Hoofddorp','CompanyName' => 'PostNL','Countrycode' => 'NL','HouseNr' => '42','Street' => 'Siriusdreef','Zipcode' => '2132WT',
]),])->setBarcode('3SDEVC201611210')->setDeliveryAddress('01')->setDimension(new Dimension('2000'))->setProductCodeDelivery('3085')
);
The output is a Firstred\PostNL\Entity\Respone\ConfirmingResponseShipment or an array with theseobjects in case you are confirming multiple shipments. The results array will have the same index keys as therequest input.
1.6. Send and track shipments 33
PostNL PHP bindings Documentation, Release 1.2.0
1.6.5 Shippingstatus webservice
Note:PostNL API documentation for this service:https://developer.postnl.nl/apis/shippingstatus-webservice
This service can be used to retrieve shipping statuses. For a short update request a current status, otherwisecomplete status will provide you with a long list containing the shipment’s history.
Current or complete shipping status by barcode
Gets the current or complete status by barcode. A complete status also includes the shipment history.
$postnl = new PostNL(...);$postnl->getShippingStatusByBarcode('3SDEVC98237423');
barcode
Required: TrueThe barcode, e.g.: 3SDEVC98237423
complete
Required: FalseReturn the complete shipping status. This includes the shipment history.
Depending on the complete parameter this returns a Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment or a Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment object.
Multiple current or complete shipping statuses by barcodes
Gets multiple current or complete statuses by barcodes. A complete status also includes the shipment history.
$postnl = new PostNL(...);$postnl->getShippingStatusesByBarcodes(['3SDEVC98237423', '3SDEVC98237423']);
barcodes
Required: TrueThe references, e.g.: ['3SDEVC98237423', '3SDEVC98237423']
complete
Required: FalseReturn the complete shipping status. This includes the shipment history.
Depending on the complete parameter this returns an array with Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment or Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment objects. The array is an associative array indexed by the given barcodes,e.g.: ['3SDEVC98237423' => CurrentStatusResponseShipment, ...].
34 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Current or complete shipping status by reference
Gets the current or complete status by reference. A complete status also includes the shipment history.
$postnl = new PostNL(...);$postnl->getShippingStatusByReference('order-12');
reference
Required: TrueThe barcode, e.g.: order-12
complete
Required: FalseReturn the complete shipping status. This includes the shipment history.
Depending on the complete parameter this returns a Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment or a Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment object.
Multiple current or complete shipping statuses by references
Gets multiple current or complete statuses by references. A complete status also includes the shipment history.
$postnl = new PostNL(...);$postnl->getShippingStatusesByReferences(['order-12', 'order-16']);
barcodes
Required: TrueThe references, e.g.: ['order-12', 'order-16]
complete
Required: FalseReturn the complete shipping status. This includes the shipment history.
Depending on the complete parameter this returns an array with Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment or Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment objects. The array is an associative array indexed by the given references,e.g.: ['order-12' => CurrentStatusResponseShipment, ...].
Current status by status code
Warning: This is no longer supported by the PostNL API.
Current status by phase code
Gets the current status by phase code. Note that the date range is required.
Warning: This is no longer supported by the PostNL API
1.6. Send and track shipments 35
PostNL PHP bindings Documentation, Release 1.2.0
Complete status by status code
Warning: This is no longer supported by the PostNL API.
Complete status by phase code
Warning: This is no longer supported by the PostNL API.
Get a single signature by barcode
Gets the signature of the shipment when available. A signature can be accessed by barcode only.
$postnl = new PostNL(...);$postnl->getSignatureByBarcode('3SDEVC23987423');
It accepts the following arguments
barcode
Required: TrueThe shipment’s barcode, e.g. 3SDEVC23987423
This method returns a Firstred\PostNL\Entity\Response\GetSignatureResponseSignature object. Toget the actual signature in binary format you will have to use:
$postnl = new PostNL(...);
$getSignatureResponseSignature = $postnl->getSignatureByBarcode('3SDEVC23987423');$content = base64_decode($getSignatureResponseSignature->getSignatureImage());
header('Content-Type: image/gif');echo $content;exit;
Get multiple signatures by barcodes
Gets multiple signatures of multiple shipments, when available.
$postnl = new PostNL(...);$postnl->getSignaturesByBarcodes(['3SDEVC23987423', '3SDEVC23987425']);
It accepts the following arguments
barcodes
Required: TrueAn array of barcodes, e.g. ['3SDEVC23987423', '3SDEVC23987425'].
It returns an array of Firstred\PostNL\Entity\Response\GetSignatureResponseSignature objects. Toget the image data out of these objects, see Get a single signature by barcode.
36 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
1.7 Exception handling
The following tree view describes how the exceptions used in this library depend on each other.
. \ExceptionFirstred\PostNL\Exception\PostNLException
Firstred\PostNL\Exception\ApiExceptionFirstred\PostNL\Exception\ApiConnectionExceptionFirstred\PostNL\Exception\CifDownExceptionFirstred\PostNL\Exception\CifExceptionFirstred\PostNL\Exception\NotFoundExceptionFirstred\PostNL\Exception\ResponseExceptionFirstred\PostNL\Exception\ShipmentNotFoundException
Firstred\PostNL\Exception\HttpClientExceptionFirstred\PostNL\Exception\InvalidArgumentException
Firstred\PostNL\Exception\InvalidBarcodeExceptionFirstred\PostNL\Exception\InvalidConfigurationExceptionFirstred\PostNL\Exception\InvalidMethodExceptionFirstred\PostNL\Exception\NotImplementedExceptionFirstred\PostNL\Exception\NotSupportedException
Psr\Cache\InvalidArgumentException
This library throws exceptions for errors that occur during a request.
• In the event of an API error a Firstred\PostNL\Exception\ApiException is thrown
use Firstred\PostNL\Exception\ApiException;
try {$postnl->getTimeframes(...);
} catch (ApiException $e) {// ...
}
• A Firstred\PostNL\Exception\ResponseException exception is thrown when a response could notbe understood by the library.
• All exceptions that occur in underlying HTTP Clients are handled by Firstred\PostNL\Exception\HttpClientException s.
• Invalid inputs are handled by the Firstred\PostNL\Exception\InvalidArgumentException excep-tions.
• In case of caching problems due to invalid keys, a Psr\Cache\InvalidArgumentException is thrown.This could mean that the library is unable to utilize the configured caching library.
If you want to catch all exceptions thrown by this library be sure to catch both Firstred\PostNL\Exception\PostNLException s and Psr\Cache\InvalidArgumentException s.
PHP 7.0 or lower
PHP 7.1 or higher
use Firstred\PostNL\Exception\PostNLException;use Psr\Cache\InvalidArgumentException as PsrCacheInvalidArgumentException;
try {$postnl->getTimeframes(...);
} catch (PostNLException $e) {// ...
} catch (PsrCacheInvalidArgumentException $e) {(continues on next page)
1.7. Exception handling 37
PostNL PHP bindings Documentation, Release 1.2.0
(continued from previous page)
// ...}
use Firstred\PostNL\Exception\PostNLException;use Psr\Cache\InvalidArgumentException as PsrCacheInvalidArgumentException;
try {$postnl->getTimeframes(...);
} catch (PostNLException | PsrCacheInvalidArgumentException $e) {// ...
}
1.8 Formats
The API can be very inconsistent when it comes to returning times and dates, for example. To standardize howsome fields are handled, the library uses different formats.
1.8.1 Dates, Times and DateTimes
This library makes a distinction between Dates, Times and DateTimes. To normalize moments in time, this packagereturns DateTimeImmutable objects when referring to a single point in time and uses strings for times.
The following definitions and formats are used:
DatesDates refer to a specific moment in time; not specifying the time. Can be formatted as 2020-02-03. Isalways a DateTimeImmutable object.
TimesTimes refer to a certain moment on any given day. Can be formatted as 12:12:12. Is always a string andshould always be formatted using the following PHP date format: H:i:s (Hours, minutes and seconds withleading zeros).
DateTimesDateTimes are referring to a specific date and time. They can be formatted for example as 2021-02-0312:12:12. Is always a DateTimeImmutable object.
Note: Every DateTimeImmutable object and time string returned by the library is adjusted to the timezone ofthe PostNL API (Europe/Amsterdam). Make sure your timezone is aligned correctly, or otherwise convert datesand times manually by adding/subtracting the time difference.
You can check your PHP’s configured timezone by printing the date.timezone setting:
die(ini_get('date.timezone'));
38 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
1.8.2 SOAP object structure
Sometimes you will notice that the REST API documentation might return property names in singular whereas thelibrary returns the plural version of a property. This is caused by the fact that the SOAP API returns most propertiesin plural format. An example is the shipping status service when requesting the current status of a shipment. TheSOAP API would return an addresses property whereas REST returns address. This is automatically convertedto the Firstred\PostNL\Entity\Shipment::$Addresses property by this library. Therefore, when in doubt,you can safely assume that plural is used.
1.9 HTTP Client
This library supports almost all available HTTP clients. There are several ways to configure the HTTP client thatshould be used.
If not passed to the Firstred\PostNL\PostNL constructor or set with the Firstred\PostNL\PostNL::setHttpClient method, the library will automatically check if HTTP clients are available inthe following order:
1. Guzzle client
2. HTTPlug client, an Asynchronous HTTP client, PSR-18 HTTP clients
3. Built-in cURL client
1.9.1 Setting the HTTP client manually
By default the library will use cURL or Guzzle when available. You can always switch HTTP clients as follows:
$postnl = new PostNL(...);$postnl->setHttpClient(\Firstred\PostNL\HttpClient\CurlClient::getInstance());
You can create a custom HTTP Client by implementing the \Firstred\PostNL\HttpClient\ClientInterface interface.
1.9.2 Setting the HTTP client with HTTPlug
Using auto-discovery with HTTPlug.
The following packages are required if you want to use HTTPlug:
composer require php-http/discovery php-http/httplug php-http/message-factory psr/→˓http-factory
HTTPlug + Symfony HTTP Client exampleThis package already requires a Message factory and HTTP factory implementation (guzzlehttp/psr7), so allwe need to do is to install the client and its requirements according to the official Symfony documentation:
composer require symfony/http-client
If you haven’t installed Guzzle itself, this library should now auto-detect the Symfony HTTP Client and use itthrough the HTTPlug bridge.
If you have installed Guzzle already, then you can still configure the PostNL library to use the Symfony HTTPClient. To do this, pass the new client to the Firstred\PostNL\PostNL constructor or Firstred\PostNL\PostNL::setHttpClient method. Example:
1.9. HTTP Client 39
PostNL PHP bindings Documentation, Release 1.2.0
use Symfony\Component\HttpClient\HttplugClient;use Firstred\PostNL\HttpClient\HTTPlugClient;
$symfonyClient = new HttplugClient();
$httpPlugBridgeClient = new HTTPlugClient($symfonyClient);
$postnl = new PostNL($customer, null, $httpClient);
Note:A list of HTTP Client supported by HTTPlug can be found on the following page:https://docs.php-http.org/en/latest/clients.html
1.10 Caching
PSR-6 caching is supported, which means you can grab any caching library for PHP that you like and plug it rightinto this library.
Note that not all services can be cached. At the moment cacheable services are:
• Labelling webservice
• Timeframes webservice
• Location webservice
• Deliverydate webservice
• Shippingstatus webservice
To enable caching for a certain service you can use the following:
use Cache\Adapter\Filesystem\FilesystemCachePool;use League\Flysystem\Adapter\Local;use League\Flysystem\Filesystem;
// Cache in the `/cache` folder relative to this directory$filesystemAdapter = new Local(__DIR__.'/');$filesystem = new Filesystem($filesystemAdapter);
$postnl = new PostNL(...);
$labellingService = $postnl->getLabellingService();$labellingService->cache = new FilesystemCachePool($filesystem);
// Set a TTL of 600 seconds$labellingService->ttl = 600;
// Using a DateInterval (600 seconds)$labellingServiceervice->ttl = new DateInterval('PT600S');
// Setting a deadline instead, useful for the timeframe service, so you can cache␣→˓until the cut-off-time or// until the next day$labellingServiceervice = $postnl->getTimeframeService();$labellingService->ttl = new DateTime('14:00:00');
40 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Note: This example used the Flysystem (filesystem) cache. An extensive list of supported caches can be found onthis page.
1.11 Logging
Requests and responses can be logged for debugging purposes. In order to enable logging you will need to pass aPSR-3 compatible logger.
use League\Flysystem\Adapter\Local;use League\Flysystem\Filesystem;
use Psr\Log\LogLevel;use wappr\Logger;
// Initialize the file system adapter$logfs = new Filesystem($adapter);
// Set the DEBUG log level$logger = new Logger($logfs, LogLevel::DEBUG);
// Set the filename format, we're creating one file for every minute of request/→˓responses$logger->setFilenameFormat('Y-m-d H:i');
// Set this logger for all services at once$postnl->setLogger($logger);
// Set the logger for just the Labelling service$postnl->getLabellingService()->setLogger($logger);
Note: This example used the Wappr logger. You can use any logger you like, as long as it implements the PSR-3standard. To log all responses the level needs to be set at DEBUG. For error responses you can set the debug levelto ERROR.
1.12 Advanced usage
This section describes more advanced ways to use this library. The main class Firstred\PostNL\PostNL andseparate service classes (such as Firstred\PostNL\Service\BarcodeService) provide more ways to interactwith the API.
1.11. Logging 41
PostNL PHP bindings Documentation, Release 1.2.0
1.12.1 Object instantiation
There are four ways in which entities can be instantiated. Either by
1. passing all arguments to the constructor in the right order
2. or using named parameters,
3. invoking the create method on an entity
4. or by instantiating an empty entity and calling the setters one by one.
Which method to use is entirely up to you. They are all supported by the library.However, if you use an IDE with code completion then the safest ways to use are (2) using named parameters(PHP 8) or by calling the setters (4), one by one.Even without using an editor with code completion you might benefit from using methods (2) and (4) since youwill be able to detect errors earlier in the process.
1 - Constructor
2 - Constructor named args
3 - Create
4 - Setters
// Your PostNL credentials$customer = new Customer(
'11223344','DEVC','123456','Sander','[email protected]','Michael',new Address(
'02','PostNL','Siriusdreef','42','2132WT','Hoofddorp','NL',
),);
// Your PostNL credentials$customer = new Customer(
CustomerNumber: '11223344',CustomerCode: 'DEVC',CollectionLocation: '123456',ContactPerson: 'Sander',Email: '[email protected]',Name: 'Michael',Address: new Address(
AddressType: '02',CompanyName: 'PostNL',Street: 'Siriusdreef',HouseNr: '42',
(continues on next page)
42 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
(continued from previous page)
Zipcode: '2132WT',City: 'Hoofddorp',Countrycode: 'NL',
),);
$customer = Customer::create(['CustomerNumber' => '11223344','CustomerCode' => 'DEVC','CollectionLocation' => '123456','ContactPerson' => 'Sander','Email' => '[email protected]','Name' => 'Michael','Address' => Address::create([
'AddressType' => '02','CompanyName' => 'PostNL','Street' => 'Siriusdreef','HouseNr' => '42','Zipcode' => '2132WT','City' => 'Hoofddorp','Countrycode' => 'NL',
]),]);
$customer = (new Customer())->setCustomerNumber('11223344')->setCustomerCode('DEVC')->setCollectionLocation('123456')->setContactPerson('Sander')->setEmail('[email protected]')->setName('Michael')->setAddress((new Address())
->setAddressType('02')->setCompanyName('PostNL')->setStreet('Siriusdreef')->setHouseNr('42')->setZipcode('2132WT')->setCity('Hoofddorp')->setCountrycode('NL')
);
1.12.2 Building requests manually
For most cases using the API through the (Firstred\PostNL\PostNL) object would be sufficient. There mightbe times, however, when the main class does not align with your use case. This section aims to describe the processthat is involved in creating requests, sending them and processing the responses.
1.12. Advanced usage 43
PostNL PHP bindings Documentation, Release 1.2.0
Interacting with the API through this library
In the above-mentioned merged label example we are passing two Firstred\PostNL\Entity\Shipment objects,filled with the needed information to generate the labels. To merge those labels manually, we have to set the mergeoption to false and can omit both the format and positions parameters. This will in turn make the libraryreturn Firstred\PostNL\Entity\Response\GenerateLabelResponse objects.
These are in line with the Firstred\PostNL\Entity\Response\GenerateLabelResponse nodes generatedby the SOAP API, even when using the REST API. The main reason for this standardization is that the initial versionof this library was built for the SOAP API. If you need a quick reference of the Firstred\PostNL\Entity\Response\GenerateLabelResponse object, you can either look up the code of the GenerateLabelResponseclass or navigate to the API documentation directly.
Sending concurrent requests manually
There is no direct need to manually handle concurrent requests. This library handles most cases automatically andeven provides a special function to quickly grab timeframe and location data for frontend delivery options widgets.
In case you manually want to send a custom mix of requests, you can look up the corresponding functions in theService class of your choice and call the `buildXXXXXXRequest()` functions manually. Thanks to the PSR-7 standard used by this library you can use the PsrHttpMessageRequestInterface object that is returned toaccess the full request that would otherwise be sent directly. To pick up where you left off you can then grab theresponse and pass it to one of the processXXXXXXXResponse()` functions of the Service class. The easiestmethod is to grab the raw HTTP message and parse it with the included PSR-7 library. An example can be foundin the cURL client.
Processing Response objects
Note: This section refers to Response objects returned by the library, not the standardized PSR-7 messages.
As soon as you’ve done your first request with this library, you will find that it returns a Response object. Asmentioned in the Building Requests section, these Response objects are based on the SOAP API, regardless ofthe mode set. The properties of a Response object can be looked up in the code, but it can be a bit confusing attimes, since the Response object will likely not contain all properties at once. It often depends on the context of therequest. For this reason, you’re better off by having a look at the SOAP API documentation directly or by checkingout some of the examples in this documentation.
1.13 Reference
\Firstred\PostNL
1.13.1 Namespaces
Entity
\Firstred\PostNL\Entity
44 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Namespaces
Message
\Firstred\PostNL\Entity\Message
Classes
LabellingMessage
class Firstred\PostNL\Entity\Message\LabellingMessage
Class LabellingMessage.
Parent Firstred\PostNL\Entity\Message\Message
Summary
Methods
• public __construct($Printertype, $MessageID, $MessageTimeStamp)
Properties
public property Firstred\PostNL\Entity\Message\LabellingMessage::$defaultProperties
Type string[][]
protected static propertyFirstred\PostNL\Entity\Message\LabellingMessage::$Printertype
Type string | null
Methods
public Firstred\PostNL\Entity\Message\LabellingMessage::__construct($Printertype=\'GraphicFile\|PDF\',$MessageID=null,$MessageTimeS-tamp=null)
LabellingMessage constructor.
Parameters• $Printertype (string | null)
• $MessageID (string | null)
• $MessageTimeStamp (string | \DateTimeInterface | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
1.13. Reference 45
PostNL PHP bindings Documentation, Release 1.2.0
Message
class Firstred\PostNL\Entity\Message\Message
Class Message.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($MessageID, $MessageTimeStamp)
• public setMessageTimeStamp($MessageTimeStamp)
Properties
public property Firstred\PostNL\Entity\Message\Message::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Message\Message::$MessageID
Type string | null
protected static property Firstred\PostNL\Entity\Message\Message::$MessageTimeStamp
Type string | null
Methods
public Firstred\PostNL\Entity\Message\Message::__construct($MessageID=null,$MessageTimeStamp=null)
Parameters• $MessageID (string | null)
• $MessageTimeStamp (string | \DateTimeInterface | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionpublic Firstred\PostNL\Entity\Message\Message::setMessageTimeStamp($MessageTimeStamp=null)
Parameters• $MessageTimeStamp (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
46 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Request
\Firstred\PostNL\Entity\Request
Classes
GetLocation
class Firstred\PostNL\Entity\Request\GetLocation
Class GetLocation.
This class is both the container and can be the actual GetLocation object itself!
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($LocationCode, $Message, $RetailNetworkID)
Properties
public property Firstred\PostNL\Entity\Request\GetLocation::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static property Firstred\PostNL\Entity\Request\GetLocation::$LocationCode
Type string | null
protected static property Firstred\PostNL\Entity\Request\GetLocation::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
protected static property Firstred\PostNL\Entity\Request\GetLocation::$RetailNetworkID
Type string | null
Methods
public Firstred\PostNL\Entity\Request\GetLocation::__construct($LocationCode=null,$Message=null,$RetailNetworkID=null)
GetLocation constructor.
Parameters• $LocationCode (string | null)
1.13. Reference 47
PostNL PHP bindings Documentation, Release 1.2.0
• $Message (Firstred\PostNL\Entity\Message\Message | null)
• $RetailNetworkID (string | null)
CompleteStatusByStatus
class Firstred\PostNL\Entity\Request\CompleteStatusByStatus
Class CompleteStatusByStatus.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Shipment, $Customer, $Message)
• public xmlSerialize($writer)
Properties
public propertyFirstred\PostNL\Entity\Request\CompleteStatusByStatus::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Request\CompleteStatusByStatus::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
protected static propertyFirstred\PostNL\Entity\Request\CompleteStatusByStatus::$Customer
Type \Firstred\PostNL\Entity\Customer | null
protected static propertyFirstred\PostNL\Entity\Request\CompleteStatusByStatus::$Shipment
Type \Firstred\PostNL\Entity\Shipment | null
Methods
public Firstred\PostNL\Entity\Request\CompleteStatusByStatus::__construct($Shipment=null,$Cus-tomer=null,$Mes-sage=null)
CompleteStatusByStatus constructor.
Parameters• $Shipment (Firstred\PostNL\Entity\Shipment | null)
48 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $Customer (Firstred\PostNL\Entity\Customer | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
public Firstred\PostNL\Entity\Request\CompleteStatusByStatus::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
GetSignature
class Firstred\PostNL\Entity\Request\GetSignature
Class GetSignature.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Shipment, $Customer, $Message)
• public xmlSerialize($writer)
Properties
public property Firstred\PostNL\Entity\Request\GetSignature::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static property Firstred\PostNL\Entity\Request\GetSignature::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
protected static property Firstred\PostNL\Entity\Request\GetSignature::$Customer
Type \Firstred\PostNL\Entity\Customer | null
protected static property Firstred\PostNL\Entity\Request\GetSignature::$Shipment
Type \Firstred\PostNL\Entity\Shipment | null
1.13. Reference 49
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Request\GetSignature::__construct($Shipment=null,$Customer=null,$Message=null)
GetSignature constructor.
Parameters• $Shipment (Firstred\PostNL\Entity\Shipment | null)
• $Customer (Firstred\PostNL\Entity\Customer | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
public Firstred\PostNL\Entity\Request\GetSignature::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
GetSentDate
class Firstred\PostNL\Entity\Request\GetSentDate
Class GetSentDate.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($AllowSundaySorting, $City, $CountryCode, $HouseNr,$HouseNrExt, $Options, $PostalCode, $DeliveryDate, $Street, $ShippingDuration)
• public setDeliveryDate($deliveryDate)
• public setPostalCode($postcode)
• public xmlSerialize($writer)
50 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Entity\Request\GetSentDate::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Request\GetSentDate::$AllowSundaySorting
Type bool | null
protected static property Firstred\PostNL\Entity\Request\GetSentDate::$City
Type string | null
protected static property Firstred\PostNL\Entity\Request\GetSentDate::$CountryCode
Type string | null
protected static property Firstred\PostNL\Entity\Request\GetSentDate::$DeliveryDate
Type \DateTimeInterface | null
protected static property Firstred\PostNL\Entity\Request\GetSentDate::$HouseNr
Type string | null
protected static property Firstred\PostNL\Entity\Request\GetSentDate::$HouseNrExt
Type string | null
protected static property Firstred\PostNL\Entity\Request\GetSentDate::$Options
Type string[] | null
protected static property Firstred\PostNL\Entity\Request\GetSentDate::$PostalCode
Type string | null
protected static propertyFirstred\PostNL\Entity\Request\GetSentDate::$ShippingDuration
Type string | null
protected static property Firstred\PostNL\Entity\Request\GetSentDate::$Street
Type string | null
Methods
public Firstred\PostNL\Entity\Request\GetSentDate::__construct($AllowSundaySorting=false,$City=null,$CountryCode=null,$HouseNr=null,$HouseNrExt=null,$Options=null,$PostalCode=null,$DeliveryDate=null,$Street=null,$ShippingDuration=null)
GetSentDate constructor.
1.13. Reference 51
PostNL PHP bindings Documentation, Release 1.2.0
Parameters• $AllowSundaySorting (bool | null)
• $City (string | null)
• $CountryCode (string | null)
• $HouseNr (string | null)
• $HouseNrExt (string | null)
• $Options (array | null)
• $PostalCode (string | null)
• $DeliveryDate (DateTimeInterface | string | null)
• $Street (string | null)
• $ShippingDuration (string | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\Entity\Request\GetSentDate::setDeliveryDate($deliveryDate=null)
Parameters• $deliveryDate (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\Request\GetSentDate::setPostalCode($postcode=null)
Set the postcode.
Parameters• $postcode (string | null)
Returns static
public Firstred\PostNL\Entity\Request\GetSentDate::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
52 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
GetLocationsInArea
class Firstred\PostNL\Entity\Request\GetLocationsInArea
Class GetLocationsInArea.
This class is both the container and can be the actual GetLocationsInArea object itself!
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Countrycode, $Location, $Message)
Properties
public property Firstred\PostNL\Entity\Request\GetLocationsInArea::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Request\GetLocationsInArea::$Countrycode
Type string | null
protected static property Firstred\PostNL\Entity\Request\GetLocationsInArea::$Location
Type \Firstred\PostNL\Entity\Location | null
protected static property Firstred\PostNL\Entity\Request\GetLocationsInArea::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
Methods
public Firstred\PostNL\Entity\Request\GetLocationsInArea::__construct($Countrycode=null,$Location=null,$Message=null)
GetLocationsInArea constructor.
Parameters• $Countrycode (string | null)
• $Location (Firstred\PostNL\Entity\Location | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
1.13. Reference 53
PostNL PHP bindings Documentation, Release 1.2.0
CurrentStatusByPhase
class Firstred\PostNL\Entity\Request\CurrentStatusByPhase
Class CurrentStatusByPhase.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Shipment, $Customer, $Message)
• public xmlSerialize($writer)
Properties
public propertyFirstred\PostNL\Entity\Request\CurrentStatusByPhase::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Request\CurrentStatusByPhase::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
protected static propertyFirstred\PostNL\Entity\Request\CurrentStatusByPhase::$Customer
Type \Firstred\PostNL\Entity\Customer | null
protected static propertyFirstred\PostNL\Entity\Request\CurrentStatusByPhase::$Shipment
Type \Firstred\PostNL\Entity\Shipment | null
Methods
public Firstred\PostNL\Entity\Request\CurrentStatusByPhase::__construct($Shipment=null,$Customer=null,$Message=null)
CurrentStatusByPhase constructor.
Parameters• $Shipment (Firstred\PostNL\Entity\Shipment | null)
• $Customer (Firstred\PostNL\Entity\Customer | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
public Firstred\PostNL\Entity\Request\CurrentStatusByPhase::xmlSerialize($writer)
54 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
CurrentStatusByStatus
class Firstred\PostNL\Entity\Request\CurrentStatusByStatus
Class CurrentStatusByStatus.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Shipment, $Customer, $Message)
• public xmlSerialize($writer)
Properties
public propertyFirstred\PostNL\Entity\Request\CurrentStatusByStatus::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Request\CurrentStatusByStatus::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
protected static propertyFirstred\PostNL\Entity\Request\CurrentStatusByStatus::$Customer
Type \Firstred\PostNL\Entity\Customer | null
protected static propertyFirstred\PostNL\Entity\Request\CurrentStatusByStatus::$Shipment
Type \Firstred\PostNL\Entity\Shipment | null
1.13. Reference 55
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Request\CurrentStatusByStatus::__construct($Shipment=null,$Customer=null,$Message=null)
CurrentStatusByStatus constructor.
Parameters• $Shipment (Firstred\PostNL\Entity\Shipment | null)
• $Customer (Firstred\PostNL\Entity\Customer | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
public Firstred\PostNL\Entity\Request\CurrentStatusByStatus::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
GetNearestLocations
class Firstred\PostNL\Entity\Request\GetNearestLocations
Class GetNearestLocations.
This class is both the container and can be the actual GetNearestLocations object itself!
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Countrycode, $Location, $Message)
Properties
public property Firstred\PostNL\Entity\Request\GetNearestLocations::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Request\GetNearestLocations::$Countrycode
Type string | null
56 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
protected static propertyFirstred\PostNL\Entity\Request\GetNearestLocations::$Location
Type \Firstred\PostNL\Entity\Location | null
protected static property Firstred\PostNL\Entity\Request\GetNearestLocations::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
Methods
public Firstred\PostNL\Entity\Request\GetNearestLocations::__construct($Countrycode=null,$Location=null,$Message=null)
GetNearestLocations constructor.
Parameters• $Countrycode (string | null)
• $Location (Firstred\PostNL\Entity\Location | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
CompleteStatusByReference
class Firstred\PostNL\Entity\Request\CompleteStatusByReference
Class CompleteStatusByReference.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Shipment, $Customer, $Message)
• public xmlSerialize($writer)
Properties
public propertyFirstred\PostNL\Entity\Request\CompleteStatusByReference::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Request\CompleteStatusByReference::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
protected static propertyFirstred\PostNL\Entity\Request\CompleteStatusByReference::$Customer
1.13. Reference 57
PostNL PHP bindings Documentation, Release 1.2.0
Type \Firstred\PostNL\Entity\Customer | null
protected static propertyFirstred\PostNL\Entity\Request\CompleteStatusByReference::$Shipment
Type \Firstred\PostNL\Entity\Shipment | null
Methods
public Firstred\PostNL\Entity\Request\CompleteStatusByReference::__construct($Shipment=null,$Cus-tomer=null,$Mes-sage=null)
CompleteStatusByReference constructor.
Parameters• $Shipment (Firstred\PostNL\Entity\Shipment | null)
• $Customer (Firstred\PostNL\Entity\Customer | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
public Firstred\PostNL\Entity\Request\CompleteStatusByReference::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
CompleteStatus
class Firstred\PostNL\Entity\Request\CompleteStatus
Class CompleteStatus.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Shipment, $Customer, $Message)
• public xmlSerialize($writer)
58 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Entity\Request\CompleteStatus::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static property Firstred\PostNL\Entity\Request\CompleteStatus::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
protected static property Firstred\PostNL\Entity\Request\CompleteStatus::$Customer
Type \Firstred\PostNL\Entity\Customer | null
protected static property Firstred\PostNL\Entity\Request\CompleteStatus::$Shipment
Type \Firstred\PostNL\Entity\Shipment | null
Methods
public Firstred\PostNL\Entity\Request\CompleteStatus::__construct($Shipment=null,$Customer=null,$Message=null)
CompleteStatus constructor.
Parameters• $Shipment (Firstred\PostNL\Entity\Shipment | null)
• $Customer (Firstred\PostNL\Entity\Customer | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
public Firstred\PostNL\Entity\Request\CompleteStatus::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
GetTimeframes
class Firstred\PostNL\Entity\Request\GetTimeframes
Class GetTimeframes.
Parent Firstred\PostNL\Entity\AbstractEntity
1.13. Reference 59
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($Message, $Timeframes)
• public setTimeframe($timeframes)
• public setTimeframes($timeframes)
• public getTimeframe()
• public getTimeframes()
• public xmlSerialize($writer)
Properties
public property Firstred\PostNL\Entity\Request\GetTimeframes::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static property Firstred\PostNL\Entity\Request\GetTimeframes::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
protected static property Firstred\PostNL\Entity\Request\GetTimeframes::$Timeframe
Type \Firstred\PostNL\Entity\Timeframe[] | null
Methods
public Firstred\PostNL\Entity\Request\GetTimeframes::__construct($Message=null,$Timeframes=null)
GetTimeframes constructor.
Parameters• $Message (Firstred\PostNL\Entity\Message\Message | null)
• $Timeframes (Firstred\PostNL\Entity\Timeframe[] | null)
public Firstred\PostNL\Entity\Request\GetTimeframes::setTimeframe($timeframes)
Set timeframes
Parameters• $timeframes (Firstred\PostNL\Entity\Timeframe | \Firstred\PostNL\Entity\Timeframe[] | null)
Returns $this
Since 1.0.0
Since 1.0.0
60 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Entity\Request\GetTimeframes::setTimeframes($timeframes)
Set timeframes
Parameters• $timeframes (Firstred\PostNL\Entity\Timeframe | \Firstred\PostNL\Entity\Timeframe[] | null)
Returns $this
Since 1.2.0
public Firstred\PostNL\Entity\Request\GetTimeframes::getTimeframe()
Get timeframes
Returns \Firstred\PostNL\Entity\Timeframe[] | null
public Firstred\PostNL\Entity\Request\GetTimeframes::getTimeframes()
Get timeframes
Returns \Firstred\PostNL\Entity\Timeframe[] | null
Since 1.2.0
public Firstred\PostNL\Entity\Request\GetTimeframes::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
CurrentStatusByReference
class Firstred\PostNL\Entity\Request\CurrentStatusByReference
Class CurrentStatusByReference.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Shipment, $Customer, $Message)
• public xmlSerialize($writer)
1.13. Reference 61
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public propertyFirstred\PostNL\Entity\Request\CurrentStatusByReference::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Request\CurrentStatusByReference::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
protected static propertyFirstred\PostNL\Entity\Request\CurrentStatusByReference::$Customer
Type \Firstred\PostNL\Entity\Customer | null
protected static propertyFirstred\PostNL\Entity\Request\CurrentStatusByReference::$Shipment
Type \Firstred\PostNL\Entity\Shipment | null
Methods
public Firstred\PostNL\Entity\Request\CurrentStatusByReference::__construct($Shipment=null,$Cus-tomer=null,$Mes-sage=null)
CurrentStatusByReference constructor.
Parameters• $Shipment (Firstred\PostNL\Entity\Shipment | null)
• $Customer (Firstred\PostNL\Entity\Customer | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
public Firstred\PostNL\Entity\Request\CurrentStatusByReference::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
62 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
GenerateBarcode
class Firstred\PostNL\Entity\Request\GenerateBarcode
Class GenerateLabel.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Barcode, $Customer, $Message)
Properties
public property Firstred\PostNL\Entity\Request\GenerateBarcode::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static property Firstred\PostNL\Entity\Request\GenerateBarcode::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
protected static property Firstred\PostNL\Entity\Request\GenerateBarcode::$Customer
Type \Firstred\PostNL\Entity\Customer | null
protected static property Firstred\PostNL\Entity\Request\GenerateBarcode::$Barcode
Type \Firstred\PostNL\Entity\Barcode | null
Methods
public Firstred\PostNL\Entity\Request\GenerateBarcode::__construct($Barcode=null,$Customer=null,$Message=null)
GenerateBarcode constructor.
Parameters• $Barcode (Firstred\PostNL\Entity\Barcode | null)
• $Customer (Firstred\PostNL\Entity\Customer | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
1.13. Reference 63
PostNL PHP bindings Documentation, Release 1.2.0
CurrentStatus
class Firstred\PostNL\Entity\Request\CurrentStatus
Class CurrentStatus.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Shipment, $Customer, $Message)
• public xmlSerialize($writer)
Properties
public property Firstred\PostNL\Entity\Request\CurrentStatus::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static property Firstred\PostNL\Entity\Request\CurrentStatus::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
protected static property Firstred\PostNL\Entity\Request\CurrentStatus::$Customer
Type \Firstred\PostNL\Entity\Customer | null
protected static property Firstred\PostNL\Entity\Request\CurrentStatus::$Shipment
Type \Firstred\PostNL\Entity\Shipment | null
Methods
public Firstred\PostNL\Entity\Request\CurrentStatus::__construct($Shipment=null,$Customer=null,$Message=null)
CurrentStatus constructor.
Parameters• $Shipment (Firstred\PostNL\Entity\Shipment | null)
• $Customer (Firstred\PostNL\Entity\Customer | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
public Firstred\PostNL\Entity\Request\CurrentStatus::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters
64 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $writer (Sabre\Xml\Writer)
Returns void
CompleteStatusByPhase
class Firstred\PostNL\Entity\Request\CompleteStatusByPhase
Class CompleteStatusByPhase.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Shipment, $Customer, $Message)
• public xmlSerialize($writer)
Properties
public propertyFirstred\PostNL\Entity\Request\CompleteStatusByPhase::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Request\CompleteStatusByPhase::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
protected static propertyFirstred\PostNL\Entity\Request\CompleteStatusByPhase::$Customer
Type \Firstred\PostNL\Entity\Customer | null
protected static propertyFirstred\PostNL\Entity\Request\CompleteStatusByPhase::$Shipment
Type \Firstred\PostNL\Entity\Shipment | null
Methods
public Firstred\PostNL\Entity\Request\CompleteStatusByPhase::__construct($Shipment=null,$Customer=null,$Message=null)
CompleteStatusByPhase constructor.
Parameters• $Shipment (Firstred\PostNL\Entity\Shipment | null)
• $Customer (Firstred\PostNL\Entity\Customer | null)
1.13. Reference 65
PostNL PHP bindings Documentation, Release 1.2.0
• $Message (Firstred\PostNL\Entity\Message\Message | null)
public Firstred\PostNL\Entity\Request\CompleteStatusByPhase::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
GenerateLabel
class Firstred\PostNL\Entity\Request\GenerateLabel
Class GenerateLabel.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Shipments, $Message, $Customer)
• public jsonSerialize()
• public xmlSerialize($writer)
Properties
public property Firstred\PostNL\Entity\Request\GenerateLabel::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static property Firstred\PostNL\Entity\Request\GenerateLabel::$Customer
Type \Firstred\PostNL\Entity\Customer | null
protected static property Firstred\PostNL\Entity\Request\GenerateLabel::$Message
Type \Firstred\PostNL\Entity\Message\LabellingMessage | null
protected static property Firstred\PostNL\Entity\Request\GenerateLabel::$Shipments
Type \Firstred\PostNL\Entity\Shipment[] | null
66 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Request\GenerateLabel::__construct($Shipments=null,$Message=null,$Customer=null)
GenerateLabel constructor.
Parameters• $Shipments (Firstred\PostNL\Entity\Shipment[] | null)
• $Message (Firstred\PostNL\Entity\Message\LabellingMessage | null)
• $Customer (Firstred\PostNL\Entity\Customer | null)
public Firstred\PostNL\Entity\Request\GenerateLabel::jsonSerialize()
Return a serializable array for `json_encode`.
Returns array
public Firstred\PostNL\Entity\Request\GenerateLabel::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
SendShipment
class Firstred\PostNL\Entity\Request\SendShipment
Class SendShipment.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Shipments, $Message, $Customer)
• public jsonSerialize()
1.13. Reference 67
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Entity\Request\SendShipment::$defaultProperties
Type array
protected static property Firstred\PostNL\Entity\Request\SendShipment::$Customer
Type \Firstred\PostNL\Entity\Customer | null
protected static property Firstred\PostNL\Entity\Request\SendShipment::$Message
Type \Firstred\PostNL\Entity\Message\LabellingMessage | null
protected static property Firstred\PostNL\Entity\Request\SendShipment::$Shipments
Type \Firstred\PostNL\Entity\Shipment[] | null
Methods
public Firstred\PostNL\Entity\Request\SendShipment::__construct($Shipments=null,$Message=null,$Customer=null)
SendShipment constructor.
Parameters• $Shipments (Firstred\PostNL\Entity\Shipment[] | null)
• $Message (Firstred\PostNL\Entity\Message\LabellingMessage | null)
• $Customer (Firstred\PostNL\Entity\Customer | null)
public Firstred\PostNL\Entity\Request\SendShipment::jsonSerialize()
Return a serializable array for `json_encode`.
Returns array
Confirming
class Firstred\PostNL\Entity\Request\Confirming
Class Confirming.
Parent Firstred\PostNL\Entity\AbstractEntity
68 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($Shipments, $Customer, $Message)
• public xmlSerialize($writer)
• public jsonSerialize()
Properties
public property Firstred\PostNL\Entity\Request\Confirming::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static property Firstred\PostNL\Entity\Request\Confirming::$Customer
Type \Firstred\PostNL\Entity\Customer | null
protected static property Firstred\PostNL\Entity\Request\Confirming::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
protected static property Firstred\PostNL\Entity\Request\Confirming::$Shipments
Type \Firstred\PostNL\Entity\Shipment[] | null
Methods
public Firstred\PostNL\Entity\Request\Confirming::__construct($Shipments=null,$Customer=null,$Message=null)
Confirming constructor.
Parameters• $Shipments (Firstred\PostNL\Entity\Shipment[] | null)
• $Customer (Firstred\PostNL\Entity\Customer | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
public Firstred\PostNL\Entity\Request\Confirming::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
public Firstred\PostNL\Entity\Request\Confirming::jsonSerialize()
Return a serializable array for `json_encode`.
1.13. Reference 69
PostNL PHP bindings Documentation, Release 1.2.0
Returns array
GetDeliveryDate
class Firstred\PostNL\Entity\Request\GetDeliveryDate
Class GetDeliveryDate.
This class is both the container and can be the actual GetDeliveryDate object itself!
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($AllowSundaySorting, $City, $CountryCode, $CutOffTimes,$HouseNr, $HouseNrExt, $Options, $OriginCountryCode, $PostalCode, $ShippingDate,$ShippingDuration, $Street, $GetDeliveryDate, $Message)
• public setShippingDate($shippingDate)
• public setPostalCode($postcode)
• public xmlSerialize($writer)
Properties
public property Firstred\PostNL\Entity\Request\GetDeliveryDate::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Request\GetDeliveryDate::$AllowSundaySorting
Type bool | null
protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$City
Type string | null
protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$CountryCode
Type string | null
protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$CutOffTimes
Type \Firstred\PostNL\Entity\CutOffTime[] | null
protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$HouseNr
Type string | null
protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$HouseNrExt
Type string | null
protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$Options
70 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Type string[] | null
protected static propertyFirstred\PostNL\Entity\Request\GetDeliveryDate::$OriginCountryCode
Type string | null
protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$PostalCode
Type string | null
protected static propertyFirstred\PostNL\Entity\Request\GetDeliveryDate::$ShippingDate
Type \DateTimeInterface | null
protected static propertyFirstred\PostNL\Entity\Request\GetDeliveryDate::$ShippingDuration
Type string | null
protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$Street
Type string | null
protected static propertyFirstred\PostNL\Entity\Request\GetDeliveryDate::$GetDeliveryDate
Type \Firstred\PostNL\Entity\Request\GetDeliveryDate | null
protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
Methods
public Firstred\PostNL\Entity\Request\GetDeliveryDate::__construct($AllowSundaySorting=null,$City=null,$CountryCode=null,$CutOffTimes=null,$HouseNr=null,$HouseNrExt=null,$Options=null, $Origin-CountryCode=null,$PostalCode=null,$ShippingDate=null,$ShippingDura-tion=null, $Street=null,$GetDeliveryDate=null,$Message=null)
GetDeliveryDate constructor.
Parameters• $AllowSundaySorting (bool | null)
• $City (string | null)
• $CountryCode (string | null)
• $CutOffTimes (array | null)
• $HouseNr (string | null)
• $HouseNrExt (string | null)
1.13. Reference 71
PostNL PHP bindings Documentation, Release 1.2.0
• $Options (array | null)
• $OriginCountryCode (string | null)
• $PostalCode (string | null)
• $ShippingDate (DateTimeInterface | string | null)
• $ShippingDuration (string | null)
• $Street (string | null)
• $GetDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\Entity\Request\GetDeliveryDate::setShippingDate($shippingDate=null)
Parameters• $shippingDate (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\Request\GetDeliveryDate::setPostalCode($postcode=null)
Set the postcode.
Parameters• $postcode (string | null)
Returns static
public Firstred\PostNL\Entity\Request\GetDeliveryDate::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
GetSentDateRequest
class Firstred\PostNL\Entity\Request\GetSentDateRequest
Class GetSentDateRequest.
Parent Firstred\PostNL\Entity\AbstractEntity
72 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($GetSentDate, $Message)
Properties
public property Firstred\PostNL\Entity\Request\GetSentDateRequest::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Request\GetSentDateRequest::$GetSentDate
Type \Firstred\PostNL\Entity\Request\GetSentDate | null
protected static property Firstred\PostNL\Entity\Request\GetSentDateRequest::$Message
Type \Firstred\PostNL\Entity\Message\Message | null
Methods
public Firstred\PostNL\Entity\Request\GetSentDateRequest::__construct($GetSentDate=null,$Message=null)
GetSentDate constructor.
Parameters• $GetSentDate (Firstred\PostNL\Entity\Request\GetSentDate | null)
• $Message (Firstred\PostNL\Entity\Message\Message | null)
Response
\Firstred\PostNL\Entity\Response
Classes
GetLocationsResult
class Firstred\PostNL\Entity\Response\GetLocationsResult
Class GetLocationsResult.
Parent Firstred\PostNL\Entity\AbstractEntity
1.13. Reference 73
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($ResponseLocation)
• public xmlSerialize($writer)
Properties
public property Firstred\PostNL\Entity\Response\GetLocationsResult::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Response\GetLocationsResult::$ResponseLocation
Type \Firstred\PostNL\Entity\Response\ResponseLocation[] | null
Methods
public Firstred\PostNL\Entity\Response\GetLocationsResult::__construct($ResponseLocation=null)
GetLocationsResult constructor.
Parameters• $ResponseLocation (Firstred\PostNL\Entity\Response\ResponseLocation[] | null)
public Firstred\PostNL\Entity\Response\GetLocationsResult::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
SignatureResponse
class Firstred\PostNL\Entity\Response\SignatureResponse
Class SignatureResponse.
Parent Firstred\PostNL\Entity\AbstractEntity
74 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($Signature)
Properties
public property Firstred\PostNL\Entity\Response\SignatureResponse::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Response\SignatureResponse::$Signature
Type \Firstred\PostNL\Entity\Signature | null
Methods
public Firstred\PostNL\Entity\Response\SignatureResponse::__construct($Signature=null)
SignatureResponse constructor.
Parameters• $Signature (Firstred\PostNL\Entity\Signature | null)
GetNearestLocationsResponse
class Firstred\PostNL\Entity\Response\GetNearestLocationsResponse
Class GetNearestLocationsResponse.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($GetLocationsResult)
• public static jsonDeserialize($json)
• public jsonSerialize()
1.13. Reference 75
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public propertyFirstred\PostNL\Entity\Response\GetNearestLocationsResponse::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Response\GetNearestLocationsResponse::$GetLocationsResult
Type \Firstred\PostNL\Entity\Response\GetLocationsResult | null
Methods
public Firstred\PostNL\Entity\Response\GetNearestLocationsResponse::__construct($GetLocationsResult=null)
GetNearestLocationsResponse constructor.
Parameters• $GetLocationsResult (Firstred\PostNL\Entity\Response\GetLocationsResult | null)
public static Firstred\PostNL\Entity\Response\GetNearestLocationsResponse::jsonDeserialize($json)
Parameters• $json (stdClass)
Returns mixed | \stdClass | null
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionSince 1.2.0
public Firstred\PostNL\Entity\Response\GetNearestLocationsResponse::jsonSerialize()
Return a serializable array for `json_encode`.
Returns array
76 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
ResponseShipment
class Firstred\PostNL\Entity\Response\ResponseShipment
Class ResponseShipment.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Barcode, $ProductCodeDelivery, $Labels, $DownPartnerBarcode,$DownPartnerID, $DownPartnerLocation, $Warnings)
Properties
public property Firstred\PostNL\Entity\Response\ResponseShipment::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Response\ResponseShipment::$Barcode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseShipment::$DownPartnerBarcode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseShipment::$DownPartnerID
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseShipment::$DownPartnerLocation
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseShipment::$Labels
Type \Firstred\PostNL\Entity\Label[] | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseShipment::$ProductCodeDelivery
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseShipment::$Warnings
Type \Firstred\PostNL\Entity\Warning[] | null
1.13. Reference 77
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Response\ResponseShipment::__construct($Barcode=null,$ProductCodeDeliv-ery=null,$Labels=null,$DownPartnerBar-code=null,$DownPart-nerID=null,$DownPartnerLoca-tion=null,$Warnings=null)
Parameters• $Barcode (string | null)
• $ProductCodeDelivery (string | null)
• $Labels (Firstred\PostNL\Entity\Label[] | null)
• $DownPartnerBarcode (string | null)
• $DownPartnerID (string | null)
• $DownPartnerLocation (string | null)
• $Warnings (Firstred\PostNL\Entity\Warning[] | null)
CompleteStatusResponseEvent
class Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent
Class CompleteStatusResponseEvent.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Code, $Description, $DestinationLocationCode, $LocationCode,$RouteCode, $RouteName, $TimeStamp)
• public setTimeStamp($TimeStamp)
Properties
public propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$Code
78 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$Description
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$DestinationLocationCode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$LocationCode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$RouteCode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$RouteName
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$TimeStamp
Type string | null
Methods
public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::__construct($Code=null,$De-scrip-tion=null,$Desti-nation-Loca-tion-Code=null,$Loca-tion-Code=null,$Route-Code=null,$Route-Name=null,$TimeS-tamp=null)
CompleteStatusResponseEvent constructor.
Parameters• $Code (string | null)
• $Description (string | null)
• $DestinationLocationCode (string | null)
• $LocationCode (string | null)
1.13. Reference 79
PostNL PHP bindings Documentation, Release 1.2.0
• $RouteCode (string | null)
• $RouteName (string | null)
• $TimeStamp (string | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::setTimeStamp($TimeStamp=null)
Parameters• $TimeStamp (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
ResponseTimeframes
class Firstred\PostNL\Entity\Response\ResponseTimeframes
Class ResponseTimeframes.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($ReasonNoTimeframes, $Timeframes)
• public jsonSerialize()
Properties
public property Firstred\PostNL\Entity\Response\ResponseTimeframes::$defaultProperties
Type array
protected static propertyFirstred\PostNL\Entity\Response\ResponseTimeframes::$ReasonNoTimeframes
Type \Firstred\PostNL\Entity\ReasonNoTimeframe[] | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseTimeframes::$Timeframes
Type \Firstred\PostNL\Entity\Timeframe[] | null
80 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Response\ResponseTimeframes::__construct($ReasonNoTimeframes=null,$Timeframes=null)
Parameters• $ReasonNoTimeframes (Firstred\PostNL\Entity\ReasonNoTimeframe[] |
null)
• $Timeframes (Firstred\PostNL\Entity\Timeframe[] | null)
public Firstred\PostNL\Entity\Response\ResponseTimeframes::jsonSerialize()
Return a serializable array for `json_encode`.
Returns array
CompleteStatusResponseShipment
class Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
Class CompleteStatusResponseShipment.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Addresses, $Amounts, $Barcode, $Customer, $DeliveryDate,$Dimension, $Events, $Expectation, $Groups, $OldStatuses, $ProductCode,$ProductOptions, $Reference, $Status, $Warnings, $MainBarcode, $ShipmentAmount,$ShipmentCounter, $ProductDescription)
• public setDeliveryDate($deliveryDate)
• public static jsonDeserialize($json)
• public xmlSerialize($writer)
Properties
public propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$defaultProperties
Type string[][]
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Addresses
Type \Firstred\PostNL\Entity\Address[] | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Amounts
Type \Firstred\PostNL\Entity\Amount[] | null
1.13. Reference 81
PostNL PHP bindings Documentation, Release 1.2.0
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Barcode
Type \Firstred\PostNL\Entity\Barcode | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Customer
Type \Firstred\PostNL\Entity\Customer | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$DeliveryDate
Type \DateTimeInterface | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Dimension
Type \Firstred\PostNL\Entity\Dimension | null Dimension
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Events
Type \Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent[] | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Expectation
Type \Firstred\PostNL\Entity\Expectation | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Groups
Type \Firstred\PostNL\Entity\Group[] | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$MainBarcode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$OldStatuses
Type \Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus[] |null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$ProductCode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$ProductDescription
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$ProductOptions
Type \Firstred\PostNL\Entity\ProductOption[] | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Reference
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$ShipmentAmount
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$ShipmentCounter
82 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Status
Type \Firstred\PostNL\Entity\Status | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Warnings
Type \Firstred\PostNL\Entity\Warning[] | null
1.13. Reference 83
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::__construct($Addresses=null,$Amounts=null,$Bar-code=null,$Cus-tomer=null,$De-liv-ery-Date=null,$Di-men-sion=null,$Events=null,$Ex-pec-ta-tion=null,$Groups=null,$Old-Sta-tuses=null,$Pro-duct-Code=null,$Pro-duc-tOp-tions=null,$Ref-er-ence=null,$Sta-tus=null,$Warn-ings=null,$Main-Bar-code=null,$Ship-men-tA-mount=null,$Ship-ment-Counter=null,$Pro-duct-De-scrip-tion=null)
CompleteStatusResponseShipment constructor.
Parameters
84 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $Addresses (Firstred\PostNL\Entity\Address[] | null)
• $Amounts (Firstred\PostNL\Entity\Amount[] | null)
• $Barcode (string | null)
• $Customer (Firstred\PostNL\Entity\Customer | null)
• $DeliveryDate (DateTimeInterface | string | null)
• $Dimension (Firstred\PostNL\Entity\Dimension | null)
• $Events (Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent[]| null)
• $Expectation (Firstred\PostNL\Entity\Expectation | null)
• $Groups (Firstred\PostNL\Entity\Group[] | null)
• $OldStatuses (Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus[] | null)
• $ProductCode (string | null)
• $ProductOptions (Firstred\PostNL\Entity\ProductOption[] | null)
• $Reference (string | null)
• $Status (Firstred\PostNL\Entity\Status | null)
• $Warnings (Firstred\PostNL\Entity\Warning[] | null)
• $MainBarcode (string | null)
• $ShipmentAmount (string | null)
• $ShipmentCounter (string | null)
• $ProductDescription (string | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setDeliveryDate($deliveryDate=null)
Parameters• $deliveryDate (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public static Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::jsonDeserialize($json)
Parameters• $json (stdClass)
Returns mixed | \stdClass | null
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionSince 1.2.0
1.13. Reference 85
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
ResponseGroup
class Firstred\PostNL\Entity\Response\ResponseGroup
Class ResponseGroup.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($GroupCount, $GroupSequence, $GroupType, $MainBarcode)
Properties
public property Firstred\PostNL\Entity\Response\ResponseGroup::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Response\ResponseGroup::$GroupCount
Amount of shipments in the ResponseGroup.
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseGroup::$GroupSequence
Sequence number.
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseGroup::$GroupType
The type of Group.
Possible values:
- `01`: Collection request- `03`: Multiple parcels in one shipment (multi-colli)- `04`: Single parcel in one shipment
86 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseGroup::$MainBarcode
Main barcode for the shipment.
Type string | null
Methods
public Firstred\PostNL\Entity\Response\ResponseGroup::__construct($GroupCount=null,$GroupSequence=null,$GroupType=null,$MainBarcode=null)
ResponseGroup Constructor.
Parameters• $GroupCount (string | null)
• $GroupSequence (string | null)
• $GroupType (string | null)
• $MainBarcode (string | null)
GenerateBarcodeResponse
class Firstred\PostNL\Entity\Response\GenerateBarcodeResponse
Class GenerateBarcodeResponse.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Barcode)
Properties
public propertyFirstred\PostNL\Entity\Response\GenerateBarcodeResponse::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Response\GenerateBarcodeResponse::$Barcode
Type string | null
1.13. Reference 87
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Response\GenerateBarcodeResponse::__construct($Barcode=null)
GenerateBarcodeResponse constructor.
Parameters• $Barcode (string | null)
GetLocationsInAreaResponse
class Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse
Class GetLocationsInAreaResponse.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($GetLocationsResult)
• public jsonSerialize()
Properties
public propertyFirstred\PostNL\Entity\Response\GetLocationsInAreaResponse::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Response\GetLocationsInAreaResponse::$GetLocationsResult
Type \Firstred\PostNL\Entity\Response\GetLocationsResult | null
Methods
public Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse::__construct($GetLocationsResult=null)
GetLocationsInAreaResponse constructor.
Parameters• $GetLocationsResult (Firstred\PostNL\Entity\Response\GetLocationsResult | null)
public Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse::jsonSerialize()
Return a serializable array for `json_encode`.
88 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Returns array
CurrentStatusResponse
class Firstred\PostNL\Entity\Response\CurrentStatusResponse
Class CurrentStatusResponse.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Shipments)
• public xmlSerialize($writer)
Properties
public propertyFirstred\PostNL\Entity\Response\CurrentStatusResponse::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponse::$Shipments
Type \Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment[] | null
Methods
public Firstred\PostNL\Entity\Response\CurrentStatusResponse::__construct($Shipments=null)
CurrentStatusResponse constructor.
Parameters• $Shipments (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment[] | null)
public Firstred\PostNL\Entity\Response\CurrentStatusResponse::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
1.13. Reference 89
PostNL PHP bindings Documentation, Release 1.2.0
CompleteStatusResponse
class Firstred\PostNL\Entity\Response\CompleteStatusResponse
Class CompleteStatusResponse.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Shipments)
• public static jsonDeserialize($json)
• public xmlSerialize($writer)
Properties
public propertyFirstred\PostNL\Entity\Response\CompleteStatusResponse::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponse::$Shipments
Type \Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment[] |null
Methods
public Firstred\PostNL\Entity\Response\CompleteStatusResponse::__construct($Shipments=null)
CompleteStatusResponse constructor.
Parameters• $Shipments (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment[] | null)
public static Firstred\PostNL\Entity\Response\CompleteStatusResponse::jsonDeserialize($json)
public Firstred\PostNL\Entity\Response\CompleteStatusResponse::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
90 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
ResponseLocation
class Firstred\PostNL\Entity\Response\ResponseLocation
Class ResponseLocation.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Address, $DeliveryOptions, $Distance, $Latitude,$Longitude, $Name, $OpeningHours, $PartnerName, $PhoneNumber, $LocationCode,$RetailNetworkID, $Saleschannel, $TerminalType, $Warnings, $DownPartnerID,$DownPartnerLocation)
• public static jsonDeserialize($json)
Properties
public property Firstred\PostNL\Entity\Response\ResponseLocation::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$Address
Type \Firstred\PostNL\Entity\Address | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseLocation::$DeliveryOptions
Type string[] | null
protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$Distance
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$Latitude
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$Longitude
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$Name
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseLocation::$OpeningHours
Type \Firstred\PostNL\Entity\OpeningHours | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseLocation::$PartnerName
Type string | null
1.13. Reference 91
PostNL PHP bindings Documentation, Release 1.2.0
protected static propertyFirstred\PostNL\Entity\Response\ResponseLocation::$PhoneNumber
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseLocation::$LocationCode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseLocation::$RetailNetworkID
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseLocation::$Saleschannel
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseLocation::$TerminalType
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$Warnings
Type \Firstred\PostNL\Entity\Warning[] | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseLocation::$DownPartnerID
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseLocation::$DownPartnerLocation
Type string | null
Methods
public Firstred\PostNL\Entity\Response\ResponseLocation::__construct($Address=null, $De-liveryOptions=null,$Distance=null,$Latitude=null,$Longitude=null,$Name=null,$OpeningHours=null,$PartnerName=null,$PhoneNumber=null,$LocationCode=null,$RetailNet-workID=null,$Saleschannel=null,$TerminalType=null,$Warnings=null,$DownPart-nerID=null,$DownPartnerLoca-tion=null)
ResponseLocation constructor.
Parameters
92 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $Address (Firstred\PostNL\Entity\Address | null)
• $DeliveryOptions (string[] | null)
• $Distance (string | null)
• $Latitude (string | null)
• $Longitude (string | null)
• $Name (string | null)
• $OpeningHours (string[] | null)
• $PartnerName (string | null)
• $PhoneNumber (string | null)
• $LocationCode (string | null)
• $RetailNetworkID (string | null)
• $Saleschannel (string | null)
• $TerminalType (string | null)
• $Warnings (Firstred\PostNL\Entity\Warning[] | null)
• $DownPartnerID (string | null)
• $DownPartnerLocation (string | null)
public static Firstred\PostNL\Entity\Response\ResponseLocation::jsonDeserialize($json)
MergedLabel
class Firstred\PostNL\Entity\Response\MergedLabel
Class MergedLabel.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Barcodes, $Labels)
Properties
public property Firstred\PostNL\Entity\Response\MergedLabel::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Response\MergedLabel::$Barcodes
Type string[] | null
protected static property Firstred\PostNL\Entity\Response\MergedLabel::$Labels
Type \Firstred\PostNL\Entity\Label[] | null
1.13. Reference 93
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Response\MergedLabel::__construct($Barcodes=null,$Labels=null)
Parameters• $Barcodes (string[] | null)
• $Labels (Firstred\PostNL\Entity\Label[] | null)
GetSentDateResponse
class Firstred\PostNL\Entity\Response\GetSentDateResponse
Class GetSentDateResponse.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($GetSentDate, $Options)
• public setSentDate($SentDate)
• public xmlSerialize($writer)
Properties
public propertyFirstred\PostNL\Entity\Response\GetSentDateResponse::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Response\GetSentDateResponse::$SentDate
Type \DateTimeInterface | null
protected static propertyFirstred\PostNL\Entity\Response\GetSentDateResponse::$Options
Type string[] | null
94 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Response\GetSentDateResponse::__construct($GetSentDate=null,$Options=null)
GetSentDateResponse constructor.
Parameters• $GetSentDate (DateTimeInterface | string | null)
• $Options (string[] | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\Entity\Response\GetSentDateResponse::setSentDate($SentDate=null)
Parameters• $SentDate (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\Response\GetSentDateResponse::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
UpdatedShipmentsResponse
class Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse
Class CompleteStatusResponse.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Barcode, $CreationDate, $CustomerNumber, $CustomerCode,$Status)
• public setCreationDate($CreationDate)
1.13. Reference 95
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public propertyFirstred\PostNL\Entity\Response\UpdatedShipmentsResponse::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Response\UpdatedShipmentsResponse::$Barcode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\UpdatedShipmentsResponse::$CreationDate
Type \DateTimeInterface | null
protected static propertyFirstred\PostNL\Entity\Response\UpdatedShipmentsResponse::$CustomerNumber
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\UpdatedShipmentsResponse::$CustomerCode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\UpdatedShipmentsResponse::$Status
Type \Firstred\PostNL\Entity\Status | null
Methods
public Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::__construct($Barcode=null,$Creation-Date=null,$Customer-Num-ber=null,$Customer-Code=null,$Sta-tus=null)
UpdatedShipmentsResponse constructor.
Parameters• $Barcode (string | null)
• $CreationDate (string | \DateTimeInterface | null)
• $CustomerNumber (string | null)
• $CustomerCode (string | null)
• $Status (Firstred\PostNL\Entity\Status | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
96 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::setCreationDate($CreationDate=null)
Parameters• $CreationDate (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
GetSignatureResponseSignature
class Firstred\PostNL\Entity\Response\GetSignatureResponseSignature
Class GetSignatureResponseSignature.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Barcode, $SignatureDate, $SignatureImage)
• public setSignatureDate($SignatureDate)
Properties
public propertyFirstred\PostNL\Entity\Response\GetSignatureResponseSignature::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Response\GetSignatureResponseSignature::$Barcode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\GetSignatureResponseSignature::$SignatureDate
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\GetSignatureResponseSignature::$SignatureImage
Type string | null
1.13. Reference 97
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Response\GetSignatureResponseSignature::__construct($Barcode=null,$Sig-na-ture-Date=null,$Sig-na-tureIm-age=null)
GetSignatureResponseSignature constructor.
Parameters• $Barcode (string | null)
• $SignatureDate (string | null)
• $SignatureImage (string | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\Entity\Response\GetSignatureResponseSignature::setSignatureDate($SignatureDate=null)
Parameters• $SignatureDate (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
ResponseAmount
class Firstred\PostNL\Entity\Response\ResponseAmount
Class ResponseAmount.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($AccountName, $ResponseAmount, $BIC, $Currency, $IBAN,$Reference, $TransactionNumber, $Value, $VerzekerdBedrag)
98 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Entity\Response\ResponseAmount::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Response\ResponseAmount::$AccountName
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseAmount::$ResponseAmountType
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAmount::$BIC
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAmount::$Currency
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAmount::$IBAN
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAmount::$Reference
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseAmount::$TransactionNumber
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAmount::$Value
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseAmount::$VerzekerdBedrag
Type string | null
Methods
public Firstred\PostNL\Entity\Response\ResponseAmount::__construct($AccountName=null,$ResponseAmount=null,$BIC=null,$Currency=null,$IBAN=null,$Reference=null,$TransactionNum-ber=null, $Value=null,$Verzek-erdBedrag=null)
Parameters• $AccountName (string | null)
• $ResponseAmount (string | null)
• $BIC (string | null)
• $Currency (string | null)
1.13. Reference 99
PostNL PHP bindings Documentation, Release 1.2.0
• $IBAN (string | null)
• $Reference (string | null)
• $TransactionNumber (string | null)
• $Value (string | null)
• $VerzekerdBedrag (string | null)
GenerateLabelResponse
class Firstred\PostNL\Entity\Response\GenerateLabelResponse
Class GenerateLabelResponse.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($MergedLabels, $ReponseShipments)
Properties
public propertyFirstred\PostNL\Entity\Response\GenerateLabelResponse::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array | null
protected static propertyFirstred\PostNL\Entity\Response\GenerateLabelResponse::$MergedLabels
Type \Firstred\PostNL\Entity\Response\MergedLabel[] | null
protected static propertyFirstred\PostNL\Entity\Response\GenerateLabelResponse::$ResponseShipments
Type \Firstred\PostNL\Entity\Response\ResponseShipment[] | null
Methods
public Firstred\PostNL\Entity\Response\GenerateLabelResponse::__construct($MergedLabels=null,$ReponseShip-ments=null)
GenerateLabelResponse constructor.
Parameters• $MergedLabels (Firstred\PostNL\Entity\Response\MergedLabel[] | null)
• $ReponseShipments (Firstred\PostNL\Entity\Response\ResponseShipment[] | null)
100 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
ResponseAddress
class Firstred\PostNL\Entity\Response\ResponseAddress
Class ResponseAddress.
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)
• public setZipcode($Zipcode)
Properties
public property Firstred\PostNL\Entity\Response\ResponseAddress::$defaultProperties
Type string[][]
protected static propertyFirstred\PostNL\Entity\Response\ResponseAddress::$AddressType
Type string | null PostNL internal applications validate the receiver ResponseAddress. In casethe spelling of ResponseAddresses should be different according to our PostNL information,the ResponseAddress details will be corrected. This can be noticed in Track & Trace.
Please note that the webservice will not add ResponseAddress details. Street and City fieldswill only be printed when they are in the call towards the labeling webservice.
The element ResponseAddress type is a code in the request. Possible values are:
Code Description 01 Receiver 02 Sender 03 Alternative sender ResponseAddress 04 Collec-tion ResponseAddress (In the orders need to be collected first) 08 Return ResponseAddress*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 > `Antwoord-nummer` in AddressType 08. > This cannot be a regular ResponseAddress
The following rules apply: If there is no ResponseAddress specified with AddressType = 02,the data from Customer/ResponseAddress will be added to the list as AddressType 02. Ifthere is no Customer/ResponseAddress, the message will be rejected.
At least one other AddressType must be specified, other than AddressType 02 In most casesthis will be AddressType 01, the receiver ResponseAddress.
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$Area
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseAddress::$Buildingname
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$City
Type string | null
1.13. Reference 101
PostNL PHP bindings Documentation, Release 1.2.0
protected static propertyFirstred\PostNL\Entity\Response\ResponseAddress::$CompanyName
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ResponseAddress::$Countrycode
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$Department
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$Doorcode
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$FirstName
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$Floor
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$HouseNr
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$HouseNrExt
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$Name
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$Region
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$Remark
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$Street
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$Zipcode
Type string | null
protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$other
Type array | null Array with optional properties
102 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Response\ResponseAddress::__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)
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)
public Firstred\PostNL\Entity\Response\ResponseAddress::setZipcode($Zipcode=null)
Set postcode.
Parameters• $Zipcode (string | null)
Returns static
1.13. Reference 103
PostNL PHP bindings Documentation, Release 1.2.0
CurrentStatusResponseShipment
class Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment
Class CurrentStatusResponseShipment.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Addresses, $Amounts, $Barcode, $DeliveryDate, $Dimension,$Expectation, $Groups, $ProductCode, $ProductOptions, $Reference, $Status,$Warnings, $MainBarcode, $ShipmentAmount, $ShipmentCounter, $ProductDescription)
• public setDeliveryDate($deliveryDate)
• public static jsonDeserialize($json)
• public xmlSerialize($writer)
Properties
public propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$defaultProperties
Type string[][]
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Addresses
Type \Firstred\PostNL\Entity\Address[] | null
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Amounts
Type \Firstred\PostNL\Entity\Amount[] | null
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Barcode
Type \Firstred\PostNL\Entity\Barcode | null
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$DeliveryDate
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Dimension
Type \Firstred\PostNL\Entity\Dimension | null Dimension
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Expectation
Type \Firstred\PostNL\Entity\Expectation | null
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Groups
Type \Firstred\PostNL\Entity\Group[] | null
104 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$MainBarcode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$ProductCode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$ProductDescription
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$ProductOptions
Type \Firstred\PostNL\Entity\ProductOption[] | null
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Reference
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$ShipmentAmount
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$ShipmentCounter
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Status
Type \Firstred\PostNL\Entity\Status | null
protected static propertyFirstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Warnings
Type \Firstred\PostNL\Entity\Warning[] | null
1.13. Reference 105
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::__construct($Addresses=null,$Amounts=null,$Bar-code=null,$De-liv-ery-Date=null,$Di-men-sion=null,$Ex-pec-ta-tion=null,$Groups=null,$Pro-duct-Code=null,$Pro-duc-tOp-tions=null,$Ref-er-ence=null,$Sta-tus=null,$Warn-ings=null,$Main-Bar-code=null,$Ship-men-tA-mount=null,$Ship-ment-Counter=null,$Pro-duct-De-scrip-tion=null)
CurrentStatusResponseShipment constructor.
Parameters• $Addresses (Firstred\PostNL\Entity\Address[] | null)
• $Amounts (Firstred\PostNL\Entity\Amount[] | null)
• $Barcode (string | null)
• $DeliveryDate (DateTimeInterface | string | null)
106 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $Dimension (Firstred\PostNL\Entity\Dimension | null)
• $Expectation (Firstred\PostNL\Entity\Expectation | null)
• $Groups (Firstred\PostNL\Entity\Group[] | null)
• $ProductCode (string | null)
• $ProductOptions (Firstred\PostNL\Entity\ProductOption[] | null)
• $Reference (string | null)
• $Status (Firstred\PostNL\Entity\Status | null)
• $Warnings (Firstred\PostNL\Entity\Warning[] | null)
• $MainBarcode (string | null)
• $ProductDescription (string | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setDeliveryDate($deliveryDate=null)
Parameters• $deliveryDate (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public static Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::jsonDeserialize($json)
Parameters• $json (stdClass)
Returns mixed | \stdClass | null
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionSince 1.2.0
public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
1.13. Reference 107
PostNL PHP bindings Documentation, Release 1.2.0
ConfirmingResponseShipment
class Firstred\PostNL\Entity\Response\ConfirmingResponseShipment
Class ConfirmingResponseShipment.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Barcode, $Warnings)
Properties
public propertyFirstred\PostNL\Entity\Response\ConfirmingResponseShipment::$defaultProperties
Type string[][]
protected static propertyFirstred\PostNL\Entity\Response\ConfirmingResponseShipment::$Barcode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\ConfirmingResponseShipment::$Warnings
Type \Firstred\PostNL\Entity\Warning[] | null
Methods
public Firstred\PostNL\Entity\Response\ConfirmingResponseShipment::__construct($Barcode=null,$Warn-ings=null)
Parameters• $Barcode (string | null)
• $Warnings (Firstred\PostNL\Entity\Warning[] | null)
GetDeliveryDateResponse
class Firstred\PostNL\Entity\Response\GetDeliveryDateResponse
Class GetDeliveryDateResponse.
Parent Firstred\PostNL\Entity\AbstractEntity
108 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($DeliveryDate, $Options)
• public setDeliveryDate($DeliveryDate)
• public xmlSerialize($writer)
• public static jsonDeserialize($json)
Properties
public propertyFirstred\PostNL\Entity\Response\GetDeliveryDateResponse::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Response\GetDeliveryDateResponse::$DeliveryDate
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\GetDeliveryDateResponse::$Options
Type string[] | null
Methods
public Firstred\PostNL\Entity\Response\GetDeliveryDateResponse::__construct($DeliveryDate=null,$Op-tions=null)
GetDeliveryDateResponse constructor.
Parameters• $DeliveryDate (string | \DateTimeInterface | null)
• $Options (string[] | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\Entity\Response\GetDeliveryDateResponse::setDeliveryDate($DeliveryDate=null)
Parameters• $DeliveryDate (DateTimeInterface | string | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\Response\GetDeliveryDateResponse::xmlSerialize($writer)
1.13. Reference 109
PostNL PHP bindings Documentation, Release 1.2.0
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
public static Firstred\PostNL\Entity\Response\GetDeliveryDateResponse::jsonDeserialize($json)
Parameters• $json (stdClass)
Returns \Firstred\PostNL\Entity\Response\GetDeliveryDateResponse | object | \stdClass | null
Throws \Firstred\PostNL\Exception\InvalidArgumentException
SendShipmentResponse
class Firstred\PostNL\Entity\Response\SendShipmentResponse
Class GenerateLabelResponse.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($MergedLabels, $ReponseShipments)
Properties
public propertyFirstred\PostNL\Entity\Response\SendShipmentResponse::$defaultProperties
Type array | null
protected static propertyFirstred\PostNL\Entity\Response\SendShipmentResponse::$MergedLabels
Type \Firstred\PostNL\Entity\Response\MergedLabel[] | null
protected static propertyFirstred\PostNL\Entity\Response\SendShipmentResponse::$ResponseShipments
Type \Firstred\PostNL\Entity\Response\ResponseShipment[] | null
110 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Response\SendShipmentResponse::__construct($MergedLabels=null,$ReponseShip-ments=null)
SendShipmentResponse constructor.
Parameters• $MergedLabels (Firstred\PostNL\Entity\Response\MergedLabel[] | null)
• $ReponseShipments (Firstred\PostNL\Entity\Response\ResponseShipment[] | null)
CompleteStatusResponseOldStatus
class Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus
Class CompleteStatusResponseOldStatus.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($StatusCode, $StatusDescription, $PhaseCode,$PhaseDescription, $TimeStamp)
• public setTimeStamp($TimeStamp)
Properties
public propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::$StatusCode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::$StatusDescription
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::$PhaseCode
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::$PhaseDescription
1.13. Reference 111
PostNL PHP bindings Documentation, Release 1.2.0
Type string | null
protected static propertyFirstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::$TimeStamp
Type \DateTimeInterface | null
Methods
public Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::__construct($StatusCode=null,$Sta-tus-De-scrip-tion=null,$PhaseC-ode=null,$PhaseDescrip-tion=null,$TimeS-tamp=null)
CompleteStatusResponseOldStatus constructor.
Parameters• $StatusCode (string | null)
• $StatusDescription (string | null)
• $PhaseCode (string | null)
• $PhaseDescription (string | null)
• $TimeStamp (DateTimeInterface | string | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::setTimeStamp($TimeStamp=null)
Parameters• $TimeStamp (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
SOAP
\Firstred\PostNL\Entity\SOAP
112 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Classes
Header
class Firstred\PostNL\Entity\SOAP\Header
Class Header.
NOTE: this class has been introduced for deserializing
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Body
class Firstred\PostNL\Entity\SOAP\Body
Class Body.
NOTE: this class has been introduced for deserializing
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Properties
public property Firstred\PostNL\Entity\SOAP\Body::$defaultProperties
Type array
protected static property Firstred\PostNL\Entity\SOAP\Body::$GenerateBarcodeResponse
Type \Firstred\PostNL\Entity\Response\GenerateBarcodeResponse | null
UsernameToken
class Firstred\PostNL\Entity\SOAP\UsernameToken
Class UsernameToken.
Parent Firstred\PostNL\Entity\AbstractEntity
1.13. Reference 113
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($Username, $Password)
• public xmlSerialize($writer)
Properties
public property Firstred\PostNL\Entity\SOAP\UsernameToken::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\SOAP\UsernameToken::$Username
Type string | null
protected static property Firstred\PostNL\Entity\SOAP\UsernameToken::$Password
Type string | null
Methods
public Firstred\PostNL\Entity\SOAP\UsernameToken::__construct($Username, $Password)
UsernameToken constructor.
Parameters• $Username (string | null)
• $Password (string | null) Plaintext password
public Firstred\PostNL\Entity\SOAP\UsernameToken::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
Security
class Firstred\PostNL\Entity\SOAP\Security
Class Security.
Parent Firstred\PostNL\Entity\AbstractEntity
114 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($UserNameToken)
Constants
SECURITY_NAMESPACE = \'http://docs\.oasis\-open\.org/wss/2004/01/oasis\-200401\-wss\-wssecurity\-secext\-1\.0\.xsd\'
Properties
public property Firstred\PostNL\Entity\SOAP\Security::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\SOAP\Security::$UsernameToken
Type \Firstred\PostNL\Entity\SOAP\UsernameToken
Methods
public Firstred\PostNL\Entity\SOAP\Security::__construct($UserNameToken)
Security constructor.
Parameters• $UserNameToken (Firstred\PostNL\Entity\SOAP\UsernameToken)
Envelope
class Firstred\PostNL\Entity\SOAP\Envelope
Class Envelope.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Header, $Body)
1.13. Reference 115
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Entity\SOAP\Envelope::$defaultProperties
Default properties and namespaces for the SOAP API.
Type array
protected static property Firstred\PostNL\Entity\SOAP\Envelope::$Header
Type \Firstred\PostNL\Entity\SOAP\Header | null
protected static property Firstred\PostNL\Entity\SOAP\Envelope::$Body
Type \Firstred\PostNL\Entity\SOAP\Body | null
Methods
public Firstred\PostNL\Entity\SOAP\Envelope::__construct($Header=null, $Body=null)
Envelope constructor.
Parameters• $Header (Firstred\PostNL\Entity\SOAP\Header | null)
• $Body (Firstred\PostNL\Entity\SOAP\Body | null)
Classes
CoordinatesSouthEast
class Firstred\PostNL\Entity\CoordinatesSouthEast
Class CoordinatesSouthEast.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Latitude, $Longitude)
116 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Entity\CoordinatesSouthEast::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\CoordinatesSouthEast::$Latitude
Type string | null
protected static property Firstred\PostNL\Entity\CoordinatesSouthEast::$Longitude
Type string | null
Methods
public Firstred\PostNL\Entity\CoordinatesSouthEast::__construct($Latitude=null,$Longitude=null)
Parameters• $Latitude (string | null)
• $Longitude (string | null)
OldStatus
class Firstred\PostNL\Entity\OldStatus
Class OldStatus.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($PhaseCode, $PhaseDescription, $OldStatusCode,$OldStatusDescription, $TimeStamp)
Properties
public property Firstred\PostNL\Entity\OldStatus::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\OldStatus::$CurrentPhaseCode
Type string | null
protected static property Firstred\PostNL\Entity\OldStatus::$CurrentPhaseDescription
Type string | null
protected static property Firstred\PostNL\Entity\OldStatus::$CurrentOldStatusCode
Type string | null
protected static propertyFirstred\PostNL\Entity\OldStatus::$CurrentOldStatusDescription
1.13. Reference 117
PostNL PHP bindings Documentation, Release 1.2.0
Type string | null
protected static property Firstred\PostNL\Entity\OldStatus::$CurrentOldStatusTimeStamp
Type string | null
Methods
public Firstred\PostNL\Entity\OldStatus::__construct($PhaseCode=null,$PhaseDescription=null,$OldStatusCode=null,$OldStatusDescription=null,$TimeStamp=null)
Parameters• $PhaseCode (string | null)
• $PhaseDescription (string | null)
• $OldStatusCode (string | null)
• $OldStatusDescription (string | null)
• $TimeStamp (string | null)
Warning
class Firstred\PostNL\Entity\Warning
Class Warning.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Code, $Description)
Properties
public property Firstred\PostNL\Entity\Warning::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Warning::$Code
Type string | null
protected static property Firstred\PostNL\Entity\Warning::$Description
Type string | null
118 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Warning::__construct($Code=null, $Description=null)
Parameters• $Code (string | null)
• $Description (string | null)
ReasonNoTimeframe
class Firstred\PostNL\Entity\ReasonNoTimeframe
Class ReasonNoTimeframe.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Code, $Date, $Description, $Options, $From, $To)
• public setDate($date)
• public static jsonDeserialize($json)
• public xmlSerialize($writer)
Properties
public property Firstred\PostNL\Entity\ReasonNoTimeframe::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\ReasonNoTimeframe::$Code
Type string | null
protected static property Firstred\PostNL\Entity\ReasonNoTimeframe::$Date
Type \DateTimeInterface | null
protected static property Firstred\PostNL\Entity\ReasonNoTimeframe::$Description
Type string | null
protected static property Firstred\PostNL\Entity\ReasonNoTimeframe::$Options
Type string[] | null
protected static property Firstred\PostNL\Entity\ReasonNoTimeframe::$From
Type string | null
protected static property Firstred\PostNL\Entity\ReasonNoTimeframe::$To
Type string | null
1.13. Reference 119
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\ReasonNoTimeframe::__construct($Code=null, $Date=null,$Description=null,$Options=null, $From=null,$To=null)
ReasonNoTimeframe constructor.
Parameters• $Code (string | null)
• $Date (string | \DateTimeInterface | null)
• $Description (string | null)
• $Options (string[] | null)
• $From (string | null)
• $To (string | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\Entity\ReasonNoTimeframe::setDate($date=null)
Set date
Parameters• $date (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public static Firstred\PostNL\Entity\ReasonNoTimeframe::jsonDeserialize($json)
Parameters• $json (stdClass)
Returns mixed | \stdClass | null
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionSince 1.2.0
public Firstred\PostNL\Entity\ReasonNoTimeframe::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
120 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Area
class Firstred\PostNL\Entity\Area
Class Area.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($CoordinatesNorthWest, $CoordinatesSouthEast)
Properties
public property Firstred\PostNL\Entity\Area::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Area::$CoordinatesNorthWest
Type \Firstred\PostNL\Entity\Coordinates | null
protected static property Firstred\PostNL\Entity\Area::$CoordinatesSouthEast
Type \Firstred\PostNL\Entity\Coordinates | null
Methods
public Firstred\PostNL\Entity\Area::__construct($CoordinatesNorthWest=null,$CoordinatesSouthEast=null)
Parameters• $CoordinatesNorthWest (Firstred\PostNL\Entity\Coordinates | null)
• $CoordinatesSouthEast (Firstred\PostNL\Entity\Coordinates | null)
Contact
class Firstred\PostNL\Entity\Contact
Class Contact.
Parent Firstred\PostNL\Entity\AbstractEntity
1.13. Reference 121
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($ContactType, $Email, $SMSNr, $TelNr)
• public setTelNr($TelNr, $countryCode)
• public setSMSNr($SMSNr, $countryCode)
Properties
public property Firstred\PostNL\Entity\Contact::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Contact::$ContactType
Type string | null
protected static property Firstred\PostNL\Entity\Contact::$Email
Type string | null
protected static property Firstred\PostNL\Entity\Contact::$SMSNr
Type string | null
protected static property Firstred\PostNL\Entity\Contact::$TelNr
Type string | null
Methods
public Firstred\PostNL\Entity\Contact::__construct($ContactType=null, $Email=null,$SMSNr=null, $TelNr=null)
Contact constructor.
Parameters• $ContactType (string | null)
• $Email (string | null)
• $SMSNr (string | null)
• $TelNr (string | null)
Throws \libphonenumber\NumberParseException
public Firstred\PostNL\Entity\Contact::setTelNr($TelNr=null, $countryCode=null)
Set the telephone number.
Parameters• $TelNr (string | null)
• $countryCode (string | null)
Returns static
Throws \libphonenumber\NumberParseException
122 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Since 1.0.0
Since 1.0.0
public Firstred\PostNL\Entity\Contact::setSMSNr($SMSNr=null, $countryCode=null)
Set the mobile number.
Parameters• $SMSNr (string | null)
• $countryCode (string | null)
Returns static
Throws \libphonenumber\NumberParseException
Since 1.0.0
Since 1.0.0
Event
class Firstred\PostNL\Entity\Event
Class Event.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($CompleteStatusResponseEvent)
Properties
public property Firstred\PostNL\Entity\Event::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Event::$CompleteStatusResponseEvent
Type \Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent | null
Methods
public Firstred\PostNL\Entity\Event::__construct($CompleteStatusResponseEvent=null)
Parameters• $CompleteStatusResponseEvent (Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent | null)
1.13. Reference 123
PostNL PHP bindings Documentation, Release 1.2.0
AbstractEntity
class Firstred\PostNL\Entity\AbstractEntity
Class Entity.
Implements JsonSerializable Firstred\PostNL\Util\XmlSerializable
Summary
Methods
• public __construct()
• public static create($properties)
• public __call($name, $value)
• public jsonSerialize()
• public xmlSerialize($writer)
• public static jsonDeserialize($json)
• public static xmlDeserialize($xml)
• public static shouldBeAnArray($fqcn, $propertyName)
• public static getFullyQualifiedEntityClassName($shortName)
Properties
public property Firstred\PostNL\Entity\AbstractEntity::$defaultProperties
Type array
protected static property Firstred\PostNL\Entity\AbstractEntity::$id
Type string
protected static property Firstred\PostNL\Entity\AbstractEntity::$currentService
Type string
Methods
public Firstred\PostNL\Entity\AbstractEntity::__construct()
AbstractEntity constructor.
public static Firstred\PostNL\Entity\AbstractEntity::create( $properties=\[\])
Create an instance of this class without touching the constructor.
Parameters• $properties (array)
Returns object | null
Since 1.0.0
124 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Entity\AbstractEntity::__call($name, $value)
Parameters• $name (string)
• $value (mixed)
Returns object | null
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionpublic Firstred\PostNL\Entity\AbstractEntity::jsonSerialize()
Return a serializable array for `json_encode`.
Returns array
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\Entity\AbstractEntity::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public static Firstred\PostNL\Entity\AbstractEntity::jsonDeserialize($json)
Deserialize JSON.
Parameters• $json (stdClass) JSON object {“EntityName”: object}
Returns mixed
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
public static Firstred\PostNL\Entity\AbstractEntity::xmlDeserialize($xml)
Deserialize XML.
Parameters• $xml (array) Associative array representation of XML response, using Clark notation
for namespaces
Returns \Firstred\PostNL\Entity\AbstractEntity
public static Firstred\PostNL\Entity\AbstractEntity::shouldBeAnArray($fqcn,$propertyName)
1.13. Reference 125
PostNL PHP bindings Documentation, Release 1.2.0
Whether the given property should bbe an array
Parameters• $fqcn (string)
• $propertyName (string)
Returns false | string If found, singular name of property
Since 1.2.0
public static Firstred\PostNL\Entity\AbstractEntity::getFullyQualifiedEntityClassName($shortName)
Get the fully qualified class name for the given entity name.
Parameters• $shortName (string)
Returns string The FQCN
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
Label
class Firstred\PostNL\Entity\Label
Class Label.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Content, $ContentType, $Labeltype)
Constants
FORMAT_A4 = 1
FORMAT_A6 = 2
Properties
public property Firstred\PostNL\Entity\Label::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Label::$Content
Type string | null Base 64 encoded content
protected static property Firstred\PostNL\Entity\Label::$Contenttype
Type string | null
126 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
protected static property Firstred\PostNL\Entity\Label::$Labeltype
Type string | null
Methods
public Firstred\PostNL\Entity\Label::__construct($Content=null, $ContentType=null,$Labeltype=null)
Parameters• $Content (string | null)
• $ContentType (string | null)
• $Labeltype (string | null)
Expectation
class Firstred\PostNL\Entity\Expectation
Class Expectation.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($ETAFrom, $ETATo)
• public setETAFrom($ETAFrom)
• public setETATo($ETATo)
Properties
public property Firstred\PostNL\Entity\Expectation::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Expectation::$ETAFrom
Type \DateTimeInterface | null
protected static property Firstred\PostNL\Entity\Expectation::$ETATo
Type \DateTimeInterface | null
1.13. Reference 127
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Expectation::__construct($ETAFrom=null, $ETATo=null)
Parameters• $ETAFrom (DateTimeInterface | string | null)
• $ETATo (DateTimeInterface | string | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionpublic Firstred\PostNL\Entity\Expectation::setETAFrom($ETAFrom=null)
Parameters• $ETAFrom (DateTimeInterface | string | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\Expectation::setETATo($ETATo=null)
Parameters• $ETATo (DateTimeInterface | string | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
Timeframes
class Firstred\PostNL\Entity\Timeframes
Class Timeframes.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($timeframes, $timeframetimeframes)
• public jsonSerialize()
128 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Entity\Timeframes::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Timeframes::$Timeframes
Type \Firstred\PostNL\Entity\Timeframe[] | null
protected static property Firstred\PostNL\Entity\Timeframes::$TimeframeTimeFrames
Type \Firstred\PostNL\Entity\TimeframeTimeFrame[] | null
Methods
public Firstred\PostNL\Entity\Timeframes::__construct($timeframes=null,$timeframetimeframes=null)
Timeframes constructor.
Parameters• $timeframes (array | null)
• $timeframetimeframes (Firstred\PostNL\Entity\TimeframeTimeFrame[] |null)
public Firstred\PostNL\Entity\Timeframes::jsonSerialize()
Return a serializable array for `json_encode`.
Returns array
Group
class Firstred\PostNL\Entity\Group
Class Group.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($GroupCount, $GroupSequence, $GroupType, $MainBarcode)
1.13. Reference 129
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Entity\Group::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Group::$GroupCount
Amount of shipments in the group.
Type string | null
protected static property Firstred\PostNL\Entity\Group::$GroupSequence
Sequence number.
Type string | null
protected static property Firstred\PostNL\Entity\Group::$GroupType
The type of group.
Possible values:
- `01`: Collection request- `03`: Multiple parcels in one shipment (multi-colli)- `04`: Single parcel in one shipment
Type string | null
protected static property Firstred\PostNL\Entity\Group::$MainBarcode
Main barcode for the shipment.
Type string | null
Methods
public Firstred\PostNL\Entity\Group::__construct($GroupCount=null, $GroupSequence=null,$GroupType=null, $MainBarcode=null)
Group Constructor.
Parameters• $GroupCount (string | null)
• $GroupSequence (string | null)
• $GroupType (string | null)
• $MainBarcode (string | null)
130 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
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 spellingof addresses should be different according to our PostNL information, the address detailswill be corrected. This can be noticed in Track & Trace.
Please note that the webservice will not add address details. Street and City fields will onlybe 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 withPick up at PostNL location)
> * When using the ‘label in the box return label’, it is mandatory to use an > `Antwoord-nummer` in AddressType 08. > This cannot be a regular address
The following rules apply: If there is no Address specified with AddressType = 02, the datafrom Customer/Address will be added to the list as AddressType 02. If there is no Cus-tomer/Address, the message will be rejected.
At least one other AddressType must be specified, other than AddressType 02 In most casesthis 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
1.13. Reference 131
PostNL PHP bindings Documentation, Release 1.2.0
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
132 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $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
Customer
class Firstred\PostNL\Entity\Customer
Class Customer.
Parent Firstred\PostNL\Entity\AbstractEntity
1.13. Reference 133
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($CustomerNumber, $CustomerCode, $CollectionLocation,$ContactPerson, $Email, $Name, $Address, $GlobalPackCustomerCode,$GlobalPackBarcodeType)
Properties
public property Firstred\PostNL\Entity\Customer::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Customer::$Address
Type \Firstred\PostNL\Entity\Address | null
protected static property Firstred\PostNL\Entity\Customer::$CollectionLocation
Type string | null
protected static property Firstred\PostNL\Entity\Customer::$ContactPerson
Type string | null
protected static property Firstred\PostNL\Entity\Customer::$CustomerCode
Type string | null
protected static property Firstred\PostNL\Entity\Customer::$CustomerNumber
Type string | null
protected static property Firstred\PostNL\Entity\Customer::$GlobalPackCustomerCode
Type string | null
protected static property Firstred\PostNL\Entity\Customer::$GlobalPackBarcodeType
Type string | null
protected static property Firstred\PostNL\Entity\Customer::$Email
Type string | null
protected static property Firstred\PostNL\Entity\Customer::$Name
Type string | null
Methods
public Firstred\PostNL\Entity\Customer::__construct($CustomerNumber=null,$CustomerCode=null,$CollectionLocation=null,$ContactPerson=null, $Email=null,$Name=null, $Address=null,$GlobalPackCustomerCode=null,$GlobalPackBarcodeType=null)
Parameters• $CustomerNumber (string | null)
• $CustomerCode (string | null)
134 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $CollectionLocation (string | null)
• $ContactPerson (string | null)
• $Email (string | null)
• $Name (string | null)
• $Address (Firstred\PostNL\Entity\Address | null)
• $GlobalPackCustomerCode (string | null)
• $GlobalPackBarcodeType (string | null)
Coordinates
class Firstred\PostNL\Entity\Coordinates
Class Coordinates.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Latitude, $Longitude)
Properties
public property Firstred\PostNL\Entity\Coordinates::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Coordinates::$Latitude
Type string | null
protected static property Firstred\PostNL\Entity\Coordinates::$Longitude
Type string | null
Methods
public Firstred\PostNL\Entity\Coordinates::__construct($Latitude=null, $Longitude=null)
Parameters• $Latitude (string)
• $Longitude (string)
1.13. Reference 135
PostNL PHP bindings Documentation, Release 1.2.0
Signature
class Firstred\PostNL\Entity\Signature
Class Signature.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($GetSignatureResponseSignature, $Warnings)
Properties
public property Firstred\PostNL\Entity\Signature::$defaultProperties
Type string[][]
protected static propertyFirstred\PostNL\Entity\Signature::$GetSignatureResponseSignature
Type \Firstred\PostNL\Entity\Response\GetSignatureResponseSignature | null
protected static property Firstred\PostNL\Entity\Signature::$Warnings
Type \Firstred\PostNL\Entity\Warning[] | null
Methods
public Firstred\PostNL\Entity\Signature::__construct($GetSignatureResponseSignature=null,$Warnings=null)
Amount
class Firstred\PostNL\Entity\Amount
Class Amount.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($AccountName, $AmountType, $BIC, $Currency, $IBAN, $Reference,$TransactionNumber, $Value, $VerzekerdBedrag)
• public setAmountType($AmountType)
• public xmlSerialize($writer)
136 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Entity\Amount::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Amount::$AccountName
Type string | null
protected static property Firstred\PostNL\Entity\Amount::$AmountType
Type string | null
protected static property Firstred\PostNL\Entity\Amount::$BIC
Type string | null
protected static property Firstred\PostNL\Entity\Amount::$Currency
Type string | null
protected static property Firstred\PostNL\Entity\Amount::$IBAN
Type string | null
protected static property Firstred\PostNL\Entity\Amount::$Reference
Type string | null
protected static property Firstred\PostNL\Entity\Amount::$TransactionNumber
Type string | null
protected static property Firstred\PostNL\Entity\Amount::$Value
Type string | null
protected static property Firstred\PostNL\Entity\Amount::$VerzekerdBedrag
Type string | null
Methods
public Firstred\PostNL\Entity\Amount::__construct($AccountName=null, $AmountType=null,$BIC=null, $Currency=null, $IBAN=null,$Reference=null, $TransactionNumber=null,$Value=null, $VerzekerdBedrag=null)
Parameters• $AccountName (string | null)
• $AmountType (string | null)
• $BIC (string | null)
• $Currency (string | null)
• $IBAN (string | null)
• $Reference (string | null)
• $TransactionNumber (string | null)
• $Value (string | null)
public Firstred\PostNL\Entity\Amount::setAmountType($AmountType=null)
Set amount type.
1.13. Reference 137
PostNL PHP bindings Documentation, Release 1.2.0
Parameters• $AmountType (string | int | null)
Returns static
public Firstred\PostNL\Entity\Amount::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
Throws \InvalidArgumentException
Dimension
class Firstred\PostNL\Entity\Dimension
Class Dimension.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Weight, $Height, $Length, $Volume, $Width)
Properties
public property Firstred\PostNL\Entity\Dimension::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Dimension::$Height
Type string | null
protected static property Firstred\PostNL\Entity\Dimension::$Length
Type string | null
protected static property Firstred\PostNL\Entity\Dimension::$Volume
Type string | null
protected static property Firstred\PostNL\Entity\Dimension::$Weight
Type string | null
protected static property Firstred\PostNL\Entity\Dimension::$Width
Type string | null
138 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Dimension::__construct($Weight=null, $Height=null,$Length=null, $Volume=null,$Width=null)
Parameters• $Weight (string | null)
• $Height (string | null)
• $Length (string | null)
• $Volume (string | null)
• $Width (string | null)
Barcode
class Firstred\PostNL\Entity\Barcode
Class Barcode.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Type, $Range, $Serie)
Properties
public property Firstred\PostNL\Entity\Barcode::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Barcode::$Type
Type string | null
protected static property Firstred\PostNL\Entity\Barcode::$Range
Type string | null
protected static property Firstred\PostNL\Entity\Barcode::$Serie
Type string | null
1.13. Reference 139
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Barcode::__construct($Type=null, $Range=null,$Serie=\'000000000\-999999999\')
Parameters• $Type (string | null)
• $Range (string | null)
• $Serie (string | null)
Location
class Firstred\PostNL\Entity\Location
Class Location.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Postalcode, $AllowSundaySorting, $DeliveryDate,$DeliveryOptions, $Options, $Coordinates, $CoordinatesNorthWest,$CoordinatesSouthEast, $City, $Street, $HouseNr, $HouseNrExt, $LocationCode,$Saleschannel, $TerminalType, $RetailNetworkID, $DownPartnerID,$DownPartnerLocation)
• public setDeliveryDate($DeliveryDate)
• public setPostalcode($Postalcode)
• public xmlSerialize($writer)
Properties
public property Firstred\PostNL\Entity\Location::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Location::$AllowSundaySorting
Type string | null
protected static property Firstred\PostNL\Entity\Location::$DeliveryDate
Type string | null
protected static property Firstred\PostNL\Entity\Location::$DeliveryOptions
Type string[] | null
protected static property Firstred\PostNL\Entity\Location::$OpeningTime
Type string | null
protected static property Firstred\PostNL\Entity\Location::$Options
Type string[] | null
140 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
protected static property Firstred\PostNL\Entity\Location::$City
Type string | null
protected static property Firstred\PostNL\Entity\Location::$HouseNr
Type string | null
protected static property Firstred\PostNL\Entity\Location::$HouseNrExt
Type string | null
protected static property Firstred\PostNL\Entity\Location::$Postalcode
Type string | null
protected static property Firstred\PostNL\Entity\Location::$Street
Type string | null
protected static property Firstred\PostNL\Entity\Location::$Coordinates
Type \Firstred\PostNL\Entity\Coordinates | null
protected static property Firstred\PostNL\Entity\Location::$CoordinatesNorthWest
Type \Firstred\PostNL\Entity\CoordinatesNorthWest | null
protected static property Firstred\PostNL\Entity\Location::$CoordinatesSouthEast
Type \Firstred\PostNL\Entity\CoordinatesSouthEast | null
protected static property Firstred\PostNL\Entity\Location::$LocationCode
Type string | null
protected static property Firstred\PostNL\Entity\Location::$Saleschannel
Type string | null
protected static property Firstred\PostNL\Entity\Location::$TerminalType
Type string | null
protected static property Firstred\PostNL\Entity\Location::$RetailNetworkID
Type string | null
protected static property Firstred\PostNL\Entity\Location::$DownPartnerID
Type string | null
protected static property Firstred\PostNL\Entity\Location::$DownPartnerLocation
Type string | null
1.13. Reference 141
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Location::__construct($Postalcode=null,$AllowSundaySorting=null,$DeliveryDate=null,$DeliveryOptions=null, $Options=null,$Coordinates=null,$CoordinatesNorthWest=null,$CoordinatesSouthEast=null, $City=null,$Street=null, $HouseNr=null,$HouseNrExt=null, $LocationCode=null,$Saleschannel=null, $TerminalType=null,$RetailNetworkID=null,$DownPartnerID=null,$DownPartnerLocation=null)
Parameters• $Postalcode (string | null)
• $AllowSundaySorting (string | null)
• $DeliveryDate (string | \DateTimeInterface | null)
• $DeliveryOptions (array | null)
• $Options (array | null)
• $Coordinates (Firstred\PostNL\Entity\Coordinates | null)
• $CoordinatesNorthWest (Firstred\PostNL\Entity\CoordinatesNorthWest |null)
• $CoordinatesSouthEast (Firstred\PostNL\Entity\CoordinatesSouthEast |null)
• $City (string | null)
• $Street (string | null)
• $HouseNr (string | null)
• $HouseNrExt (string | null)
• $LocationCode (string | null)
• $Saleschannel (string | null)
• $TerminalType (string | null)
• $RetailNetworkID (string | null)
• $DownPartnerID (string | null)
• $DownPartnerLocation (string | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionpublic Firstred\PostNL\Entity\Location::setDeliveryDate($DeliveryDate=null)
Parameters• $DeliveryDate (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
142 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Entity\Location::setPostalcode($Postalcode=null)
Set the postcode.
Parameters• $Postalcode (string | null)
Returns \Firstred\PostNL\Entity\Location
public Firstred\PostNL\Entity\Location::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
ProductOption
class Firstred\PostNL\Entity\ProductOption
Class ProductOption.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Characteristic, $Option)
Properties
public property Firstred\PostNL\Entity\ProductOption::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\ProductOption::$Characteristic
Type string | null
protected static property Firstred\PostNL\Entity\ProductOption::$Option
Type string | null
1.13. Reference 143
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\ProductOption::__construct($Characteristic=null, $Option=null)
Parameters• $Characteristic (string | null)
• $Option (string | null)
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
144 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
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
1.13. Reference 145
PostNL PHP bindings Documentation, Release 1.2.0
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
146 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
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)
1.13. Reference 147
PostNL PHP bindings Documentation, Release 1.2.0
• $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\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\Shipment::setCollectionTimeStampEnd($CollectionTimeStampEnd=null)
Parameters• $CollectionTimeStampEnd (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\Shipment::setDeliveryTimeStampStart($DeliveryTimeStampStart=null)
Parameters• $DeliveryTimeStampStart (string | \DateTimeInterface | null)
148 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\Shipment::setDeliveryTimeStampEnd($DeliveryTimeStampEnd=null)
Parameters• $DeliveryTimeStampEnd (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\Shipment::setDeliveryDate($DeliveryDate=null)
Parameters• $DeliveryDate (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\Shipment::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
Status
class Firstred\PostNL\Entity\Status
Class Status.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($PhaseCode, $PhaseDescription, $StatusCode,$StatusDescription, $TimeStamp)
• public setTimeStamp($TimeStamp)
• public getCurrentStatusPhaseCode()
• public getCurrentStatusPhaseDescription()
• public getCurrentStatusStatusCode()
• public getCurrentStatusStatusDescription()
1.13. Reference 149
PostNL PHP bindings Documentation, Release 1.2.0
• public getCurrentStatusTimeStamp()
• public getCompleteStatusPhaseCode()
• public getCompleteStatusPhaseDescription()
• public getCompleteStatusStatusCode()
• public getCompleteStatusStatusDescription()
• public getCompleteStatusTimeStamp()
Properties
public property Firstred\PostNL\Entity\Status::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Status::$PhaseCode
Type string | null
protected static property Firstred\PostNL\Entity\Status::$PhaseDescription
Type string | null
protected static property Firstred\PostNL\Entity\Status::$StatusCode
Type string | null
protected static property Firstred\PostNL\Entity\Status::$StatusDescription
Type string | null
protected static property Firstred\PostNL\Entity\Status::$TimeStamp
Type \DateTimeInterface | null
Methods
public Firstred\PostNL\Entity\Status::__construct($PhaseCode=null, $PhaseDescription=null,$StatusCode=null, $StatusDescription=null,$TimeStamp=null)
Status constructor.
Parameters• $PhaseCode (string | null)
• $PhaseDescription (string | null)
• $StatusCode (string | null)
• $StatusDescription (string | null)
• $TimeStamp (string | \DateTimeInterface | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\Entity\Status::setTimeStamp($TimeStamp=null)
Parameters• $TimeStamp (string | \DateTimeInterface | null)
Returns static
150 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\Status::getCurrentStatusPhaseCode()
Backward compatible with SOAP API
Returns string | null
Since 1.2.0
public Firstred\PostNL\Entity\Status::getCurrentStatusPhaseDescription()
Backward compatible with SOAP API
Returns string | null
Since 1.2.0
public Firstred\PostNL\Entity\Status::getCurrentStatusStatusCode()
Backward compatible with SOAP API
Returns string | null
Since 1.2.0
public Firstred\PostNL\Entity\Status::getCurrentStatusStatusDescription()
Backward compatible with SOAP API
Returns string | null
Since 1.2.0
public Firstred\PostNL\Entity\Status::getCurrentStatusTimeStamp()
Backward compatible with SOAP API
Returns string | null
Since 1.2.0
public Firstred\PostNL\Entity\Status::getCompleteStatusPhaseCode()
Backward compatible with SOAP API
Returns string | null
Since 1.2.0
public Firstred\PostNL\Entity\Status::getCompleteStatusPhaseDescription()
Backward compatible with SOAP API
Returns string | null
Since 1.2.0
1.13. Reference 151
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Entity\Status::getCompleteStatusStatusCode()
Backward compatible with SOAP API
Returns string | null
Since 1.2.0
public Firstred\PostNL\Entity\Status::getCompleteStatusStatusDescription()
Backward compatible with SOAP API
Returns string | null
Since 1.2.0
public Firstred\PostNL\Entity\Status::getCompleteStatusTimeStamp()
Backward compatible with SOAP API
Returns string | null
Since 1.2.0
Timeframe
class Firstred\PostNL\Entity\Timeframe
Class Timeframe.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($City, $CountryCode, $Date, $EndDate, $HouseNr, $HouseNrExt,$Options, $PostalCode, $Street, $SundaySorting, $Interval, $Range, $Timeframes,$StartDate)
• public setDate($Date)
• public setStartDate($StartDate)
• public setEndDate($EndDate)
• public setPostalCode($PostalCode)
• public jsonSerialize()
• public xmlSerialize($writer)
152 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Entity\Timeframe::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Timeframe::$City
Type string | null
protected static property Firstred\PostNL\Entity\Timeframe::$CountryCode
Type string | null
protected static property Firstred\PostNL\Entity\Timeframe::$Date
Type \DateTimeInterface | null
protected static property Firstred\PostNL\Entity\Timeframe::$EndDate
Type \DateTimeInterface | null
protected static property Firstred\PostNL\Entity\Timeframe::$HouseNr
Type string | null
protected static property Firstred\PostNL\Entity\Timeframe::$HouseNrExt
Type string | null
protected static property Firstred\PostNL\Entity\Timeframe::$Options
Type string[] | null
protected static property Firstred\PostNL\Entity\Timeframe::$PostalCode
Type string | null
protected static property Firstred\PostNL\Entity\Timeframe::$StartDate
Type string | null
protected static property Firstred\PostNL\Entity\Timeframe::$Street
Type string | null
protected static property Firstred\PostNL\Entity\Timeframe::$SundaySorting
Type string | null
protected static property Firstred\PostNL\Entity\Timeframe::$Interval
Type string | null
protected static property Firstred\PostNL\Entity\Timeframe::$TimeframeRange
Type string | null
protected static property Firstred\PostNL\Entity\Timeframe::$Timeframes
Type \Firstred\PostNL\Entity\TimeframeTimeFrame[] | \Firstred\PostNL\Entity\Timeframe[] | null
1.13. Reference 153
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\Timeframe::__construct( $City=null, $CountryCode=null,$Date=null, $EndDate=null,$HouseNr=null, $HouseNrExt=null,$Options=\[\], $PostalCode=null,$Street=null, $SundaySorting=\'false\',$Interval=null, $Range=null,$Timeframes=null, $StartDate=null)
Timeframe constructor.
Parameters• $City (string | null)
• $CountryCode (string | null)
• $Date (string | \DateTimeInterface | null)
• $EndDate (string | \DateTimeInterface | null)
• $HouseNr (string | null)
• $HouseNrExt (string | null)
• $Options (array | null)
• $PostalCode (string | null)
• $Street (string | null)
• $SundaySorting (string | null)
• $Interval (string | null)
• $Range (string | null)
• $Timeframes (Firstred\PostNL\Entity\Timeframe[] | null)
• $StartDate (string | \DateTimeInterface | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\Entity\Timeframe::setDate($Date=null)
Parameters• $Date (null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\Timeframe::setStartDate($StartDate=null)
Parameters• $StartDate (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
154 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Entity\Timeframe::setEndDate($EndDate=null)
Parameters• $EndDate (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\Timeframe::setPostalCode($PostalCode=null)
Set the postcode.
Parameters• $PostalCode (string | null)
Returns static
public Firstred\PostNL\Entity\Timeframe::jsonSerialize()
Return a serializable array for `json_encode`.
Returns array
public Firstred\PostNL\Entity\Timeframe::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
Throws \InvalidArgumentException
Customs
class Firstred\PostNL\Entity\Customs
Class Customs.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Certificate, $CertificateNr, $Content, $Currency,$HandleAsNonDeliverable, $Invoice, $InvoiceNr, $License, $LicenseNr,$ShipmentType)
1.13. Reference 155
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Entity\Customs::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Customs::$Certificate
Type string | null
protected static property Firstred\PostNL\Entity\Customs::$CertificateNr
Type string | null
protected static property Firstred\PostNL\Entity\Customs::$Content
Type \Firstred\PostNL\Entity\Content[] | null
protected static property Firstred\PostNL\Entity\Customs::$Currency
Type string | null
protected static property Firstred\PostNL\Entity\Customs::$HandleAsNonDeliverable
Type string | null
protected static property Firstred\PostNL\Entity\Customs::$Invoice
Type string | null
protected static property Firstred\PostNL\Entity\Customs::$InvoiceNr
Type string | null
protected static property Firstred\PostNL\Entity\Customs::$License
Type string | null
protected static property Firstred\PostNL\Entity\Customs::$LicenseNr
Type string | null
protected static property Firstred\PostNL\Entity\Customs::$ShipmentType
Type string | null
protected static property Firstred\PostNL\Entity\Customs::$TrustedShipperID
Type string | null
protected static property Firstred\PostNL\Entity\Customs::$TransactionCode
Type string | null
protected static property Firstred\PostNL\Entity\Customs::$TransactionDescription
Type string | null
Methods
public Firstred\PostNL\Entity\Customs::__construct($Certificate=null, $CertificateNr=null,$Content=null, $Currency=null,$HandleAsNonDeliverable=null,$Invoice=null, $InvoiceNr=null,$License=null, $LicenseNr=null,$ShipmentType=null, $TrustedShipperID =null, $TransactionCode = null,$TransactionDescription = null)
Parameters
156 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $Certificate (string | null)
• $CertificateNr (string | null)
• $Content (Firstred\PostNL\Entity\Content[] | null)
• $Currency (string | null)
• $HandleAsNonDeliverable (string | null)
• $Invoice (string | null)
• $InvoiceNr (string | null)
• $License (string | null)
• $LicenseNr (string | null)
• $ShipmentType (string | null)
• TrustedShipperID (string | null)
• TransactionCode (string | null)
• TransactionDescription (string | null)
TimeframeTimeFrame
class Firstred\PostNL\Entity\TimeframeTimeFrame
Class TimeframeTimeFrame.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($GetSentDate, $From, $To, $Options)
• public setDate($Date)
• public static jsonDeserialize($json)
Properties
public property Firstred\PostNL\Entity\TimeframeTimeFrame::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\TimeframeTimeFrame::$Date
Type string | null
protected static property Firstred\PostNL\Entity\TimeframeTimeFrame::$From
Type string | null
protected static property Firstred\PostNL\Entity\TimeframeTimeFrame::$Options
Type string[] | null
protected static property Firstred\PostNL\Entity\TimeframeTimeFrame::$To
Type string | null
1.13. Reference 157
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Entity\TimeframeTimeFrame::__construct($GetSentDate=null,$From=null, $To=null,$Options=null)
Parameters• $GetSentDate (string | \DateTimeInterface | null)
• $From (string | null)
• $To (string | null)
• $Options (string[] | null)
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionpublic Firstred\PostNL\Entity\TimeframeTimeFrame::setDate($Date=null)
Parameters• $Date (string | \DateTimeInterface | null)
Returns static
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public static Firstred\PostNL\Entity\TimeframeTimeFrame::jsonDeserialize($json)
Parameters• $json (stdClass)
Returns mixed | \stdClass | null
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionSince 1.2.0
CoordinatesNorthWest
class Firstred\PostNL\Entity\CoordinatesNorthWest
Class CoordinatesNorthWest.
Parent Firstred\PostNL\Entity\AbstractEntity
158 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($Latitude, $Longitude)
Properties
public property Firstred\PostNL\Entity\CoordinatesNorthWest::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\CoordinatesNorthWest::$Latitude
Type string | null
protected static property Firstred\PostNL\Entity\CoordinatesNorthWest::$Longitude
Type string | null
Methods
public Firstred\PostNL\Entity\CoordinatesNorthWest::__construct($Latitude=null,$Longitude=null)
Parameters• $Latitude (string)
• $Longitude (string)
CutOffTime
class Firstred\PostNL\Entity\CutOffTime
Class CutOffTime.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($Day, $Time, $Available)
• public xmlSerialize($writer)
1.13. Reference 159
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Entity\CutOffTime::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\CutOffTime::$Day
Type string | null
protected static property Firstred\PostNL\Entity\CutOffTime::$Time
Type string | null
protected static property Firstred\PostNL\Entity\CutOffTime::$Available
Type bool | null
Methods
public Firstred\PostNL\Entity\CutOffTime::__construct($Day=null, $Time=null,$Available=null)
Parameters• $Day (string)
• $Time (string)
• $Available (bool)
public Firstred\PostNL\Entity\CutOffTime::xmlSerialize($writer)
Return a serializable array for the XMLWriter.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
Content
class Firstred\PostNL\Entity\Content
Class Content.
Parent Firstred\PostNL\Entity\AbstractEntity
Summary
Methods
• public __construct($CountryOfOrigin, $Description, $HSTariffNr, $Quantity,$Value, $Weight, $Content)
160 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Entity\Content::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\Content::$CountryOfOrigin
Type string | null
protected static property Firstred\PostNL\Entity\Content::$Description
Type string | null
protected static property Firstred\PostNL\Entity\Content::$HSTariffNr
Type string | null
protected static property Firstred\PostNL\Entity\Content::$Quantity
Type string | null
protected static property Firstred\PostNL\Entity\Content::$Value
Type string | null
protected static property Firstred\PostNL\Entity\Content::$Weight
Type string | null
protected static property Firstred\PostNL\Entity\Content::$Content
Type \Firstred\PostNL\Entity\Content[] | null
Methods
public Firstred\PostNL\Entity\Content::__construct($CountryOfOrigin=null, $Description=null,$HSTariffNr=null, $Quantity=null,$Value=null, $Weight=null, $Content=null)
Parameters• $CountryOfOrigin (string | null)
• $Description (string | null)
• $HSTariffNr (string | null)
• $Quantity (string | null)
• $Value (string | null)
• $Weight (string | null)
• $Content (Firstred\PostNL\Entity\Content[] | null)
1.13. Reference 161
PostNL PHP bindings Documentation, Release 1.2.0
OpeningHours
class Firstred\PostNL\Entity\OpeningHours
Class OpeningHours.
Parent Firstred\PostNL\Entity\AbstractEntityImplements ArrayAccess Iterator
Summary
Methods
• public __construct($Monday, $Tuesday, $Wednesday, $Thursday, $Friday, $Saturday,$Sunday)
• public static jsonDeserialize($json)
• public toArray()
• public offsetExists($offset)
• public offsetGet($offset)
• public offsetSet($offset, $value)
• public offsetUnset($offset)
• public current()
• public next()
• public key()
• public valid()
• public rewind()
Properties
public property Firstred\PostNL\Entity\OpeningHours::$defaultProperties
Type string[][]
protected static property Firstred\PostNL\Entity\OpeningHours::$Monday
Type string | null
protected static property Firstred\PostNL\Entity\OpeningHours::$Tuesday
Type string | null
protected static property Firstred\PostNL\Entity\OpeningHours::$Wednesday
Type string | null
protected static property Firstred\PostNL\Entity\OpeningHours::$Thursday
Type string | null
protected static property Firstred\PostNL\Entity\OpeningHours::$Friday
Type string | null
protected static property Firstred\PostNL\Entity\OpeningHours::$Saturday
162 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Type string | null
protected static property Firstred\PostNL\Entity\OpeningHours::$Sunday
Type string | null
Methods
public Firstred\PostNL\Entity\OpeningHours::__construct($Monday=\'\', $Tuesday=\'\',$Wednesday=\'\', $Thursday=\'\',$Friday=\'\', $Saturday=\'\',$Sunday=\'\')
OpeningHours constructor.
Parameters• $Monday (string | null)
• $Tuesday (string | null)
• $Wednesday (string | null)
• $Thursday (string | null)
• $Friday (string | null)
• $Saturday (string | null)
• $Sunday (string | null)
public static Firstred\PostNL\Entity\OpeningHours::jsonDeserialize($json)
Deserialize opening hours
Parameters• $json (stdClass)
Returns \Firstred\PostNL\Entity\OpeningHoursThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Entity\OpeningHours::toArray()
Returns array
public Firstred\PostNL\Entity\OpeningHours::offsetExists($offset)
Parameters• $offset (mixed)
Returns bool
Since 1.2.0
1.13. Reference 163
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Entity\OpeningHours::offsetGet($offset)
Parameters• $offset (mixed)
Returns array
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\OpeningHours::offsetSet($offset, $value)
Parameters• $offset (mixed)
• $value (mixed)
Since 1.2.0
public Firstred\PostNL\Entity\OpeningHours::offsetUnset($offset)
Parameters• $offset (mixed)
Since 1.2.0
public Firstred\PostNL\Entity\OpeningHours::current()
Returns mixed
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\OpeningHours::next()
Since 1.2.0
public Firstred\PostNL\Entity\OpeningHours::key()
Returns string
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Entity\OpeningHours::valid()
Returns bool
Since 1.2.0
164 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Entity\OpeningHours::rewind()
Since 1.2.0
Exception
\Firstred\PostNL\Exception
Namespaces
Promise
\Firstred\PostNL\Exception\Promise
Classes
RejectionException
class Firstred\PostNL\Exception\Promise\RejectionException
A special exception that is thrown when waiting on a rejected promise.
The reason value is available via the getReason() method.
Parent RuntimeException
Summary
Methods
• public __construct($reason, $description)
• public getReason()
Methods
public Firstred\PostNL\Exception\Promise\RejectionException::__construct($reason, $de-scription=null)
Parameters• $reason (mixed) rejection reason
• $description (string) Optional description
public Firstred\PostNL\Exception\Promise\RejectionException::getReason()
Returns the rejection reason.
Returns mixed
1.13. Reference 165
PostNL PHP bindings Documentation, Release 1.2.0
CancellationException
class Firstred\PostNL\Exception\Promise\CancellationException
Exception that is set as the reason for a promise that has been cancelled.
Parent Firstred\PostNL\Exception\Promise\RejectionException
Summary
AggregateException
class Firstred\PostNL\Exception\Promise\AggregateException
Exception thrown when too many errors occur in the some() or any() methods.
Parent Firstred\PostNL\Exception\Promise\RejectionException
Summary
Methods
• public __construct($msg, $reasons)
Methods
public Firstred\PostNL\Exception\Promise\AggregateException::__construct($msg, $reasons)
AggregateException constructor.
Parameters• $msg (mixed)
• $reasons (array)
Classes
ApiConnectionException
class Firstred\PostNL\Exception\ApiConnectionException
Class ApiConnectionException.
Parent Firstred\PostNL\Exception\ApiException
166 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($message, $code, $body, $jsonBody, $headers)
• public getBody()
• public getJsonBody()
• public getHeaders()
Properties
protected static property Firstred\PostNL\Exception\ApiConnectionException::$body
Type string
protected static property Firstred\PostNL\Exception\ApiConnectionException::$jsonBody
Type object
protected static property Firstred\PostNL\Exception\ApiConnectionException::$headers
Type array
Methods
public Firstred\PostNL\Exception\ApiConnectionException::__construct($message=\'\',$code=0, $body=null,$jsonBody=null,$headers=null)
ApiConnectionException constructor.
Parameters• $message (string)
• $code (int)
• $body (string | null)
• $jsonBody (object | null)
• $headers (array | null)
public Firstred\PostNL\Exception\ApiConnectionException::getBody()
Returns string
public Firstred\PostNL\Exception\ApiConnectionException::getJsonBody()
Returns object
public Firstred\PostNL\Exception\ApiConnectionException::getHeaders()
Returns array
1.13. Reference 167
PostNL PHP bindings Documentation, Release 1.2.0
NotSupportedException
class Firstred\PostNL\Exception\NotSupportedException
Class NotSupportedException
Parent Firstred\PostNL\Exception\InvalidArgumentException
Summary
ApiException
class Firstred\PostNL\Exception\ApiException
Class ApiException.
Parent Firstred\PostNL\Exception\PostNLException
Summary
InvalidMethodException
class Firstred\PostNL\Exception\InvalidMethodException
Class InvalidMethodException.
Parent Firstred\PostNL\Exception\HttpClientException
Summary
ResponseException
class Firstred\PostNL\Exception\ResponseException
Class ResponseException
Parent Firstred\PostNL\Exception\ApiException
Summary
Methods
• public __construct($message, $code, $previous, $response)
• public setResponse($response)
• public getResponse()
168 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Exception\ResponseException::__construct($message=\'\', $code=0,$previous=null,$response=null)
ResponseException constructor.
Parameters• $message (string)
• $code (int)
• $previous (Exception | null)
• $response (Psr\Http\Message\ResponseInterface | null)
public Firstred\PostNL\Exception\ResponseException::setResponse($response)
Parameters• $response (Psr\Http\Message\ResponseInterface)
public Firstred\PostNL\Exception\ResponseException::getResponse()
Returns \Psr\Http\Message\ResponseInterface
InvalidBarcodeException
class Firstred\PostNL\Exception\InvalidBarcodeException
Class InvalidBarcodeException.
Parent Firstred\PostNL\Exception\InvalidArgumentException
Summary
CifException
class Firstred\PostNL\Exception\CifException
Class CifException.
Parent Firstred\PostNL\Exception\ApiException
1.13. Reference 169
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($message, $code, $previous)
• public getMessagesDescriptionsAndCodes()
Properties
protected static property Firstred\PostNL\Exception\CifException::$messages
Type array
Methods
public Firstred\PostNL\Exception\CifException::__construct($message=\'\', $code=0,$previous=null)
CifException constructor.
Parameters• $message (string | string[]) In case of multiple errors, the format looks like:
[ ‘description’ => string <The description>, ‘message’ => string <The error message>, ‘code’=> int <The error code> ] The code param will be discarded if $message is an array * $code(int) * $previous (Throwable | null)
public Firstred\PostNL\Exception\CifException::getMessagesDescriptionsAndCodes()
Get error messages and codes.
Returns array | string | string[]
CifDownException
class Firstred\PostNL\Exception\CifDownException
Class CifDownException.
Parent Firstred\PostNL\Exception\ApiException
Summary
PostNLException
class Firstred\PostNL\Exception\PostNLException
Class AbstractException
Parent Exception
170 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Summary
InvalidArgumentException
class Firstred\PostNL\Exception\InvalidArgumentException
Class InvalidArgumentException.
Parent Firstred\PostNL\Exception\PostNLException
Summary
HttpClientException
class Firstred\PostNL\Exception\HttpClientException
Class HttpClientException
Parent Exception
Summary
Methods
• public __construct($message, $code, $previous, $response)
• public setResponse($response)
• public getResponse()
Methods
public Firstred\PostNL\Exception\HttpClientException::__construct($message=\'\', $code=0,$previous=null,$response=null)
ResponseException constructor.
Parameters• $message (string)
• $code (int)
• $previous (Exception | null)
• $response (Psr\Http\Message\ResponseInterface | null)
public Firstred\PostNL\Exception\HttpClientException::setResponse($response)
Parameters• $response (Psr\Http\Message\ResponseInterface)
public Firstred\PostNL\Exception\HttpClientException::getResponse()
1.13. Reference 171
PostNL PHP bindings Documentation, Release 1.2.0
Returns \Psr\Http\Message\ResponseInterface
InvalidConfigurationException
class Firstred\PostNL\Exception\InvalidConfigurationException
Class InvalidConfigurationException.
Parent Firstred\PostNL\Exception\InvalidArgumentException
Summary
NotImplementedException
class Firstred\PostNL\Exception\NotImplementedException
Class NotImplementedException.
Parent Firstred\PostNL\Exception\InvalidArgumentException
Summary
ShipmentNotFoundException
class Firstred\PostNL\Exception\ShipmentNotFoundException
Class InvalidArgumentException.
Parent Firstred\PostNL\Exception\InvalidArgumentException
Summary
NotFoundException
class Firstred\PostNL\Exception\NotFoundException
Class NotFoundException.
Parent Firstred\PostNL\Exception\ApiException
172 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Factory
\Firstred\PostNL\Factory
Interfaces
StreamFactoryInterface
interface Firstred\PostNL\Factory\StreamFactoryInterface
Factory for PSR-7 Stream.
Summary
Methods
• public createStream($content)
• public createStreamFromFile($filename, $mode)
• public createStreamFromResource($resource)
Methods
public Firstred\PostNL\Factory\StreamFactoryInterface::createStream($content=\'\')
Create a new stream from a string.
The stream SHOULD be created with a temporary resource.
Parameters• $content (string) String content with which to populate the stream.
Returns \Psr\Http\Message\StreamInterface
public Firstred\PostNL\Factory\StreamFactoryInterface::createStreamFromFile($filename,$mode=\'r\')
Create a stream from an existing file.
The file MUST be opened using the given mode, which may be any modesupported by the `fopen` function.
The `$filename` MAY be any string supported by `fopen()`.
Parameters• $filename (string) Filename or stream URI to use as basis of stream.
1.13. Reference 173
PostNL PHP bindings Documentation, Release 1.2.0
• $mode (string) Mode with which to open the underlying filename/stream.
Returns \Psr\Http\Message\StreamInterface
Throws \RuntimeException If the file cannot be opened.
Throws \InvalidArgumentException If the mode is invalid.
Throws \RuntimeException If the file cannot be opened.
Throws \InvalidArgumentException If the mode is invalid.
public Firstred\PostNL\Factory\StreamFactoryInterface::createStreamFromResource($resource)
Create a new stream from an existing resource.
The stream MUST be readable and may be writable.
Parameters• $resource (resource) PHP resource to use as basis of stream.
Returns \Psr\Http\Message\StreamInterface
ResponseFactoryInterface
interface Firstred\PostNL\Factory\ResponseFactoryInterface
Factory for PSR-7 Response.
This factory contract can be reused in Message and Server Message factories.
Summary
Methods
• public createResponse($code, $reasonPhrase)
Methods
public Firstred\PostNL\Factory\ResponseFactoryInterface::createResponse($code=200, $rea-sonPhrase=\'\')
Creates a new PSR-7 response.
Parameters• $code (int)
• $reasonPhrase (string | null)
Returns \Psr\Http\Message\ResponseInterface
174 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
RequestFactoryInterface
interface Firstred\PostNL\Factory\RequestFactoryInterface
Factory for PSR-7 Request.
Summary
Methods
• public createRequest($method, $uri)
Methods
public Firstred\PostNL\Factory\RequestFactoryInterface::createRequest($method, $uri)
Creates a new PSR-7 request.
Parameters• $method (string)
• $uri (string | \Psr\Http\Message\UriInterface)
Returns \Psr\Http\Message\RequestInterface
Classes
GuzzleResponseFactory
class Firstred\PostNL\Factory\GuzzleResponseFactory
Class GuzzleResponseFactory
Implements Firstred\PostNL\Factory\ResponseFactoryInterface
Summary
Methods
• public createResponse($code, $reasonPhrase)
1.13. Reference 175
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Factory\GuzzleResponseFactory::createResponse($code=200,$reasonPhrase=\'\')
Creates a new PSR-7 response.
Parameters• $code (int)
• $reasonPhrase (string | null)
Returns \Psr\Http\Message\ResponseInterface
GuzzleRequestFactory
class Firstred\PostNL\Factory\GuzzleRequestFactory
Class GuzzleRequestFactory
Implements Firstred\PostNL\Factory\RequestFactoryInterface
Summary
Methods
• public createRequest($method, $uri)
Methods
public Firstred\PostNL\Factory\GuzzleRequestFactory::createRequest($method, $uri)
Creates a new PSR-7 request.
Parameters• $method (string)
• $uri (string | \Psr\Http\Message\UriInterface)
Returns \Psr\Http\Message\RequestInterface
GuzzleStreamFactory
class Firstred\PostNL\Factory\GuzzleStreamFactory
Class GuzzleStreamFactory
Implements Firstred\PostNL\Factory\StreamFactoryInterface
176 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public createStream($content)
• public createStreamFromFile($file, $mode)
• public createStreamFromResource($resource)
Methods
public Firstred\PostNL\Factory\GuzzleStreamFactory::createStream($content=\'\')
Creat a new stream from a string.
Parameters• $content (string)
Returns \Psr\Http\Message\StreamInterface
public Firstred\PostNL\Factory\GuzzleStreamFactory::createStreamFromFile($file,$mode=\'r\')
Create a new PSR-7 stream from file.
Parameters• $file (string)
• $mode (string)
Returns \Psr\Http\Message\StreamInterface
public Firstred\PostNL\Factory\GuzzleStreamFactory::createStreamFromResource($resource)
Create a new PSR-7 stream from resource.
Parameters• $resource (resource)
Returns \Psr\Http\Message\StreamInterface
HttpClient
\Firstred\PostNL\HttpClient
1.13. Reference 177
PostNL PHP bindings Documentation, Release 1.2.0
Interfaces
ClientInterface
interface Firstred\PostNL\HttpClient\ClientInterface
Interface ClientInterface.
Summary
Methods
• public getLogger()
• public setLogger($logger)
• public static getInstance()
• public addOrUpdateRequest($id, $request)
• public setVerify($verify)
• public getVerify()
• public removeRequest($id)
• public clearRequests()
• public doRequest($request)
• public doRequests($requests)
Methods
public Firstred\PostNL\HttpClient\ClientInterface::getLogger()
Get the logger.
Returns \Psr\Log\LoggerInterface
public Firstred\PostNL\HttpClient\ClientInterface::setLogger($logger)
Set the logger.
Parameters• $logger (Psr\Log\LoggerInterface)
public static Firstred\PostNL\HttpClient\ClientInterface::getInstance()
Get the HTTP Client instance.
Returns static
public Firstred\PostNL\HttpClient\ClientInterface::addOrUpdateRequest($id, $request)
Adds a request to the list of pending requests
178 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Using the ID you can replace a request.
Parameters• $id (string) Request ID
• $request (Psr\Http\Message\RequestInterface) PSR-7 request
Returns int | string
public Firstred\PostNL\HttpClient\ClientInterface::setVerify($verify)
Set the verify setting.
Parameters• $verify (bool | string)
Returns static
Deprecated
public Firstred\PostNL\HttpClient\ClientInterface::getVerify()
Return verify setting.
Returns bool | string
Deprecated
public Firstred\PostNL\HttpClient\ClientInterface::removeRequest($id)
Remove a request from the list of pending requests.
Parameters• $id (string)
public Firstred\PostNL\HttpClient\ClientInterface::clearRequests()
Clear all requests.
public Firstred\PostNL\HttpClient\ClientInterface::doRequest($request)
Do a single request.
Exceptions are captured into the result array
Parameters• $request (Psr\Http\Message\RequestInterface)
Returns \Psr\Http\Message\ResponseInterface
Throws \Firstred\PostNL\Exception\HttpClientException
public Firstred\PostNL\HttpClient\ClientInterface::doRequests( $requests=\[\])
Do all async requests.
1.13. Reference 179
PostNL PHP bindings Documentation, Release 1.2.0
Exceptions are captured into the result array
Parameters• $requests (Psr\Http\Message\RequestInterface[])
Returns \Psr\Http\Message\ResponseInterface | \Psr\Http\Message\ResponseInterface[] | \Firstred\PostNL\Exception\HttpClientException| \Firstred\PostNL\Exception\HttpClientException[]
Classes
HTTPlugClient
class Firstred\PostNL\HttpClient\HTTPlugClient
Class HTTPlugClient.
Implements Firstred\PostNL\HttpClient\ClientInterface
Summary
Methods
• public __construct($client, $logger, $concurrency)
• public addOrUpdateRequest($id, $request)
• public removeRequest($id)
• public doRequests($requests)
• public clearRequests()
• public doRequest($request)
• public getConcurrency()
• public setConcurrency($concurrency)
• public getLogger()
• public setLogger($logger)
• public getClient()
• public setClient($client)
• public static getInstance($client)
• public setVerify($verify)
• public getVerify()
180 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Properties
protected static property Firstred\PostNL\HttpClient\HTTPlugClient::$client
Type \Http\Client\HttpAsyncClient | \Http\Client\HttpClient
protected static property Firstred\PostNL\HttpClient\HTTPlugClient::$pendingRequests
List of pending PSR-7 requests.
Type \Psr\Http\Message\RequestInterface[]
protected static property Firstred\PostNL\HttpClient\HTTPlugClient::$logger
Type \Psr\Log\LoggerInterface | null
protected static property Firstred\PostNL\HttpClient\HTTPlugClient::$concurrency
Type int
Methods
public Firstred\PostNL\HttpClient\HTTPlugClient::__construct($client=null, $logger=null,$concurrency=5)
HTTPlugClient constructor.
Parameters• $client (Http\Client\HttpAsyncClient | \Http\Client\HttpClient | null)
• $logger (Psr\Log\LoggerInterface | null)
• $concurrency (int)
Throws \Firstred\PostNL\Exception\HttpClientException
public Firstred\PostNL\HttpClient\HTTPlugClient::addOrUpdateRequest($id, $request)
Adds a request to the list of pending requestsUsing the ID you can replace a request.
Parameters• $id (string)
• $request (Psr\Http\Message\RequestInterface)
Returns string
public Firstred\PostNL\HttpClient\HTTPlugClient::removeRequest($id)
Remove a request from the list of pending requests.
Parameters• $id (string)
public Firstred\PostNL\HttpClient\HTTPlugClient::doRequests( $requests=\[\])
Do all async requests.
1.13. Reference 181
PostNL PHP bindings Documentation, Release 1.2.0
Exceptions are captured into the result array
Parameters• $requests (array)
Returns array
public Firstred\PostNL\HttpClient\HTTPlugClient::clearRequests()
Clear all pending requests.
public Firstred\PostNL\HttpClient\HTTPlugClient::doRequest($request)
Do a single request.
Exceptions are captured into the result array
Parameters• $request (Psr\Http\Message\RequestInterface)
Returns \Psr\Http\Message\ResponseInterface
Throws \Firstred\PostNL\Exception\HttpClientException
public Firstred\PostNL\HttpClient\HTTPlugClient::getConcurrency()
Returns int
public Firstred\PostNL\HttpClient\HTTPlugClient::setConcurrency($concurrency)
Parameters• $concurrency (int)
Returns static
public Firstred\PostNL\HttpClient\HTTPlugClient::getLogger()
Returns \Psr\Log\LoggerInterface | null
public Firstred\PostNL\HttpClient\HTTPlugClient::setLogger($logger)
Parameters• $logger (Psr\Log\LoggerInterface | null)
Returns static
public Firstred\PostNL\HttpClient\HTTPlugClient::getClient()
Returns \Http\Client\HttpAsyncClient | \Http\Client\HttpClient
public Firstred\PostNL\HttpClient\HTTPlugClient::setClient($client)
Parameters• $client (Http\Client\HttpAsyncClient | \Http\Client\HttpClient)
Returns static
182 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public static Firstred\PostNL\HttpClient\HTTPlugClient::getInstance($client=null)
Parameters• $client (Http\Client\HttpAsyncClient | \Http\Client\HttpClient | null)
Returns \Firstred\PostNL\HttpClient\HTTPlugClientThrows \Firstred\PostNL\Exception\HttpClientExceptionDeprecated Please instantiate a new client rather than using this singleton
public Firstred\PostNL\HttpClient\HTTPlugClient::setVerify($verify)
Parameters• $verify (bool | string)
Returns \Firstred\PostNL\HttpClient\HTTPlugClientDeprecated
public Firstred\PostNL\HttpClient\HTTPlugClient::getVerify()
Returns bool | string | void
Deprecated
CurlClient
class Firstred\PostNL\HttpClient\CurlClient
Class CurlClient.
Implements Firstred\PostNL\HttpClient\ClientInterface Psr\Log\LoggerAwareInterface
Summary
Methods
• public static getInstance()
• public setTimeout($seconds)
• public setConnectTimeout($seconds)
• public setVerify($verify)
• public setLogger($logger)
• public getTimeout()
• public getConnectTimeout()
• public getVerify()
• public getLogger()
• public addOrUpdateRequest($id, $request)
• public removeRequest($id)
• public clearRequests()
1.13. Reference 183
PostNL PHP bindings Documentation, Release 1.2.0
• public doRequest($request)
• public doRequests($requests)
• protected prepareRequest($curl, $request)
Constants
DEFAULT_TIMEOUT = 80
DEFAULT_CONNECT_TIMEOUT = 30
Properties
protected static property Firstred\PostNL\HttpClient\CurlClient::$defaultOptions
Type array | callable | null
protected static property Firstred\PostNL\HttpClient\CurlClient::$userAgentInfo
Type array
protected static property Firstred\PostNL\HttpClient\CurlClient::$pendingRequests
Type array
protected static property Firstred\PostNL\HttpClient\CurlClient::$logger
Type \Psr\Log\LoggerInterface
Methods
public static Firstred\PostNL\HttpClient\CurlClient::getInstance()
CurlClient Singleton.
Returns \Firstred\PostNL\HttpClient\CurlClientDeprecated Please instantiate a new client rather than using this singleton
public Firstred\PostNL\HttpClient\CurlClient::setTimeout($seconds)
Set timeout.
Parameters• $seconds (int)
Returns \Firstred\PostNL\HttpClient\CurlClient
public Firstred\PostNL\HttpClient\CurlClient::setConnectTimeout($seconds)
Set connection timeout.
Parameters• $seconds (int)
Returns \Firstred\PostNL\HttpClient\CurlClient
184 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\HttpClient\CurlClient::setVerify($verify)
Set the verify setting.
Parameters• $verify (bool | string)
Returns \Firstred\PostNL\HttpClient\CurlClientDeprecated
public Firstred\PostNL\HttpClient\CurlClient::setLogger($logger)
Set the logger.
Parameters• $logger (Psr\Log\LoggerInterface)
Returns \Firstred\PostNL\HttpClient\CurlClient
public Firstred\PostNL\HttpClient\CurlClient::getTimeout()
Get timeout.
Returns int
public Firstred\PostNL\HttpClient\CurlClient::getConnectTimeout()
Get connection timeout.
Returns int
public Firstred\PostNL\HttpClient\CurlClient::getVerify()
Return verify setting.
Returns bool | string
Deprecated
public Firstred\PostNL\HttpClient\CurlClient::getLogger()
Get logger.
Returns \Psr\Log\LoggerInterface
public Firstred\PostNL\HttpClient\CurlClient::addOrUpdateRequest($id, $request)
Adds a request to the list of pending requestsUsing the ID you can replace a request.
Parameters• $id (string) Request ID
• $request (Psr\Http\Message\RequestInterface) PSR-7 request
1.13. Reference 185
PostNL PHP bindings Documentation, Release 1.2.0
Returns int | string
public Firstred\PostNL\HttpClient\CurlClient::removeRequest($id)
Remove a request from the list of pending requests.
Parameters• $id (string)
public Firstred\PostNL\HttpClient\CurlClient::clearRequests()
Clear all pending requests.
public Firstred\PostNL\HttpClient\CurlClient::doRequest($request)
Do a single request.
Exceptions are captured into the result array
Parameters• $request (Psr\Http\Message\RequestInterface)
Returns \Psr\Http\Message\ResponseInterface
Throws \Firstred\PostNL\Exception\HttpClientException
public Firstred\PostNL\HttpClient\CurlClient::doRequests( $requests=\[\])
Do all async requests.
Exceptions are captured into the result array
Parameters• $requests (Psr\Http\Message\RequestInterface[])
Returns \Psr\Http\Message\ResponseInterface[] | \Firstred\PostNL\Exception\HttpClientException[]
protected Firstred\PostNL\HttpClient\CurlClient::prepareRequest($curl, $request)
Parameters• $curl (resource)
• $request (Psr\Http\Message\RequestInterface)
Throws \Firstred\PostNL\Exception\HttpClientException
186 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
MockClient
class Firstred\PostNL\HttpClient\MockClient
Class MockClient.
Implements Firstred\PostNL\HttpClient\ClientInterface Psr\Log\LoggerAwareInterface
Summary
Methods
• public static getInstance()
• public setOption($name, $value)
• public getOption($name)
• public setVerify($verify)
• public getVerify()
• public setMaxRetries($maxRetries)
• public getMaxRetries()
• public setLogger($logger)
• public getLogger()
• public addOrUpdateRequest($id, $request)
• public removeRequest($id)
• public clearRequests()
• public setHandler($handler)
• public getHandler()
• public doRequest($request)
• public doRequests($requests)
Constants
DEFAULT_TIMEOUT = 60
DEFAULT_CONNECT_TIMEOUT = 20
Properties
protected property Firstred\PostNL\HttpClient\MockClient::$instance
Type static
protected static property Firstred\PostNL\HttpClient\MockClient::$defaultOptions
Type array
protected static property Firstred\PostNL\HttpClient\MockClient::$pendingRequests
1.13. Reference 187
PostNL PHP bindings Documentation, Release 1.2.0
List of pending PSR-7 requests.
Type \Psr\Http\Message\RequestInterface[]
protected static property Firstred\PostNL\HttpClient\MockClient::$logger
Type \Psr\Log\LoggerInterface
Methods
public static Firstred\PostNL\HttpClient\MockClient::getInstance()
Returns \Firstred\PostNL\HttpClient\MockClient | static
Deprecated Please instantiate a new client rather than using this singleton
public Firstred\PostNL\HttpClient\MockClient::setOption($name, $value)
Set Guzzle option.
Parameters• $name (string)
• $value (mixed)
Returns \Firstred\PostNL\HttpClient\MockClient
public Firstred\PostNL\HttpClient\MockClient::getOption($name)
Get Guzzle option.
Parameters• $name (string)
Returns mixed | null
public Firstred\PostNL\HttpClient\MockClient::setVerify($verify)
Set the verify setting.
Parameters• $verify (bool | string)
Returns static
public Firstred\PostNL\HttpClient\MockClient::getVerify()
Return verify setting.
Returns bool | string
public Firstred\PostNL\HttpClient\MockClient::setMaxRetries($maxRetries)
Set the amount of retries.
Parameters
188 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $maxRetries (int)
Returns static
public Firstred\PostNL\HttpClient\MockClient::getMaxRetries()
Return max retries.
Returns int
public Firstred\PostNL\HttpClient\MockClient::setLogger($logger)
Set the logger.
Parameters• $logger (Psr\Log\LoggerInterface)
Returns \Firstred\PostNL\HttpClient\MockClient
public Firstred\PostNL\HttpClient\MockClient::getLogger()
Get the logger.
Returns \Psr\Log\LoggerInterface
public Firstred\PostNL\HttpClient\MockClient::addOrUpdateRequest($id, $request)
Adds a request to the list of pending requestsUsing the ID you can replace a request.
Parameters• $id (string) Request ID
• $request (Psr\Http\Message\RequestInterface) PSR-7 request
Returns int | string
public Firstred\PostNL\HttpClient\MockClient::removeRequest($id)
Remove a request from the list of pending requests.
Parameters• $id (string)
public Firstred\PostNL\HttpClient\MockClient::clearRequests()
Clear all pending requests.
public Firstred\PostNL\HttpClient\MockClient::setHandler($handler)
Returns \Firstred\PostNL\HttpClient\MockClientpublic Firstred\PostNL\HttpClient\MockClient::getHandler()
Returns \GuzzleHttp\HandlerStack
1.13. Reference 189
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\HttpClient\MockClient::doRequest($request)
Do a single request.
Exceptions are captured into the result array
Parameters• $request (Psr\Http\Message\RequestInterface)
Returns \Psr\Http\Message\ResponseInterface
Throws \Firstred\PostNL\Exception\HttpClientException
public Firstred\PostNL\HttpClient\MockClient::doRequests( $requests=\[\])
Do all async requests.
Exceptions are captured into the result array
Parameters• $requests (Psr\Http\Message\RequestInterface[])
Returns \Psr\Http\Message\ResponseInterface[] | \Firstred\PostNL\Exception\HttpClientException[]
GuzzleClient
class Firstred\PostNL\HttpClient\GuzzleClient
Class GuzzleClient.
Implements Firstred\PostNL\HttpClient\ClientInterface Psr\Log\LoggerAwareInterface
Summary
Methods
• public static getInstance()
• public setOption($name, $value)
• public getOption($name)
• public setVerify($verify)
• public getVerify()
• public setMaxRetries($maxRetries)
• public getMaxRetries()
• public setConcurrency($concurrency)
• public getConcurrency()
190 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• public setLogger($logger)
• public getLogger()
• public addOrUpdateRequest($id, $request)
• public removeRequest($id)
• public clearRequests()
• public doRequest($request)
• public doRequests($requests)
Constants
DEFAULT_TIMEOUT = 60
DEFAULT_CONNECT_TIMEOUT = 20
Properties
protected property Firstred\PostNL\HttpClient\GuzzleClient::$instance
Type static
protected static property Firstred\PostNL\HttpClient\GuzzleClient::$defaultOptions
Type array
protected static property Firstred\PostNL\HttpClient\GuzzleClient::$pendingRequests
List of pending PSR-7 requests.
Type \Psr\Http\Message\RequestInterface[]
protected static property Firstred\PostNL\HttpClient\GuzzleClient::$logger
Type \Psr\Log\LoggerInterface
Methods
public static Firstred\PostNL\HttpClient\GuzzleClient::getInstance()
Returns \Firstred\PostNL\HttpClient\GuzzleClient | static
Deprecated Please instantiate a new client rather than using this singleton
public Firstred\PostNL\HttpClient\GuzzleClient::setOption($name, $value)
Set Guzzle option.
Parameters• $name (string)
• $value (mixed)
Returns \Firstred\PostNL\HttpClient\GuzzleClient
public Firstred\PostNL\HttpClient\GuzzleClient::getOption($name)
1.13. Reference 191
PostNL PHP bindings Documentation, Release 1.2.0
Get Guzzle option.
Parameters• $name (string)
Returns mixed | null
public Firstred\PostNL\HttpClient\GuzzleClient::setVerify($verify)
Set the verify setting.
Parameters• $verify (bool | string)
Returns static
Deprecated
public Firstred\PostNL\HttpClient\GuzzleClient::getVerify()
Return verify setting.
Returns bool | string
Deprecated
public Firstred\PostNL\HttpClient\GuzzleClient::setMaxRetries($maxRetries)
Set the amount of retries.
Parameters• $maxRetries (int)
Returns static
public Firstred\PostNL\HttpClient\GuzzleClient::getMaxRetries()
Return max retries.
Returns int
public Firstred\PostNL\HttpClient\GuzzleClient::setConcurrency($concurrency)
Set the concurrency.
Parameters• $concurrency (int)
Returns static
public Firstred\PostNL\HttpClient\GuzzleClient::getConcurrency()
Return concurrency.
Returns int
192 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\HttpClient\GuzzleClient::setLogger($logger)
Set the logger.
Parameters• $logger (Psr\Log\LoggerInterface)
Returns \Firstred\PostNL\HttpClient\GuzzleClient
public Firstred\PostNL\HttpClient\GuzzleClient::getLogger()
Get the logger.
Returns \Psr\Log\LoggerInterface
public Firstred\PostNL\HttpClient\GuzzleClient::addOrUpdateRequest($id, $request)
Adds a request to the list of pending requestsUsing the ID you can replace a request.
Parameters• $id (string) Request ID
• $request (Psr\Http\Message\RequestInterface) PSR-7 request
Returns int | string
public Firstred\PostNL\HttpClient\GuzzleClient::removeRequest($id)
Remove a request from the list of pending requests.
Parameters• $id (string)
public Firstred\PostNL\HttpClient\GuzzleClient::clearRequests()
Clear all pending requests.
public Firstred\PostNL\HttpClient\GuzzleClient::doRequest($request)
Do a single request.
Exceptions are captured into the result array
Parameters• $request (Psr\Http\Message\RequestInterface)
Returns \Psr\Http\Message\ResponseInterface
Throws \Firstred\PostNL\Exception\HttpClientException
public Firstred\PostNL\HttpClient\GuzzleClient::doRequests( $requests=\[\])
Do all async requests.
1.13. Reference 193
PostNL PHP bindings Documentation, Release 1.2.0
Exceptions are captured into the result array
Parameters• $requests (Psr\Http\Message\RequestInterface[])
Returns \Firstred\PostNL\Exception\HttpClientException[] | \Psr\Http\Message\ResponseInterface[]
Service
\Firstred\PostNL\Service
Interfaces
TimeframeServiceInterface
interface Firstred\PostNL\Service\TimeframeServiceInterface
Class TimeframeService.
Parent Firstred\PostNL\Service\ServiceInterface
Summary
Methods
• public getTimeframesREST($getTimeframes)
• public getTimeframesSOAP($getTimeframes)
• public buildGetTimeframesRequestREST($getTimeframes)
• public processGetTimeframesResponseREST($response)
• public buildGetTimeframesRequestSOAP($getTimeframes)
• public processGetTimeframesResponseSOAP($response)
Methods
public Firstred\PostNL\Service\TimeframeServiceInterface::getTimeframesREST($getTimeframes)
Get timeframes via REST.
Parameters• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)
Returns \Firstred\PostNL\Entity\Response\ResponseTimeframesThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
194 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientException
1.13. Reference 195
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\TimeframeServiceInterface::getTimeframesSOAP($getTimeframes)
Get timeframes via SOAP.
Parameters• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)
Returns \Firstred\PostNL\Entity\Response\ResponseTimeframesThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseException
196 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\TimeframeServiceInterface::buildGetTimeframesRequestREST($getTimeframes)
Build the GetTimeframes request for the REST API.
Parameters• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\TimeframeServiceInterface::processGetTimeframesResponseREST($response)
Process GetTimeframes Response REST.
Parameters• $response (mixed)
1.13. Reference 197
PostNL PHP bindings Documentation, Release 1.2.0
Returns \Firstred\PostNL\Entity\Response\ResponseTimeframes | null
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\TimeframeServiceInterface::buildGetTimeframesRequestSOAP($getTimeframes)
Build the GetTimeframes request for the SOAP API.
Parameters• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\TimeframeServiceInterface::processGetTimeframesResponseSOAP($response)
Process GetTimeframes Response SOAP.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\ResponseTimeframesThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientException
198 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
ConfirmingServiceInterface
interface Firstred\PostNL\Service\ConfirmingServiceInterface
Class ConfirmingService.
Parent Firstred\PostNL\Service\ServiceInterface
Summary
Methods
• public confirmShipmentREST($confirming)
• public confirmShipmentsREST($confirms)
• public confirmShipmentSOAP($confirming)
• public confirmShipmentsSOAP($confirmings)
• public buildConfirmRequestREST($confirming)
• public processConfirmResponseREST($response)
• public buildConfirmRequestSOAP($confirming)
• public processConfirmResponseSOAP($response)
Methods
public Firstred\PostNL\Service\ConfirmingServiceInterface::confirmShipmentREST($confirming)
Generate a single barcode via REST.
Parameters• $confirming (Firstred\PostNL\Entity\Request\Confirming)
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipmentThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
1.13. Reference 199
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
200 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\ConfirmingServiceInterface::confirmShipmentsREST($confirms)
Confirm multiple shipments.
Parameters• $confirms (Firstred\PostNL\Entity\Request\Confirming[]) [‘uuid’ => Con-
firming, . . . ]
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipment[]Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedException
1.13. Reference 201
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\ConfirmingServiceInterface::confirmShipmentSOAP($confirming)
Generate a single label via SOAP.
Parameters• $confirming (Firstred\PostNL\Entity\Request\Confirming)
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipmentThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\ConfirmingServiceInterface::confirmShipmentsSOAP($confirmings)
202 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Generate multiple labels at once.
Parameters• $confirmings (array) [‘uuid’ => Confirming, . . . ]
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipment[]Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\ConfirmingServiceInterface::buildConfirmRequestREST($confirming)
Parameters• $confirming (Firstred\PostNL\Entity\Request\Confirming)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\ConfirmingServiceInterface::processConfirmResponseREST($response)
Proces Confirm REST Response.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipment | null
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
1.13. Reference 203
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\ConfirmingServiceInterface::buildConfirmRequestSOAP($confirming)
Parameters• $confirming (Firstred\PostNL\Entity\Request\Confirming)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\ConfirmingServiceInterface::processConfirmResponseSOAP($response)
204 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Process Confirm SOAP response.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipmentThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
LabellingServiceInterface
interface Firstred\PostNL\Service\LabellingServiceInterface
Class LabellingService.
Parent Firstred\PostNL\Service\ServiceInterface
Summary
Methods
• public generateLabelREST($generateLabel, $confirm)
• public generateLabelsREST($generateLabels)
• public generateLabelSOAP($generateLabel, $confirm)
• public generateLabelsSOAP($generateLabels)
• public buildGenerateLabelRequestREST($generateLabel, $confirm)
• public processGenerateLabelResponseREST($response)
• public buildGenerateLabelRequestSOAP($generateLabel, $confirm)
1.13. Reference 205
PostNL PHP bindings Documentation, Release 1.2.0
• public processGenerateLabelResponseSOAP($response)
Methods
public Firstred\PostNL\Service\LabellingServiceInterface::generateLabelREST($generateLabel,$con-firm=true)
Generate a single barcode via REST.
Parameters• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)
• $confirm (bool)
Returns \Firstred\PostNL\Entity\Response\GenerateLabelResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseException
206 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
1.13. Reference 207
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Service\LabellingServiceInterface::generateLabelsREST($generateLabels)
Generate multiple labels at once.
Parameters• $generateLabels (array) [‘uuid’ => [GenerateBarcode, confirm], . . . ]
Returns array
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\LabellingServiceInterface::generateLabelSOAP($generateLabel,$con-firm=true)
Generate a single label via SOAP.
Parameters• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)
208 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $confirm (bool)
Returns \Firstred\PostNL\Entity\Response\GenerateLabelResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
public Firstred\PostNL\Service\LabellingServiceInterface::generateLabelsSOAP($generateLabels)
Generate multiple labels at once via SOAP.
Parameters• $generateLabels (array) [‘uuid’ => [GenerateBarcode, confirm], . . . ]
Returns array
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseException
1.13. Reference 209
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\LabellingServiceInterface::buildGenerateLabelRequestREST($generateLabel,$con-firm=true)
Build the GenerateLabel request for the REST API.
Parameters• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)
• $confirm (bool)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LabellingServiceInterface::processGenerateLabelResponseREST($response)
Process the GenerateLabel REST Response.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\GenerateLabelResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientException
210 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\LabellingServiceInterface::buildGenerateLabelRequestSOAP($generateLabel,$con-firm=true)
Build the GenerateLabel request for the SOAP API.
Parameters• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)
• $confirm (bool)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LabellingServiceInterface::processGenerateLabelResponseSOAP($response)
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\GenerateLabelResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownException
1.13. Reference 211
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
DeliveryDateServiceInterface
interface Firstred\PostNL\Service\DeliveryDateServiceInterface
Class DeliveryDateService.
Parent Firstred\PostNL\Service\ServiceInterface
Summary
Methods
• public getDeliveryDateREST($getDeliveryDate)
• public getDeliveryDateSOAP($getDeliveryDate)
• public getSentDateREST($getSentDate)
• public getSentDateSOAP($getSentDate)
• public buildGetDeliveryDateRequestREST($getDeliveryDate)
• public processGetDeliveryDateResponseREST($response)
• public buildGetDeliveryDateRequestSOAP($getDeliveryDate)
• public processGetDeliveryDateResponseSOAP($response)
• public buildGetSentDateRequestREST($getSentDate)
• public processGetSentDateResponseREST($response)
• public buildGetSentDateRequestSOAP($getSentDate)
• public processGetSentDateResponseSOAP($response)
Methods
public Firstred\PostNL\Service\DeliveryDateServiceInterface::getDeliveryDateREST($getDeliveryDate)
Get a delivery date via REST.
Parameters• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)
Returns \Firstred\PostNL\Entity\Response\GetDeliveryDateResponse
212 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientException
1.13. Reference 213
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateServiceInterface::getDeliveryDateSOAP($getDeliveryDate)
Get a delivery date via SOAP.
Parameters• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)
Returns \Firstred\PostNL\Entity\Response\GetDeliveryDateResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientException
214 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateServiceInterface::getSentDateREST($getSentDate)
Get the sent date via REST.
Parameters• $getSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest)
Returns \Firstred\PostNL\Entity\Response\GetSentDateResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
1.13. Reference 215
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownException
216 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateServiceInterface::getSentDateSOAP($getSentDate)
Generate a single label via SOAP.
Parameters• $getSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest)
Returns \Firstred\PostNL\Entity\Response\GetSentDateResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownException
1.13. Reference 217
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateServiceInterface::buildGetDeliveryDateRequestREST($getDeliveryDate)
Build the GetDeliveryDate request for the REST API.
Parameters• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateServiceInterface::processGetDeliveryDateResponseREST($response)
Process GetDeliveryDate REST Response.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\GetDeliveryDateResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\DeliveryDateServiceInterface::buildGetDeliveryDateRequestSOAP($getDeliveryDate)
Build the GetDeliveryDate request for the SOAP API.
218 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Parameters• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateServiceInterface::processGetDeliveryDateResponseSOAP($response)
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\GetDeliveryDateResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
public Firstred\PostNL\Service\DeliveryDateServiceInterface::buildGetSentDateRequestREST($getSentDate)
Build the GetSentDate request for the REST API.
Parameters• $getSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateServiceInterface::processGetSentDateResponseREST($response)
Process GetSentDate REST Response.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\GetSentDateResponse | null
1.13. Reference 219
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\DeliveryDateServiceInterface::buildGetSentDateRequestSOAP($getSentDate)
Build the GetSentDate request for the SOAP API.
Parameters• $getSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateServiceInterface::processGetSentDateResponseSOAP($response)
Process GetSentDate SOAP Response.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\GetSentDateResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientException
220 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
LocationServiceInterface
interface Firstred\PostNL\Service\LocationServiceInterface
Class LocationService.
Parent Firstred\PostNL\Service\ServiceInterface
Summary
Methods
• public getNearestLocationsREST($getNearestLocations)
• public getNearestLocationsSOAP($getNearestLocations)
• public getLocationsInAreaREST($getLocations)
• public getLocationsInAreaSOAP($getNearestLocations)
• public getLocationREST($getLocation)
• public getLocationSOAP($getLocation)
• public buildGetNearestLocationsRequestREST($getNearestLocations)
• public processGetNearestLocationsResponseREST($response)
• public buildGetNearestLocationsRequestSOAP($getLocations)
• public processGetNearestLocationsResponseSOAP($response)
• public buildGetLocationsInAreaRequestREST($getLocations)
• public processGetLocationsInAreaResponseREST($response)
• public buildGetLocationsInAreaRequestSOAP($getLocations)
• public processGetLocationsInAreaResponseSOAP($response)
• public buildGetLocationRequestREST($getLocation)
• public processGetLocationResponseREST($response)
• public buildGetLocationRequestSOAP($getLocations)
• public processGetLocationResponseSOAP($response)
1.13. Reference 221
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Service\LocationServiceInterface::getNearestLocationsREST($getNearestLocations)
Get the nearest locations via REST.
Parameters• $getNearestLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)
Returns \Firstred\PostNL\Entity\Response\GetNearestLocationsResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseException
222 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::getNearestLocationsSOAP($getNearestLocations)
Get the nearest locations via SOAP.
Parameters
1.13. Reference 223
PostNL PHP bindings Documentation, Release 1.2.0
• $getNearestLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)
Returns \Firstred\PostNL\Entity\Response\GetNearestLocationsResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownException
224 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::getLocationsInAreaREST($getLocations)
Get the nearest locations via REST.
Parameters• $getLocations (Firstred\PostNL\Entity\Request\GetLocationsInArea)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseException
1.13. Reference 225
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
226 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::getLocationsInAreaSOAP($getNearestLocations)
Get the nearest locations via SOAP.
Parameters• $getNearestLocations (Firstred\PostNL\Entity\Request\GetLocationsInArea)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseException
1.13. Reference 227
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::getLocationREST($getLocation)
Get the location via REST.
Parameters• $getLocation (Firstred\PostNL\Entity\Request\GetLocation)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundException
228 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientException
1.13. Reference 229
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::getLocationSOAP($getLocation)
Get the nearest locations via SOAP.
Parameters• $getLocation (Firstred\PostNL\Entity\Request\GetLocation)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownException
230 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::buildGetNearestLocationsRequestREST($getNearestLocations)
Build the GenerateLabel request for the REST API.
Parameters
1.13. Reference 231
PostNL PHP bindings Documentation, Release 1.2.0
• $getNearestLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::processGetNearestLocationsResponseREST($response)
Process GetNearestLocations Response REST.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\GetNearestLocationsResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::buildGetNearestLocationsRequestSOAP($getLocations)
Build the GenerateLabel request for the SOAP API.
Parameters• $getLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::processGetNearestLocationsResponseSOAP($response)
Process GetNearestLocations Response SOAP.
Parameters
232 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\GetNearestLocationsResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::buildGetLocationsInAreaRequestREST($getLocations)
Build the GetLocationsInArea request for the REST API.
Parameters• $getLocations (Firstred\PostNL\Entity\Request\GetLocationsInArea)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::processGetLocationsInAreaResponseREST($response)
Proess GetLocationsInArea Response REST.
1.13. Reference 233
PostNL PHP bindings Documentation, Release 1.2.0
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::buildGetLocationsInAreaRequestSOAP($getLocations)
Build the GetLocationsInArea request for the SOAP API.
Parameters• $getLocations (Firstred\PostNL\Entity\Request\GetLocationsInArea)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::processGetLocationsInAreaResponseSOAP($response)
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
234 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::buildGetLocationRequestREST($getLocation)
Build the GetLocation request for the REST API.
Parameters• $getLocation (Firstred\PostNL\Entity\Request\GetLocation)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::processGetLocationResponseREST($response)
Process GetLocation Response REST.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedException
1.13. Reference 235
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::buildGetLocationRequestSOAP($getLocations)
Build the GetLocation request for the SOAP API.
Parameters• $getLocations (Firstred\PostNL\Entity\Request\GetLocation)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LocationServiceInterface::processGetLocationResponseSOAP($response)
Process GetLocation Response SOAP.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientException
236 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
ServiceInterface
interface Firstred\PostNL\Service\ServiceInterface
Summary
Methods
• public cacheItem($item)
• public retrieveCachedItem($uuid)
• public removeCachedItem($item)
• public getTtl()
• public setTtl($ttl)
• public getCache()
• public setCache($cache)
Methods
public Firstred\PostNL\Service\ServiceInterface::cacheItem($item)
Cache an item
Parameters• $item (Psr\Cache\CacheItemInterface)
Since 1.0.0
public Firstred\PostNL\Service\ServiceInterface::retrieveCachedItem($uuid)
Retrieve a cached item.
Parameters• $uuid (string)
1.13. Reference 237
PostNL PHP bindings Documentation, Release 1.2.0
Returns \Psr\Cache\CacheItemInterface | null
Throws \Psr\Cache\InvalidArgumentException
Since 1.0.0
public Firstred\PostNL\Service\ServiceInterface::removeCachedItem($item)
Delete an item from cache
Parameters• $item (Psr\Cache\CacheItemInterface)
Since 1.2.0
public Firstred\PostNL\Service\ServiceInterface::getTtl()
Returns \DateInterval | \DateTimeInterface | int | null
Since 1.2.0
public Firstred\PostNL\Service\ServiceInterface::setTtl($ttl=null)
Parameters• $ttl (int | \DateTimeInterface | \DateInterval | null)
Returns static
Since 1.2.0
public Firstred\PostNL\Service\ServiceInterface::getCache()
Returns \Psr\Cache\CacheItemPoolInterface | null
Since 1.2.0
public Firstred\PostNL\Service\ServiceInterface::setCache($cache=null)
Parameters• $cache (Psr\Cache\CacheItemPoolInterface | null)
Returns static
Since 1.2.0
BarcodeServiceInterface
interface Firstred\PostNL\Service\BarcodeServiceInterface
Class BarcodeService.
Parent Firstred\PostNL\Service\ServiceInterface
238 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public generateBarcodeREST($generateBarcode)
• public generateBarcodesREST($generateBarcodes)
• public generateBarcodeSOAP($generateBarcode)
• public generateBarcodesSOAP($generateBarcodes)
• public buildGenerateBarcodeRequestREST($generateBarcode)
• public processGenerateBarcodeResponseREST($response)
• public buildGenerateBarcodeRequestSOAP($generateBarcode)
• public processGenerateBarcodeResponseSOAP($response)
Methods
public Firstred\PostNL\Service\BarcodeServiceInterface::generateBarcodeREST($generateBarcode)
Generate a single barcode.
Parameters• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)
Returns string Barcode
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseException
1.13. Reference 239
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionSince 1.0.0
public Firstred\PostNL\Service\BarcodeServiceInterface::generateBarcodesREST($generateBarcodes)
Generate multiple barcodes at once.
Parameters• $generateBarcodes (Firstred\PostNL\Entity\Request\GenerateBarcode[])
Returns string[] Barcodes
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionSince 1.0.0
240 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Service\BarcodeServiceInterface::generateBarcodeSOAP($generateBarcode)
Generate a single barcode.
Parameters• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)
Returns string Barcode
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\BarcodeServiceInterface::generateBarcodesSOAP($generateBarcodes)
Generate multiple barcodes at once.
Parameters• $generateBarcodes (Firstred\PostNL\Entity\Request\GenerateBarcode[])
Returns string[] Barcodes
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
1.13. Reference 241
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\BarcodeServiceInterface::buildGenerateBarcodeRequestREST($generateBarcode)
Build the `generateBarcode` HTTP request for the REST API.
Parameters• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\BarcodeServiceInterface::processGenerateBarcodeResponseREST($response)
Process GenerateBarcode REST response.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns array
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientException
242 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionSince 1.0.0
public Firstred\PostNL\Service\BarcodeServiceInterface::buildGenerateBarcodeRequestSOAP($generateBarcode)
Build the `generateBarcode` HTTP request for the SOAP API.
Parameters• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\BarcodeServiceInterface::processGenerateBarcodeResponseSOAP($response)
Process GenerateBarcode SOAP response.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns string
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
1.13. Reference 243
PostNL PHP bindings Documentation, Release 1.2.0
ShippingServiceInterface
interface Firstred\PostNL\Service\ShippingServiceInterface
Class ShippingService.
Parent Firstred\PostNL\Service\ServiceInterface
Summary
Methods
• public sendShipmentRest($sendShipment, $confirm)
• public buildSendShipmentRequestREST($sendShipment, $confirm)
• public processSendShipmentResponseREST($response)
Methods
public Firstred\PostNL\Service\ShippingServiceInterface::sendShipmentRest($sendShipment,$confirm=true)
Generate a single Shipping vai REST.
Parameters• $sendShipment (Firstred\PostNL\Entity\Request\SendShipment)
• $confirm (bool)
Returns \Firstred\PostNL\Entity\Response\SendShipmentResponse | null
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
244 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedException
1.13. Reference 245
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Service\ShippingServiceInterface::buildSendShipmentRequestREST($sendShipment,$con-firm=true)
Parameters• $sendShipment (Firstred\PostNL\Entity\Request\SendShipment)
• $confirm (bool)
Returns \Psr\Http\Message\RequestInterface
Since 1.2.0
public Firstred\PostNL\Service\ShippingServiceInterface::processSendShipmentResponseREST($response)
Process the SendShipment REST Response.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\SendShipmentResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedException
246 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
ShippingStatusServiceInterface
interface Firstred\PostNL\Service\ShippingStatusServiceInterface
Class ShippingStatusService.
Parent Firstred\PostNL\Service\ServiceInterface
Summary
Methods
• public currentStatusREST($currentStatus)
• public currentStatusesREST($currentStatuses)
• public completeStatusREST($completeStatus)
• public completeStatusesREST($completeStatuses)
• public getSignatureREST($getSignature)
• public getSignaturesREST($getSignatures)
• public buildCurrentStatusRequestREST($currentStatus)
• public processCurrentStatusResponseREST($response)
• public buildCompleteStatusRequestREST($completeStatus)
• public processCompleteStatusResponseREST($response)
• public buildGetSignatureRequestREST($getSignature)
• public processGetSignatureResponseREST($response)
• public getUpdatedShipmentsREST($customer, $dateTimeFrom, $dateTimeTo)
• public buildGetUpdatedShipmentsRequestREST($customer, $dateTimeFrom, $dateTimeTo)
• public processGetUpdatedShipmentsResponseREST($response)
Methods
public Firstred\PostNL\Service\ShippingStatusServiceInterface::currentStatusREST($currentStatus)
Gets the current status.
This is a combi-function, supporting the following:- CurrentStatus (by barcode):
- Fill the Shipment->Barcode property. Leave the rest empty.- CurrentStatusByReference:
- Fill the Shipment->Reference property. Leave the rest empty.
Parameters
1.13. Reference 247
PostNL PHP bindings Documentation, Release 1.2.0
• $currentStatus (Firstred\PostNL\Entity\Request\CurrentStatus | \Firstred\PostNL\Entity\Request\CurrentStatusByReference)
Returns \Firstred\PostNL\Entity\Response\CurrentStatusResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedException
248 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\ShippingStatusServiceInterface::currentStatusesREST($currentStatuses)
Get current statuses REST.
Parameters• $currentStatuses (Firstred\PostNL\Entity\Request\CurrentStatus[] |\Firstred\PostNL\Entity\Request\CurrentStatusByReference[])
Returns \Firstred\PostNL\Entity\Response\CurrentStatusResponse[]Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
1.13. Reference 249
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.2.0
public Firstred\PostNL\Service\ShippingStatusServiceInterface::completeStatusREST($completeStatus)
Gets the complete status.
This is a combi-function, supporting the following:- CurrentStatus (by barcode):
- Fill the Shipment->Barcode property. Leave the rest empty.- CurrentStatusByReference:
- Fill the Shipment->Reference property. Leave the rest empty.
Parameters• $completeStatus (Firstred\PostNL\Entity\Request\CompleteStatus | \Firstred\PostNL\Entity\Request\CompleteStatusByReference)
Returns \Firstred\PostNL\Entity\Response\UpdatedShipmentsResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientException
250 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundException
1.13. Reference 251
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\ShippingStatusServiceInterface::completeStatusesREST($completeStatuses)
Get complete statuses REST.
Parameters• $completeStatuses (Firstred\PostNL\Entity\Request\CompleteStatus[] | \Firstred\PostNL\Entity\Request\CompleteStatusByReference[])
Returns \Firstred\PostNL\Entity\Response\CompleteStatusResponse[]Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
252 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.2.0
public Firstred\PostNL\Service\ShippingStatusServiceInterface::getSignatureREST($getSignature)
Gets the complete status.
This is a combi-function, supporting the following:- CurrentStatus (by barcode):
- Fill the Shipment->Barcode property. Leave the rest empty.- CurrentStatusByReference:
- Fill the Shipment->Reference property. Leave the rest empty.
Parameters• $getSignature (Firstred\PostNL\Entity\Request\GetSignature)
Returns \Firstred\PostNL\Entity\Response\GetSignatureResponseSignatureThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownException
1.13. Reference 253
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundException
254 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Since 1.0.0
public Firstred\PostNL\Service\ShippingStatusServiceInterface::getSignaturesREST($getSignatures)
Get multiple signatures.
Parameters• $getSignatures (Firstred\PostNL\Entity\Request\GetSignature[])
Returns \Firstred\PostNL\Entity\Response\GetSignatureResponseSignature[]Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.2.0
public Firstred\PostNL\Service\ShippingStatusServiceInterface::buildCurrentStatusRequestREST($currentStatus)
Build the CurrentStatus request for the REST API.
This function auto-detects and adjusts the following requests:- CurrentStatus
1.13. Reference 255
PostNL PHP bindings Documentation, Release 1.2.0
- CurrentStatusByReference
Parameters• $currentStatus (Firstred\PostNL\Entity\Request\CurrentStatus | \Firstred\PostNL\Entity\Request\CurrentStatusByReference)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\ShippingStatusServiceInterface::processCurrentStatusResponseREST($response)
Process CurrentStatus Response REST.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\CurrentStatusResponseThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\ShippingStatusServiceInterface::buildCompleteStatusRequestREST($completeStatus)
Build the CompleteStatus request for the REST API.
This function auto-detects and adjusts the following requests:- CompleteStatus- CompleteStatusByReference
Parameters• $completeStatus (Firstred\PostNL\Entity\Request\CompleteStatus)
256 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\ShippingStatusServiceInterface::processCompleteStatusResponseREST($response)
Process CompleteStatus Response REST.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\ShippingStatusServiceInterface::buildGetSignatureRequestREST($getSignature)
Build the GetSignature request for the REST API.
Parameters• $getSignature (Firstred\PostNL\Entity\Request\GetSignature)
Returns \Psr\Http\Message\RequestInterface
public Firstred\PostNL\Service\ShippingStatusServiceInterface::processGetSignatureResponseREST($response)
Process GetSignature Response REST.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\GetSignatureResponseSignature |null
1.13. Reference 257
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\ShippingStatusServiceInterface::getUpdatedShipmentsREST($customer,$date-Time-From=null,$date-TimeTo=null)
Get updated shipments for customer REST.
Parameters• $customer (Firstred\PostNL\Entity\Customer)
• $dateTimeFrom (DateTimeInterface | null)
• $dateTimeTo (DateTimeInterface | null)
Returns \Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse[]Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
258 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownException
1.13. Reference 259
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.2.0
public Firstred\PostNL\Service\ShippingStatusServiceInterface::buildGetUpdatedShipmentsRequestREST($customer,$date-Time-From=null,$date-TimeTo=null)
Build get updated shipments request REST.
Parameters• $customer (Firstred\PostNL\Entity\Customer)
• $dateTimeFrom (DateTimeInterface | null)
• $dateTimeTo (DateTimeInterface | null)
Returns \Psr\Http\Message\RequestInterface
Since 1.2.0
public Firstred\PostNL\Service\ShippingStatusServiceInterface::processGetUpdatedShipmentsResponseREST($response)
Process updated shipments response REST.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse[]Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseException
260 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.2.0
Classes
AbstractService
class Firstred\PostNL\Service\AbstractService
Class AbstractService.
Summary
Methods
• public __construct($postnl, $cache, $ttl)
• public __call($name, $args)
• public setService($object)
• public static registerNamespaces($element)
• public static validateRESTResponse($response)
• public static validateSOAPResponse($xml)
• public static getResponseText($response)
• public retrieveCachedItem($uuid)
• public cacheItem($item)
• public removeCachedItem($item)
• public getTtl()
• public setTtl($ttl)
• public getCache()
• public setCache($cache)
• public static defaultDateFormat($writer, $value)
1.13. Reference 261
PostNL PHP bindings Documentation, Release 1.2.0
Constants
COMMON_NAMESPACE = \'http://postnl\.nl/cif/services/common/\'
XML_SCHEMA_NAMESPACE = \'http://www\.w3\.org/2001/XMLSchema\-instance\'
ENVELOPE_NAMESPACE = \'http://schemas\.xmlsoap\.org/soap/envelope/\'
OLD_ENVELOPE_NAMESPACE = \'http://www\.w3\.org/2003/05/soap\-envelope\'
Properties
public property Firstred\PostNL\Service\AbstractService::$namespaces
Type array
protected static property Firstred\PostNL\Service\AbstractService::$postnl
Type \Firstred\PostNL\PostNLpublic static property Firstred\PostNL\Service\AbstractService::$ttl
TTL for the cache.
`null` disables the cache`int` is the TTL in secondsAny `DateTime` will be used as the exact date/time at which to expire the data (auto calculate TTL)A `DateInterval` can be used as well to set the TTL
Type int | \DateTimeInterface | \DateInterval | null
public static property Firstred\PostNL\Service\AbstractService::$cache
The [PSR-6](https://www.php-fig.org/psr/psr-6/) CacheItemPoolInterface.
Use a caching library that implements [PSR-6](https://www.php-fig.org/psr/psr-6/) and you'll be good to go`null` disables the cache
Type \Psr\Cache\CacheItemPoolInterface | null
Methods
public Firstred\PostNL\Service\AbstractService::__construct($postnl, $cache=null, $ttl=null)
AbstractService constructor.
Parameters• $postnl (Firstred\PostNL\PostNL) PostNL instance
• $cache (Psr\Cache\CacheItemPoolInterface | null)
• $ttl (int | \DateTimeInterface | \DateInterval | null)
public Firstred\PostNL\Service\AbstractService::__call($name, $args)
262 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Parameters• $name (string)
• $args (mixed)
Returns mixed
Throws \Firstred\PostNL\Exception\InvalidMethodExceptionSince 1.0.0
public Firstred\PostNL\Service\AbstractService::setService($object)
Set the webservice on the object.
This lets the object know for which service it should serialize
Parameters• $object (Firstred\PostNL\Entity\AbstractEntity)
Returns bool
Since 1.0.0
public static Firstred\PostNL\Service\AbstractService::registerNamespaces($element)
Register namespaces.
Parameters• $element (SimpleXMLElement)
Since 1.0.0
public static Firstred\PostNL\Service\AbstractService::validateRESTResponse($response)
Parameters• $response (Psr\Http\Message\ResponseInterface | \Exception)
Returns bool
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
1.13. Reference 263
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionSince 1.0.0
public static Firstred\PostNL\Service\AbstractService::validateSOAPResponse($xml)
Parameters• $xml (SimpleXMLElement)
Returns bool
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionSince 1.0.0
public static Firstred\PostNL\Service\AbstractService::getResponseText($response)
Get the response.
Parameters• $response
Returns string
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
public Firstred\PostNL\Service\AbstractService::retrieveCachedItem($uuid)
Retrieve a cached item.
Parameters
264 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $uuid (string)
Returns \Psr\Cache\CacheItemInterface | null
Throws \Psr\Cache\InvalidArgumentException
Since 1.0.0
public Firstred\PostNL\Service\AbstractService::cacheItem($item)
Cache an item
Parameters• $item (Psr\Cache\CacheItemInterface)
Since 1.0.0
public Firstred\PostNL\Service\AbstractService::removeCachedItem($item)
Delete an item from cache
Parameters• $item (Psr\Cache\CacheItemInterface)
Throws \Psr\Cache\InvalidArgumentException
Since 1.2.0
public Firstred\PostNL\Service\AbstractService::getTtl()
Returns \DateInterval | \DateTimeInterface | int | null
Since 1.2.0
public Firstred\PostNL\Service\AbstractService::setTtl($ttl=null)
Parameters• $ttl (int | \DateTimeInterface | \DateInterval | null)
Returns static
Since 1.2.0
public Firstred\PostNL\Service\AbstractService::getCache()
Returns \Psr\Cache\CacheItemPoolInterface | null
Since 1.2.0
public Firstred\PostNL\Service\AbstractService::setCache($cache=null)
Parameters• $cache (Psr\Cache\CacheItemPoolInterface | null)
Returns static
Since 1.2.0
public static Firstred\PostNL\Service\AbstractService::defaultDateFormat($writer, $value)
Write default date format in XML
1.13. Reference 265
PostNL PHP bindings Documentation, Release 1.2.0
Parameters• $writer (Sabre\Xml\Writer)
• $value (DateTimeImmutable)
Since 1.2.0
LocationService
class Firstred\PostNL\Service\LocationService
Class LocationService.
Parent Firstred\PostNL\Service\AbstractServiceImplements Firstred\PostNL\Service\LocationServiceInterface
Summary
Methods
• public getNearestLocationsREST($getNearestLocations)
• public getNearestLocationsSOAP($getNearestLocations)
• public getLocationsInAreaREST($getLocations)
• public getLocationsInAreaSOAP($getNearestLocations)
• public getLocationREST($getLocation)
• public getLocationSOAP($getLocation)
• public buildGetNearestLocationsRequestREST($getNearestLocations)
• public processGetNearestLocationsResponseREST($response)
• public buildGetNearestLocationsRequestSOAP($getLocations)
• public processGetNearestLocationsResponseSOAP($response)
• public buildGetLocationsInAreaRequestREST($getLocations)
• public processGetLocationsInAreaResponseREST($response)
• public buildGetLocationsInAreaRequestSOAP($getLocations)
• public processGetLocationsInAreaResponseSOAP($response)
• public buildGetLocationRequestREST($getLocation)
• public processGetLocationResponseREST($response)
• public buildGetLocationRequestSOAP($getLocations)
• public processGetLocationResponseSOAP($response)
266 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Constants
VERSION = \'2\.1\'
LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2\_1/locations\'
SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2\_1/locations\'
SOAP_ACTION = \'http://postnl\.nl/cif/services/LocationWebService/ILocationWebService/GetNearestLocations\'
SOAP_ACTION_LOCATIONS_IN_AREA = \'http://postnl\.nl/cif/services/LocationWebService/ILocationWebService/GetLocationsInArea\'
SERVICES_NAMESPACE = \'http://postnl\.nl/cif/services/LocationWebService/\'
DOMAIN_NAMESPACE = \'http://postnl\.nl/cif/domain/LocationWebService/\'
Properties
public property Firstred\PostNL\Service\LocationService::$namespaces
Namespaces uses for the SOAP version of this service.
Type array
Methods
public Firstred\PostNL\Service\LocationService::getNearestLocationsREST($getNearestLocations)
Get the nearest locations via REST.
Parameters• $getNearestLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)
Returns \Firstred\PostNL\Entity\Response\GetNearestLocationsResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
1.13. Reference 267
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
268 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationService::getNearestLocationsSOAP($getNearestLocations)
Get the nearest locations via SOAP.
Parameters• $getNearestLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)
Returns \Firstred\PostNL\Entity\Response\GetNearestLocationsResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientException
1.13. Reference 269
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationService::getLocationsInAreaREST($getLocations)
Get the nearest locations via REST.
Parameters• $getLocations (Firstred\PostNL\Entity\Request\GetLocationsInArea)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseException
270 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
1.13. Reference 271
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationService::getLocationsInAreaSOAP($getNearestLocations)
Get the nearest locations via SOAP.
Parameters• $getNearestLocations (Firstred\PostNL\Entity\Request\GetLocationsInArea)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
272 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientException
1.13. Reference 273
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationService::getLocationREST($getLocation)
Get the location via REST.
Parameters• $getLocation (Firstred\PostNL\Entity\Request\GetLocation)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientException
274 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationService::getLocationSOAP($getLocation)
Get the nearest locations via SOAP.
Parameters• $getLocation (Firstred\PostNL\Entity\Request\GetLocation)
1.13. Reference 275
PostNL PHP bindings Documentation, Release 1.2.0
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
276 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationService::buildGetNearestLocationsRequestREST($getNearestLocations)
Build the GenerateLabel request for the REST API.
Parameters• $getNearestLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LocationService::processGetNearestLocationsResponseREST($response)
Process GetNearestLocations Response REST.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\GetNearestLocationsResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseException
1.13. Reference 277
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationService::buildGetNearestLocationsRequestSOAP($getLocations)
Build the GenerateLabel request for the SOAP API.
Parameters• $getLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LocationService::processGetNearestLocationsResponseSOAP($response)
Process GetNearestLocations Response SOAP.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\GetNearestLocationsResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownException
278 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationService::buildGetLocationsInAreaRequestREST($getLocations)
Build the GetLocationsInArea request for the REST API.
Parameters• $getLocations (Firstred\PostNL\Entity\Request\GetLocationsInArea)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LocationService::processGetLocationsInAreaResponseREST($response)
Process GetLocationsInArea Response REST.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationService::buildGetLocationsInAreaRequestSOAP($getLocations)
Build the GetLocationsInArea request for the SOAP API.
1.13. Reference 279
PostNL PHP bindings Documentation, Release 1.2.0
Parameters• $getLocations (Firstred\PostNL\Entity\Request\GetLocationsInArea)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LocationService::processGetLocationsInAreaResponseSOAP($response)
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationService::buildGetLocationRequestREST($getLocation)
Build the GetLocation request for the REST API.
Parameters
280 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $getLocation (Firstred\PostNL\Entity\Request\GetLocation)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LocationService::processGetLocationResponseREST($response)
Process GetLocation Response REST.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\LocationService::buildGetLocationRequestSOAP($getLocations)
Build the GetLocation request for the SOAP API.
Parameters• $getLocations (Firstred\PostNL\Entity\Request\GetLocation)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LocationService::processGetLocationResponseSOAP($response)
Process GetLocation Response SOAP.
Parameters• $response (Psr\Http\Message\ResponseInterface)
1.13. Reference 281
PostNL PHP bindings Documentation, Release 1.2.0
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Sabre\Xml\LibXMLException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
ShippingService
class Firstred\PostNL\Service\ShippingService
Class ShippingService.
Parent Firstred\PostNL\Service\AbstractServiceImplements Firstred\PostNL\Service\ShippingServiceInterface
282 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public sendShipmentRest($sendShipment, $confirm)
• public buildSendShipmentRequestREST($sendShipment, $confirm)
• public processSendShipmentResponseREST($response)
Constants
VERSION = \'1\'
LIVE_ENDPOINT = \'https://api\.postnl\.nl/v1/shipment\'
SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/v1/shipment\'
DOMAIN_NAMESPACE = \'http://postnl\.nl/\'
Methods
public Firstred\PostNL\Service\ShippingService::sendShipmentRest($sendShipment,$confirm=true)
Generate a single Shipping vai REST.
Parameters• $sendShipment (Firstred\PostNL\Entity\Request\SendShipment)
• $confirm (bool)
Returns \Firstred\PostNL\Entity\Response\SendShipmentResponse | null
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
1.13. Reference 283
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedException
284 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\Service\ShippingService::buildSendShipmentRequestREST($sendShipment,$con-firm=true)
Parameters• $sendShipment (Firstred\PostNL\Entity\Request\SendShipment)
• $confirm (bool)
Returns \Psr\Http\Message\RequestInterface
Since 1.2.0
public Firstred\PostNL\Service\ShippingService::processSendShipmentResponseREST($response)
Process the SendShipment REST Response.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\SendShipmentResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedException
1.13. Reference 285
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
BarcodeService
class Firstred\PostNL\Service\BarcodeService
Class BarcodeService.
Parent Firstred\PostNL\Service\AbstractServiceImplements Firstred\PostNL\Service\BarcodeServiceInterface
Summary
Methods
• public generateBarcodeREST($generateBarcode)
• public generateBarcodeSOAP($generateBarcode)
• public generateBarcodesREST($generateBarcodes)
• public generateBarcodesSOAP($generateBarcodes)
• public buildGenerateBarcodeRequestREST($generateBarcode)
• public buildGenerateBarcodeRequestSOAP($generateBarcode)
• public processGenerateBarcodeResponseREST($response)
• public processGenerateBarcodeResponseSOAP($response)
Constants
VERSION = \'1\.1\'
SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v1\_1/barcode\'
LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v1\_1/barcode\'
SOAP_ACTION = \'http://postnl\.nl/cif/services/BarcodeWebService/IBarcodeWebService/GenerateBarcode\'
ENVELOPE_NAMESPACE = \'http://schemas\.xmlsoap\.org/soap/envelope/\'
SERVICES_NAMESPACE = \'http://postnl\.nl/cif/services/BarcodeWebService/\'
DOMAIN_NAMESPACE = \'http://postnl\.nl/cif/domain/BarcodeWebService/\'
286 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Properties
protected static property Firstred\PostNL\Service\BarcodeService::$postnl
Type \Firstred\PostNL\PostNLpublic property Firstred\PostNL\Service\BarcodeService::$namespaces
Namespaces uses for the SOAP version of this service.
Type array
Methods
public Firstred\PostNL\Service\BarcodeService::generateBarcodeREST($generateBarcode)
Generate a single barcode.
Parameters• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)
Returns string | null Barcode
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientException
1.13. Reference 287
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionSince 1.0.0
public Firstred\PostNL\Service\BarcodeService::generateBarcodeSOAP($generateBarcode)
Generate a single barcode.
Parameters• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)
Returns string Barcode
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\BarcodeService::generateBarcodesREST($generateBarcodes)
Generate multiple barcodes at once.
Parameters• $generateBarcodes (Firstred\PostNL\Entity\Request\GenerateBarcode[])
Returns string[] Barcodes
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownException
288 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionSince 1.0.0
public Firstred\PostNL\Service\BarcodeService::generateBarcodesSOAP($generateBarcodes)
Generate multiple barcodes at once.
Parameters• $generateBarcodes (Firstred\PostNL\Entity\Request\GenerateBarcode[])
Returns string[] Barcodes
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownException
1.13. Reference 289
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\BarcodeService::buildGenerateBarcodeRequestREST($generateBarcode)
Build the `generateBarcode` HTTP request for the REST API.
Parameters• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\BarcodeService::buildGenerateBarcodeRequestSOAP($generateBarcode)
Build the `generateBarcode` HTTP request for the SOAP API.
Parameters• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\BarcodeService::processGenerateBarcodeResponseREST($response)
Process GenerateBarcode REST response.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \stdClass
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseException
290 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionSince 1.0.0
public Firstred\PostNL\Service\BarcodeService::processGenerateBarcodeResponseSOAP($response)
Process GenerateBarcode SOAP response.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns string
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
1.13. Reference 291
PostNL PHP bindings Documentation, Release 1.2.0
DeliveryDateService
class Firstred\PostNL\Service\DeliveryDateService
Class DeliveryDateService.
Parent Firstred\PostNL\Service\AbstractServiceImplements Firstred\PostNL\Service\DeliveryDateServiceInterface
Summary
Methods
• public getDeliveryDateREST($getDeliveryDate)
• public getDeliveryDateSOAP($getDeliveryDate)
• public getSentDateREST($getSentDate)
• public getSentDateSOAP($getSentDate)
• public buildGetDeliveryDateRequestREST($getDeliveryDate)
• public processGetDeliveryDateResponseREST($response)
• public buildGetDeliveryDateRequestSOAP($getDeliveryDate)
• public processGetDeliveryDateResponseSOAP($response)
• public buildGetSentDateRequestREST($getSentDate)
• public processGetSentDateResponseREST($response)
• public buildGetSentDateRequestSOAP($getSentDate)
• public processGetSentDateResponseSOAP($response)
Constants
VERSION = \'2\.2\'
LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2\_2/calculate/date\'
SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2\_2/calculate/date\'
SOAP_ACTION = \'http://postnl\.nl/cif/services/DeliveryDateWebService/IDeliveryDateWebService/GetDeliveryDate\'
SERVICES_NAMESPACE = \'http://postnl\.nl/cif/services/DeliveryDateWebService/\'
DOMAIN_NAMESPACE = \'http://postnl\.nl/cif/domain/DeliveryDateWebService/\'
292 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Properties
public property Firstred\PostNL\Service\DeliveryDateService::$namespaces
Namespaces uses for the SOAP version of this service.
Type array
Methods
public Firstred\PostNL\Service\DeliveryDateService::getDeliveryDateREST($getDeliveryDate)
Get a delivery date via REST.
Parameters• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)
Returns \Firstred\PostNL\Entity\Response\GetDeliveryDateResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientException
1.13. Reference 293
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateService::getDeliveryDateSOAP($getDeliveryDate)
Get a delivery date via SOAP.
Parameters• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)
Returns \Firstred\PostNL\Entity\Response\GetDeliveryDateResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
294 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateService::getSentDateREST($getSentDate)
Get the sent date via REST.
Parameters• $getSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest)
Returns \Firstred\PostNL\Entity\Response\GetSentDateResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientException
1.13. Reference 295
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseException
296 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateService::getSentDateSOAP($getSentDate)
Generate a single label via SOAP.
Parameters• $getSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest)
Returns \Firstred\PostNL\Entity\Response\GetSentDateResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundException
1.13. Reference 297
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Psr\Cache\InvalidArgumentException
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateService::buildGetDeliveryDateRequestREST($getDeliveryDate)
Build the GetDeliveryDate request for the REST API.
Parameters• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateService::processGetDeliveryDateResponseREST($response)
Process GetDeliveryDate REST Response.
Parameters• $response (mixed)
298 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Returns \Firstred\PostNL\Entity\Response\GetDeliveryDateResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\DeliveryDateService::buildGetDeliveryDateRequestSOAP($getDeliveryDate)
Build the GetDeliveryDate request for the SOAP API.
Parameters• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateService::processGetDeliveryDateResponseSOAP($response)
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\GetDeliveryDateResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientException
1.13. Reference 299
PostNL PHP bindings Documentation, Release 1.2.0
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateService::buildGetSentDateRequestREST($getSentDate)
Build the GetSentDate request for the REST API.
Parameters• $getSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\DeliveryDateService::processGetSentDateResponseREST($response)
Process GetSentDate REST Response.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\GetSentDateResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\DeliveryDateService::buildGetSentDateRequestSOAP($getSentDate)
Build the GetSentDate request for the SOAP API.
Parameters• $getSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
300 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Service\DeliveryDateService::processGetSentDateResponseSOAP($response)
Process GetSentDate SOAP Response.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\GetSentDateResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
TimeframeService
class Firstred\PostNL\Service\TimeframeService
Class TimeframeService.
Parent Firstred\PostNL\Service\AbstractServiceImplements Firstred\PostNL\Service\TimeframeServiceInterface
Summary
Methods
• public getTimeframesREST($getTimeframes)
• public getTimeframesSOAP($getTimeframes)
• public buildGetTimeframesRequestREST($getTimeframes)
• public processGetTimeframesResponseREST($response)
• public buildGetTimeframesRequestSOAP($getTimeframes)
1.13. Reference 301
PostNL PHP bindings Documentation, Release 1.2.0
• public processGetTimeframesResponseSOAP($response)
Constants
VERSION = \'2\.1\'
LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2\_1/calculate/timeframes\'
SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2\_1/calculate/timeframes\'
SOAP_ACTION = \'http://postnl\.nl/cif/services/TimeframeWebService/ITimeframeWebService/GetTimeframes\'
SERVICES_NAMESPACE = \'http://postnl\.nl/cif/services/TimeframeWebService/\'
DOMAIN_NAMESPACE = \'http://postnl\.nl/cif/domain/TimeframeWebService/\'
Properties
public property Firstred\PostNL\Service\TimeframeService::$namespaces
Namespaces uses for the SOAP version of this service.
Type array
Methods
public Firstred\PostNL\Service\TimeframeService::getTimeframesREST($getTimeframes)
Get timeframes via REST.
Parameters• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)
Returns \Firstred\PostNL\Entity\Response\ResponseTimeframesThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
302 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedException
1.13. Reference 303
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\TimeframeService::getTimeframesSOAP($getTimeframes)
Get timeframes via SOAP.
Parameters• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)
Returns \Firstred\PostNL\Entity\Response\ResponseTimeframesThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Psr\Cache\InvalidArgumentException
304 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\TimeframeService::buildGetTimeframesRequestREST($getTimeframes)
Build the GetTimeframes request for the REST API.
Parameters• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\TimeframeService::processGetTimeframesResponseREST($response)
Process GetTimeframes Response REST.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\ResponseTimeframes | null
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientException
1.13. Reference 305
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\TimeframeService::buildGetTimeframesRequestSOAP($getTimeframes)
Build the GetTimeframes request for the SOAP API.
Parameters• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\TimeframeService::processGetTimeframesResponseSOAP($response)
Process GetTimeframes Response SOAP.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\ResponseTimeframesThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
306 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
ShippingStatusService
class Firstred\PostNL\Service\ShippingStatusService
Class ShippingStatusService.
Parent Firstred\PostNL\Service\AbstractServiceImplements Firstred\PostNL\Service\ShippingStatusServiceInterface
Summary
Methods
• public currentStatusREST($currentStatus)
• public currentStatusesREST($currentStatuses)
• public completeStatusREST($completeStatus)
• public completeStatusesREST($completeStatuses)
• public getSignatureREST($getSignature)
• public getSignaturesREST($getSignatures)
• public buildCurrentStatusRequestREST($currentStatus)
• public processCurrentStatusResponseREST($response)
• public buildCompleteStatusRequestREST($completeStatus)
• public processCompleteStatusResponseREST($response)
• public buildGetSignatureRequestREST($getSignature)
• public processGetSignatureResponseREST($response)
• public getUpdatedShipmentsREST($customer, $dateTimeFrom, $dateTimeTo)
• public buildGetUpdatedShipmentsRequestREST($customer, $dateTimeFrom, $dateTimeTo)
• public processGetUpdatedShipmentsResponseREST($response)
Constants
VERSION = \'2\'
LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2/status\'
SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2/status\'
DOMAIN_NAMESPACE = \'http://postnl\.nl/\'
1.13. Reference 307
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Service\ShippingStatusService::currentStatusREST($currentStatus)
Gets the current status.
This is a combi-function, supporting the following:- CurrentStatus (by barcode):
- Fill the Shipment->Barcode property. Leave the rest empty.- CurrentStatusByReference:
- Fill the Shipment->Reference property. Leave the rest empty.- CurrentStatusByPhase:
- Fill the Shipment->PhaseCode property, do not pass Barcode or Reference.Optionally add DateFrom and/or DateTo.
- CurrentStatusByStatus:- Fill the Shipment->StatusCode property. Leave the rest empty.
Parameters• $currentStatus (Firstred\PostNL\Entity\Request\CurrentStatus | \Firstred\PostNL\Entity\Request\CurrentStatusByReference)
Returns \Firstred\PostNL\Entity\Response\CurrentStatusResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
308 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedException
1.13. Reference 309
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\ShippingStatusService::currentStatusesREST($currentStatuses)
Get current statuses REST.
Parameters• $currentStatuses (Firstred\PostNL\Entity\Request\CurrentStatus[] |\Firstred\PostNL\Entity\Request\CurrentStatusByReference[])
Returns \Firstred\PostNL\Entity\Response\CurrentStatusResponse[]Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.2.0
310 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Service\ShippingStatusService::completeStatusREST($completeStatus)
Gets the complete status.
This is a combi-function, supporting the following:- CurrentStatus (by barcode):
- Fill the Shipment->Barcode property. Leave the rest empty.- CurrentStatusByReference:
- Fill the Shipment->Reference property. Leave the rest empty.
Parameters• $completeStatus (Firstred\PostNL\Entity\Request\CompleteStatus | \Firstred\PostNL\Entity\Request\CompleteStatusByReference)
Returns \Firstred\PostNL\Entity\Response\CompleteStatusResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseException
1.13. Reference 311
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\ShippingStatusService::completeStatusesREST($completeStatuses)
Get complete statuses REST.
Parameters• $completeStatuses (Firstred\PostNL\Entity\Request\CompleteStatus[] | \Firstred\PostNL\Entity\Request\CompleteStatusByReference[])
Returns \Firstred\PostNL\Entity\Response\CompleteStatusResponse[]Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
312 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.2.0
public Firstred\PostNL\Service\ShippingStatusService::getSignatureREST($getSignature)
Gets the signature.
Parameters• $getSignature (Firstred\PostNL\Entity\Request\GetSignature)
Returns \Firstred\PostNL\Entity\Response\GetSignatureResponseSignatureThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundException
1.13. Reference 313
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
314 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\ShippingStatusService::getSignaturesREST($getSignatures)
Get multiple signatures.
Parameters• $getSignatures (Firstred\PostNL\Entity\Request\GetSignature[])
Returns \Firstred\PostNL\Entity\Response\GetSignatureResponseSignature[]Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
1.13. Reference 315
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.2.0
public Firstred\PostNL\Service\ShippingStatusService::buildCurrentStatusRequestREST($currentStatus)
Build the CurrentStatus request for the REST API.
This function auto-detects and adjusts the following requests:- CurrentStatus- CurrentStatusByReference
Parameters• $currentStatus (Firstred\PostNL\Entity\Request\CurrentStatus | \Firstred\PostNL\Entity\Request\CurrentStatusByReference)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\ShippingStatusService::processCurrentStatusResponseREST($response)
Process CurrentStatus Response REST.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\CurrentStatusResponseThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
316 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Service\ShippingStatusService::buildCompleteStatusRequestREST($completeStatus)
Build the CompleteStatus request for the REST API.
This function auto-detects and adjusts the following requests:- CompleteStatus- CompleteStatusByReference- CompleteStatusByPhase- CompleteStatusByStatus
Parameters• $completeStatus (Firstred\PostNL\Entity\Request\CompleteStatus)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\ShippingStatusService::processCompleteStatusResponseREST($response)
Process CompleteStatus Response REST.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\ShippingStatusService::buildGetSignatureRequestREST($getSignature)
Build the GetSignature request for the REST API.
1.13. Reference 317
PostNL PHP bindings Documentation, Release 1.2.0
Parameters• $getSignature (Firstred\PostNL\Entity\Request\GetSignature)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\ShippingStatusService::processGetSignatureResponseREST($response)
Process GetSignature Response REST.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\GetSignatureResponseSignature |null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\ShippingStatusService::getUpdatedShipmentsREST($customer,$date-Time-From=null,$date-TimeTo=null)
Get updated shipments for customer REST.
Parameters• $customer (Firstred\PostNL\Entity\Customer)
• $dateTimeFrom (DateTimeInterface | null)
• $dateTimeTo (DateTimeInterface | null)
318 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Returns \Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse[]Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedException
1.13. Reference 319
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.2.0
public Firstred\PostNL\Service\ShippingStatusService::buildGetUpdatedShipmentsRequestREST($customer,$date-Time-From=null,$date-TimeTo=null)
Build get updated shipments request REST.
Parameters• $customer (Firstred\PostNL\Entity\Customer)
• $dateTimeFrom (DateTimeInterface | null)
• $dateTimeTo (DateTimeInterface | null)
Returns \Psr\Http\Message\RequestInterface
320 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Since 1.2.0
public Firstred\PostNL\Service\ShippingStatusService::processGetUpdatedShipmentsResponseREST($response)
Process updated shipments response REST.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse[]Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.2.0
LabellingService
class Firstred\PostNL\Service\LabellingService
Class LabellingService.
Parent Firstred\PostNL\Service\AbstractServiceImplements Firstred\PostNL\Service\LabellingServiceInterface
1.13. Reference 321
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public generateLabelREST($generateLabel, $confirm)
• public generateLabelsREST($generateLabels)
• public generateLabelSOAP($generateLabel, $confirm)
• public generateLabelsSOAP($generateLabels)
• public buildGenerateLabelRequestREST($generateLabel, $confirm)
• public processGenerateLabelResponseREST($response)
• public buildGenerateLabelRequestSOAP($generateLabel, $confirm)
• public processGenerateLabelResponseSOAP($response)
Constants
VERSION = \'2\.2\'
LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2\_2/label\'
SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2\_2/label\'
SOAP_ACTION = \'http://postnl\.nl/cif/services/LabellingWebService/ILabellingWebService/GenerateLabel\'
SOAP_ACTION_NO_CONFIRM = \'http://postnl\.nl/cif/services/LabellingWebService/ILabellingWebService/GenerateLabelWithoutConfirm\'
SERVICES_NAMESPACE = \'http://postnl\.nl/cif/services/LabellingWebService/\'
DOMAIN_NAMESPACE = \'http://postnl\.nl/cif/domain/LabellingWebService/\'
Properties
public property Firstred\PostNL\Service\LabellingService::$namespaces
Namespaces uses for the SOAP version of this service.
Type array
Methods
public Firstred\PostNL\Service\LabellingService::generateLabelREST($generateLabel,$confirm=true)
Generate a single barcode via REST.
Parameters• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)
• $confirm (bool)
Returns \Firstred\PostNL\Entity\Response\GenerateLabelResponseThrows \Firstred\PostNL\Exception\CifDownException
322 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundException
1.13. Reference 323
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\LabellingService::generateLabelsREST($generateLabels)
Generate multiple labels at once.
Parameters• $generateLabels (array) [‘uuid’ => [GenerateBarcode, confirm], . . . ]
Returns array
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
324 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\LabellingService::generateLabelSOAP($generateLabel,$confirm=true)
Generate a single label via SOAP.
Parameters• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)
• $confirm (bool)
Returns \Firstred\PostNL\Entity\Response\GenerateLabelResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseException
1.13. Reference 325
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
public Firstred\PostNL\Service\LabellingService::generateLabelsSOAP($generateLabels)
Generate multiple labels at once via SOAP.
Parameters• $generateLabels (array) [‘uuid’ => [GenerateBarcode, confirm], . . . ]
Returns array
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseException
326 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\LabellingService::buildGenerateLabelRequestREST($generateLabel,$con-firm=true)
Build the GenerateLabel request for the REST API.
Parameters• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)
• $confirm (bool)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LabellingService::processGenerateLabelResponseREST($response)
Process the GenerateLabel REST Response.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\GenerateLabelResponse | null
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
1.13. Reference 327
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\Service\LabellingService::buildGenerateLabelRequestSOAP($generateLabel,$con-firm=true)
Build the GenerateLabel request for the SOAP API.
Parameters• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)
• $confirm (bool)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\LabellingService::processGenerateLabelResponseSOAP($response)
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\GenerateLabelResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
328 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
ConfirmingService
class Firstred\PostNL\Service\ConfirmingService
Class ConfirmingService.
Parent Firstred\PostNL\Service\AbstractServiceImplements Firstred\PostNL\Service\ConfirmingServiceInterface
Summary
Methods
• public confirmShipmentREST($confirming)
• public confirmShipmentsREST($confirms)
• public confirmShipmentSOAP($confirming)
• public confirmShipmentsSOAP($confirmings)
• public buildConfirmRequestREST($confirming)
• public processConfirmResponseREST($response)
• public buildConfirmRequestSOAP($confirming)
• public processConfirmResponseSOAP($response)
Constants
VERSION = \'2\.0\'
LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2/confirm\'
SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2/confirm\'
SOAP_ACTION = \'http://postnl\.nl/cif/services/ConfirmingWebService/IConfirmingWebService/Confirming\'
ENVELOPE_NAMESPACE = \'http://schemas\.xmlsoap\.org/soap/envelope/\'
SERVICES_NAMESPACE = \'http://postnl\.nl/cif/services/ConfirmingWebService/\'
DOMAIN_NAMESPACE = \'http://postnl\.nl/cif/domain/ConfirmingWebService/\'
Properties
public property Firstred\PostNL\Service\ConfirmingService::$namespaces
Namespaces uses for the SOAP version of this service.
Type array
1.13. Reference 329
PostNL PHP bindings Documentation, Release 1.2.0
Methods
public Firstred\PostNL\Service\ConfirmingService::confirmShipmentREST($confirming)
Confirm a single shipment via REST.
Parameters• $confirming (Firstred\PostNL\Entity\Request\Confirming)
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipmentThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseException
330 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\Service\ConfirmingService::confirmShipmentsREST($confirms)
Confirm multiple shipments.
Parameters• $confirms (Firstred\PostNL\Entity\Request\Confirming[]) [‘uuid’ => Con-
firming, . . . ]
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipment[]Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownException
1.13. Reference 331
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\ConfirmingService::confirmShipmentSOAP($confirming)
Generate a single label via SOAP.
Parameters• $confirming (Firstred\PostNL\Entity\Request\Confirming)
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipmentThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownException
332 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\ConfirmingService::confirmShipmentsSOAP($confirmings)
Generate multiple labels at once.
Parameters• $confirmings (array) [‘uuid’ => Confirming, . . . ]
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipment[]Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\Service\ConfirmingService::buildConfirmRequestREST($confirming)
Parameters• $confirming (Firstred\PostNL\Entity\Request\Confirming)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\ConfirmingService::processConfirmResponseREST($response)
1.13. Reference 333
PostNL PHP bindings Documentation, Release 1.2.0
Proces Confirm REST Response.
Parameters• $response (mixed)
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipment[] | null
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedException
334 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\Service\ConfirmingService::buildConfirmRequestSOAP($confirming)
Parameters• $confirming (Firstred\PostNL\Entity\Request\Confirming)
Returns \Psr\Http\Message\RequestInterface
Since 1.0.0
public Firstred\PostNL\Service\ConfirmingService::processConfirmResponseSOAP($response)
Process Confirm SOAP response.
Parameters• $response (Psr\Http\Message\ResponseInterface)
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipmentThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionSince 1.0.0
1.13. Reference 335
PostNL PHP bindings Documentation, Release 1.2.0
Util
\Firstred\PostNL\Util
Interfaces
XmlSerializable
interface Firstred\PostNL\Util\XmlSerializable
Objects implementing XmlSerializable can control how they are represented inXml.
Summary
Methods
• public xmlSerialize($writer)
Methods
public Firstred\PostNL\Util\XmlSerializable::xmlSerialize($writer)
The xmlSerialize method is called during xml writing.
Use the $writer argument to write its own xml serialization.
An important note: do _not_ create a parent element. Any elementimplementing XmlSerializable should only ever write what's consideredits 'inner xml'.
The parent of the current element is responsible for writing acontaining element.
This allows serializers to be re-used for different element names.
If you are opening new elements, you must also close them again.
Parameters• $writer (Sabre\Xml\Writer)
Returns void
336 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Classes
PendingPromise
class Firstred\PostNL\Util\PendingPromise
Promises/A+ implementation that avoids recursion when possible.
Implements Http\Promise\Promise
Summary
Methods
• public __construct($waitFn, $cancelFn)
• public then($onFulfilled, $onRejected)
• public otherwise($onRejected)
• public wait($unwrap)
• public getState()
• public cancel()
• public resolve($value)
• public reject($reason)
Methods
public Firstred\PostNL\Util\PendingPromise::__construct($waitFn=null, $cancelFn=null)
Parameters• $waitFn (callable) fn that when invoked resolves the promise
• $cancelFn (callable) fn that when invoked cancels the promise
public Firstred\PostNL\Util\PendingPromise::then($onFulfilled=null, $onRejected=null)
Parameters• $onFulfilled (callable | null)
• $onRejected (callable | null)
Returns \Firstred\PostNL\Util\PendingPromise | \Http\Promise\Promise
public Firstred\PostNL\Util\PendingPromise::otherwise($onRejected)
Parameters• $onRejected (callable)
Returns \Firstred\PostNL\Util\PendingPromise | \Http\Promise\Promise
public Firstred\PostNL\Util\PendingPromise::wait($unwrap=true)
Parameters
1.13. Reference 337
PostNL PHP bindings Documentation, Release 1.2.0
• $unwrap (bool)
Returns mixed | void
Throws \Exception
public Firstred\PostNL\Util\PendingPromise::getState()
Returns string
public Firstred\PostNL\Util\PendingPromise::cancel()
Returns void
public Firstred\PostNL\Util\PendingPromise::resolve($value)
Parameters• $value (mixed)
public Firstred\PostNL\Util\PendingPromise::reject($reason)
Parameters• $reason (mixed)
UUID
class Firstred\PostNL\Util\UUID
Class UUID.
Summary
Methods
• public static generate()
Methods
public static Firstred\PostNL\Util\UUID::generate()
Generate a v4 UUID.
Returns string
338 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
PromiseTool
class Firstred\PostNL\Util\PromiseTool
Class PromiseTool.
Summary
Methods
• public static queue($assign)
• public static task($task)
• public static promiseFor($value)
• public static rejectionFor($reason)
• public static exceptionFor($reason)
• public static iterFor($value)
• public static inspect($promise)
• public static inspectAll($promises)
• public static unwrap($promises)
• public static all($promises, $recursive)
• public static some($count, $promises)
• public static any($promises)
• public static settle($promises)
• public static each($iterable, $onFulfilled, $onRejected)
• public static eachLimit($iterable, $concurrency, $onFulfilled, $onRejected)
• public static eachLimitAll($iterable, $concurrency, $onFulfilled)
• public static isFulfilled($promise)
• public static isRejected($promise)
• public static isSettled($promise)
Methods
public static Firstred\PostNL\Util\PromiseTool::queue($assign=null)
Get the global task queue used for promise resolution.
This task queue MUST be run in an event loop in order for promises to besettled asynchronously. It will be automatically run when synchronouslywaiting on a promise.
<code>while ($eventLoop->isRunning()) {
queue()->run();
1.13. Reference 339
PostNL PHP bindings Documentation, Release 1.2.0
}</code>
Parameters• $assign (Firstred\PostNL\Util\TaskQueue) optionally specify a new queue in-
stance
Returns \Firstred\PostNL\Util\TaskQueue
public static Firstred\PostNL\Util\PromiseTool::task($task)
Adds a function to run in the task queue when it is next `run()` and returnsa promise that is fulfilled or rejected with the result.
Parameters• $task (callable) task function to run
Returns \Http\Promise\Promise
public static Firstred\PostNL\Util\PromiseTool::promiseFor($value)
Creates a promise for a value if the value is not a promise.
Parameters• $value (mixed) promise or value
Returns \Http\Promise\Promise
public static Firstred\PostNL\Util\PromiseTool::rejectionFor($reason)
Creates a rejected promise for a reason if the reason is not a promise. Ifthe provided reason is a promise, then it is returned as-is.
Parameters• $reason (mixed) promise or reason
Returns \Http\Promise\Promise
public static Firstred\PostNL\Util\PromiseTool::exceptionFor($reason)
Create an exception for a rejected promise value.
Parameters• $reason (mixed)
Returns \Firstred\PostNL\Util\Throwable
public static Firstred\PostNL\Util\PromiseTool::iterFor($value)
Returns an iterator for the given value.
Parameters• $value (mixed)
Returns \Iterator
340 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public static Firstred\PostNL\Util\PromiseTool::inspect($promise)
Synchronously waits on a promise to resolve and returns an inspection statearray.
Returns a state associative array containing a “state” key mapping to avalid promise state. If the state of the promise is “fulfilled”, the arraywill contain a “value” key mapping to the fulfilled value of the promise. Ifthe promise is rejected, the array will contain a “reason” key mapping tothe rejection reason of the promise.
Parameters• $promise (Http\Promise\Promise) promise or value
Returns array
Throws \Exception
public static Firstred\PostNL\Util\PromiseTool::inspectAll($promises)
Waits on all of the provided promises, but does not unwrap rejected promisesas thrown exception.
Returns an array of inspection state arrays.
Parameters• $promises (Http\Promise\Promise[]) traversable of promises to wait upon
Returns array
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
public static Firstred\PostNL\Util\PromiseTool::unwrap($promises)
Waits on all of the provided promises and returns the fulfilled values.
Returns an array that contains the value of each promise (in the same orderthe promises were provided). An exception is thrown if any of the promisesare rejected.
Parameters• $promises (mixed) iterable of Promise objects to wait on
Returns array
Throws \Exception on error
Throws \Firstred\PostNL\Util\Throwable on error in PHP >=7
1.13. Reference 341
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Exception on error
Throws \Firstred\PostNL\Util\Throwable on error in PHP >=7
public static Firstred\PostNL\Util\PromiseTool::all($promises, $recursive=false)
Given an array of promises, return a promise that is fulfilled when all theitems in the array are fulfilled.
The promise's fulfillment value is an array with fulfillment values atrespective positions to the original array. If any promise in the arrayrejects, the returned promise is rejected with the rejection reason.
Parameters• $promises (mixed) promises or values
• $recursive (bool) - If true, resolves new promises that might have been added to thestack during its own resolution
Returns \Http\Promise\Promise
public static Firstred\PostNL\Util\PromiseTool::some($count, $promises)
Initiate a competitive race between multiple promises or values (values willbecome immediately fulfilled promises).
When count amount of promises have been fulfilled, the returned promise isfulfilled with an array that contains the fulfillment values of the winnersin order of resolution.
Parameters• $count (int) total number of promises
• $promises (mixed) promises or values
Returns \Http\Promise\Promise
public static Firstred\PostNL\Util\PromiseTool::any($promises)
Like some(), with 1 as count. However, if the promise fulfills, thefulfillment value is not an array of 1 but the value directly.
Parameters• $promises (mixed) promises or values
Returns \Http\Promise\Promise
public static Firstred\PostNL\Util\PromiseTool::settle($promises)
Returns a promise that is fulfilled when all of the provided promises havebeen fulfilled or rejected.
342 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
The returned promise is fulfilled with an array of inspection state arrays.
Parameters• $promises (mixed) promises or values
Returns \Http\Promise\Promise
public static Firstred\PostNL\Util\PromiseTool::each($iterable, $onFulfilled=null,$onRejected=null)
Given an iterator that yields promises or values, returns a promise that isfulfilled with a null value when the iterator has been consumed or theaggregate promise has been fulfilled or rejected.
$onFulfilled is a function that accepts the fulfilled value, iteratorindex, and the aggregate promise. The callback can invoke any necessary sideeffects and choose to resolve or reject the aggregate promise if needed.
$onRejected is a function that accepts the rejection reason, iteratorindex, and the aggregate promise. The callback can invoke any necessary sideeffects and choose to resolve or reject the aggregate promise if needed.
Parameters• $iterable (mixed) iterator or array to iterate over
• $onFulfilled (callable)
• $onRejected (callable)
Returns \Http\Promise\Promise
public static Firstred\PostNL\Util\PromiseTool::eachLimit($iterable, $concurrency,$onFulfilled=null,$onRejected=null)
Like each, but only allows a certain number of outstanding promises at anygiven time.
$concurrency may be an integer or a function that accepts the number ofpending promises and returns a numeric concurrency limit value to allow fordynamic a concurrency size.
Parameters• $iterable (mixed)
• $concurrency (int | callable)
• $onFulfilled (callable)
• $onRejected (callable)
Returns \Http\Promise\Promise
1.13. Reference 343
PostNL PHP bindings Documentation, Release 1.2.0
public static Firstred\PostNL\Util\PromiseTool::eachLimitAll($iterable, $concurrency,$onFulfilled=null)
Like each_limit, but ensures that no promise in the given $iterable argumentis rejected. If any promise is rejected, then the aggregate promise isrejected with the encountered rejection.
Parameters• $iterable (mixed)
• $concurrency (int | callable)
• $onFulfilled (callable)
Returns \Http\Promise\Promise
public static Firstred\PostNL\Util\PromiseTool::isFulfilled($promise)
Returns true if a promise is fulfilled.
Parameters• $promise (Http\Promise\Promise)
Returns bool
public static Firstred\PostNL\Util\PromiseTool::isRejected($promise)
Returns true if a promise is rejected.
Parameters• $promise (Http\Promise\Promise)
Returns bool
public static Firstred\PostNL\Util\PromiseTool::isSettled($promise)
Returns true if a promise is fulfilled or rejected.
Parameters• $promise (Http\Promise\Promise)
Returns bool
TaskQueue
class Firstred\PostNL\Util\TaskQueue
A task queue that executes tasks in a FIFO order.
This task queue class is used to settle promises asynchronously andmaintains a constant stack size. You can use the task queue asynchronouslyby calling the `run()` function of the global task queue in an event loop.
queue()->run();
344 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public __construct($withShutdown)
• public isEmpty()
• public add($task)
• public run()
• public disableShutdown()
Methods
public Firstred\PostNL\Util\TaskQueue::__construct($withShutdown=true)
TaskQueue constructor.
Parameters• $withShutdown (bool)
public Firstred\PostNL\Util\TaskQueue::isEmpty()
Returns bool
public Firstred\PostNL\Util\TaskQueue::add($task)
Parameters• $task (callable)
public Firstred\PostNL\Util\TaskQueue::run()
Returns void
public Firstred\PostNL\Util\TaskQueue::disableShutdown()
The task queue will be run and exhausted by default when the processexits IFF the exit is not the result of a PHP E_ERROR error.
You can disable running the automatic shutdown of the queue by callingthis function. If you disable the task queue shutdown process, then youMUST either run the task queue (as a result of running your event loopor manually using the run() method) or wait on each outstanding promise.
Note: This shutdown will occur before any destructors are triggered.
1.13. Reference 345
PostNL PHP bindings Documentation, Release 1.2.0
RFPdi
class Firstred\PostNL\Util\RFPdi
Class RFPdi.
Parent setasign\Fpdi\Fpdi
Summary
Methods
• public rotate($angle, $x, $y)
• public rotateClockWise()
• public rotateCounterClockWise()
• public _endpage()
Properties
public static property Firstred\PostNL\Util\RFPdi::$angle
Methods
public Firstred\PostNL\Util\RFPdi::rotate($angle, $x=\-1, $y=\-1)
public Firstred\PostNL\Util\RFPdi::rotateClockWise()
public Firstred\PostNL\Util\RFPdi::rotateCounterClockWise()
public Firstred\PostNL\Util\RFPdi::_endpage()
EachPromise
class Firstred\PostNL\Util\EachPromise
Represents a promise that iterates over many promises and invokesside-effect functions in the process.
Summary
Methods
• public __construct($iterable, $config)
• public promise()
346 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Constants
PENDING = \'pending\'
FULFILLED = \'fulfilled\'
REJECTED = \'rejected\'
Methods
public Firstred\PostNL\Util\EachPromise::__construct( $iterable, $config=\[\])
Configuration hash can include the following key value pairs:.
- fulfilled: (callable) Invoked when a promise fulfills. The functionis invoked with three arguments: the fulfillment value, the indexposition from the iterable list of the promise, and the aggregatepromise that manages all of the promises. The aggregate promise maybe resolved from within the callback to short-circuit the promise.
- rejected: (callable) Invoked when a promise is rejected. Thefunction is invoked with three arguments: the rejection reason, theindex position from the iterable list of the promise, and theaggregate promise that manages all of the promises. The aggregatepromise may be resolved from within the callback to short-circuitthe promise.
- concurrency: (integer) Pass this configuration option to limit theallowed number of outstanding concurrently executing promises,creating a capped pool of promises. There is no limit by default.
Parameters• $iterable (mixed) promises or values to iterate
• $config (array) Configuration options
public Firstred\PostNL\Util\EachPromise::promise()
Returns \Http\Promise\Promise
Util
class Firstred\PostNL\Util\Util
Class Util.
1.13. Reference 347
PostNL PHP bindings Documentation, Release 1.2.0
Summary
Methods
• public static urlEncode($arr, $prefix)
• public static getPdfSizeAndOrientation($pdf)
• public static getDeliveryDate($deliveryDate, $mondayDelivery, $sundayDelivery)
• public static getShippingDate($deliveryDate, $days)
• public static getShippingDaysRemaining($shippingDate, $preferredDeliveryDate)
• protected static getHolidaysForYear($year)
Constants
ERROR_MARGIN = 2
Methods
public static Firstred\PostNL\Util\Util::urlEncode($arr, $prefix=null)
Parameters• $arr (array) a map of param keys to values
• $prefix (string | null)
Returns string a querystring, essentially
public static Firstred\PostNL\Util\Util::getPdfSizeAndOrientation($pdf )
Parameters• $pdf (string) Raw PDF string
Returns array | false | string Returns an array with the dimensions or ISO size and orientationThe orientation is in FPDF format, so L for Landscape and P for Portrait Sizes are in mm
public static Firstred\PostNL\Util\Util::getDeliveryDate($deliveryDate,$mondayDelivery=false,$sundayDelivery=false)
Offline delivery date calculation.
Parameters• $deliveryDate (string) Delivery date in any format accepted by DateTime
• $mondayDelivery (bool) Sunday sorting/Monday delivery enabled
• $sundayDelivery (bool) Sunday delivery enabled
Returns string (format: `Y-m-d H:i:s`)
Throws \Exception
348 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public static Firstred\PostNL\Util\Util::getShippingDate( $deliveryDate, $days=\[0 =\> false,1 =\> true, 2 =\> true, 3 =\> true, 4=\> true, 5 =\> true, 6 =\> true\])
Offline shipping date calculation.
Parameters• $deliveryDate (string)
• $days (array)
Returns string
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public static Firstred\PostNL\Util\Util::getShippingDaysRemaining($shippingDate,$preferredDeliveryDate)
Calculates amount of days remainingi.e. preferred delivery date the day tomorrow => today = 0i.e. preferred delivery date the day after tomorrow => today + tomorrow = 1i.e. preferred delivery date the day after tomorrow, but one holiday => today + holiday = 0.
0 means: should ship today< 0 means: should've shipped in the pastanything higher means: you've got some more time
Parameters• $shippingDate (string) Shipping date (format: Y-m-d H:i:s)
• $preferredDeliveryDate (string) Customer preference
Returns int
Throws \Exception
protected static Firstred\PostNL\Util\Util::getHolidaysForYear($year)
Get an array with all Dutch holidays for the given year.
Parameters• $year (string)
Returns array Credits to @tvlooy (https://gist.github.com/tvlooy/1894247)
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
1.13. Reference 349
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
350 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
Throws \Exception
1.13. Reference 351
PostNL PHP bindings Documentation, Release 1.2.0
DummyLogger
class Firstred\PostNL\Util\DummyLogger
Class DummyLogger.
Implements Psr\Log\LoggerInterface
Summary
Methods
• public emergency($message, $context)
• public alert($message, $context)
• public critical($message, $context)
• public error($message, $context)
• public warning($message, $context)
• public notice($message, $context)
• public info($message, $context)
• public debug($message, $context)
• public log($level, $message, $context)
Methods
public Firstred\PostNL\Util\DummyLogger::emergency( $message, $context=\[\])
Parameters• $message (string)
• $context (array)
public Firstred\PostNL\Util\DummyLogger::alert( $message, $context=\[\])
Parameters• $message (string)
• $context (array)
public Firstred\PostNL\Util\DummyLogger::critical( $message, $context=\[\])
Parameters• $message (string)
• $context (array)
public Firstred\PostNL\Util\DummyLogger::error( $message, $context=\[\])
Parameters• $message (string)
352 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $context (array)
public Firstred\PostNL\Util\DummyLogger::warning( $message, $context=\[\])
Parameters• $message (string)
• $context (array)
public Firstred\PostNL\Util\DummyLogger::notice( $message, $context=\[\])
Parameters• $message (string)
• $context (array)
public Firstred\PostNL\Util\DummyLogger::info( $message, $context=\[\])
Parameters• $message (string)
• $context (array)
public Firstred\PostNL\Util\DummyLogger::debug( $message, $context=\[\])
Parameters• $message (string)
• $context (array)
public Firstred\PostNL\Util\DummyLogger::log( $level, $message, $context=\[\])
Parameters• $level (mixed)
• $message (string)
• $context (array)
Message
class Firstred\PostNL\Util\Message
Class Message.
Summary
Methods
• public static str($message)
• public static parseResponse($message)
1.13. Reference 353
PostNL PHP bindings Documentation, Release 1.2.0
Constants
RFC7230_HEADER_REGEX = "\(^\(\[^\(\)<\>@,;:\\\\\\"/\[\\\\\]?=\{\}\\1\- \]\+\+\):\[ \\t\]\*\+\(\(?:\[ \\t\]\*\+\[\!\-~?\-?\]\+\+\)\*\+\)\[ \\t\]\*\+\\r?\\n\)m"
RFC7230_HEADER_FOLD_REGEX = "\(\\r?\\n\[ \\t\]\+\+\)"
Methods
public static Firstred\PostNL\Util\Message::str($message)
Returns the string representation of an HTTP message.
Parameters• $message (Psr\Http\Message\MessageInterface) message to convert to a string
Returns string
public static Firstred\PostNL\Util\Message::parseResponse($message)
Parses a response message string into a response object.
Parameters• $message (string) response message string
Returns \Psr\Http\Message\ResponseInterface
Traits
FlexibleEntityTrait
trait Firstred\PostNL\Util\FlexibleEntityTrait
Trait FlexibleEntityTrait.
Methods
public Firstred\PostNL\Util\FlexibleEntityTrait::__call($name, $value)
Add additional properties.
Parameters• $name (string)
• $value (mixed)
Returns object | null
Throws \Firstred\PostNL\Exception\InvalidArgumentException
354 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
1.13.2 Classes
PostNL
class Firstred\PostNL\PostNL
Class PostNL.
Implements Psr\Log\LoggerAwareInterface
Summary
Methods
• public __construct($customer, $apiKey, $sandbox, $mode)
• public setToken($apiKey)
• public getRestApiKey()
• public getToken()
• public getCustomer()
• public setCustomer($customer)
• public getSandbox()
• public setSandbox($sandbox)
• public getMode()
• public setMode($mode)
• public getHttpClient()
• public setHttpClient($client)
• public getLogger()
• public setLogger($logger)
• public resetLogger()
• public getRequestFactory()
• public setRequestFactory($requestFactory)
• public getResponseFactory()
• public setResponseFactory($responseFactory)
• public getStreamFactory()
• public setStreamFactory($streamFactory)
• public getBarcodeService()
• public setBarcodeService($service)
• public getLabellingService()
• public setLabellingService($service)
• public getConfirmingService()
• public setConfirmingService($service)
• public getShippingStatusService()
1.13. Reference 355
PostNL PHP bindings Documentation, Release 1.2.0
• public setShippingStatusService($service)
• public getDeliveryDateService()
• public setDeliveryDateService($service)
• public getTimeframeService()
• public setTimeframeService($service)
• public getLocationService()
• public setLocationService($service)
• public getShippingService()
• public setShippingService($service)
• public generateBarcode($type, $range, $serie, $eps)
• public generateBarcodeByCountryCode($iso)
• public generateBarcodesByCountryCodes($isos)
• public sendShipment($shipment, $printertype, $confirm)
• public sendShipments($shipments, $printertype, $confirm, $merge, $format,$positions, $a6Orientation)
• public generateLabel($shipment, $printertype, $confirm)
• public generateLabels($shipments, $printertype, $confirm, $merge, $format,$positions, $a6Orientation)
• public confirmShipment($shipment)
• public confirmShipments($shipments)
• public getCurrentStatus($currentStatus)
• public getShippingStatusByBarcode($barcode, $complete)
• public getShippingStatusesByBarcodes($barcodes, $complete)
• public getShippingStatusByReference($reference, $complete)
• public getShippingStatusesByReference($references, $complete)
• public getCompleteStatus($completeStatus)
• public getUpdatedShipments($dateTimeFrom, $dateTimeTo)
• public getSignature($signature)
• public getSignatureByBarcode($barcode)
• public getSignaturesByBarcodes($barcodes)
• public getDeliveryDate($getDeliveryDate)
• public getSentDate($getSentDate)
• public getTimeframes($getTimeframes)
• public getNearestLocations($getNearestLocations)
• public getTimeframesAndNearestLocations($getTimeframes, $getNearestLocations,$getDeliveryDate)
• public getLocationsInArea($getLocationsInArea)
• public getLocation($getLocation)
• public findBarcodeSerie($type, $range, $eps)
356 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Constants
MODE_REST = 1
MODE_SOAP = 2
MODE_LEGACY = 2
Properties
public property Firstred\PostNL\PostNL::$threeSCountries
3S (or EU Pack Special) countries.
Type array
public property Firstred\PostNL\PostNL::$a6positions
A6 positions(index = amount of a6 left on the page).
Type array
public static property Firstred\PostNL\PostNL::$verifySslCerts
Verify SSL certificate of the PostNL REST API.
Type bool
Deprecated
protected static property Firstred\PostNL\PostNL::$apiKey
The PostNL REST API key or SOAP username/password to be used for requests.
In case of REST the API key is the `Password` property of the `UsernameToken`In case of SOAP this has to be a `UsernameToken` object, with the following requirements:
- Do not pass a username (`null`)And pass the plaintext password.
Type string
protected static property Firstred\PostNL\PostNL::$customer
The PostNL Customer to be used for requests.
Type \Firstred\PostNL\Entity\Customer
protected static property Firstred\PostNL\PostNL::$sandbox
Sandbox mode.
Type bool
1.13. Reference 357
PostNL PHP bindings Documentation, Release 1.2.0
protected static property Firstred\PostNL\PostNL::$httpClient
Type \Firstred\PostNL\HttpClient\ClientInterfaceprotected static property Firstred\PostNL\PostNL::$logger
Type \Psr\Log\LoggerInterface
protected static property Firstred\PostNL\PostNL::$requestFactory
Type \Firstred\PostNL\Factory\RequestFactoryInterfaceprotected static property Firstred\PostNL\PostNL::$responseFactory
Type \Firstred\PostNL\Factory\ResponseFactoryInterfaceprotected static property Firstred\PostNL\PostNL::$streamFactory
Type \Firstred\PostNL\Factory\StreamFactoryInterfaceprotected static property Firstred\PostNL\PostNL::$mode
This is the current mode.
Type int
protected static property Firstred\PostNL\PostNL::$barcodeService
Type \Firstred\PostNL\Service\BarcodeServiceInterfaceprotected static property Firstred\PostNL\PostNL::$labellingService
Type \Firstred\PostNL\Service\LabellingServiceInterfaceprotected static property Firstred\PostNL\PostNL::$confirmingService
Type \Firstred\PostNL\Service\ConfirmingServiceInterfaceprotected static property Firstred\PostNL\PostNL::$shippingStatusService
Type \Firstred\PostNL\Service\ShippingStatusServiceInterfaceprotected static property Firstred\PostNL\PostNL::$deliveryDateService
Type \Firstred\PostNL\Service\DeliveryDateServiceInterfaceprotected static property Firstred\PostNL\PostNL::$timeframeService
Type \Firstred\PostNL\Service\TimeframeServiceInterfaceprotected static property Firstred\PostNL\PostNL::$locationService
Type \Firstred\PostNL\Service\LocationServiceInterfaceprotected static property Firstred\PostNL\PostNL::$shippingService
Type \Firstred\PostNL\Service\ShippingServiceInterface
Methods
public Firstred\PostNL\PostNL::__construct($customer, $apiKey, $sandbox,$mode=self::MODE\_REST)
PostNL constructor.
Parameters• $customer (Firstred\PostNL\Entity\Customer) Customer object.
358 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
• $apiKey (Firstred\PostNL\Entity\SOAP\UsernameToken | string) API key orUsernameToken object.
• $sandbox (bool) Whether the testing environment should be used.
• $mode (int) Set the preferred connection strategy.
Valid options are: - MODE_REST : New REST API - MODE_SOAP: New SOAP API -MODE_LEGACY : Not supported anymore, converts to MODE_SOAP
Throws \Firstred\PostNL\Exception\InvalidArgumentException
public Firstred\PostNL\PostNL::setToken($apiKey)
Set the token.
Parameters• $apiKey (string | \Firstred\PostNL\Entity\SOAP\UsernameToken)
Returns \Firstred\PostNL\PostNLThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\PostNL::getRestApiKey()
Get REST API Key.
Returns bool | string
Since 1.0.0
public Firstred\PostNL\PostNL::getToken()
Get UsernameToken object (for SOAP).
Returns bool | \Firstred\PostNL\Entity\SOAP\UsernameToken
Since 1.0.0
public Firstred\PostNL\PostNL::getCustomer()
Get PostNL Customer.
Returns \Firstred\PostNL\Entity\CustomerSince 1.0.0
public Firstred\PostNL\PostNL::setCustomer($customer)
Set PostNL Customer.
Parameters• $customer (Firstred\PostNL\Entity\Customer)
Returns \Firstred\PostNL\PostNLSince 1.0.0
1.13. Reference 359
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\PostNL::getSandbox()
Get sandbox mode.
Returns bool
Since 1.0.0
public Firstred\PostNL\PostNL::setSandbox($sandbox)
Set sandbox mode.
Parameters• $sandbox (bool)
Returns \Firstred\PostNL\PostNLSince 1.0.0
public Firstred\PostNL\PostNL::getMode()
Get the current mode.
Returns int
Since 1.0.0
public Firstred\PostNL\PostNL::setMode($mode)
Set current mode.
Parameters• $mode (int)
Returns \Firstred\PostNL\PostNLThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.0.0
public Firstred\PostNL\PostNL::getHttpClient()
HttpClient.
Automatically load Guzzle when available
Returns \Firstred\PostNL\HttpClient\ClientInterfaceSince 1.0.0
public Firstred\PostNL\PostNL::setHttpClient($client)
Set the HttpClient.
Parameters• $client (Firstred\PostNL\HttpClient\ClientInterface)
360 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Since 1.0.0
public Firstred\PostNL\PostNL::getLogger()
Get the logger.
Returns \Psr\Log\LoggerInterface
Since 1.0.0
public Firstred\PostNL\PostNL::setLogger($logger)
Set the logger.
Parameters• $logger (Psr\Log\LoggerInterface)
Returns \Firstred\PostNL\PostNLSince 1.0.0
public Firstred\PostNL\PostNL::resetLogger()
Set a dummy logger
Returns static
Since 1.2.0
public Firstred\PostNL\PostNL::getRequestFactory()
Get PSR-7 Request factory.
Returns \Firstred\PostNL\Factory\RequestFactoryInterfaceSince 1.2.0
public Firstred\PostNL\PostNL::setRequestFactory($requestFactory)
Set PSR-7 Request factory.
Parameters• $requestFactory (Firstred\PostNL\Factory\RequestFactoryInterface)
Returns static
Since 1.2.0
public Firstred\PostNL\PostNL::getResponseFactory()
Get PSR-7 Response factory.
Returns \Firstred\PostNL\Factory\ResponseFactoryInterfaceSince 1.2.0
public Firstred\PostNL\PostNL::setResponseFactory($responseFactory)
1.13. Reference 361
PostNL PHP bindings Documentation, Release 1.2.0
Set PSR-7 Response factory.
Parameters• $responseFactory (Firstred\PostNL\Factory\ResponseFactoryInterface)
Returns static
Since 1.2.0
public Firstred\PostNL\PostNL::getStreamFactory()
Set PSR-7 Stream factory.
Returns \Firstred\PostNL\Factory\StreamFactoryInterfaceSince 1.2.0
public Firstred\PostNL\PostNL::setStreamFactory($streamFactory)
Set PSR-7 Stream factory.
Parameters• $streamFactory (Firstred\PostNL\Factory\StreamFactoryInterface)
Returns static
Since 1.2.0
public Firstred\PostNL\PostNL::getBarcodeService()
Barcode service.
Automatically load the barcode service
Returns \Firstred\PostNL\Service\BarcodeServiceInterfaceSince 1.0.0
public Firstred\PostNL\PostNL::setBarcodeService($service)
Set the barcode service.
Parameters• $service (Firstred\PostNL\Service\BarcodeServiceInterface)
Since 1.0.0
public Firstred\PostNL\PostNL::getLabellingService()
Labelling service.
Automatically load the labelling service
Returns \Firstred\PostNL\Service\LabellingServiceInterface
362 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Since 1.0.0
public Firstred\PostNL\PostNL::setLabellingService($service)
Set the labelling service.
Parameters• $service (Firstred\PostNL\Service\LabellingServiceInterface)
Since 1.0.0
public Firstred\PostNL\PostNL::getConfirmingService()
Confirming service.
Automatically load the confirming service
Returns \Firstred\PostNL\Service\ConfirmingServiceInterfaceSince 1.0.0
public Firstred\PostNL\PostNL::setConfirmingService($service)
Set the confirming service.
Parameters• $service (Firstred\PostNL\Service\ConfirmingServiceInterface)
Since 1.0.0
public Firstred\PostNL\PostNL::getShippingStatusService()
Shipping status service.
Automatically load the shipping status service
Returns \Firstred\PostNL\Service\ShippingStatusServiceInterfaceSince 1.0.0
public Firstred\PostNL\PostNL::setShippingStatusService($service)
Set the shipping status service.
Parameters• $service (Firstred\PostNL\Service\ShippingStatusServiceInterface)
Since 1.0.0
public Firstred\PostNL\PostNL::getDeliveryDateService()
Delivery date service.
1.13. Reference 363
PostNL PHP bindings Documentation, Release 1.2.0
Automatically load the delivery date service
Returns \Firstred\PostNL\Service\DeliveryDateServiceInterfaceSince 1.0.0
public Firstred\PostNL\PostNL::setDeliveryDateService($service)
Set the delivery date service.
Parameters• $service (Firstred\PostNL\Service\DeliveryDateServiceInterface)
Since 1.0.0
public Firstred\PostNL\PostNL::getTimeframeService()
Timeframe service.
Automatically load the timeframe service
Returns \Firstred\PostNL\Service\TimeframeServiceInterfaceSince 1.0.0
public Firstred\PostNL\PostNL::setTimeframeService($service)
Set the timeframe service.
Parameters• $service (Firstred\PostNL\Service\TimeframeServiceInterface)
Since 1.0.0
public Firstred\PostNL\PostNL::getLocationService()
Location service.
Automatically load the location service
Returns \Firstred\PostNL\Service\LocationServiceInterfaceSince 1.0.0
public Firstred\PostNL\PostNL::setLocationService($service)
Set the location service.
Parameters• $service (Firstred\PostNL\Service\LocationServiceInterface)
Since 1.0.0
364 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\PostNL::getShippingService()
Shipping service.
Automatically load the shipping service
Returns mixed
Since 1.2.0
public Firstred\PostNL\PostNL::setShippingService($service)
Set the shipping service.
Parameters• $service (Firstred\PostNL\Service\ShippingServiceInterface)
Since 1.2.0
public Firstred\PostNL\PostNL::generateBarcode($type=\'3S\', $range=null, $serie=null,$eps=false)
Generate a single barcode.
Parameters• $type (string)
• $range (string)
• $serie (string)
• $eps (bool)
Returns string The barcode as a string
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientException
1.13. Reference 365
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionSince 1.0.0
public Firstred\PostNL\PostNL::generateBarcodeByCountryCode($iso)
Generate a single barcode by country code.
Parameters• $iso (string) 2-letter Country ISO Code
Returns string The Barcode as a string
Throws \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientException
366 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionSince 1.0.0
1.13. Reference 367
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\PostNL::generateBarcodesByCountryCodes($isos)
Generate a single barcode by country code.
Parameters• $isos (array) key = iso code, value = amount of barcodes requested
Returns array Country isos with the barcode as string
Throws \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseException
368 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\InvalidConfigurationExceptionThrows \Firstred\PostNL\Exception\InvalidBarcodeExceptionSince 1.0.0
public Firstred\PostNL\PostNL::sendShipment($shipment, $printertype=\'GraphicFile\|PDF\',$confirm=true)
Send a single shipment.
Parameters• $shipment (Firstred\PostNL\Entity\Shipment)
• $printertype (string)
• $confirm (bool)
Returns \Firstred\PostNL\Entity\Response\SendShipmentResponseThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
1.13. Reference 369
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseException
370 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\PostNL::sendShipments( $shipments, $printertype=\'GraphicFile\|PDF\',$confirm=true, $merge=false,$format=Label::FORMAT\_A4, $positions=\[1 =\>true, 2 =\> true, 3 =\> true, 4 =\> true\],$a6Orientation=\'P\')
Send multiple shipments.
Parameters• $shipments (Firstred\PostNL\Entity\Shipment[]) Array of shipments
• $printertype (string) Printer type, see PostNL dev docs for available types
• $confirm (bool) Immediately confirm the shipments
• $merge (bool) Merge the PDFs and return them in a MyParcel way
• $format (int) A4 or A6
• $positions (array) Set the positions of the A6s on the first A4
The indices should be the position number, marked with true or false These are the posi-tion numbers: ` +-+-+ |2|4| +-+-+ |1|3| +-+-+ ` So, for ` +-+-+ |x|XXX| +-+-+|XXX|x| +-+-+ ` you would have to pass: `php [ 1 => true, 2 => false, 3 =>false, 4 => true, ] ` * $a6Orientation (string) A6 orientation (P or L)
Returns \Firstred\PostNL\Entity\Response\SendShipmentResponse | string
Throws \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
1.13. Reference 371
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
372 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
1.13. Reference 373
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
374 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifException
1.13. Reference 375
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionSince 1.2.0
public Firstred\PostNL\PostNL::generateLabel($shipment, $printertype=\'GraphicFile\|PDF\',$confirm=true)
Generate a single label.
Parameters• $shipment (Firstred\PostNL\Entity\Shipment)
• $printertype (string)
• $confirm (bool)
Returns \Firstred\PostNL\Entity\Response\GenerateLabelResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownException
376 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundException
1.13. Reference 377
PostNL PHP bindings Documentation, Release 1.2.0
Since 1.0.0
public Firstred\PostNL\PostNL::generateLabels( $shipments, $printertype=\'GraphicFile\|PDF\',$confirm=true, $merge=false,$format=Label::FORMAT\_A4, $positions=\[1 =\>true, 2 =\> true, 3 =\> true, 4 =\> true\],$a6Orientation=\'P\')
Generate or retrieve multiple labels.
Note that instead of returning a GenerateLabelResponse this function can merge the labels and return astring which contains the PDF with the merged pages as well.
Parameters• $shipments (Firstred\PostNL\Entity\Shipment[]) (key = ID) Shipments
• $printertype (string) Printer type, see PostNL dev docs for available types
• $confirm (bool) Immediately confirm the shipments
• $merge (bool) Merge the PDFs and return them in a MyParcel way
• $format (int) A4 or A6
• $positions (array) Set the positions of the A6s on the first A4
The indices should be the position number, marked with true or false These are the posi-tion numbers: ` +-+-+ |2|4| +-+-+ |1|3| +-+-+ ` So, for ` +-+-+ |x|XXX| +-+-+|XXX|x| +-+-+ ` you would have to pass: `php [ 1 => true, 2 => false, 3 =>false, 4 => true, ] ` * $a6Orientation (string) A6 orientation (P or L)
Returns \Firstred\PostNL\Entity\Response\GenerateLabelResponse[] | string
Throws \Firstred\PostNL\Exception\PostNLExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\PostNLExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
378 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\PostNLExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\PostNLExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\PostNLExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedException
1.13. Reference 379
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\PostNLExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\PostNLExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\PostNLExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseException
380 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\PostNLExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\PostNLExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\PostNLExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\PostNLExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \setasign\Fpdi\PdfParser\CrossReference\CrossReferenceException
1.13. Reference 381
PostNL PHP bindings Documentation, Release 1.2.0
Throws \setasign\Fpdi\PdfParser\Filter\FilterException
Throws \setasign\Fpdi\PdfParser\PdfParserException
Throws \setasign\Fpdi\PdfParser\Type\PdfTypeException
Throws \setasign\Fpdi\PdfReader\PdfReaderException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.0.0
public Firstred\PostNL\PostNL::confirmShipment($shipment)
Confirm a single shipment.
Parameters• $shipment (Firstred\PostNL\Entity\Shipment)
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipmentSince 1.0.0
public Firstred\PostNL\PostNL::confirmShipments($shipments)
Confirm multiple shipments.
Parameters• $shipments (array)
Returns \Firstred\PostNL\Entity\Response\ConfirmingResponseShipment[]Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownException
382 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
public Firstred\PostNL\PostNL::getCurrentStatus($currentStatus)
Get the current status of a shipment.
1.13. Reference 383
PostNL PHP bindings Documentation, Release 1.2.0
This is a combi-function, supporting the following:- CurrentStatus (by barcode):
- Fill the Shipment->Barcode property. Leave the rest empty.- CurrentStatusByReference:
- Fill the Shipment->Reference property. Leave the rest empty.
Parameters• $currentStatus (Firstred\PostNL\Entity\Request\CurrentStatus | \Firstred\PostNL\Entity\Request\CurrentStatusByReference)
Returns \Firstred\PostNL\Entity\Response\CurrentStatusResponseThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
384 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
Deprecated 1.2.0 Use the dedicated methods (get by phase and status are no longer working)
public Firstred\PostNL\PostNL::getShippingStatusByBarcode($barcode, $complete=false)
Get the current status of the given shipment by barcode.
1.13. Reference 385
PostNL PHP bindings Documentation, Release 1.2.0
Parameters• $barcode (string) Pass a single barcode
• $complete (bool) Return the complete status (incl. shipment history)
Returns \Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment | \Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
Throws \Firstred\PostNL\Exception\ShipmentNotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\ShipmentNotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\ShipmentNotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\ShipmentNotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\ShipmentNotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownException
386 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\ShipmentNotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\ShipmentNotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\ShipmentNotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.2.0
public Firstred\PostNL\PostNL::getShippingStatusesByBarcodes($barcodes, $complete=false)
Get the current statuses of the given shipments by barcodes.
Parameters• $barcodes (string[]) Pass multiple barcodes
• $complete (bool) Return the complete status (incl. shipment history)
Returns \Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment[] |\Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment[]
1.13. Reference 387
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.2.0
public Firstred\PostNL\PostNL::getShippingStatusByReference($reference, $complete=false)
Get the current status of the given shipment by reference.
Parameters• $reference (string) Pass a single reference
• $complete (bool) Return the complete status (incl. shipment history)
Returns \Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment | \Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
388 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Http\Discovery\NotFoundException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Http\Discovery\NotFoundException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Http\Discovery\NotFoundException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Http\Discovery\NotFoundException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Http\Discovery\NotFoundException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedException
1.13. Reference 389
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Http\Discovery\NotFoundException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Http\Discovery\NotFoundException
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Http\Discovery\NotFoundException
Since 1.2.0
public Firstred\PostNL\PostNL::getShippingStatusesByReference($references, $complete=false)
Get the current statuses of the given shipments by references.
Parameters• $references (string[]) Pass multiple references
• $complete (bool) Return the complete status (incl. shipment history)
Returns \Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment[] |\Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment[]
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseException
390 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.2.0
public Firstred\PostNL\PostNL::getCompleteStatus($completeStatus)
Get the complete status of a shipment.
This is a combi-function, supporting the following:- CurrentStatus (by barcode):
- Fill the Shipment->Barcode property. Leave the rest empty.- CurrentStatusByReference:
- Fill the Shipment->Reference property. Leave the rest empty.- CurrentStatusByPhase:
- Fill the Shipment->PhaseCode property, do not pass Barcode or Reference.Optionally add DateFrom and/or DateTo.
- CurrentStatusByStatus:- Fill the Shipment->StatusCode property. Leave the rest empty.
Parameters• $completeStatus (Firstred\PostNL\Entity\Request\CompleteStatus)
Returns \Firstred\PostNL\Entity\Response\CompleteStatusResponseThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundException
1.13. Reference 391
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionThrows \Firstred\PostNL\Exception\CifDownExceptionThrows \Firstred\PostNL\Exception\CifExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedException
392 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\NotFoundExceptionSince 1.0.0
Deprecated 1.2.0 Use the dedicated getShippingStatus* methods (get by phase and status are nolonger working)
public Firstred\PostNL\PostNL::getUpdatedShipments($dateTimeFrom=null, $dateTimeTo=null)
Get updated shipments
Parameters• $dateTimeFrom (DateTimeInterface | null)
• $dateTimeTo (DateTimeInterface | null)
Returns \Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse[]Since 1.2.0
public Firstred\PostNL\PostNL::getSignature($signature)
Get the signature of a shipment.
Parameters• $signature (Firstred\PostNL\Entity\Request\GetSignature)
Returns \Firstred\PostNL\Entity\Response\GetSignatureResponseSignatureSince 1.0.0
Deprecated 1.2.0 Use the getSignature(s)By* alternatives
public Firstred\PostNL\PostNL::getSignatureByBarcode($barcode)
Get the signature of a shipment.
Parameters• $barcode (string)
Returns \Firstred\PostNL\Entity\Response\GetSignatureResponseSignatureSince 1.2.0
public Firstred\PostNL\PostNL::getSignaturesByBarcodes($barcodes)
Get the signature of a shipment.
Parameters• $barcodes (string[])
Returns \Firstred\PostNL\Entity\Response\GetSignatureResponseSignature[]Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentException
1.13. Reference 393
PostNL PHP bindings Documentation, Release 1.2.0
Throws \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionThrows \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\NotSupportedExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\ResponseExceptionSince 1.2.0
public Firstred\PostNL\PostNL::getDeliveryDate($getDeliveryDate)
Get a delivery date.
Parameters• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)
Returns \Firstred\PostNL\Entity\Response\GetDeliveryDateResponseSince 1.0.0
public Firstred\PostNL\PostNL::getSentDate($getSentDate)
Get a shipping date.
Parameters• $getSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest)
Returns \Firstred\PostNL\Entity\Response\GetSentDateResponseSince 1.0.0
394 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\PostNL::getTimeframes($getTimeframes)
Get timeframes.
Parameters• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)
Returns \Firstred\PostNL\Entity\Response\ResponseTimeframesSince 1.0.0
public Firstred\PostNL\PostNL::getNearestLocations($getNearestLocations)
Get nearest locations.
Parameters• $getNearestLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)
Returns \Firstred\PostNL\Entity\Response\GetNearestLocationsResponseSince 1.0.0
public Firstred\PostNL\PostNL::getTimeframesAndNearestLocations($getTimeframes,$getNearestLocations,$getDeliveryDate)
All-in-one function for checkout widgets. It retrieves and returns the- timeframes- locations- delivery date.
Parameters• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)
• $getNearestLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)
• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)
Returns array [uuid => ResponseTimeframes, uuid => GetNearestLocationsResponse, uuid =>GetDeliveryDateResponse]
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Throws \Firstred\PostNL\Exception\HttpClientExceptionThrows \Firstred\PostNL\Exception\InvalidArgumentExceptionThrows \Psr\Cache\InvalidArgumentException
Since 1.0.0
1.13. Reference 395
PostNL PHP bindings Documentation, Release 1.2.0
public Firstred\PostNL\PostNL::getLocationsInArea($getLocationsInArea)
Get locations in area.
Parameters• $getLocationsInArea (Firstred\PostNL\Entity\Request\GetLocationsInArea)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseSince 1.0.0
public Firstred\PostNL\PostNL::getLocation($getLocation)
Get locations in area.
Parameters• $getLocation (Firstred\PostNL\Entity\Request\GetLocation)
Returns \Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseSince 1.0.0
public Firstred\PostNL\PostNL::findBarcodeSerie($type, $range, $eps)
Find a suitable serie for the barcode.
Parameters• $type (string)
• $range (string)
• $eps (bool) Indicates whether it is an EPS Shipment
Returns string
Throws \Firstred\PostNL\Exception\InvalidBarcodeExceptionSince 1.0.0
1.14 Authors
1.14.1 Maintainers:
• Michael Dekker <[email protected]> (maintainer)
Looking for maintainers! If you’d like to help keep this library up to date please send and email [email protected]
396 Chapter 1. Developer Guide
PostNL PHP bindings Documentation, Release 1.2.0
1.14.2 Contributors:
These contributors have helped with making this library possible. Thank you so much!
• janwilletje (contributor)
• jbours (contributor)
• timmtim (contributor)
• niccifor (contributor)
• fgd007 (contributor)
• TomKriek (contributor)
• rowhel95 (contributor)
• lenvanessen (contributor)
• GetMagented (contributor)
• rvanvelzen (contributor)
• timo002 (contributor)
• Mathieu Haverkamp (contributor)
• Jeroen Smit (contributor)
1.14. Authors 397
PostNL PHP bindings Documentation, Release 1.2.0
398 Chapter 1. Developer Guide
PHP NAMESPACE INDEX
fFirstred\PostNL, 355Firstred\PostNL\Entity, 118Firstred\PostNL\Entity\Message, 46Firstred\PostNL\Entity\Request, 67Firstred\PostNL\Entity\Response, 95Firstred\PostNL\Entity\SOAP, 113Firstred\PostNL\Exception, 172Firstred\PostNL\Exception\Promise, 165Firstred\PostNL\Factory, 173Firstred\PostNL\HttpClient, 187Firstred\PostNL\Service, 194Firstred\PostNL\Util, 336
399
PostNL PHP bindings Documentation, Release 1.2.0
400 PHP Namespace Index
INDEX
Symbols__call() (Firstred\PostNL\Entity\AbstractEntity
method), 124__call() (Firstred\PostNL\Service\AbstractService
method), 262__call() (Firstred\PostNL\Util\FlexibleEntityTrait
method), 354__construct() (Firstred\PostNL\Entity\AbstractEntity
method), 124__construct() (Firstred\PostNL\Entity\Address
method), 132__construct() (Firstred\PostNL\Entity\Amount
method), 137__construct() (Firstred\PostNL\Entity\Area
method), 121__construct() (Firstred\PostNL\Entity\Barcode
method), 140__construct() (Firstred\PostNL\Entity\Contact
method), 122__construct() (Firstred\PostNL\Entity\Content
method), 161__construct() (Firstred\PostNL\Entity\Coordinates
method), 135__construct() (Firstred\PostNL\Entity\CoordinatesNorthWest
method), 159__construct() (Firstred\PostNL\Entity\CoordinatesSouthEast
method), 117__construct() (Firstred\PostNL\Entity\Customer
method), 134__construct() (Firstred\PostNL\Entity\Customs
method), 156__construct() (Firstred\PostNL\Entity\CutOffTime
method), 160__construct() (Firstred\PostNL\Entity\Dimension
method), 139__construct() (Firstred\PostNL\Entity\Event
method), 123__construct() (Firstred\PostNL\Entity\Expectation
method), 128__construct() (Firstred\PostNL\Entity\Group
method), 130__construct() (Firstred\PostNL\Entity\Label
method), 127__construct() (Firstred\PostNL\Entity\Location
method), 142__construct() (Firstred\PostNL\Entity\Message\LabellingMessage
method), 45__construct() (Firstred\PostNL\Entity\Message\Message
method), 46__construct() (Firstred\PostNL\Entity\OldStatus
method), 118__construct() (Firstred\PostNL\Entity\OpeningHours
method), 163__construct() (Firstred\PostNL\Entity\ProductOption
method), 144__construct() (Firstred\PostNL\Entity\ReasonNoTimeframe
method), 120__construct() (Firstred\PostNL\Entity\Request\CompleteStatus
method), 59__construct() (Firstred\PostNL\Entity\Request\CompleteStatusByPhase
method), 65__construct() (Firstred\PostNL\Entity\Request\CompleteStatusByReference
method), 58__construct() (Firstred\PostNL\Entity\Request\CompleteStatusByStatus
method), 48__construct() (Firstred\PostNL\Entity\Request\Confirming
method), 69__construct() (Firstred\PostNL\Entity\Request\CurrentStatus
method), 64__construct() (Firstred\PostNL\Entity\Request\CurrentStatusByPhase
method), 54__construct() (Firstred\PostNL\Entity\Request\CurrentStatusByReference
method), 62__construct() (Firstred\PostNL\Entity\Request\CurrentStatusByStatus
method), 56__construct() (Firstred\PostNL\Entity\Request\GenerateBarcode
method), 63__construct() (Firstred\PostNL\Entity\Request\GenerateLabel
method), 67__construct() (Firstred\PostNL\Entity\Request\GetDeliveryDate
method), 71__construct() (Firstred\PostNL\Entity\Request\GetLocation
method), 47__construct() (Firstred\PostNL\Entity\Request\GetLocationsInArea
method), 53__construct() (Firstred\PostNL\Entity\Request\GetNearestLocations
method), 57__construct() (Firstred\PostNL\Entity\Request\GetSentDate
method), 51__construct() (Firstred\PostNL\Entity\Request\GetSentDateRequest
method), 73__construct() (Firstred\PostNL\Entity\Request\GetSignature
401
PostNL PHP bindings Documentation, Release 1.2.0
method), 50__construct() (Firstred\PostNL\Entity\Request\GetTimeframes
method), 60__construct() (Firstred\PostNL\Entity\Request\SendShipment
method), 68__construct() (Firstred\PostNL\Entity\Response\CompleteStatusResponse
method), 90__construct() (Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent
method), 79__construct() (Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus
method), 112__construct() (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
method), 84__construct() (Firstred\PostNL\Entity\Response\ConfirmingResponseShipment
method), 108__construct() (Firstred\PostNL\Entity\Response\CurrentStatusResponse
method), 89__construct() (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment
method), 106__construct() (Firstred\PostNL\Entity\Response\GenerateBarcodeResponse
method), 88__construct() (Firstred\PostNL\Entity\Response\GenerateLabelResponse
method), 100__construct() (Firstred\PostNL\Entity\Response\GetDeliveryDateResponse
method), 109__construct() (Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse
method), 88__construct() (Firstred\PostNL\Entity\Response\GetLocationsResult
method), 74__construct() (Firstred\PostNL\Entity\Response\GetNearestLocationsResponse
method), 76__construct() (Firstred\PostNL\Entity\Response\GetSentDateResponse
method), 95__construct() (Firstred\PostNL\Entity\Response\GetSignatureResponseSignature
method), 98__construct() (Firstred\PostNL\Entity\Response\MergedLabel
method), 94__construct() (Firstred\PostNL\Entity\Response\ResponseAddress
method), 103__construct() (Firstred\PostNL\Entity\Response\ResponseAmount
method), 99__construct() (Firstred\PostNL\Entity\Response\ResponseGroup
method), 87__construct() (Firstred\PostNL\Entity\Response\ResponseLocation
method), 92__construct() (Firstred\PostNL\Entity\Response\ResponseShipment
method), 78__construct() (Firstred\PostNL\Entity\Response\ResponseTimeframes
method), 81__construct() (Firstred\PostNL\Entity\Response\SendShipmentResponse
method), 111__construct() (Firstred\PostNL\Entity\Response\SignatureResponse
method), 75__construct() (Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse
method), 96__construct() (Firstred\PostNL\Entity\SOAP\Envelope
method), 116__construct() (Firstred\PostNL\Entity\SOAP\Security
method), 115__construct() (Firstred\PostNL\Entity\SOAP\UsernameToken
method), 114__construct() (Firstred\PostNL\Entity\Shipment
method), 147__construct() (Firstred\PostNL\Entity\Signature
method), 136__construct() (Firstred\PostNL\Entity\Status
method), 150__construct() (Firstred\PostNL\Entity\Timeframe
method), 154__construct() (Firstred\PostNL\Entity\TimeframeTimeFrame
method), 158__construct() (Firstred\PostNL\Entity\Timeframes
method), 129__construct() (Firstred\PostNL\Entity\Warning
method), 119__construct() (Firstred\PostNL\Exception\ApiConnectionException
method), 167__construct() (Firstred\PostNL\Exception\CifException
method), 170__construct() (Firstred\PostNL\Exception\HttpClientException
method), 171__construct() (Firstred\PostNL\Exception\Promise\AggregateException
method), 166__construct() (Firstred\PostNL\Exception\Promise\RejectionException
method), 165__construct() (Firstred\PostNL\Exception\ResponseException
method), 169__construct() (Firstred\PostNL\HttpClient\HTTPlugClient
method), 181__construct() (Firstred\PostNL\PostNL method),
358__construct() (Firstred\PostNL\Service\AbstractService
method), 262__construct() (Firstred\PostNL\Util\EachPromise
method), 347__construct() (Firstred\PostNL\Util\PendingPromise
method), 337__construct() (Firstred\PostNL\Util\TaskQueue
method), 345_endpage() (Firstred\PostNL\Util\RFPdi method),
346
Aa6positions (Firstred\PostNL\PostNL property), 357AbstractEntity (class in Firstred\PostNL\Entity),
124AbstractService (class in Firstred\PostNL\Service),
261AccountName (Firstred\PostNL\Entity\Amount prop-
erty), 137AccountName (Firstred\PostNL\Entity\Response\ResponseAmount
property), 99add() (Firstred\PostNL\Util\TaskQueue method), 345addOrUpdateRequest()
(Firstred\PostNL\HttpClient\ClientInterfacemethod), 178
402 Index
PostNL PHP bindings Documentation, Release 1.2.0
addOrUpdateRequest()(Firstred\PostNL\HttpClient\CurlClientmethod), 185
addOrUpdateRequest()(Firstred\PostNL\HttpClient\GuzzleClientmethod), 193
addOrUpdateRequest()(Firstred\PostNL\HttpClient\HTTPlugClientmethod), 181
addOrUpdateRequest()(Firstred\PostNL\HttpClient\MockClientmethod), 189
Address (class in Firstred\PostNL\Entity), 131Address (Firstred\PostNL\Entity\Customer property),
134Address (Firstred\PostNL\Entity\Response\ResponseLocation
property), 91Addresses (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
property), 81Addresses (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment
property), 104Addresses (Firstred\PostNL\Entity\Shipment prop-
erty), 144AddressType (Firstred\PostNL\Entity\Address prop-
erty), 131AddressType (Firstred\PostNL\Entity\Response\ResponseAddress
property), 101AggregateException (class in
Firstred\PostNL\Exception\Promise), 166alert() (Firstred\PostNL\Util\DummyLogger
method), 352all() (Firstred\PostNL\Util\PromiseTool method), 342AllowSundaySorting
(Firstred\PostNL\Entity\Location property),140
AllowSundaySorting(Firstred\PostNL\Entity\Request\GetDeliveryDateproperty), 70
AllowSundaySorting(Firstred\PostNL\Entity\Request\GetSentDateproperty), 51
Amount (class in Firstred\PostNL\Entity), 136Amounts (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
property), 81Amounts (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment
property), 104Amounts (Firstred\PostNL\Entity\Shipment property),
144AmountType (Firstred\PostNL\Entity\Amount prop-
erty), 137angle (Firstred\PostNL\Util\RFPdi property), 346any() (Firstred\PostNL\Util\PromiseTool method), 342ApiConnectionException (class in
Firstred\PostNL\Exception), 166ApiException (class in Firstred\PostNL\Exception),
168apiKey (Firstred\PostNL\PostNL property), 357Area (class in Firstred\PostNL\Entity), 121
Area (Firstred\PostNL\Entity\Address property), 131Area (Firstred\PostNL\Entity\Response\ResponseAddress
property), 101Available (Firstred\PostNL\Entity\CutOffTime prop-
erty), 160
BBarcode (class in Firstred\PostNL\Entity), 139Barcode (Firstred\PostNL\Entity\Request\GenerateBarcode
property), 63Barcode (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
property), 81Barcode (Firstred\PostNL\Entity\Response\ConfirmingResponseShipment
property), 108Barcode (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment
property), 104Barcode (Firstred\PostNL\Entity\Response\GenerateBarcodeResponse
property), 87Barcode (Firstred\PostNL\Entity\Response\GetSignatureResponseSignature
property), 97Barcode (Firstred\PostNL\Entity\Response\ResponseShipment
property), 77Barcode (Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse
property), 96Barcode (Firstred\PostNL\Entity\Shipment property),
144Barcodes (Firstred\PostNL\Entity\Response\MergedLabel
property), 93BarcodeService (class in Firstred\PostNL\Service),
286barcodeService (Firstred\PostNL\PostNL property),
358BarcodeServiceInterface (interface in
Firstred\PostNL\Service), 238BIC (Firstred\PostNL\Entity\Amount property), 137BIC (Firstred\PostNL\Entity\Response\ResponseAmount
property), 99Body (class in Firstred\PostNL\Entity\SOAP), 113Body (Firstred\PostNL\Entity\SOAP\Envelope prop-
erty), 116body (Firstred\PostNL\Exception\ApiConnectionException
property), 167buildCompleteStatusRequestREST()
(Firstred\PostNL\Service\ShippingStatusServicemethod), 316
buildCompleteStatusRequestREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 256
buildConfirmRequestREST()(Firstred\PostNL\Service\ConfirmingServicemethod), 333
buildConfirmRequestREST()(Firstred\PostNL\Service\ConfirmingServiceInterfacemethod), 203
buildConfirmRequestSOAP()(Firstred\PostNL\Service\ConfirmingServicemethod), 335
buildConfirmRequestSOAP()
Index 403
PostNL PHP bindings Documentation, Release 1.2.0
(Firstred\PostNL\Service\ConfirmingServiceInterfacemethod), 204
buildCurrentStatusRequestREST()(Firstred\PostNL\Service\ShippingStatusServicemethod), 316
buildCurrentStatusRequestREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 255
buildGenerateBarcodeRequestREST()(Firstred\PostNL\Service\BarcodeServicemethod), 290
buildGenerateBarcodeRequestREST()(Firstred\PostNL\Service\BarcodeServiceInterfacemethod), 242
buildGenerateBarcodeRequestSOAP()(Firstred\PostNL\Service\BarcodeServicemethod), 290
buildGenerateBarcodeRequestSOAP()(Firstred\PostNL\Service\BarcodeServiceInterfacemethod), 243
buildGenerateLabelRequestREST()(Firstred\PostNL\Service\LabellingServicemethod), 327
buildGenerateLabelRequestREST()(Firstred\PostNL\Service\LabellingServiceInterfacemethod), 210
buildGenerateLabelRequestSOAP()(Firstred\PostNL\Service\LabellingServicemethod), 327
buildGenerateLabelRequestSOAP()(Firstred\PostNL\Service\LabellingServiceInterfacemethod), 211
buildGetDeliveryDateRequestREST()(Firstred\PostNL\Service\DeliveryDateServicemethod), 298
buildGetDeliveryDateRequestREST()(Firstred\PostNL\Service\DeliveryDateServiceInterfacemethod), 218
buildGetDeliveryDateRequestSOAP()(Firstred\PostNL\Service\DeliveryDateServicemethod), 299
buildGetDeliveryDateRequestSOAP()(Firstred\PostNL\Service\DeliveryDateServiceInterfacemethod), 218
buildGetLocationRequestREST()(Firstred\PostNL\Service\LocationServicemethod), 280
buildGetLocationRequestREST()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 235
buildGetLocationRequestSOAP()(Firstred\PostNL\Service\LocationServicemethod), 281
buildGetLocationRequestSOAP()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 236
buildGetLocationsInAreaRequestREST()(Firstred\PostNL\Service\LocationService
method), 279buildGetLocationsInAreaRequestREST()
(Firstred\PostNL\Service\LocationServiceInterfacemethod), 233
buildGetLocationsInAreaRequestSOAP()(Firstred\PostNL\Service\LocationServicemethod), 279
buildGetLocationsInAreaRequestSOAP()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 234
buildGetNearestLocationsRequestREST()(Firstred\PostNL\Service\LocationServicemethod), 277
buildGetNearestLocationsRequestREST()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 231
buildGetNearestLocationsRequestSOAP()(Firstred\PostNL\Service\LocationServicemethod), 278
buildGetNearestLocationsRequestSOAP()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 232
buildGetSentDateRequestREST()(Firstred\PostNL\Service\DeliveryDateServicemethod), 300
buildGetSentDateRequestREST()(Firstred\PostNL\Service\DeliveryDateServiceInterfacemethod), 219
buildGetSentDateRequestSOAP()(Firstred\PostNL\Service\DeliveryDateServicemethod), 300
buildGetSentDateRequestSOAP()(Firstred\PostNL\Service\DeliveryDateServiceInterfacemethod), 220
buildGetSignatureRequestREST()(Firstred\PostNL\Service\ShippingStatusServicemethod), 317
buildGetSignatureRequestREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 257
buildGetTimeframesRequestREST()(Firstred\PostNL\Service\TimeframeServicemethod), 305
buildGetTimeframesRequestREST()(Firstred\PostNL\Service\TimeframeServiceInterfacemethod), 197
buildGetTimeframesRequestSOAP()(Firstred\PostNL\Service\TimeframeServicemethod), 306
buildGetTimeframesRequestSOAP()(Firstred\PostNL\Service\TimeframeServiceInterfacemethod), 198
buildGetUpdatedShipmentsRequestREST()(Firstred\PostNL\Service\ShippingStatusServicemethod), 320
buildGetUpdatedShipmentsRequestREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 260
404 Index
PostNL PHP bindings Documentation, Release 1.2.0
Buildingname (Firstred\PostNL\Entity\Address prop-erty), 131
Buildingname (Firstred\PostNL\Entity\Response\ResponseAddressproperty), 101
buildSendShipmentRequestREST()(Firstred\PostNL\Service\ShippingServicemethod), 285
buildSendShipmentRequestREST()(Firstred\PostNL\Service\ShippingServiceInterfacemethod), 246
Ccache (Firstred\PostNL\Service\AbstractService prop-
erty), 262cacheItem() (Firstred\PostNL\Service\AbstractService
method), 265cacheItem() (Firstred\PostNL\Service\ServiceInterface
method), 237cancel() (Firstred\PostNL\Util\PendingPromise
method), 338CancellationException (class in
Firstred\PostNL\Exception\Promise), 166Certificate (Firstred\PostNL\Entity\Customs prop-
erty), 156CertificateNr (Firstred\PostNL\Entity\Customs
property), 156Characteristic (Firstred\PostNL\Entity\ProductOption
property), 143CifDownException (class in
Firstred\PostNL\Exception), 170CifException (class in Firstred\PostNL\Exception),
169City (Firstred\PostNL\Entity\Address property), 131City (Firstred\PostNL\Entity\Location property), 140City (Firstred\PostNL\Entity\Request\GetDeliveryDate
property), 70City (Firstred\PostNL\Entity\Request\GetSentDate
property), 51City (Firstred\PostNL\Entity\Response\ResponseAddress
property), 101City (Firstred\PostNL\Entity\Timeframe property), 153clearRequests() (Firstred\PostNL\HttpClient\ClientInterface
method), 179clearRequests() (Firstred\PostNL\HttpClient\CurlClient
method), 186clearRequests() (Firstred\PostNL\HttpClient\GuzzleClient
method), 193clearRequests() (Firstred\PostNL\HttpClient\HTTPlugClient
method), 182clearRequests() (Firstred\PostNL\HttpClient\MockClient
method), 189client (Firstred\PostNL\HttpClient\HTTPlugClient
property), 181ClientInterface (interface in
Firstred\PostNL\HttpClient), 178Code (Firstred\PostNL\Entity\ReasonNoTimeframe
property), 119
Code (Firstred\PostNL\Entity\Response\CompleteStatusResponseEventproperty), 78
Code (Firstred\PostNL\Entity\Warning property), 118CollectionLocation
(Firstred\PostNL\Entity\Customer prop-erty), 134
CollectionTimeStampEnd(Firstred\PostNL\Entity\Shipment property),144
CollectionTimeStampStart(Firstred\PostNL\Entity\Shipment property),145
CompanyName (Firstred\PostNL\Entity\Address prop-erty), 131
CompanyName (Firstred\PostNL\Entity\Response\ResponseAddressproperty), 101
CompleteStatus (class inFirstred\PostNL\Entity\Request), 58
CompleteStatusByPhase (class inFirstred\PostNL\Entity\Request), 65
CompleteStatusByReference (class inFirstred\PostNL\Entity\Request), 57
CompleteStatusByStatus (class inFirstred\PostNL\Entity\Request), 48
completeStatusesREST()(Firstred\PostNL\Service\ShippingStatusServicemethod), 312
completeStatusesREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 252
CompleteStatusResponse (class inFirstred\PostNL\Entity\Response), 90
CompleteStatusResponseEvent (class inFirstred\PostNL\Entity\Response), 78
CompleteStatusResponseEvent(Firstred\PostNL\Entity\Event property),123
CompleteStatusResponseOldStatus (class inFirstred\PostNL\Entity\Response), 111
CompleteStatusResponseShipment (class inFirstred\PostNL\Entity\Response), 81
completeStatusREST()(Firstred\PostNL\Service\ShippingStatusServicemethod), 310
completeStatusREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 250
concurrency (Firstred\PostNL\HttpClient\HTTPlugClientproperty), 181
Confirming (class in Firstred\PostNL\Entity\Request),68
ConfirmingResponseShipment (class inFirstred\PostNL\Entity\Response), 108
ConfirmingService (class inFirstred\PostNL\Service), 329
confirmingService (Firstred\PostNL\PostNL prop-erty), 358
ConfirmingServiceInterface (interface in
Index 405
PostNL PHP bindings Documentation, Release 1.2.0
Firstred\PostNL\Service), 199confirmShipment() (Firstred\PostNL\PostNL
method), 382confirmShipmentREST()
(Firstred\PostNL\Service\ConfirmingServicemethod), 330
confirmShipmentREST()(Firstred\PostNL\Service\ConfirmingServiceInterfacemethod), 199
confirmShipments() (Firstred\PostNL\PostNLmethod), 382
confirmShipmentSOAP()(Firstred\PostNL\Service\ConfirmingServicemethod), 332
confirmShipmentSOAP()(Firstred\PostNL\Service\ConfirmingServiceInterfacemethod), 202
confirmShipmentsREST()(Firstred\PostNL\Service\ConfirmingServicemethod), 331
confirmShipmentsREST()(Firstred\PostNL\Service\ConfirmingServiceInterfacemethod), 201
confirmShipmentsSOAP()(Firstred\PostNL\Service\ConfirmingServicemethod), 333
confirmShipmentsSOAP()(Firstred\PostNL\Service\ConfirmingServiceInterfacemethod), 202
Contact (class in Firstred\PostNL\Entity), 121ContactPerson (Firstred\PostNL\Entity\Customer
property), 134Contacts (Firstred\PostNL\Entity\Shipment property),
145ContactType (Firstred\PostNL\Entity\Contact prop-
erty), 122Content (class in Firstred\PostNL\Entity), 160Content (Firstred\PostNL\Entity\Content property),
161Content (Firstred\PostNL\Entity\Customs property),
156Content (Firstred\PostNL\Entity\Label property), 126Content (Firstred\PostNL\Entity\Shipment property),
145Contenttype (Firstred\PostNL\Entity\Label property),
126Coordinates (class in Firstred\PostNL\Entity), 135Coordinates (Firstred\PostNL\Entity\Location prop-
erty), 141CoordinatesNorthWest (class in
Firstred\PostNL\Entity), 158CoordinatesNorthWest
(Firstred\PostNL\Entity\Area property),121
CoordinatesNorthWest(Firstred\PostNL\Entity\Location property),141
CoordinatesSouthEast (class in
Firstred\PostNL\Entity), 116CoordinatesSouthEast
(Firstred\PostNL\Entity\Area property),121
CoordinatesSouthEast(Firstred\PostNL\Entity\Location property),141
CostCenter (Firstred\PostNL\Entity\Shipment prop-erty), 145
Countrycode (Firstred\PostNL\Entity\Address prop-erty), 132
CountryCode (Firstred\PostNL\Entity\Request\GetDeliveryDateproperty), 70
Countrycode (Firstred\PostNL\Entity\Request\GetLocationsInAreaproperty), 53
Countrycode (Firstred\PostNL\Entity\Request\GetNearestLocationsproperty), 56
CountryCode (Firstred\PostNL\Entity\Request\GetSentDateproperty), 51
Countrycode (Firstred\PostNL\Entity\Response\ResponseAddressproperty), 102
CountryCode (Firstred\PostNL\Entity\Timeframeproperty), 153
CountryOfOrigin (Firstred\PostNL\Entity\Contentproperty), 161
create() (Firstred\PostNL\Entity\AbstractEntitymethod), 124
createRequest() (Firstred\PostNL\Factory\GuzzleRequestFactorymethod), 176
createRequest() (Firstred\PostNL\Factory\RequestFactoryInterfacemethod), 175
createResponse() (Firstred\PostNL\Factory\GuzzleResponseFactorymethod), 176
createResponse() (Firstred\PostNL\Factory\ResponseFactoryInterfacemethod), 174
createStream() (Firstred\PostNL\Factory\GuzzleStreamFactorymethod), 177
createStream() (Firstred\PostNL\Factory\StreamFactoryInterfacemethod), 173
createStreamFromFile()(Firstred\PostNL\Factory\GuzzleStreamFactorymethod), 177
createStreamFromFile()(Firstred\PostNL\Factory\StreamFactoryInterfacemethod), 173
createStreamFromResource()(Firstred\PostNL\Factory\GuzzleStreamFactorymethod), 177
createStreamFromResource()(Firstred\PostNL\Factory\StreamFactoryInterfacemethod), 174
CreationDate (Firstred\PostNL\Entity\Response\UpdatedShipmentsResponseproperty), 96
critical() (Firstred\PostNL\Util\DummyLoggermethod), 352
CurlClient (class in Firstred\PostNL\HttpClient), 183Currency (Firstred\PostNL\Entity\Amount property),
137
406 Index
PostNL PHP bindings Documentation, Release 1.2.0
Currency (Firstred\PostNL\Entity\Customs property),156
Currency (Firstred\PostNL\Entity\Response\ResponseAmountproperty), 99
current() (Firstred\PostNL\Entity\OpeningHoursmethod), 164
CurrentOldStatusCode(Firstred\PostNL\Entity\OldStatus prop-erty), 117
CurrentOldStatusDescription(Firstred\PostNL\Entity\OldStatus prop-erty), 117
CurrentOldStatusTimeStamp(Firstred\PostNL\Entity\OldStatus prop-erty), 118
CurrentPhaseCode (Firstred\PostNL\Entity\OldStatusproperty), 117
CurrentPhaseDescription(Firstred\PostNL\Entity\OldStatus prop-erty), 117
currentService (Firstred\PostNL\Entity\AbstractEntityproperty), 124
CurrentStatus (class inFirstred\PostNL\Entity\Request), 64
CurrentStatusByPhase (class inFirstred\PostNL\Entity\Request), 54
CurrentStatusByReference (class inFirstred\PostNL\Entity\Request), 61
CurrentStatusByStatus (class inFirstred\PostNL\Entity\Request), 55
currentStatusesREST()(Firstred\PostNL\Service\ShippingStatusServicemethod), 310
currentStatusesREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 249
CurrentStatusResponse (class inFirstred\PostNL\Entity\Response), 89
CurrentStatusResponseShipment (class inFirstred\PostNL\Entity\Response), 104
currentStatusREST()(Firstred\PostNL\Service\ShippingStatusServicemethod), 308
currentStatusREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 247
Customer (class in Firstred\PostNL\Entity), 133Customer (Firstred\PostNL\Entity\Request\CompleteStatus
property), 59Customer (Firstred\PostNL\Entity\Request\CompleteStatusByPhase
property), 65Customer (Firstred\PostNL\Entity\Request\CompleteStatusByReference
property), 57Customer (Firstred\PostNL\Entity\Request\CompleteStatusByStatus
property), 48Customer (Firstred\PostNL\Entity\Request\Confirming
property), 69Customer (Firstred\PostNL\Entity\Request\CurrentStatus
property), 64Customer (Firstred\PostNL\Entity\Request\CurrentStatusByPhase
property), 54Customer (Firstred\PostNL\Entity\Request\CurrentStatusByReference
property), 62Customer (Firstred\PostNL\Entity\Request\CurrentStatusByStatus
property), 55Customer (Firstred\PostNL\Entity\Request\GenerateBarcode
property), 63Customer (Firstred\PostNL\Entity\Request\GenerateLabel
property), 66Customer (Firstred\PostNL\Entity\Request\GetSignature
property), 49Customer (Firstred\PostNL\Entity\Request\SendShipment
property), 68Customer (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
property), 82Customer (Firstred\PostNL\Entity\Shipment property),
145customer (Firstred\PostNL\PostNL property), 357CustomerCode (Firstred\PostNL\Entity\Customer
property), 134CustomerCode (Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse
property), 96CustomerNumber (Firstred\PostNL\Entity\Customer
property), 134CustomerNumber (Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse
property), 96CustomerOrderNumber
(Firstred\PostNL\Entity\Shipment property),145
Customs (class in Firstred\PostNL\Entity), 155Customs (Firstred\PostNL\Entity\Shipment property),
145CutOffTime (class in Firstred\PostNL\Entity), 159CutOffTimes (Firstred\PostNL\Entity\Request\GetDeliveryDate
property), 70
DDate (Firstred\PostNL\Entity\ReasonNoTimeframe
property), 119Date (Firstred\PostNL\Entity\Timeframe property), 153Date (Firstred\PostNL\Entity\TimeframeTimeFrame
property), 157DateFrom (Firstred\PostNL\Entity\Shipment property),
145DateTo (Firstred\PostNL\Entity\Shipment property),
145Day (Firstred\PostNL\Entity\CutOffTime property), 160debug() (Firstred\PostNL\Util\DummyLogger
method), 353defaultDateFormat()
(Firstred\PostNL\Service\AbstractServicemethod), 265
defaultOptions (Firstred\PostNL\HttpClient\CurlClientproperty), 184
defaultOptions (Firstred\PostNL\HttpClient\GuzzleClientproperty), 191
Index 407
PostNL PHP bindings Documentation, Release 1.2.0
defaultOptions (Firstred\PostNL\HttpClient\MockClientproperty), 187
defaultProperties (Firstred\PostNL\Entity\AbstractEntityproperty), 124
defaultProperties (Firstred\PostNL\Entity\Addressproperty), 131
defaultProperties (Firstred\PostNL\Entity\Amountproperty), 137
defaultProperties (Firstred\PostNL\Entity\Areaproperty), 121
defaultProperties (Firstred\PostNL\Entity\Barcodeproperty), 139
defaultProperties (Firstred\PostNL\Entity\Contactproperty), 122
defaultProperties (Firstred\PostNL\Entity\Contentproperty), 161
defaultProperties (Firstred\PostNL\Entity\Coordinatesproperty), 135
defaultProperties (Firstred\PostNL\Entity\CoordinatesNorthWestproperty), 159
defaultProperties (Firstred\PostNL\Entity\CoordinatesSouthEastproperty), 117
defaultProperties (Firstred\PostNL\Entity\Customerproperty), 134
defaultProperties (Firstred\PostNL\Entity\Customsproperty), 156
defaultProperties (Firstred\PostNL\Entity\CutOffTimeproperty), 160
defaultProperties (Firstred\PostNL\Entity\Dimensionproperty), 138
defaultProperties (Firstred\PostNL\Entity\Eventproperty), 123
defaultProperties (Firstred\PostNL\Entity\Expectationproperty), 127
defaultProperties (Firstred\PostNL\Entity\Groupproperty), 130
defaultProperties (Firstred\PostNL\Entity\Labelproperty), 126
defaultProperties (Firstred\PostNL\Entity\Locationproperty), 140
defaultProperties (Firstred\PostNL\Entity\Message\LabellingMessageproperty), 45
defaultProperties (Firstred\PostNL\Entity\Message\Messageproperty), 46
defaultProperties (Firstred\PostNL\Entity\OldStatusproperty), 117
defaultProperties (Firstred\PostNL\Entity\OpeningHoursproperty), 162
defaultProperties (Firstred\PostNL\Entity\ProductOptionproperty), 143
defaultProperties (Firstred\PostNL\Entity\ReasonNoTimeframeproperty), 119
defaultProperties (Firstred\PostNL\Entity\Request\CompleteStatusproperty), 59
defaultProperties (Firstred\PostNL\Entity\Request\CompleteStatusByPhaseproperty), 65
defaultProperties (Firstred\PostNL\Entity\Request\CompleteStatusByReferenceproperty), 57
defaultProperties (Firstred\PostNL\Entity\Request\CompleteStatusByStatusproperty), 48
defaultProperties (Firstred\PostNL\Entity\Request\Confirmingproperty), 69
defaultProperties (Firstred\PostNL\Entity\Request\CurrentStatusproperty), 64
defaultProperties (Firstred\PostNL\Entity\Request\CurrentStatusByPhaseproperty), 54
defaultProperties (Firstred\PostNL\Entity\Request\CurrentStatusByReferenceproperty), 62
defaultProperties (Firstred\PostNL\Entity\Request\CurrentStatusByStatusproperty), 55
defaultProperties (Firstred\PostNL\Entity\Request\GenerateBarcodeproperty), 63
defaultProperties (Firstred\PostNL\Entity\Request\GenerateLabelproperty), 66
defaultProperties (Firstred\PostNL\Entity\Request\GetDeliveryDateproperty), 70
defaultProperties (Firstred\PostNL\Entity\Request\GetLocationproperty), 47
defaultProperties (Firstred\PostNL\Entity\Request\GetLocationsInAreaproperty), 53
defaultProperties (Firstred\PostNL\Entity\Request\GetNearestLocationsproperty), 56
defaultProperties (Firstred\PostNL\Entity\Request\GetSentDateproperty), 51
defaultProperties (Firstred\PostNL\Entity\Request\GetSentDateRequestproperty), 73
defaultProperties (Firstred\PostNL\Entity\Request\GetSignatureproperty), 49
defaultProperties (Firstred\PostNL\Entity\Request\GetTimeframesproperty), 60
defaultProperties (Firstred\PostNL\Entity\Request\SendShipmentproperty), 68
defaultProperties (Firstred\PostNL\Entity\Response\CompleteStatusResponseproperty), 90
defaultProperties (Firstred\PostNL\Entity\Response\CompleteStatusResponseEventproperty), 78
defaultProperties (Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatusproperty), 111
defaultProperties (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipmentproperty), 81
defaultProperties (Firstred\PostNL\Entity\Response\ConfirmingResponseShipmentproperty), 108
defaultProperties (Firstred\PostNL\Entity\Response\CurrentStatusResponseproperty), 89
defaultProperties (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipmentproperty), 104
defaultProperties (Firstred\PostNL\Entity\Response\GenerateBarcodeResponseproperty), 87
defaultProperties (Firstred\PostNL\Entity\Response\GenerateLabelResponseproperty), 100
defaultProperties (Firstred\PostNL\Entity\Response\GetDeliveryDateResponseproperty), 109
defaultProperties (Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseproperty), 88
defaultProperties (Firstred\PostNL\Entity\Response\GetLocationsResultproperty), 74
408 Index
PostNL PHP bindings Documentation, Release 1.2.0
defaultProperties (Firstred\PostNL\Entity\Response\GetNearestLocationsResponseproperty), 76
defaultProperties (Firstred\PostNL\Entity\Response\GetSentDateResponseproperty), 94
defaultProperties (Firstred\PostNL\Entity\Response\GetSignatureResponseSignatureproperty), 97
defaultProperties (Firstred\PostNL\Entity\Response\MergedLabelproperty), 93
defaultProperties (Firstred\PostNL\Entity\Response\ResponseAddressproperty), 101
defaultProperties (Firstred\PostNL\Entity\Response\ResponseAmountproperty), 99
defaultProperties (Firstred\PostNL\Entity\Response\ResponseGroupproperty), 86
defaultProperties (Firstred\PostNL\Entity\Response\ResponseLocationproperty), 91
defaultProperties (Firstred\PostNL\Entity\Response\ResponseShipmentproperty), 77
defaultProperties (Firstred\PostNL\Entity\Response\ResponseTimeframesproperty), 80
defaultProperties (Firstred\PostNL\Entity\Response\SendShipmentResponseproperty), 110
defaultProperties (Firstred\PostNL\Entity\Response\SignatureResponseproperty), 75
defaultProperties (Firstred\PostNL\Entity\Response\UpdatedShipmentsResponseproperty), 96
defaultProperties (Firstred\PostNL\Entity\Shipmentproperty), 144
defaultProperties (Firstred\PostNL\Entity\Signatureproperty), 136
defaultProperties (Firstred\PostNL\Entity\SOAP\Bodyproperty), 113
defaultProperties (Firstred\PostNL\Entity\SOAP\Envelopeproperty), 116
defaultProperties (Firstred\PostNL\Entity\SOAP\Securityproperty), 115
defaultProperties (Firstred\PostNL\Entity\SOAP\UsernameTokenproperty), 114
defaultProperties (Firstred\PostNL\Entity\Statusproperty), 150
defaultProperties (Firstred\PostNL\Entity\Timeframeproperty), 153
defaultProperties (Firstred\PostNL\Entity\Timeframesproperty), 129
defaultProperties (Firstred\PostNL\Entity\TimeframeTimeFrameproperty), 157
defaultProperties (Firstred\PostNL\Entity\Warningproperty), 118
DeliveryAddress (Firstred\PostNL\Entity\Shipmentproperty), 145
DeliveryDate (Firstred\PostNL\Entity\Location prop-erty), 140
DeliveryDate (Firstred\PostNL\Entity\Request\GetSentDateproperty), 51
DeliveryDate (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipmentproperty), 82
DeliveryDate (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipmentproperty), 104
DeliveryDate (Firstred\PostNL\Entity\Response\GetDeliveryDateResponseproperty), 109
DeliveryDate (Firstred\PostNL\Entity\Shipmentproperty), 145
DeliveryDateService (class inFirstred\PostNL\Service), 292
deliveryDateService (Firstred\PostNL\PostNLproperty), 358
DeliveryDateServiceInterface (interface inFirstred\PostNL\Service), 212
DeliveryOptions (Firstred\PostNL\Entity\Locationproperty), 140
DeliveryOptions (Firstred\PostNL\Entity\Response\ResponseLocationproperty), 91
DeliveryTimeStampEnd(Firstred\PostNL\Entity\Shipment property),145
DeliveryTimeStampStart(Firstred\PostNL\Entity\Shipment property),145
Department (Firstred\PostNL\Entity\Address prop-erty), 132
Department (Firstred\PostNL\Entity\Response\ResponseAddressproperty), 102
Description (Firstred\PostNL\Entity\Content prop-erty), 161
Description (Firstred\PostNL\Entity\ReasonNoTimeframeproperty), 119
Description (Firstred\PostNL\Entity\Response\CompleteStatusResponseEventproperty), 79
Description (Firstred\PostNL\Entity\Warning prop-erty), 118
DestinationLocationCode(Firstred\PostNL\Entity\Response\CompleteStatusResponseEventproperty), 79
Dimension (class in Firstred\PostNL\Entity), 138Dimension (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
property), 82Dimension (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment
property), 104Dimension (Firstred\PostNL\Entity\Shipment prop-
erty), 145disableShutdown() (Firstred\PostNL\Util\TaskQueue
method), 345Distance (Firstred\PostNL\Entity\Response\ResponseLocation
property), 91Doorcode (Firstred\PostNL\Entity\Address property),
132Doorcode (Firstred\PostNL\Entity\Response\ResponseAddress
property), 102doRequest() (Firstred\PostNL\HttpClient\ClientInterface
method), 179doRequest() (Firstred\PostNL\HttpClient\CurlClient
method), 186doRequest() (Firstred\PostNL\HttpClient\GuzzleClient
method), 193doRequest() (Firstred\PostNL\HttpClient\HTTPlugClient
method), 182
Index 409
PostNL PHP bindings Documentation, Release 1.2.0
doRequest() (Firstred\PostNL\HttpClient\MockClientmethod), 189
doRequests() (Firstred\PostNL\HttpClient\ClientInterfacemethod), 179
doRequests() (Firstred\PostNL\HttpClient\CurlClientmethod), 186
doRequests() (Firstred\PostNL\HttpClient\GuzzleClientmethod), 193
doRequests() (Firstred\PostNL\HttpClient\HTTPlugClientmethod), 181
doRequests() (Firstred\PostNL\HttpClient\MockClientmethod), 190
DownPartnerBarcode(Firstred\PostNL\Entity\Response\ResponseShipmentproperty), 77
DownPartnerBarcode(Firstred\PostNL\Entity\Shipment property),145
DownPartnerID (Firstred\PostNL\Entity\Locationproperty), 141
DownPartnerID (Firstred\PostNL\Entity\Response\ResponseLocationproperty), 92
DownPartnerID (Firstred\PostNL\Entity\Response\ResponseShipmentproperty), 77
DownPartnerID (Firstred\PostNL\Entity\Shipmentproperty), 145
DownPartnerLocation(Firstred\PostNL\Entity\Location property),141
DownPartnerLocation(Firstred\PostNL\Entity\Response\ResponseLocationproperty), 92
DownPartnerLocation(Firstred\PostNL\Entity\Response\ResponseShipmentproperty), 77
DownPartnerLocation(Firstred\PostNL\Entity\Shipment property),145
DummyLogger (class in Firstred\PostNL\Util), 352
Eeach() (Firstred\PostNL\Util\PromiseTool method),
343eachLimit() (Firstred\PostNL\Util\PromiseTool
method), 343eachLimitAll() (Firstred\PostNL\Util\PromiseTool
method), 343EachPromise (class in Firstred\PostNL\Util), 346Email (Firstred\PostNL\Entity\Contact property), 122Email (Firstred\PostNL\Entity\Customer property),
134emergency() (Firstred\PostNL\Util\DummyLogger
method), 352EndDate (Firstred\PostNL\Entity\Timeframe property),
153Envelope (class in Firstred\PostNL\Entity\SOAP), 115error() (Firstred\PostNL\Util\DummyLogger
method), 352
ETAFrom (Firstred\PostNL\Entity\Expectation prop-erty), 127
ETATo (Firstred\PostNL\Entity\Expectation property),127
Event (class in Firstred\PostNL\Entity), 123Events (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
property), 82Events (Firstred\PostNL\Entity\Shipment property),
146exceptionFor() (Firstred\PostNL\Util\PromiseTool
method), 340Expectation (class in Firstred\PostNL\Entity), 127Expectation (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
property), 82Expectation (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment
property), 104
FfindBarcodeSerie() (Firstred\PostNL\PostNL
method), 396FirstName (Firstred\PostNL\Entity\Address property),
132FirstName (Firstred\PostNL\Entity\Response\ResponseAddress
property), 102Firstred\PostNL (namespace), 355Firstred\PostNL\Entity (namespace), 116–119,
121, 123, 124, 126–129, 131, 133, 135, 136,138–140, 143, 144, 149, 152, 155, 157–160,162
Firstred\PostNL\Entity\Message (namespace),45, 46
Firstred\PostNL\Entity\Request (namespace),47–50, 53–59, 61, 63–68, 70, 72
Firstred\PostNL\Entity\Response (namespace),73–75, 77, 78, 80, 81, 86–91, 93–95, 97, 98,100, 101, 104, 108, 110, 111
Firstred\PostNL\Entity\SOAP (namespace), 113–115
Firstred\PostNL\Exception (namespace), 166,168–172
Firstred\PostNL\Exception\Promise (names-pace), 165, 166
Firstred\PostNL\Factory (namespace), 173–176Firstred\PostNL\HttpClient (namespace), 178,
180, 183, 187, 190Firstred\PostNL\Service (namespace), 194, 199,
205, 212, 221, 237, 238, 244, 247, 261, 266,282, 286, 292, 301, 307, 321, 329
Firstred\PostNL\Util (namespace), 336–339, 344,346, 347, 352–354
FlexibleEntityTrait (trait in Firstred\PostNL\Util),354
Floor (Firstred\PostNL\Entity\Address property), 132Floor (Firstred\PostNL\Entity\Response\ResponseAddress
property), 102Friday (Firstred\PostNL\Entity\OpeningHours prop-
erty), 162
410 Index
PostNL PHP bindings Documentation, Release 1.2.0
From (Firstred\PostNL\Entity\ReasonNoTimeframeproperty), 119
From (Firstred\PostNL\Entity\TimeframeTimeFrameproperty), 157
Ggenerate() (Firstred\PostNL\Util\UUID method),
338GenerateBarcode (class in
Firstred\PostNL\Entity\Request), 63generateBarcode() (Firstred\PostNL\PostNL
method), 365generateBarcodeByCountryCode()
(Firstred\PostNL\PostNL method), 366GenerateBarcodeResponse (class in
Firstred\PostNL\Entity\Response), 87GenerateBarcodeResponse
(Firstred\PostNL\Entity\SOAP\Body prop-erty), 113
generateBarcodeREST()(Firstred\PostNL\Service\BarcodeServicemethod), 287
generateBarcodeREST()(Firstred\PostNL\Service\BarcodeServiceInterfacemethod), 239
generateBarcodesByCountryCodes()(Firstred\PostNL\PostNL method), 367
generateBarcodeSOAP()(Firstred\PostNL\Service\BarcodeServicemethod), 288
generateBarcodeSOAP()(Firstred\PostNL\Service\BarcodeServiceInterfacemethod), 241
generateBarcodesREST()(Firstred\PostNL\Service\BarcodeServicemethod), 288
generateBarcodesREST()(Firstred\PostNL\Service\BarcodeServiceInterfacemethod), 240
generateBarcodesSOAP()(Firstred\PostNL\Service\BarcodeServicemethod), 289
generateBarcodesSOAP()(Firstred\PostNL\Service\BarcodeServiceInterfacemethod), 241
GenerateLabel (class inFirstred\PostNL\Entity\Request), 66
generateLabel() (Firstred\PostNL\PostNL method),376
GenerateLabelResponse (class inFirstred\PostNL\Entity\Response), 100
generateLabelREST()(Firstred\PostNL\Service\LabellingServicemethod), 322
generateLabelREST()(Firstred\PostNL\Service\LabellingServiceInterfacemethod), 206
generateLabels() (Firstred\PostNL\PostNLmethod), 378
generateLabelSOAP()(Firstred\PostNL\Service\LabellingServicemethod), 325
generateLabelSOAP()(Firstred\PostNL\Service\LabellingServiceInterfacemethod), 208
generateLabelsREST()(Firstred\PostNL\Service\LabellingServicemethod), 324
generateLabelsREST()(Firstred\PostNL\Service\LabellingServiceInterfacemethod), 207
generateLabelsSOAP()(Firstred\PostNL\Service\LabellingServicemethod), 326
generateLabelsSOAP()(Firstred\PostNL\Service\LabellingServiceInterfacemethod), 209
getBarcodeService() (Firstred\PostNL\PostNLmethod), 362
getBody() (Firstred\PostNL\Exception\ApiConnectionExceptionmethod), 167
getCache() (Firstred\PostNL\Service\AbstractServicemethod), 265
getCache() (Firstred\PostNL\Service\ServiceInterfacemethod), 238
getClient() (Firstred\PostNL\HttpClient\HTTPlugClientmethod), 182
getCompleteStatus() (Firstred\PostNL\PostNLmethod), 391
getCompleteStatusPhaseCode()(Firstred\PostNL\Entity\Status method),151
getCompleteStatusPhaseDescription()(Firstred\PostNL\Entity\Status method),151
getCompleteStatusStatusCode()(Firstred\PostNL\Entity\Status method),151
getCompleteStatusStatusDescription()(Firstred\PostNL\Entity\Status method),152
getCompleteStatusTimeStamp()(Firstred\PostNL\Entity\Status method),152
getConcurrency() (Firstred\PostNL\HttpClient\GuzzleClientmethod), 192
getConcurrency() (Firstred\PostNL\HttpClient\HTTPlugClientmethod), 182
getConfirmingService() (Firstred\PostNL\PostNLmethod), 363
getConnectTimeout()(Firstred\PostNL\HttpClient\CurlClientmethod), 185
getCurrentStatus() (Firstred\PostNL\PostNLmethod), 383
Index 411
PostNL PHP bindings Documentation, Release 1.2.0
getCurrentStatusPhaseCode()(Firstred\PostNL\Entity\Status method),151
getCurrentStatusPhaseDescription()(Firstred\PostNL\Entity\Status method),151
getCurrentStatusStatusCode()(Firstred\PostNL\Entity\Status method),151
getCurrentStatusStatusDescription()(Firstred\PostNL\Entity\Status method),151
getCurrentStatusTimeStamp()(Firstred\PostNL\Entity\Status method),151
getCustomer() (Firstred\PostNL\PostNL method),359
GetDeliveryDate (class inFirstred\PostNL\Entity\Request), 70
GetDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDateproperty), 71
getDeliveryDate() (Firstred\PostNL\PostNLmethod), 394
getDeliveryDate() (Firstred\PostNL\Util\Utilmethod), 348
GetDeliveryDateResponse (class inFirstred\PostNL\Entity\Response), 108
getDeliveryDateREST()(Firstred\PostNL\Service\DeliveryDateServicemethod), 293
getDeliveryDateREST()(Firstred\PostNL\Service\DeliveryDateServiceInterfacemethod), 212
getDeliveryDateService()(Firstred\PostNL\PostNL method), 363
getDeliveryDateSOAP()(Firstred\PostNL\Service\DeliveryDateServicemethod), 294
getDeliveryDateSOAP()(Firstred\PostNL\Service\DeliveryDateServiceInterfacemethod), 214
getFullyQualifiedEntityClassName()(Firstred\PostNL\Entity\AbstractEntitymethod), 126
getHandler() (Firstred\PostNL\HttpClient\MockClientmethod), 189
getHeaders() (Firstred\PostNL\Exception\ApiConnectionExceptionmethod), 167
getHolidaysForYear() (Firstred\PostNL\Util\Utilmethod), 349
getHttpClient() (Firstred\PostNL\PostNL method),360
getInstance() (Firstred\PostNL\HttpClient\ClientInterfacemethod), 178
getInstance() (Firstred\PostNL\HttpClient\CurlClientmethod), 184
getInstance() (Firstred\PostNL\HttpClient\GuzzleClientmethod), 191
getInstance() (Firstred\PostNL\HttpClient\HTTPlugClientmethod), 182
getInstance() (Firstred\PostNL\HttpClient\MockClientmethod), 188
getJsonBody() (Firstred\PostNL\Exception\ApiConnectionExceptionmethod), 167
getLabellingService() (Firstred\PostNL\PostNLmethod), 362
GetLocation (class inFirstred\PostNL\Entity\Request), 47
getLocation() (Firstred\PostNL\PostNL method),396
getLocationREST() (Firstred\PostNL\Service\LocationServicemethod), 274
getLocationREST() (Firstred\PostNL\Service\LocationServiceInterfacemethod), 228
getLocationService() (Firstred\PostNL\PostNLmethod), 364
GetLocationsInArea (class inFirstred\PostNL\Entity\Request), 53
getLocationsInArea() (Firstred\PostNL\PostNLmethod), 395
GetLocationsInAreaResponse (class inFirstred\PostNL\Entity\Response), 88
getLocationsInAreaREST()(Firstred\PostNL\Service\LocationServicemethod), 270
getLocationsInAreaREST()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 225
getLocationsInAreaSOAP()(Firstred\PostNL\Service\LocationServicemethod), 272
getLocationsInAreaSOAP()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 227
getLocationSOAP() (Firstred\PostNL\Service\LocationServicemethod), 275
getLocationSOAP() (Firstred\PostNL\Service\LocationServiceInterfacemethod), 230
GetLocationsResult (class inFirstred\PostNL\Entity\Response), 73
GetLocationsResult(Firstred\PostNL\Entity\Response\GetLocationsInAreaResponseproperty), 88
GetLocationsResult(Firstred\PostNL\Entity\Response\GetNearestLocationsResponseproperty), 76
getLogger() (Firstred\PostNL\HttpClient\ClientInterfacemethod), 178
getLogger() (Firstred\PostNL\HttpClient\CurlClientmethod), 185
getLogger() (Firstred\PostNL\HttpClient\GuzzleClientmethod), 193
getLogger() (Firstred\PostNL\HttpClient\HTTPlugClientmethod), 182
getLogger() (Firstred\PostNL\HttpClient\MockClientmethod), 189
412 Index
PostNL PHP bindings Documentation, Release 1.2.0
getLogger() (Firstred\PostNL\PostNL method), 361getMaxRetries() (Firstred\PostNL\HttpClient\GuzzleClient
method), 192getMaxRetries() (Firstred\PostNL\HttpClient\MockClient
method), 189getMessagesDescriptionsAndCodes()
(Firstred\PostNL\Exception\CifExceptionmethod), 170
getMode() (Firstred\PostNL\PostNL method), 360GetNearestLocations (class in
Firstred\PostNL\Entity\Request), 56getNearestLocations() (Firstred\PostNL\PostNL
method), 395GetNearestLocationsResponse (class in
Firstred\PostNL\Entity\Response), 75getNearestLocationsREST()
(Firstred\PostNL\Service\LocationServicemethod), 267
getNearestLocationsREST()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 222
getNearestLocationsSOAP()(Firstred\PostNL\Service\LocationServicemethod), 269
getNearestLocationsSOAP()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 223
getOption() (Firstred\PostNL\HttpClient\GuzzleClientmethod), 191
getOption() (Firstred\PostNL\HttpClient\MockClientmethod), 188
getPdfSizeAndOrientation()(Firstred\PostNL\Util\Util method), 348
getReason() (Firstred\PostNL\Exception\Promise\RejectionExceptionmethod), 165
getRequestFactory() (Firstred\PostNL\PostNLmethod), 361
getResponse() (Firstred\PostNL\Exception\HttpClientExceptionmethod), 171
getResponse() (Firstred\PostNL\Exception\ResponseExceptionmethod), 169
getResponseFactory() (Firstred\PostNL\PostNLmethod), 361
getResponseText() (Firstred\PostNL\Service\AbstractServicemethod), 264
getRestApiKey() (Firstred\PostNL\PostNL method),359
getSandbox() (Firstred\PostNL\PostNL method), 359GetSentDate (class in
Firstred\PostNL\Entity\Request), 50GetSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest
property), 73getSentDate() (Firstred\PostNL\PostNL method),
394GetSentDateRequest (class in
Firstred\PostNL\Entity\Request), 72GetSentDateResponse (class in
Firstred\PostNL\Entity\Response), 94
getSentDateREST() (Firstred\PostNL\Service\DeliveryDateServicemethod), 295
getSentDateREST() (Firstred\PostNL\Service\DeliveryDateServiceInterfacemethod), 215
getSentDateSOAP() (Firstred\PostNL\Service\DeliveryDateServicemethod), 297
getSentDateSOAP() (Firstred\PostNL\Service\DeliveryDateServiceInterfacemethod), 217
getShippingDate() (Firstred\PostNL\Util\Utilmethod), 348
getShippingDaysRemaining()(Firstred\PostNL\Util\Util method), 349
getShippingService() (Firstred\PostNL\PostNLmethod), 364
getShippingStatusByBarcode()(Firstred\PostNL\PostNL method), 385
getShippingStatusByReference()(Firstred\PostNL\PostNL method), 388
getShippingStatusesByBarcodes()(Firstred\PostNL\PostNL method), 387
getShippingStatusesByReference()(Firstred\PostNL\PostNL method), 390
getShippingStatusService()(Firstred\PostNL\PostNL method), 363
GetSignature (class inFirstred\PostNL\Entity\Request), 49
getSignature() (Firstred\PostNL\PostNL method),393
getSignatureByBarcode()(Firstred\PostNL\PostNL method), 393
GetSignatureResponseSignature (class inFirstred\PostNL\Entity\Response), 97
GetSignatureResponseSignature(Firstred\PostNL\Entity\Signature prop-erty), 136
getSignatureREST()(Firstred\PostNL\Service\ShippingStatusServicemethod), 313
getSignatureREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 253
getSignaturesByBarcodes()(Firstred\PostNL\PostNL method), 393
getSignaturesREST()(Firstred\PostNL\Service\ShippingStatusServicemethod), 315
getSignaturesREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 255
getState() (Firstred\PostNL\Util\PendingPromisemethod), 338
getStreamFactory() (Firstred\PostNL\PostNLmethod), 362
getTimeframe() (Firstred\PostNL\Entity\Request\GetTimeframesmethod), 61
GetTimeframes (class inFirstred\PostNL\Entity\Request), 59
getTimeframes() (Firstred\PostNL\Entity\Request\GetTimeframes
Index 413
PostNL PHP bindings Documentation, Release 1.2.0
method), 61getTimeframes() (Firstred\PostNL\PostNL method),
394getTimeframesAndNearestLocations()
(Firstred\PostNL\PostNL method), 395getTimeframeService() (Firstred\PostNL\PostNL
method), 364getTimeframesREST()
(Firstred\PostNL\Service\TimeframeServicemethod), 302
getTimeframesREST()(Firstred\PostNL\Service\TimeframeServiceInterfacemethod), 194
getTimeframesSOAP()(Firstred\PostNL\Service\TimeframeServicemethod), 304
getTimeframesSOAP()(Firstred\PostNL\Service\TimeframeServiceInterfacemethod), 196
getTimeout() (Firstred\PostNL\HttpClient\CurlClientmethod), 185
getToken() (Firstred\PostNL\PostNL method), 359getTtl() (Firstred\PostNL\Service\AbstractService
method), 265getTtl() (Firstred\PostNL\Service\ServiceInterface
method), 238getUpdatedShipments() (Firstred\PostNL\PostNL
method), 393getUpdatedShipmentsREST()
(Firstred\PostNL\Service\ShippingStatusServicemethod), 318
getUpdatedShipmentsREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 258
getVerify() (Firstred\PostNL\HttpClient\ClientInterfacemethod), 179
getVerify() (Firstred\PostNL\HttpClient\CurlClientmethod), 185
getVerify() (Firstred\PostNL\HttpClient\GuzzleClientmethod), 192
getVerify() (Firstred\PostNL\HttpClient\HTTPlugClientmethod), 183
getVerify() (Firstred\PostNL\HttpClient\MockClientmethod), 188
GlobalPackBarcodeType(Firstred\PostNL\Entity\Customer prop-erty), 134
GlobalPackCustomerCode(Firstred\PostNL\Entity\Customer prop-erty), 134
Group (class in Firstred\PostNL\Entity), 129GroupCount (Firstred\PostNL\Entity\Group property),
130GroupCount (Firstred\PostNL\Entity\Response\ResponseGroup
property), 86Groups (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
property), 82Groups (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment
property), 104Groups (Firstred\PostNL\Entity\Shipment property),
146GroupSequence (Firstred\PostNL\Entity\Group prop-
erty), 130GroupSequence (Firstred\PostNL\Entity\Response\ResponseGroup
property), 86GroupType (Firstred\PostNL\Entity\Group property),
130GroupType (Firstred\PostNL\Entity\Response\ResponseGroup
property), 86GuzzleClient (class in Firstred\PostNL\HttpClient),
190GuzzleRequestFactory (class in
Firstred\PostNL\Factory), 176GuzzleResponseFactory (class in
Firstred\PostNL\Factory), 175GuzzleStreamFactory (class in
Firstred\PostNL\Factory), 176
HHandleAsNonDeliverable
(Firstred\PostNL\Entity\Customs property),156
Header (class in Firstred\PostNL\Entity\SOAP), 113Header (Firstred\PostNL\Entity\SOAP\Envelope prop-
erty), 116headers (Firstred\PostNL\Exception\ApiConnectionException
property), 167Height (Firstred\PostNL\Entity\Dimension property),
138HouseNr (Firstred\PostNL\Entity\Address property),
132HouseNr (Firstred\PostNL\Entity\Location property),
141HouseNr (Firstred\PostNL\Entity\Request\GetDeliveryDate
property), 70HouseNr (Firstred\PostNL\Entity\Request\GetSentDate
property), 51HouseNr (Firstred\PostNL\Entity\Response\ResponseAddress
property), 102HouseNr (Firstred\PostNL\Entity\Timeframe property),
153HouseNrExt (Firstred\PostNL\Entity\Address prop-
erty), 132HouseNrExt (Firstred\PostNL\Entity\Location prop-
erty), 141HouseNrExt (Firstred\PostNL\Entity\Request\GetDeliveryDate
property), 70HouseNrExt (Firstred\PostNL\Entity\Request\GetSentDate
property), 51HouseNrExt (Firstred\PostNL\Entity\Response\ResponseAddress
property), 102HouseNrExt (Firstred\PostNL\Entity\Timeframe prop-
erty), 153HSTariffNr (Firstred\PostNL\Entity\Content prop-
erty), 161httpClient (Firstred\PostNL\PostNL property), 358
414 Index
PostNL PHP bindings Documentation, Release 1.2.0
HttpClientException (class inFirstred\PostNL\Exception), 171
HTTPlugClient (class in Firstred\PostNL\HttpClient),180
IIBAN (Firstred\PostNL\Entity\Amount property), 137IBAN (Firstred\PostNL\Entity\Response\ResponseAmount
property), 99id (Firstred\PostNL\Entity\AbstractEntity property),
124IDExpiration (Firstred\PostNL\Entity\Shipment
property), 146IDNumber (Firstred\PostNL\Entity\Shipment property),
146IDType (Firstred\PostNL\Entity\Shipment property),
146info() (Firstred\PostNL\Util\DummyLogger method),
353inspect() (Firstred\PostNL\Util\PromiseTool
method), 341inspectAll() (Firstred\PostNL\Util\PromiseTool
method), 341instance (Firstred\PostNL\HttpClient\GuzzleClient
property), 191instance (Firstred\PostNL\HttpClient\MockClient
property), 187Interval (Firstred\PostNL\Entity\Timeframe prop-
erty), 153InvalidArgumentException (class in
Firstred\PostNL\Exception), 171InvalidBarcodeException (class in
Firstred\PostNL\Exception), 169InvalidConfigurationException (class in
Firstred\PostNL\Exception), 172InvalidMethodException (class in
Firstred\PostNL\Exception), 168Invoice (Firstred\PostNL\Entity\Customs property),
156InvoiceNr (Firstred\PostNL\Entity\Customs prop-
erty), 156isEmpty() (Firstred\PostNL\Util\TaskQueue method),
345isFulfilled() (Firstred\PostNL\Util\PromiseTool
method), 344isRejected() (Firstred\PostNL\Util\PromiseTool
method), 344isSettled() (Firstred\PostNL\Util\PromiseTool
method), 344iterFor() (Firstred\PostNL\Util\PromiseTool
method), 340
JjsonBody (Firstred\PostNL\Exception\ApiConnectionException
property), 167jsonDeserialize() (Firstred\PostNL\Entity\AbstractEntity
method), 125
jsonDeserialize() (Firstred\PostNL\Entity\OpeningHoursmethod), 163
jsonDeserialize() (Firstred\PostNL\Entity\ReasonNoTimeframemethod), 120
jsonDeserialize() (Firstred\PostNL\Entity\Response\CompleteStatusResponsemethod), 90
jsonDeserialize() (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipmentmethod), 85
jsonDeserialize() (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipmentmethod), 107
jsonDeserialize() (Firstred\PostNL\Entity\Response\GetDeliveryDateResponsemethod), 110
jsonDeserialize() (Firstred\PostNL\Entity\Response\GetNearestLocationsResponsemethod), 76
jsonDeserialize() (Firstred\PostNL\Entity\Response\ResponseLocationmethod), 93
jsonDeserialize() (Firstred\PostNL\Entity\TimeframeTimeFramemethod), 158
jsonSerialize() (Firstred\PostNL\Entity\AbstractEntitymethod), 125
jsonSerialize() (Firstred\PostNL\Entity\Request\Confirmingmethod), 69
jsonSerialize() (Firstred\PostNL\Entity\Request\GenerateLabelmethod), 67
jsonSerialize() (Firstred\PostNL\Entity\Request\SendShipmentmethod), 68
jsonSerialize() (Firstred\PostNL\Entity\Response\GetLocationsInAreaResponsemethod), 88
jsonSerialize() (Firstred\PostNL\Entity\Response\GetNearestLocationsResponsemethod), 76
jsonSerialize() (Firstred\PostNL\Entity\Response\ResponseTimeframesmethod), 81
jsonSerialize() (Firstred\PostNL\Entity\Timeframemethod), 155
jsonSerialize() (Firstred\PostNL\Entity\Timeframesmethod), 129
Kkey() (Firstred\PostNL\Entity\OpeningHours method),
164
LLabel (class in Firstred\PostNL\Entity), 126LabellingMessage (class in
Firstred\PostNL\Entity\Message), 45LabellingService (class in
Firstred\PostNL\Service), 321labellingService (Firstred\PostNL\PostNL prop-
erty), 358LabellingServiceInterface (interface in
Firstred\PostNL\Service), 205Labels (Firstred\PostNL\Entity\Response\MergedLabel
property), 93Labels (Firstred\PostNL\Entity\Response\ResponseShipment
property), 77Labeltype (Firstred\PostNL\Entity\Label property),
126
Index 415
PostNL PHP bindings Documentation, Release 1.2.0
Latitude (Firstred\PostNL\Entity\Coordinates prop-erty), 135
Latitude (Firstred\PostNL\Entity\CoordinatesNorthWestproperty), 159
Latitude (Firstred\PostNL\Entity\CoordinatesSouthEastproperty), 117
Latitude (Firstred\PostNL\Entity\Response\ResponseLocationproperty), 91
Length (Firstred\PostNL\Entity\Dimension property),138
License (Firstred\PostNL\Entity\Customs property),156
LicenseNr (Firstred\PostNL\Entity\Customs prop-erty), 156
Location (class in Firstred\PostNL\Entity), 140Location (Firstred\PostNL\Entity\Request\GetLocationsInArea
property), 53Location (Firstred\PostNL\Entity\Request\GetNearestLocations
property), 56LocationCode (Firstred\PostNL\Entity\Location prop-
erty), 141LocationCode (Firstred\PostNL\Entity\Request\GetLocation
property), 47LocationCode (Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent
property), 79LocationCode (Firstred\PostNL\Entity\Response\ResponseLocation
property), 92LocationService (class in Firstred\PostNL\Service),
266locationService (Firstred\PostNL\PostNL prop-
erty), 358LocationServiceInterface (interface in
Firstred\PostNL\Service), 221log() (Firstred\PostNL\Util\DummyLogger method),
353logger (Firstred\PostNL\HttpClient\CurlClient prop-
erty), 184logger (Firstred\PostNL\HttpClient\GuzzleClient
property), 191logger (Firstred\PostNL\HttpClient\HTTPlugClient
property), 181logger (Firstred\PostNL\HttpClient\MockClient prop-
erty), 188logger (Firstred\PostNL\PostNL property), 358Longitude (Firstred\PostNL\Entity\Coordinates prop-
erty), 135Longitude (Firstred\PostNL\Entity\CoordinatesNorthWest
property), 159Longitude (Firstred\PostNL\Entity\CoordinatesSouthEast
property), 117Longitude (Firstred\PostNL\Entity\Response\ResponseLocation
property), 91
MMainBarcode (Firstred\PostNL\Entity\Group prop-
erty), 130MainBarcode (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
property), 82
MainBarcode (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipmentproperty), 104
MainBarcode (Firstred\PostNL\Entity\Response\ResponseGroupproperty), 87
MergedLabel (class inFirstred\PostNL\Entity\Response), 93
MergedLabels (Firstred\PostNL\Entity\Response\GenerateLabelResponseproperty), 100
MergedLabels (Firstred\PostNL\Entity\Response\SendShipmentResponseproperty), 110
Message (class in Firstred\PostNL\Entity\Message), 46Message (class in Firstred\PostNL\Util), 353Message (Firstred\PostNL\Entity\Request\CompleteStatus
property), 59Message (Firstred\PostNL\Entity\Request\CompleteStatusByPhase
property), 65Message (Firstred\PostNL\Entity\Request\CompleteStatusByReference
property), 57Message (Firstred\PostNL\Entity\Request\CompleteStatusByStatus
property), 48Message (Firstred\PostNL\Entity\Request\Confirming
property), 69Message (Firstred\PostNL\Entity\Request\CurrentStatus
property), 64Message (Firstred\PostNL\Entity\Request\CurrentStatusByPhase
property), 54Message (Firstred\PostNL\Entity\Request\CurrentStatusByReference
property), 62Message (Firstred\PostNL\Entity\Request\CurrentStatusByStatus
property), 55Message (Firstred\PostNL\Entity\Request\GenerateBarcode
property), 63Message (Firstred\PostNL\Entity\Request\GenerateLabel
property), 66Message (Firstred\PostNL\Entity\Request\GetDeliveryDate
property), 71Message (Firstred\PostNL\Entity\Request\GetLocation
property), 47Message (Firstred\PostNL\Entity\Request\GetLocationsInArea
property), 53Message (Firstred\PostNL\Entity\Request\GetNearestLocations
property), 57Message (Firstred\PostNL\Entity\Request\GetSentDateRequest
property), 73Message (Firstred\PostNL\Entity\Request\GetSignature
property), 49Message (Firstred\PostNL\Entity\Request\GetTimeframes
property), 60Message (Firstred\PostNL\Entity\Request\SendShipment
property), 68MessageID (Firstred\PostNL\Entity\Message\Message
property), 46messages (Firstred\PostNL\Exception\CifException
property), 170MessageTimeStamp (Firstred\PostNL\Entity\Message\Message
property), 46MockClient (class in Firstred\PostNL\HttpClient), 187mode (Firstred\PostNL\PostNL property), 358
416 Index
PostNL PHP bindings Documentation, Release 1.2.0
Monday (Firstred\PostNL\Entity\OpeningHours prop-erty), 162
NName (Firstred\PostNL\Entity\Address property), 132Name (Firstred\PostNL\Entity\Customer property), 134Name (Firstred\PostNL\Entity\Response\ResponseAddress
property), 102Name (Firstred\PostNL\Entity\Response\ResponseLocation
property), 91namespaces (Firstred\PostNL\Service\AbstractService
property), 262namespaces (Firstred\PostNL\Service\BarcodeService
property), 287namespaces (Firstred\PostNL\Service\ConfirmingService
property), 329namespaces (Firstred\PostNL\Service\DeliveryDateService
property), 293namespaces (Firstred\PostNL\Service\LabellingService
property), 322namespaces (Firstred\PostNL\Service\LocationService
property), 267namespaces (Firstred\PostNL\Service\TimeframeService
property), 302next() (Firstred\PostNL\Entity\OpeningHours
method), 164NotFoundException (class in
Firstred\PostNL\Exception), 172notice() (Firstred\PostNL\Util\DummyLogger
method), 353NotImplementedException (class in
Firstred\PostNL\Exception), 172NotSupportedException (class in
Firstred\PostNL\Exception), 168
OoffsetExists() (Firstred\PostNL\Entity\OpeningHours
method), 163offsetGet() (Firstred\PostNL\Entity\OpeningHours
method), 163offsetSet() (Firstred\PostNL\Entity\OpeningHours
method), 164offsetUnset() (Firstred\PostNL\Entity\OpeningHours
method), 164OldStatus (class in Firstred\PostNL\Entity), 117OldStatuses (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
property), 82OldStatuses (Firstred\PostNL\Entity\Shipment prop-
erty), 146OpeningHours (class in Firstred\PostNL\Entity), 162OpeningHours (Firstred\PostNL\Entity\Response\ResponseLocation
property), 91OpeningTime (Firstred\PostNL\Entity\Location prop-
erty), 140Option (Firstred\PostNL\Entity\ProductOption prop-
erty), 143Options (Firstred\PostNL\Entity\Location property),
140
Options (Firstred\PostNL\Entity\ReasonNoTimeframeproperty), 119
Options (Firstred\PostNL\Entity\Request\GetDeliveryDateproperty), 70
Options (Firstred\PostNL\Entity\Request\GetSentDateproperty), 51
Options (Firstred\PostNL\Entity\Response\GetDeliveryDateResponseproperty), 109
Options (Firstred\PostNL\Entity\Response\GetSentDateResponseproperty), 94
Options (Firstred\PostNL\Entity\Timeframe property),153
Options (Firstred\PostNL\Entity\TimeframeTimeFrameproperty), 157
OriginCountryCode (Firstred\PostNL\Entity\Request\GetDeliveryDateproperty), 71
other (Firstred\PostNL\Entity\Address property), 132other (Firstred\PostNL\Entity\Response\ResponseAddress
property), 102otherwise() (Firstred\PostNL\Util\PendingPromise
method), 337
PparseResponse() (Firstred\PostNL\Util\Message
method), 354PartnerName (Firstred\PostNL\Entity\Response\ResponseLocation
property), 91Password (Firstred\PostNL\Entity\SOAP\UsernameToken
property), 114PendingPromise (class in Firstred\PostNL\Util), 337pendingRequests (Firstred\PostNL\HttpClient\CurlClient
property), 184pendingRequests (Firstred\PostNL\HttpClient\GuzzleClient
property), 191pendingRequests (Firstred\PostNL\HttpClient\HTTPlugClient
property), 181pendingRequests (Firstred\PostNL\HttpClient\MockClient
property), 187PhaseCode (Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus
property), 111PhaseCode (Firstred\PostNL\Entity\Shipment prop-
erty), 145PhaseCode (Firstred\PostNL\Entity\Status property),
150PhaseDescription (Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus
property), 111PhaseDescription (Firstred\PostNL\Entity\Status
property), 150PhoneNumber (Firstred\PostNL\Entity\Response\ResponseLocation
property), 91Postalcode (Firstred\PostNL\Entity\Location prop-
erty), 141PostalCode (Firstred\PostNL\Entity\Request\GetDeliveryDate
property), 71PostalCode (Firstred\PostNL\Entity\Request\GetSentDate
property), 51PostalCode (Firstred\PostNL\Entity\Timeframe prop-
erty), 153
Index 417
PostNL PHP bindings Documentation, Release 1.2.0
PostNL (class in Firstred\PostNL), 355postnl (Firstred\PostNL\Service\AbstractService
property), 262postnl (Firstred\PostNL\Service\BarcodeService
property), 287PostNLException (class in
Firstred\PostNL\Exception), 170prepareRequest() (Firstred\PostNL\HttpClient\CurlClient
method), 186Printertype (Firstred\PostNL\Entity\Message\LabellingMessage
property), 45processCompleteStatusResponseREST()
(Firstred\PostNL\Service\ShippingStatusServicemethod), 317
processCompleteStatusResponseREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 257
processConfirmResponseREST()(Firstred\PostNL\Service\ConfirmingServicemethod), 333
processConfirmResponseREST()(Firstred\PostNL\Service\ConfirmingServiceInterfacemethod), 203
processConfirmResponseSOAP()(Firstred\PostNL\Service\ConfirmingServicemethod), 335
processConfirmResponseSOAP()(Firstred\PostNL\Service\ConfirmingServiceInterfacemethod), 204
processCurrentStatusResponseREST()(Firstred\PostNL\Service\ShippingStatusServicemethod), 316
processCurrentStatusResponseREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 256
processGenerateBarcodeResponseREST()(Firstred\PostNL\Service\BarcodeServicemethod), 290
processGenerateBarcodeResponseREST()(Firstred\PostNL\Service\BarcodeServiceInterfacemethod), 242
processGenerateBarcodeResponseSOAP()(Firstred\PostNL\Service\BarcodeServicemethod), 291
processGenerateBarcodeResponseSOAP()(Firstred\PostNL\Service\BarcodeServiceInterfacemethod), 243
processGenerateLabelResponseREST()(Firstred\PostNL\Service\LabellingServicemethod), 327
processGenerateLabelResponseREST()(Firstred\PostNL\Service\LabellingServiceInterfacemethod), 210
processGenerateLabelResponseSOAP()(Firstred\PostNL\Service\LabellingServicemethod), 328
processGenerateLabelResponseSOAP()(Firstred\PostNL\Service\LabellingServiceInterface
method), 211processGetDeliveryDateResponseREST()
(Firstred\PostNL\Service\DeliveryDateServicemethod), 298
processGetDeliveryDateResponseREST()(Firstred\PostNL\Service\DeliveryDateServiceInterfacemethod), 218
processGetDeliveryDateResponseSOAP()(Firstred\PostNL\Service\DeliveryDateServicemethod), 299
processGetDeliveryDateResponseSOAP()(Firstred\PostNL\Service\DeliveryDateServiceInterfacemethod), 219
processGetLocationResponseREST()(Firstred\PostNL\Service\LocationServicemethod), 281
processGetLocationResponseREST()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 235
processGetLocationResponseSOAP()(Firstred\PostNL\Service\LocationServicemethod), 281
processGetLocationResponseSOAP()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 236
processGetLocationsInAreaResponseREST()(Firstred\PostNL\Service\LocationServicemethod), 279
processGetLocationsInAreaResponseREST()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 233
processGetLocationsInAreaResponseSOAP()(Firstred\PostNL\Service\LocationServicemethod), 280
processGetLocationsInAreaResponseSOAP()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 234
processGetNearestLocationsResponseREST()(Firstred\PostNL\Service\LocationServicemethod), 277
processGetNearestLocationsResponseREST()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 232
processGetNearestLocationsResponseSOAP()(Firstred\PostNL\Service\LocationServicemethod), 278
processGetNearestLocationsResponseSOAP()(Firstred\PostNL\Service\LocationServiceInterfacemethod), 232
processGetSentDateResponseREST()(Firstred\PostNL\Service\DeliveryDateServicemethod), 300
processGetSentDateResponseREST()(Firstred\PostNL\Service\DeliveryDateServiceInterfacemethod), 219
processGetSentDateResponseSOAP()(Firstred\PostNL\Service\DeliveryDateServicemethod), 300
418 Index
PostNL PHP bindings Documentation, Release 1.2.0
processGetSentDateResponseSOAP()(Firstred\PostNL\Service\DeliveryDateServiceInterfacemethod), 220
processGetSignatureResponseREST()(Firstred\PostNL\Service\ShippingStatusServicemethod), 318
processGetSignatureResponseREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 257
processGetTimeframesResponseREST()(Firstred\PostNL\Service\TimeframeServicemethod), 305
processGetTimeframesResponseREST()(Firstred\PostNL\Service\TimeframeServiceInterfacemethod), 197
processGetTimeframesResponseSOAP()(Firstred\PostNL\Service\TimeframeServicemethod), 306
processGetTimeframesResponseSOAP()(Firstred\PostNL\Service\TimeframeServiceInterfacemethod), 198
processGetUpdatedShipmentsResponseREST()(Firstred\PostNL\Service\ShippingStatusServicemethod), 321
processGetUpdatedShipmentsResponseREST()(Firstred\PostNL\Service\ShippingStatusServiceInterfacemethod), 260
processSendShipmentResponseREST()(Firstred\PostNL\Service\ShippingServicemethod), 285
processSendShipmentResponseREST()(Firstred\PostNL\Service\ShippingServiceInterfacemethod), 246
ProductCode (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipmentproperty), 82
ProductCode (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipmentproperty), 105
ProductCodeCollect(Firstred\PostNL\Entity\Shipment property),146
ProductCodeDelivery(Firstred\PostNL\Entity\Response\ResponseShipmentproperty), 77
ProductCodeDelivery(Firstred\PostNL\Entity\Shipment property),146
ProductDescription(Firstred\PostNL\Entity\Response\CompleteStatusResponseShipmentproperty), 82
ProductDescription(Firstred\PostNL\Entity\Response\CurrentStatusResponseShipmentproperty), 105
ProductOption (class in Firstred\PostNL\Entity), 143ProductOptions (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
property), 82ProductOptions (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment
property), 105ProductOptions (Firstred\PostNL\Entity\Shipment
property), 146promise() (Firstred\PostNL\Util\EachPromise
method), 347promiseFor() (Firstred\PostNL\Util\PromiseTool
method), 340PromiseTool (class in Firstred\PostNL\Util), 339
QQuantity (Firstred\PostNL\Entity\Content property),
161queue() (Firstred\PostNL\Util\PromiseTool method),
339
RRange (Firstred\PostNL\Entity\Barcode property), 139ReasonNoTimeframe (class in
Firstred\PostNL\Entity), 119ReasonNoTimeframes
(Firstred\PostNL\Entity\Response\ResponseTimeframesproperty), 80
ReceiverDateOfBirth(Firstred\PostNL\Entity\Shipment property),146
Reference (Firstred\PostNL\Entity\Amount property),137
Reference (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipmentproperty), 82
Reference (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipmentproperty), 105
Reference (Firstred\PostNL\Entity\Response\ResponseAmountproperty), 99
Reference (Firstred\PostNL\Entity\Shipment prop-erty), 146
ReferenceCollect (Firstred\PostNL\Entity\Shipmentproperty), 146
Region (Firstred\PostNL\Entity\Address property), 132Region (Firstred\PostNL\Entity\Response\ResponseAddress
property), 102registerNamespaces()
(Firstred\PostNL\Service\AbstractServicemethod), 263
reject() (Firstred\PostNL\Util\PendingPromisemethod), 338
RejectionException (class inFirstred\PostNL\Exception\Promise), 165
rejectionFor() (Firstred\PostNL\Util\PromiseToolmethod), 340
Remark (Firstred\PostNL\Entity\Address property), 132Remark (Firstred\PostNL\Entity\Response\ResponseAddress
property), 102Remark (Firstred\PostNL\Entity\Shipment property),
146removeCachedItem()
(Firstred\PostNL\Service\AbstractServicemethod), 265
removeCachedItem()(Firstred\PostNL\Service\ServiceInterfacemethod), 238
Index 419
PostNL PHP bindings Documentation, Release 1.2.0
removeRequest() (Firstred\PostNL\HttpClient\ClientInterfacemethod), 179
removeRequest() (Firstred\PostNL\HttpClient\CurlClientmethod), 186
removeRequest() (Firstred\PostNL\HttpClient\GuzzleClientmethod), 193
removeRequest() (Firstred\PostNL\HttpClient\HTTPlugClientmethod), 181
removeRequest() (Firstred\PostNL\HttpClient\MockClientmethod), 189
requestFactory (Firstred\PostNL\PostNL property),358
RequestFactoryInterface (interface inFirstred\PostNL\Factory), 175
resetLogger() (Firstred\PostNL\PostNL method),361
resolve() (Firstred\PostNL\Util\PendingPromisemethod), 338
ResponseAddress (class inFirstred\PostNL\Entity\Response), 101
ResponseAmount (class inFirstred\PostNL\Entity\Response), 98
ResponseAmountType(Firstred\PostNL\Entity\Response\ResponseAmountproperty), 99
ResponseException (class inFirstred\PostNL\Exception), 168
responseFactory (Firstred\PostNL\PostNL prop-erty), 358
ResponseFactoryInterface (interface inFirstred\PostNL\Factory), 174
ResponseGroup (class inFirstred\PostNL\Entity\Response), 86
ResponseLocation (class inFirstred\PostNL\Entity\Response), 91
ResponseLocation (Firstred\PostNL\Entity\Response\GetLocationsResultproperty), 74
ResponseShipment (class inFirstred\PostNL\Entity\Response), 77
ResponseShipments (Firstred\PostNL\Entity\Response\GenerateLabelResponseproperty), 100
ResponseShipments (Firstred\PostNL\Entity\Response\SendShipmentResponseproperty), 110
ResponseTimeframes (class inFirstred\PostNL\Entity\Response), 80
RetailNetworkID (Firstred\PostNL\Entity\Locationproperty), 141
RetailNetworkID (Firstred\PostNL\Entity\Request\GetLocationproperty), 47
RetailNetworkID (Firstred\PostNL\Entity\Response\ResponseLocationproperty), 92
retrieveCachedItem()(Firstred\PostNL\Service\AbstractServicemethod), 264
retrieveCachedItem()(Firstred\PostNL\Service\ServiceInterfacemethod), 237
ReturnBarcode (Firstred\PostNL\Entity\Shipment
property), 146ReturnReference (Firstred\PostNL\Entity\Shipment
property), 146rewind() (Firstred\PostNL\Entity\OpeningHours
method), 164RFPdi (class in Firstred\PostNL\Util), 346rotate() (Firstred\PostNL\Util\RFPdi method), 346rotateClockWise() (Firstred\PostNL\Util\RFPdi
method), 346rotateCounterClockWise()
(Firstred\PostNL\Util\RFPdi method),346
RouteCode (Firstred\PostNL\Entity\Response\CompleteStatusResponseEventproperty), 79
RouteName (Firstred\PostNL\Entity\Response\CompleteStatusResponseEventproperty), 79
run() (Firstred\PostNL\Util\TaskQueue method), 345
SSaleschannel (Firstred\PostNL\Entity\Location prop-
erty), 141Saleschannel (Firstred\PostNL\Entity\Response\ResponseLocation
property), 92sandbox (Firstred\PostNL\PostNL property), 357Saturday (Firstred\PostNL\Entity\OpeningHours
property), 162Security (class in Firstred\PostNL\Entity\SOAP), 114SendShipment (class in
Firstred\PostNL\Entity\Request), 67sendShipment() (Firstred\PostNL\PostNL method),
369SendShipmentResponse (class in
Firstred\PostNL\Entity\Response), 110sendShipmentRest()
(Firstred\PostNL\Service\ShippingServicemethod), 283
sendShipmentRest()(Firstred\PostNL\Service\ShippingServiceInterfacemethod), 244
sendShipments() (Firstred\PostNL\PostNL method),371
SentDate (Firstred\PostNL\Entity\Response\GetSentDateResponseproperty), 94
Serie (Firstred\PostNL\Entity\Barcode property), 139ServiceInterface (interface in
Firstred\PostNL\Service), 237setAddressType() (Firstred\PostNL\Entity\Address
method), 133setAmountType() (Firstred\PostNL\Entity\Amount
method), 137setBarcodeService() (Firstred\PostNL\PostNL
method), 362setCache() (Firstred\PostNL\Service\AbstractService
method), 265setCache() (Firstred\PostNL\Service\ServiceInterface
method), 238setClient() (Firstred\PostNL\HttpClient\HTTPlugClient
method), 182
420 Index
PostNL PHP bindings Documentation, Release 1.2.0
setCollectionTimeStampEnd()(Firstred\PostNL\Entity\Shipment method),148
setCollectionTimeStampStart()(Firstred\PostNL\Entity\Shipment method),148
setConcurrency() (Firstred\PostNL\HttpClient\GuzzleClientmethod), 192
setConcurrency() (Firstred\PostNL\HttpClient\HTTPlugClientmethod), 182
setConfirmingService() (Firstred\PostNL\PostNLmethod), 363
setConnectTimeout()(Firstred\PostNL\HttpClient\CurlClientmethod), 184
setCreationDate() (Firstred\PostNL\Entity\Response\UpdatedShipmentsResponsemethod), 96
setCustomer() (Firstred\PostNL\PostNL method),359
setDate() (Firstred\PostNL\Entity\ReasonNoTimeframemethod), 120
setDate() (Firstred\PostNL\Entity\Timeframemethod), 154
setDate() (Firstred\PostNL\Entity\TimeframeTimeFramemethod), 158
setDeliveryDate() (Firstred\PostNL\Entity\Locationmethod), 142
setDeliveryDate() (Firstred\PostNL\Entity\Request\GetSentDatemethod), 52
setDeliveryDate() (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipmentmethod), 85
setDeliveryDate() (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipmentmethod), 107
setDeliveryDate() (Firstred\PostNL\Entity\Response\GetDeliveryDateResponsemethod), 109
setDeliveryDate() (Firstred\PostNL\Entity\Shipmentmethod), 149
setDeliveryDateService()(Firstred\PostNL\PostNL method), 364
setDeliveryTimeStampEnd()(Firstred\PostNL\Entity\Shipment method),149
setDeliveryTimeStampStart()(Firstred\PostNL\Entity\Shipment method),148
setEndDate() (Firstred\PostNL\Entity\Timeframemethod), 154
setETAFrom() (Firstred\PostNL\Entity\Expectationmethod), 128
setETATo() (Firstred\PostNL\Entity\Expectationmethod), 128
setHandler() (Firstred\PostNL\HttpClient\MockClientmethod), 189
setHttpClient() (Firstred\PostNL\PostNL method),360
setLabellingService() (Firstred\PostNL\PostNLmethod), 363
setLocationService() (Firstred\PostNL\PostNL
method), 364setLogger() (Firstred\PostNL\HttpClient\ClientInterface
method), 178setLogger() (Firstred\PostNL\HttpClient\CurlClient
method), 185setLogger() (Firstred\PostNL\HttpClient\GuzzleClient
method), 192setLogger() (Firstred\PostNL\HttpClient\HTTPlugClient
method), 182setLogger() (Firstred\PostNL\HttpClient\MockClient
method), 189setLogger() (Firstred\PostNL\PostNL method), 361setMaxRetries() (Firstred\PostNL\HttpClient\GuzzleClient
method), 192setMaxRetries() (Firstred\PostNL\HttpClient\MockClient
method), 188setMessageTimeStamp()
(Firstred\PostNL\Entity\Message\Messagemethod), 46
setMode() (Firstred\PostNL\PostNL method), 360setOption() (Firstred\PostNL\HttpClient\GuzzleClient
method), 191setOption() (Firstred\PostNL\HttpClient\MockClient
method), 188setPostalcode() (Firstred\PostNL\Entity\Location
method), 142setPostalCode() (Firstred\PostNL\Entity\Request\GetDeliveryDate
method), 72setPostalCode() (Firstred\PostNL\Entity\Request\GetSentDate
method), 52setPostalCode() (Firstred\PostNL\Entity\Timeframe
method), 155setRequestFactory() (Firstred\PostNL\PostNL
method), 361setResponse() (Firstred\PostNL\Exception\HttpClientException
method), 171setResponse() (Firstred\PostNL\Exception\ResponseException
method), 169setResponseFactory() (Firstred\PostNL\PostNL
method), 361setSandbox() (Firstred\PostNL\PostNL method), 360setSentDate() (Firstred\PostNL\Entity\Response\GetSentDateResponse
method), 95setService() (Firstred\PostNL\Service\AbstractService
method), 263setShippingDate() (Firstred\PostNL\Entity\Request\GetDeliveryDate
method), 72setShippingService() (Firstred\PostNL\PostNL
method), 365setShippingStatusService()
(Firstred\PostNL\PostNL method), 363setSignatureDate()
(Firstred\PostNL\Entity\Response\GetSignatureResponseSignaturemethod), 98
setSMSNr() (Firstred\PostNL\Entity\Contact method),123
setStartDate() (Firstred\PostNL\Entity\Timeframemethod), 154
Index 421
PostNL PHP bindings Documentation, Release 1.2.0
setStreamFactory() (Firstred\PostNL\PostNLmethod), 362
setTelNr() (Firstred\PostNL\Entity\Contact method),122
setTimeframe() (Firstred\PostNL\Entity\Request\GetTimeframesmethod), 60
setTimeframes() (Firstred\PostNL\Entity\Request\GetTimeframesmethod), 60
setTimeframeService() (Firstred\PostNL\PostNLmethod), 364
setTimeout() (Firstred\PostNL\HttpClient\CurlClientmethod), 184
setTimeStamp() (Firstred\PostNL\Entity\Response\CompleteStatusResponseEventmethod), 80
setTimeStamp() (Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatusmethod), 112
setTimeStamp() (Firstred\PostNL\Entity\Statusmethod), 150
settle() (Firstred\PostNL\Util\PromiseTool method),342
setToken() (Firstred\PostNL\PostNL method), 359setTtl() (Firstred\PostNL\Service\AbstractService
method), 265setTtl() (Firstred\PostNL\Service\ServiceInterface
method), 238setVerify() (Firstred\PostNL\HttpClient\ClientInterface
method), 179setVerify() (Firstred\PostNL\HttpClient\CurlClient
method), 184setVerify() (Firstred\PostNL\HttpClient\GuzzleClient
method), 192setVerify() (Firstred\PostNL\HttpClient\HTTPlugClient
method), 183setVerify() (Firstred\PostNL\HttpClient\MockClient
method), 188setZipcode() (Firstred\PostNL\Entity\Address
method), 133setZipcode() (Firstred\PostNL\Entity\Response\ResponseAddress
method), 103Shipment (class in Firstred\PostNL\Entity), 144Shipment (Firstred\PostNL\Entity\Request\CompleteStatus
property), 59Shipment (Firstred\PostNL\Entity\Request\CompleteStatusByPhase
property), 65Shipment (Firstred\PostNL\Entity\Request\CompleteStatusByReference
property), 58Shipment (Firstred\PostNL\Entity\Request\CompleteStatusByStatus
property), 48Shipment (Firstred\PostNL\Entity\Request\CurrentStatus
property), 64Shipment (Firstred\PostNL\Entity\Request\CurrentStatusByPhase
property), 54Shipment (Firstred\PostNL\Entity\Request\CurrentStatusByReference
property), 62Shipment (Firstred\PostNL\Entity\Request\CurrentStatusByStatus
property), 55Shipment (Firstred\PostNL\Entity\Request\GetSignature
property), 49
ShipmentAmount (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipmentproperty), 82
ShipmentAmount (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipmentproperty), 105
ShipmentCounter (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipmentproperty), 82
ShipmentCounter (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipmentproperty), 105
ShipmentNotFoundException (class inFirstred\PostNL\Exception), 172
Shipments (Firstred\PostNL\Entity\Request\Confirmingproperty), 69
Shipments (Firstred\PostNL\Entity\Request\GenerateLabelproperty), 66
Shipments (Firstred\PostNL\Entity\Request\SendShipmentproperty), 68
Shipments (Firstred\PostNL\Entity\Response\CompleteStatusResponseproperty), 90
Shipments (Firstred\PostNL\Entity\Response\CurrentStatusResponseproperty), 89
ShipmentType (Firstred\PostNL\Entity\Customs prop-erty), 156
ShippingDate (Firstred\PostNL\Entity\Request\GetDeliveryDateproperty), 71
ShippingDuration (Firstred\PostNL\Entity\Request\GetDeliveryDateproperty), 71
ShippingDuration (Firstred\PostNL\Entity\Request\GetSentDateproperty), 51
ShippingService (class in Firstred\PostNL\Service),282
shippingService (Firstred\PostNL\PostNL prop-erty), 358
ShippingServiceInterface (interface inFirstred\PostNL\Service), 244
ShippingStatusService (class inFirstred\PostNL\Service), 307
shippingStatusService (Firstred\PostNL\PostNLproperty), 358
ShippingStatusServiceInterface (interface inFirstred\PostNL\Service), 247
shouldBeAnArray() (Firstred\PostNL\Entity\AbstractEntitymethod), 125
Signature (class in Firstred\PostNL\Entity), 136Signature (Firstred\PostNL\Entity\Response\SignatureResponse
property), 75SignatureDate (Firstred\PostNL\Entity\Response\GetSignatureResponseSignature
property), 97SignatureImage (Firstred\PostNL\Entity\Response\GetSignatureResponseSignature
property), 97SignatureResponse (class in
Firstred\PostNL\Entity\Response), 74SMSNr (Firstred\PostNL\Entity\Contact property), 122some() (Firstred\PostNL\Util\PromiseTool method),
342StartDate (Firstred\PostNL\Entity\Timeframe prop-
erty), 153Status (class in Firstred\PostNL\Entity), 149Status (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
422 Index
PostNL PHP bindings Documentation, Release 1.2.0
property), 83Status (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment
property), 105Status (Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse
property), 96StatusCode (Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus
property), 111StatusCode (Firstred\PostNL\Entity\Shipment prop-
erty), 145StatusCode (Firstred\PostNL\Entity\Status property),
150StatusDescription (Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus
property), 111StatusDescription (Firstred\PostNL\Entity\Status
property), 150str() (Firstred\PostNL\Util\Message method), 354streamFactory (Firstred\PostNL\PostNL property),
358StreamFactoryInterface (interface in
Firstred\PostNL\Factory), 173Street (Firstred\PostNL\Entity\Address property), 132Street (Firstred\PostNL\Entity\Location property),
141Street (Firstred\PostNL\Entity\Request\GetDeliveryDate
property), 71Street (Firstred\PostNL\Entity\Request\GetSentDate
property), 51Street (Firstred\PostNL\Entity\Response\ResponseAddress
property), 102Street (Firstred\PostNL\Entity\Timeframe property),
153StreetHouseNrExt (Firstred\PostNL\Entity\Address
property), 132Sunday (Firstred\PostNL\Entity\OpeningHours prop-
erty), 163SundaySorting (Firstred\PostNL\Entity\Timeframe
property), 153
Ttask() (Firstred\PostNL\Util\PromiseTool method),
340TaskQueue (class in Firstred\PostNL\Util), 344TelNr (Firstred\PostNL\Entity\Contact property), 122TerminalType (Firstred\PostNL\Entity\Location prop-
erty), 141TerminalType (Firstred\PostNL\Entity\Response\ResponseLocation
property), 92then() (Firstred\PostNL\Util\PendingPromise
method), 337threeSCountries (Firstred\PostNL\PostNL prop-
erty), 357Thursday (Firstred\PostNL\Entity\OpeningHours
property), 162Time (Firstred\PostNL\Entity\CutOffTime property),
160Timeframe (class in Firstred\PostNL\Entity), 152Timeframe (Firstred\PostNL\Entity\Request\GetTimeframes
property), 60
TimeframeRange (Firstred\PostNL\Entity\Timeframeproperty), 153
Timeframes (class in Firstred\PostNL\Entity), 128Timeframes (Firstred\PostNL\Entity\Response\ResponseTimeframes
property), 80Timeframes (Firstred\PostNL\Entity\Timeframe prop-
erty), 153Timeframes (Firstred\PostNL\Entity\Timeframes prop-
erty), 129TimeframeService (class in
Firstred\PostNL\Service), 301timeframeService (Firstred\PostNL\PostNL prop-
erty), 358TimeframeServiceInterface (interface in
Firstred\PostNL\Service), 194TimeframeTimeFrame (class in
Firstred\PostNL\Entity), 157TimeframeTimeFrames
(Firstred\PostNL\Entity\Timeframes prop-erty), 129
TimeStamp (Firstred\PostNL\Entity\Response\CompleteStatusResponseEventproperty), 79
TimeStamp (Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatusproperty), 112
TimeStamp (Firstred\PostNL\Entity\Status property),150
To (Firstred\PostNL\Entity\ReasonNoTimeframe prop-erty), 119
To (Firstred\PostNL\Entity\TimeframeTimeFrame prop-erty), 157
toArray() (Firstred\PostNL\Entity\OpeningHoursmethod), 163
TransactionCode (Firstred\PostNL\Entity\Customsproperty), 156
TransactionDescription(Firstred\PostNL\Entity\Customs property),156
TransactionNumber (Firstred\PostNL\Entity\Amountproperty), 137
TransactionNumber (Firstred\PostNL\Entity\Response\ResponseAmountproperty), 99
TrustedShipperID (Firstred\PostNL\Entity\Customsproperty), 156
ttl (Firstred\PostNL\Service\AbstractService prop-erty), 262
Tuesday (Firstred\PostNL\Entity\OpeningHours prop-erty), 162
Type (Firstred\PostNL\Entity\Barcode property), 139
Uunwrap() (Firstred\PostNL\Util\PromiseTool method),
341UpdatedShipmentsResponse (class in
Firstred\PostNL\Entity\Response), 95urlEncode() (Firstred\PostNL\Util\Util method), 348userAgentInfo (Firstred\PostNL\HttpClient\CurlClient
property), 184
Index 423
PostNL PHP bindings Documentation, Release 1.2.0
Username (Firstred\PostNL\Entity\SOAP\UsernameTokenproperty), 114
UsernameToken (class inFirstred\PostNL\Entity\SOAP), 113
UsernameToken (Firstred\PostNL\Entity\SOAP\Securityproperty), 115
Util (class in Firstred\PostNL\Util), 347UUID (class in Firstred\PostNL\Util), 338
Vvalid() (Firstred\PostNL\Entity\OpeningHours
method), 164validateRESTResponse()
(Firstred\PostNL\Service\AbstractServicemethod), 263
validateSOAPResponse()(Firstred\PostNL\Service\AbstractServicemethod), 264
Value (Firstred\PostNL\Entity\Amount property), 137Value (Firstred\PostNL\Entity\Content property), 161Value (Firstred\PostNL\Entity\Response\ResponseAmount
property), 99verifySslCerts (Firstred\PostNL\PostNL property),
357VerzekerdBedrag (Firstred\PostNL\Entity\Amount
property), 137VerzekerdBedrag (Firstred\PostNL\Entity\Response\ResponseAmount
property), 99Volume (Firstred\PostNL\Entity\Dimension property),
138
Wwait() (Firstred\PostNL\Util\PendingPromise
method), 337Warning (class in Firstred\PostNL\Entity), 118warning() (Firstred\PostNL\Util\DummyLogger
method), 353Warnings (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
property), 83Warnings (Firstred\PostNL\Entity\Response\ConfirmingResponseShipment
property), 108Warnings (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment
property), 105Warnings (Firstred\PostNL\Entity\Response\ResponseLocation
property), 92Warnings (Firstred\PostNL\Entity\Response\ResponseShipment
property), 77Warnings (Firstred\PostNL\Entity\Signature property),
136Wednesday (Firstred\PostNL\Entity\OpeningHours
property), 162Weight (Firstred\PostNL\Entity\Content property), 161Weight (Firstred\PostNL\Entity\Dimension property),
138Width (Firstred\PostNL\Entity\Dimension property),
138
XxmlDeserialize() (Firstred\PostNL\Entity\AbstractEntity
method), 125XmlSerializable (interface in Firstred\PostNL\Util),
336xmlSerialize() (Firstred\PostNL\Entity\AbstractEntity
method), 125xmlSerialize() (Firstred\PostNL\Entity\Amount
method), 138xmlSerialize() (Firstred\PostNL\Entity\CutOffTime
method), 160xmlSerialize() (Firstred\PostNL\Entity\Location
method), 143xmlSerialize() (Firstred\PostNL\Entity\ReasonNoTimeframe
method), 120xmlSerialize() (Firstred\PostNL\Entity\Request\CompleteStatus
method), 59xmlSerialize() (Firstred\PostNL\Entity\Request\CompleteStatusByPhase
method), 66xmlSerialize() (Firstred\PostNL\Entity\Request\CompleteStatusByReference
method), 58xmlSerialize() (Firstred\PostNL\Entity\Request\CompleteStatusByStatus
method), 49xmlSerialize() (Firstred\PostNL\Entity\Request\Confirming
method), 69xmlSerialize() (Firstred\PostNL\Entity\Request\CurrentStatus
method), 64xmlSerialize() (Firstred\PostNL\Entity\Request\CurrentStatusByPhase
method), 54xmlSerialize() (Firstred\PostNL\Entity\Request\CurrentStatusByReference
method), 62xmlSerialize() (Firstred\PostNL\Entity\Request\CurrentStatusByStatus
method), 56xmlSerialize() (Firstred\PostNL\Entity\Request\GenerateLabel
method), 67xmlSerialize() (Firstred\PostNL\Entity\Request\GetDeliveryDate
method), 72xmlSerialize() (Firstred\PostNL\Entity\Request\GetSentDate
method), 52xmlSerialize() (Firstred\PostNL\Entity\Request\GetSignature
method), 50xmlSerialize() (Firstred\PostNL\Entity\Request\GetTimeframes
method), 61xmlSerialize() (Firstred\PostNL\Entity\Response\CompleteStatusResponse
method), 90xmlSerialize() (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment
method), 85xmlSerialize() (Firstred\PostNL\Entity\Response\CurrentStatusResponse
method), 89xmlSerialize() (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment
method), 107xmlSerialize() (Firstred\PostNL\Entity\Response\GetDeliveryDateResponse
method), 109xmlSerialize() (Firstred\PostNL\Entity\Response\GetLocationsResult
method), 74xmlSerialize() (Firstred\PostNL\Entity\Response\GetSentDateResponse
method), 95xmlSerialize() (Firstred\PostNL\Entity\Shipment
424 Index
PostNL PHP bindings Documentation, Release 1.2.0
method), 149xmlSerialize() (Firstred\PostNL\Entity\SOAP\UsernameToken
method), 114xmlSerialize() (Firstred\PostNL\Entity\Timeframe
method), 155xmlSerialize() (Firstred\PostNL\Util\XmlSerializable
method), 336
ZZipcode (Firstred\PostNL\Entity\Address property),
132Zipcode (Firstred\PostNL\Entity\Response\ResponseAddress
property), 102
Index 425