Welcome to the documentation site of an unofficial PostNL PHP library

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 being able to follow the official API documentation.

• Abstracts away direct requests to the API, allowing you to focus on the code itself. The object structure is based 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-3 logging. You can log the requests and responses for debugging purposes. More info on the page Logging.

  • PSR-6 caching, so you can use your favorite cache for caching API responses. Chapter Caching.

  • PSR-7 interfaces for requests and responses. Build and process functions are provided for every service so you can create your own mix of batch requests. See the Firstred\PostNL\PostNL::getTimeframesAndNearestLocations method for an example.

  • 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 Symfony HTTP client is strongly recommended. Any HTTPlug client can be used by installing the related packages. See the HTTP Client chapter for more information.

<?php

use Firstred\PostNL\PostNL;
use Firstred\PostNL\Entity\Request\GetTimeframes;
use Firstred\PostNL\Entity\Timeframe;

$postnl = new PostNL();
$timeframes = $postnl->getTimeframes(
    getTimeframes: new GetTimeframes(
        Timeframes: [
            new Timeframe(
                CountryCode: 'NL',
                EndDate: date(format: 'd-m-Y', timestamp: strtotime(datetime: '+14 days')),
                HouseNr: 42,
                Options: ['Daytime', 'Evening'],
                PostalCode: '2132WT',
                SundaySorting: true,
                StartDate: date(format: 'd-m-Y', timestamp: strtotime(datetime: '+1 day')),
            ),
        ],
    ),
);
var_dump(value: $timeframes);

Developer Guide

Overview

Requirements

1. PHP 8.1 or higher (up to and including 8.2)

Note

You can install any HTTP Client that is supported by the HTTPlug project. See chapter HTTP Client for more 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 PHP stream wrapper to handle HTTP requests. For more information check out Guzzle’s documentation.

License

Licensed using the MIT license.

The MIT License (MIT).

Copyright (c) 2017-2023 Michael Dekker (https://github.com/firstred)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Contributing

Guidelines

1. This library supports PSR-1, PSR-2, PSR-3, PSR-4, PSR-6, PSR-7, PSR-17, PSR-18 and PSR-20.

2. The library is meant to be lean, fast and sticks to the standards of the SOAP API (when it comes to data transfer objects). This means that not every feature request can be accepted. When in doubt, please open an issue first.

3. The PostNL library has a minimum PHP version requirement of PHP 8.1. Pull requests must not require a PHP version lower than PHP 8.1.

4. Pull requests must include unit tests to ensure the change works as expected and to prevent regressions.

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.git
cd postnl-api-php && composer install

This library is unit tested with PHPUnit. Run the tests using the included PHPUnit version:

composer test

Building the documentation

The documentation is automatically built and hosted on readthedocs.io. You can build a local HTML copy by installing 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.

Installation

The recommended way to install the PostNL library is through Composer. Composer is a dependency management tool 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/

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 necessary 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';

You can find out more on how to install Composer, configure autoloading, and other best-practices for defining dependencies at getcomposer.org.

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 version requirement for this library to dev-2.0.x.

{
   "require": {
      "firstred/postnl-api-php": "dev-2.0.x"
   }
}

Note

You will likely have to change the min-stability setting:

https://getcomposer.org/doc/04-schema.md#minimum-stability

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.

Passing all credentials

Besides having to provide an API key, you will have to pass information about your business. These credentials will 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 will need from a developer’s perspective. After instantiating a new Firstred\PostNL\PostNL object you will have everything 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:

Required credentials

API key

Required: True

The API key

Customer code

Required: True

The customer code is a code that usually consists of 4 letters and appears in domestic 3S-codes.

Customer number

Required: True

The customer number is a number that usually consists of 8 digits.

Address

A filled Firstred\PostNL\Entity\Address object with at least the following information:

AddressType

Required: True

Default: 02

The address type should be 02, which means the address belongs to the sender.

City

Required: True

City

CompanyName

Required: True

The company name

HouseNr

Required: True

The house number

Street

Required: True

Street name

Zipcode

Required: True

The postcode. Be aware that the API might sometimes refer to a postcode as postcode, postal code or zipcode.

Collection location

Required: True

Default: 123456

I must admit that to this day I still do not have a single clue what this value means. It could refer to your local drop-off location (if you use one). If your PostNL account manager can provide you with a collection location number please use that one.

I usually fill out 123456 and it seems to work just fine.

Globalpack barcode type

Required: False

The 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.

Globalpack customer code

Required: False

The 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\Customer and main Firstred\PostNL\PostNL class.

<?php

use Firstred\PostNL\Entity\Address;
use Firstred\PostNL\Entity\Customer;

$apiKey = 'qjsdjufhjasudhfaSDFasdifh324';
$customer = new Customer(
    CustomerNumber: '11223344',
    CustomerCode: 'DEVC',
    CollectionLocation: '123456',
    ContactPerson: 'Test',
    Address: new Address(
        AddressType: '02',
        CompanyName: 'PostNL',
        Street: 'Siriusdreef',
        HouseNr: '42',
        Zipcode: '2132WT',
        City: 'Hoofddorp',
        Countrycode: 'NL',
    ),
    GlobalPackCustomerCode: '1234',
    GlobalPackBarcodeType: 'AB',
);

$postnl = new PostNL(
    customer: $customer,  // The filled Customer object
    apiKey: $apiKey,      // The API key
    sandbox: false,       // Sandbox = false, meaning we are now using the live environment
);

You might have noticed that several different ways have been used to instantiate an object. More information about this can be found in the Object instantiation section.

The PostNL client constructor accepts a few options:

customer

Required: True

The Firstred\PostNL\Entity\Customer object that is used to configure the client and let PostNL know who is requesting the data.

<?php

use Firstred\PostNL\Entity\Address;
use Firstred\PostNL\Entity\Customer;

// Create a new customer
$client = new Customer(
    CustomerNumber: '11223344',     // Your collection location
    CustomerCode: 'DEVC',           // Your Customer Code
    CollectionLocation: '123456',   // Your Customer Number
    ContactPerson: 'Sander',        // Add your GlobalPack information if you need
    Email: 'test@voorbeeld.nl',     // to create international shipment labels
    Name: 'Michael',
    Address: new Address(
        AddressType: '02',          // This address will be shown on the label
        CompanyName: 'PostNL',
        Street: 'Siriusdreef',
        HouseNr: '42',
        Zipcode: '2132WT',
        City: 'Hoofddorp',
        Countrycode: 'NL',
    ),
    GlobalPackCustomerCode: '1234',
    GlobalPackBarcodeType: 'CX',
);

apiKey

The API key to use. Note that if you want to switch from the legacy API to the new SOAP and REST API you 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: True

Indicate whether you’d like to connect to the sandbox environment. When false the library uses the live endpoints.

Authorization

You may not be authorized to access all services. Contact your PostNL account manager to find out what’s available to you.

Quickstart

This page provides a quick introduction to this library and a few quick copy/paste examples which you can adjust to 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 the main 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 the main 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 request examples from the official API documentation and quickly figure out what each field does.

Using an IDE with code completion is strongly recommended.

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 delivery options.

Note

For more details on how to retrieve delivery options, consult the Delivery options chapter.

Here’s how it is done from scratch:

<?php

use Firstred\PostNL\Entity\Address;
use Firstred\PostNL\Entity\Customer;
use Firstred\PostNL\Entity\CutOffTime;
use Firstred\PostNL\Entity\Location;
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;

require_once __DIR__.'/vendor/autoload.php';

// Your PostNL credentials
$customer = new Customer(
    CustomerNumber: '11223344',
    CustomerCode: 'DEVC',
    CollectionLocation: '123456',
    ContactPerson: 'Sander',
    Email: 'test@voorbeeld.nl',
    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,
);

$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(start: 1, end: 7) as $day) {
    if ($dropoffDays[$day]) {
        $cutOffTimes[] = new CutOffTime(
            Day: str_pad(string: $day, length: 2, pad_string: '0', pad_type: STR_PAD_LEFT),
            Time: date(format: 'H:i:00', timestamp: strtotime(datetime: $cutoffTime)),
            Available: true,
        );
    }
}

$response = $postnl->getTimeframesAndNearestLocations(
    getTimeframes: new GetTimeframes(
        Timeframes: [
            new Timeframe(
                CountryCode: 'NL',
                EndDate: date(format: 'd-m-Y', timestamp: strtotime(datetime: " +{$deliveryDaysWindow} days +{$dropoffDelay} days")),
                HouseNr: '66',
                Options: ['Morning', 'Daytime'],
                PostalCode: '2132WT',
                SundaySorting: !empty($mondayDelivery) && date(format: 'w', timestamp: strtotime(datetime: "+{$dropoffDelay} days")),
                StartDate: date(format: 'd-m-Y', timestamp: strtotime(datetime: '+1 days')),
            ),
        ],
    ),
    getNearestLocations: new GetNearestLocations(
        Countrycode: 'NL',
        Location: new Location(
            Postalcode: '2132WT',
            AllowSundaySorting: !empty($mondayDelivery),
            DeliveryOptions: ['PG'],
            Options: ['Daytime'],
            HouseNr: '66',
        ),
    ),
    getDeliveryDate: new GetDeliveryDate(
        GetDeliveryDate: new GetDeliveryDate(
            AllowSundaySorting: !empty($mondayDelivery),
            CountryCode: 'NL',
            CutOffTimes: $cutOffTimes,
            HouseNr: '12',
            Options: ['Daytime', 'Evening'],
            PostalCode: '2132WT',
            ShippingDate: date(format: 'd-m-Y H:i:s'),
            ShippingDuration: strval(value: 1 + $dropoffDelay),
        ),
    )
);

The response variable will be an associative array containing the timeframes, nearest locations and delivery date. It has the following keys:

timeframes

The embedded timeframes contain the actual timeframes on that particular day.

The response format is the same for both the SOAP and REST API and is 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 and therefore may differ from the API. Please refer to the Formats chapter for more information.

locations

The 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_date

The 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');

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 track shipments chapter.

Example code:

<?php

use Firstred\PostNL\Entity\Address;
use Firstred\PostNL\Entity\Customer;
use Firstred\PostNL\Entity\Dimension;
use Firstred\PostNL\Entity\Label;
use Firstred\PostNL\Entity\Shipment;
use Firstred\PostNL\Enum\LabelPosition;
use Firstred\PostNL\PostNL;

require_once __DIR__.'/vendor/autoload.php';

// Your PostNL credentials
$customer = new Customer(
    CustomerNumber: '11223344',
    CustomerCode: 'DEVC',
    CollectionLocation: '123456',
    ContactPerson: 'Sander',
    Email: 'test@voorbeeld.nl',
    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);

$barcodes = $postnl->generateBarcodesByCountryCodes(isos: ['NL' => 2]);

$shipments = [
    new Shipment(
        Addresses: [
            new Address(
                AddressType: '01',
                FirstName: 'Peter',
                Name: 'de Ruijter',
                Street: 'Bilderdijkstraat',
                HouseNr: '9',
                HouseNrExt: 'a bis',
                Zipcode: '3521VA',
                City: 'Utrecht',
                Countrycode: 'NL',
            ),
        ],
        Barcode: $barcodes['NL'][0],
        Dimension  : new Dimension(Weight: '1000'),
        ProductCodeDelivery : '3085',
    ),
    new Shipment(
        Addresses           : [
            new Address(
                AddressType: '01',
                FirstName: 'Peter',
                Name: 'de Ruijter',
                Street: 'Bilderdijkstraat',
                HouseNr: '9',
                HouseNrExt: 'a bis',
                Zipcode: '3521VA',
                City: 'Utrecht',
                Countrycode: 'NL',
            ),
        ],
        Barcode  : $barcodes['NL'][1],
        Dimension        : new Dimension(Weight: '1000'),
        ProductCodeDelivery: '3085',
    ),
];

$label = $postnl->generateLabels(
    shipments: $shipments,
    printertype: 'GraphicFile|PDF', // Printertype (only PDFs can be merged -- no need to use the Merged types)
    confirm: true, // Confirm immediately
    merge: true, // Merge
    format: Label::FORMAT_A4, // Format -- this merges multiple A6 labels onto an A4
    positions: [
        LabelPosition::TopLeft->value     => true,
        LabelPosition::TopRight->value    => true,
        LabelPosition::BottomLeft->value  => true,
        LabelPosition::BottomRight->value => true,
    ],
);

file_put_contents('labels.pdf', $label);

This will write a labels.pdf file that looks like this:

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 popular PHP frameworks:

SymfonyLaravel

<?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
        $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 request
        return $response;
    }
}

Source: https://ourcodeworld.com/articles/read/329/how-to-send-a-file-as-response-from-a-controller-in-symfony-3

Tracking a shipment

You can track a single shipment by calling Firstred\PostNL\PostNL::getShippingStatusByBarcode with the barcode of the shipment.

It accepts the following parameters:

barcode

The actual barcode, for example: 3SABCD1837238723.

complete

Whether the method should return a complete status update. A complete status update contains the shipment history as well.

Code example:

<?php

$postnl = new PostNL(...);

$currentStatusResponse = $postnl->getShippingStatusByBarcode(
    barcode: '3SABCD1837238723',
    complete: false,
);

Delivery options

The PostNL API allows you to retrieve a list of predicted timeframes and a list of possible pickup locations. For timeframes you will have to use a certain date range and to get the nearest pickup locations you can use an address or 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 three separate 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 to request:

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

Checkout

On an e-commerce checkout page you will probably want to show timeframes and/or pickup locations based on the current day and cut-off window. This library provides an interface to easily combine the three webservices required to show all the delivery options. It will simultaneously contact the three webservices and request a list of timeframes 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 the delivery date at once, part of the Quickstart chapter.

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 calculate the 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:

<?php

use Firstred\PostNL\Entity\CutOffTime;
use Firstred\PostNL\Entity\Request\GetDeliveryDate;

$cutoffTime = '15:00:00';
$dropoffDays = [1 => true, 2 => true, 3 => true, 4 => true, 5 => true, 6 => false, 7 => false];
foreach (range(start: 1, end: 7) as $day) {
    if (isset($dropoffDays[$day])) {
        $cutOffTimes[] = new CutOffTime(
            Day: str_pad(string: $day, length: 2, pad_string: '0', pad_type: STR_PAD_LEFT),
            Time: date(format: 'H:i:00', timestamp: strtotime(datetime: $cutoffTime)),
            Available: true
        );
    }
}

$deliveryDate = $postnl->getDeliveryDate(
    getDeliveryDate: new GetDeliveryDate(
        GetDeliveryDate: new GetDeliveryDate(
                AllowSundaySorting: false,
                CountryCode: 'NL',
                CutOffTimes: $cutOffTimes,
                HouseNr: '66',
                Options: ['Morning', 'Daytime'],
                PostalCode: '2132WT',
                ShippingDate: date(format: 'd-m-Y H:i:s'),
                ShippingDuration: '1',
            ),
        ),
    );

The result will be a GetDeliveryDateResponse. Calling getDeliveryDate on this object will return the delivery date as a string in the d-m-Y H:i:s PHP date format.

The function accepts the following arguments

getDeliveryDate

Required: True

The Firstred\PostNL\Entity\Request\GetDeliveryDate request object. See the API documentation for the possibilities. As shown in the example you will need to provide as many details as possible to get accurate availability information.

Shipping dates

The Shipping Date service almost works in the same way as the Delivery Date service, except this time you provide the actual delivery date in order to calculate the closest shipping date.

<?php

use Firstred\PostNL\Entity\Request\GetSentDate;
use Firstred\PostNL\Entity\Request\GetSentDateRequest;

$cutoffTime = '15:00:00';
$deliveryDate = $postnl->getSentDate(
    getSentDate: new GetSentDateRequest(
        GetSentDate: new GetSentDate(
            AllowSundaySorting: false,
            CountryCode: 'NL',
            HouseNr: '66',
            Options: ['Morning', 'Daytime'],
            PostalCode: '2132WT',
            DeliveryDate: date(format: 'd-m-Y H:i:s'),
            ShippingDuration: '1',
        ),
    ),
);

The function accepts the following arguments

getSentDate

Required: True

The Firstred\PostNL\Entity\Request\GetSentDate request object. See the API documentation for the possibilities. As shown in the example you will need to provide as many details as possible to get accurate availability information.

Timeframe webservice

Note

PostNL API documentation for this service:

https://developer.postnl.nl/apis/timeframe-webservice

Timeframes

use Firstred\PostNL\Entity\Timeframe;
use Firstred\PostNL\Entity\Request\GetTimeframes;

$deliveryDaysWindow = 7;
$dropoffDelay = 0;

$postnl = new PostNL();

$timeframes = $postnl->getTimeframes(
    getTimeframes: new GetTimeframes(
        timeframes: [
            new Timeframe(
                CountryCode: 'NL',
                EndDate: date(format: 'd-m-Y', timestamp: strtotime(datetime: " +{$deliveryDaysWindow} days +{$dropoffDelay} days")),
                HouseNr: '66',
                Options: ['Daytime', 'Evening'],
                PostalCode: '2132WT',
                SundaySorting: false,
                StartDate: date(format: 'd-m-Y', timestamp: strtotime(datetime: " +1 day +{$dropoffDelay} days")),
            ),
        ],
    ),
);

timeframes

Required: True

The Firstred\PostNL\Entity\Request\GetTimeframes request object. See the API documentation for more details.

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:

<?php

use Firstred\PostNL\Entity\Location;
use Firstred\PostNL\Entity\Request\GetNearestLocations;
use Firstred\PostNL\PostNL;

$postnl->getNearestLocations(
    getNearestLocations: new GetNearestLocations(
        Countrycode: 'NL',
        Location: new Location(
            Postalcode: '2132WT',
            AllowSundaySorting: false,
            DeliveryOptions: ['PG'],
            Options: ['Daytime'],
            HouseNr: '66',
        ),
    ),
);

getNearestLocations

Required: True

The Firstred\PostNL\Entity\Request\GetNearestLocations request object. See the API documentation 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 and South-East corner of the box:

<?php

use Firstred\PostNL\Entity\CoordinatesNorthWest;
use Firstred\PostNL\Entity\CoordinatesSouthEast;
use Firstred\PostNL\Entity\Location;
use Firstred\PostNL\Entity\Request\GetLocationsInArea;

$postnl->getLocationsInArea(
    getLocationsInArea: new GetLocationsInArea(
        Countrycode: 'NL',
        Location: new Location(
            AllowSundaySorting: false,
            DeliveryDate: date(format: 'd-m-Y', timestamp: strtotime(datetime: '+1 day')),
            DeliveryOptions: ['PG'],
            Options: ['Daytime'],
            CoordinatesNorthWest: new CoordinatesNorthWest(
                Latitude: (string) 52.156439,
                Longitude: (string) 5.015643,
            ),
            CoordinatesSouthEast: new CoordinatesSouthEast(
                Latitude: (string) 52.017473,
                Longitude: (string) 5.065254,
            ),
        ),
    ),
);

This function accepts the arguments:

locationsInArea

Required: True

The Firstred\PostNL\Entity\Request\GetLocationsInArea request object. See the API documentation for more details.

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.

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 an amount of barcodes, generate shipping labels and eventually confirm those labels. According to PostNL, this flow is necessary for a higher delivery success rate.

Generate a single barcode

You can generate a single barcode for domestic shipments as follows:

<?php

$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: False

Default: 3S

The barcode type. This is 2S/3S for the Netherlands and EU Pack Special shipments. For other destinations this is your GlobalPack barcode type. For more info, check the PostNL barcode service page.

range

Required: False

Default: null

serie

Required: False

Default: null

This is the barcode range for your shipment(s). Check the PostNL barcode service page for the ranges that are available.

eps

Required: False

Default: false

Indicates whether this is an EU Pack Special shipment.

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 to use.

Example:

<?php

$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: True

The 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 like to generate.

Example:

<?php

$postnl->generatesBarcodeByCountryCodes(['NL' => 2, 'DE' => 3]);

The method Firstred\PostNL\PostNL::generateBarcodesByCountryCodes will return a list of barcodes:

<?php

[
    'NL' => [
        '3SDEVC11111111111',
        '3SDEVC22222222222',
    ],
    'DE' => [
        '3SDEVC111111111',
        '3SDEVC222222222',
        '3SDEVC333333333',
    ],
];

The function accepts the following argument:

type

Required: True

This must be an associative array with country codes as key and the amount of barcodes you’d like to generate per country as the value.

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 a built-in way to merge labels automatically, so you can request labels for multiple shipments at once.

Generate a single label

The following example generates a single shipment label for a domestic shipment:

<?php

use Firstred\PostNL\Entity\Address;
use Firstred\PostNL\Entity\Shipment;
use Firstred\PostNL\PostNL;

$barcode = '3S...';
$postnl = new PostNL(...);
$postnl->generateLabel(
    Shipment: new Shipment(
        Addresses: [
            new Address(
                AddressType: '01',
                FirstName: 'Peter',
                Name: 'de Ruijter',
                Street: 'Bilderdijkstraat',
                HouseNr: '9',
                HouseNrExt: 'a bis',
                Zipcode: '3521VA',
                City: 'Utrecht',
                Countrycode: 'NL',
            ),
            new Address(
                AddressType: '02',
                CompanyName: 'PostNL',
                Street: 'Siriusdreef',
                HouseNr: '42',
                Zipcode: '2132WT',
                City: 'Hoofddorp',
                Countrycode: 'NL',
            ),
        ],
        Barcode: $barcode,
        DeliveryAddress: '01',
        Dimension: new Dimension('2000'),
        ProductCodeDelivery: '3085',
    ),
    printertype: 'GraphicFile|PDF',
    confirm: false
);

This will create a standard shipment (product code 3085). You can access the label (base64 encoded PDF) this way:

<?php

$pdf = base64_decode($label->getResponseShipments()[0]->getLabels()[0]->getContent());

This function accepts the following arguments:

shipment

Required: True

The Firstred\PostNL\Entity\Shipment object. Visit the PostNL API documentation to find out 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: True

Default: GraphicFile|PDF

The 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: False

Default: true

Indicates whether the shipment should immediately be confirmed.

Generate multiple shipment labels

The following example shows how a label can be merged:

<?php

use Firstred\PostNL\Entity\Address;
use Firstred\PostNL\Entity\Dimension;
use Firstred\PostNL\Entity\Label;
use Firstred\PostNL\Entity\Shipment;
use Firstred\PostNL\Enum\LabelPosition;

$postnl = new PostNL(...);

$barcodes = [
    'NL' => ['3S...', '3S...'],
];

$shipments = [
    new Shipment(
        Addresses: [
            new Address(
                AddressType: '01',
                FirstName: 'Peter',
                Name: 'de Ruijter',
                Street: 'Bilderdijkstraat',
                HouseNr: '9',
                HouseNrExt: 'a bis',
                Zipcode: '3521VA',
                City: 'Utrecht',
                Countrycode: 'NL',
            ),
        ],
        Barcode: $barcodes['NL'][0],
        Dimension: new Dimension(Weight: '1000'),
        ProductCodeDelivery: '3085',
    ),
    new Shipment(
        Addresses: [
            new Address(
                AddressType: '01',
                FirstName: 'Peter',
                Name: 'de Ruijter',
                Street: 'Bilderdijkstraat',
                HouseNr: '9',
                HouseNrExt: 'a bis',
                Zipcode: '3521VA',
                City: 'Utrecht',
                Countrycode: 'NL',
            ),
        ],
        Barcode: $barcodes['NL'][1],
        Dimension: new Dimension(Weight: '1000'),
        ProductCodeDelivery: '3085',
    ),
];

$label = $postnl->generateLabels(
    $shipments,
    'GraphicFile|PDF', // Printertype (only PDFs can be merged -- no need to use the Merged types)
    true, // Confirm immediately
    true, // Merge
    Label::FORMAT_A4, // Format -- this merges multiple A6 labels onto an A4
    [
        LabelPosition::TopLeft->value => true,
        LabelPosition::TopRight->value => true,
        LabelPosition::BottomLeft->value => true,
        LabelPosition::BottomRight->value => 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: True

An array with Firstred\PostNL\Entity\Shipment objects. Visit the PostNL API documentation to find out 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: False

Default: GraphicFile|PDF

The 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: False

Default: true

Indicates whether the shipment should immediately be confirmed.

merge

Required: False

Default: false

This will merge the labels and make the function return a pdf string of the merged label.

format

Required: False

Default: Firstred\PostNL\PostNL::FORMAT_A4

This sets the paper format (can be Firstred\PostNL\PostNL::FORMAT_A4 or Firstred\PostNL\PostNL::FORMAT_A6).

positions

Required: False

Default: [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 false to resp. enable or disable a position:

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:

<?php

use Firstred\PostNL\Entity\Address;
use Firstred\PostNL\Entity\Dimension;
use Firstred\PostNL\Entity\Shipment;
use Firstred\PostNL\PostNL;

$postnl = new PostNL(...);
$postnl->sendShipment(
    shipment: new Shipment(
        Addresses: [
            new Address(
                AddressType: '01',
                FirstName: 'Peter',
                Name: 'de Ruijter',
                Street: 'Bilderdijkstraat',
                HouseNr: '9',
                HouseNrExt: 'a bis',
                Zipcode: '3521VA',
                City: 'Utrecht',
                Countrycode: 'NL',
            ),
            new Address(
                AddressType: '02',
                CompanyName: 'PostNL',
                Street: 'Siriusdreef',
                HouseNr: '42',
                Zipcode: '2132WT',
                City: 'Hoofddorp',
                Countrycode: 'NL',
            ),
        ],
        DeliveryAddress: '01',
        Dimension: new Dimension(Weight: '2000'),
        ProductCodeDelivery: '3085',
    ),
    printertype: 'GraphicFile|PDF',
    confirm: false
);

This will create a standard shipment (product code 3085). You can access the label (base64 encoded PDF) this way:

<?php

$pdf = base64_decode($shipping->getResponseShipments()[0]->getLabels()[0]->getContent());

This function accepts the following arguments:

shipment

Required: True

The Firstred\PostNL\Entity\Shipment object. Visit the PostNL API documentation to find out what a Shipment object consists of.

printertype

Required: False

Default: GraphicFile|PDF

The 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: False

Default: true

Indicates whether the shipment should immediately be confirmed.

Send multiple shipments

The following example shows how labels of multiple shipment labels can be merged:

<?php

use Firstred\PostNL\Entity\Address;
use Firstred\PostNL\Entity\Dimension;
use Firstred\PostNL\Entity\Label;
use Firstred\PostNL\Entity\Shipment;
use Firstred\PostNL\Enum\LabelPosition;
use Firstred\PostNL\PostNL;

$postnl = new PostNL(...);

$shipments = [
    new Shipment(
        Addresses: [
            new Address(
                AddressType: '01',
                FirstName: 'Peter',
                Name: 'de Ruijter',
                Street: 'Bilderdijkstraat',
                HouseNr: '9',
                HouseNrExt: 'a bis',
                Zipcode: '3521VA',
                City: 'Utrecht',
                Countrycode: 'NL',
            ),
        ],
        Dimension: new Dimension(Weight: '1000'),
        ProductCodeDelivery: '3085',
    ),
    new Shipment(
        Addresses: [
            new Address(
                AddressType: '01',
                FirstName: 'Peter',
                Name: 'de Ruijter',
                Street: 'Bilderdijkstraat',
                HouseNr: '9',
                HouseNrExt: 'a bis',
                Zipcode: '3521VA',
                City: 'Utrecht',
                Countrycode: 'NL',
            ),
        ],
        Dimension: new Dimension(Weight: '1000'),
        ProductCodeDelivery: '3085',
    ),
];

$label = $postnl->sendShipments(
    shipments: $shipments,
    printertype: 'GraphicFile|PDF', // Printertype (only PDFs can be merged -- no need to use the Merged types)
    confirm: true, // Confirm immediately
    merge: true, // Merge
    format: Label::FORMAT_A4, // Format -- this merges multiple A6 labels onto an A4
    positions: [
        LabelPosition::TopLeft->value     => true,
        LabelPosition::TopRight->value    => true,
        LabelPosition::BottomLeft->value  => true,
        LabelPosition::BottomRight->value => 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: True

An array with Firstred\Entity\Shipment objects. Visit the PostNL API documentation to find out what a Shipment object consists of.

printertype

Required: False

Default: GraphicFile|PDF

The 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: False

Default: true

Indicates whether the shipment should immediately be confirmed.

merge

Required: False

Default: false

This will merge the labels and make the function return a pdf string of the merged label.

format

Required: False

Default: Firstred\PostNL\PostNL::FORMAT_A4

This sets the paper format (can be Firstred\PostNL\PostNL::FORMAT_A4 or Firstred\PostNL\PostNL::FORMAT_A6).

positions

Required: False

Default: [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 false to resp. enable or disable a position:

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 the Labelling 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 object whereas the latter accepts an array of :php:class:`Firstred\PostNL\Entity\Shipment`s.

Example code:

<?php

use Firstred\PostNL\Entity\Address;
use Firstred\PostNL\Entity\Dimension;
use Firstred\PostNL\Entity\Shipment;
use Firstred\PostNL\PostNL;

$postnl = new PostNL(...);

$confirmedShipment = $postnl->confirmShipment(
    shipment: new Shipment(
        Addresses: [
            new Address(
                AddressType: '01',
                FirstName: 'Peter',
                Name: 'de Ruijter',
                Street: 'Bilderdijkstraat',
                HouseNr: '9',
                HouseNrExt: 'a bis',
                Zipcode: '3521VA',
                City: 'Utrecht',
                Countrycode: 'NL',
            ),
            new Address(
                AddressType: '02',
                CompanyName: 'PostNL',
                Street: 'Siriusdreef',
                HouseNr: '42',
                Zipcode: '2132WT',
                City: 'Hoofddorp',
                Countrycode: 'NL',
            ),
        ],
        Barcode: '3SDEVC201611210',
        DeliveryAddress: '01',
        Dimension: new Dimension('2000'),
        ProductCodeDelivery: '3085',
    ),
);

The output is a Firstred\PostNL\Entity\Respone\ConfirmingResponseShipment or an array with these objects in case you are confirming multiple shipments. The results array will have the same index keys as the request input.

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, otherwise complete 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.

<?php

$postnl = new PostNL(...);
$postnl->getShippingStatusByBarcode('3SDEVC98237423');

barcode

Required: True

The barcode, e.g.: 3SDEVC98237423

complete

Required: False

Return 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.

<?php

$postnl = new PostNL(...);
$postnl->getShippingStatusesByBarcodes(['3SDEVC98237423', '3SDEVC98237423']);

barcodes

Required: True

The references, e.g.: ['3SDEVC98237423', '3SDEVC98237423']

complete

Required: False

Return 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, ...].

Current or complete shipping status by reference

Gets the current or complete status by reference. A complete status also includes the shipment history.

<?php

$postnl = new PostNL(...);
$postnl->getShippingStatusByReference('order-12');

reference

Required: True

The barcode, e.g.: order-12

complete

Required: False

Return 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.

<?php

$postnl = new PostNL(...);
$postnl->getShippingStatusesByReferences(['order-12', 'order-16']);

barcodes

Required: True

The references, e.g.: ['order-12', 'order-16]

complete

Required: False

Return 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

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.

<?php

$postnl = new PostNL(...);
$postnl->getSignatureByBarcode('3SDEVC23987423');

It accepts the following arguments

barcode

Required: True

The shipment’s barcode, e.g. 3SDEVC23987423

This method returns a Firstred\PostNL\Entity\Response\GetSignatureResponseSignature object. To get the actual signature in binary format you will have to use:

<?php

$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.

<?php

$postnl = new PostNL(...);
$postnl->getSignaturesByBarcodes(['3SDEVC23987423', '3SDEVC23987425']);

It accepts the following arguments

barcodes

Required: True

An array of barcodes, e.g. ['3SDEVC23987423', '3SDEVC23987425'].

It returns an array of Firstred\PostNL\Entity\Response\GetSignatureResponseSignature objects. To get the image data out of these objects, see Get a single signature by barcode.

Exception handling

The following tree view describes how the exceptions used in this library depend on each other.

. Exception : Throwable
└── Firstred\PostNL\Exception\PostNLException
    ├── Firstred\PostNL\Exception\ApiException
    │   ├── Firstred\PostNL\Exception\ApiConnectionException
    │   ├── Firstred\PostNL\Exception\CifDownException
    │   ├── Firstred\PostNL\Exception\CifException
    │   ├── Firstred\PostNL\Exception\NotFoundException
    │   ├── Firstred\PostNL\Exception\ResponseException
    │   └── Firstred\PostNL\Exception\ShipmentNotFoundException
    ├── Firstred\PostNL\Exception\HttpClientException
    └── Firstred\PostNL\Exception\InvalidArgumentException
        ├── Firstred\PostNL\Exception\InvalidBarcodeException
        ├── Firstred\PostNL\Exception\InvalidConfigurationException
        ├── Firstred\PostNL\Exception\InvalidMethodException
        ├── Firstred\PostNL\Exception\NotImplementedException
        └── Firstred\PostNL\Exception\NotSupportedException

Exception types

This library throws several exceptions for errors that can occur. In order to provide harmonized error handling for different API modes, several implementation details are left out. For example, errors related to XML or JSON parsing are wrapped in a Firstred\PostNL\Exception\ResponseException exception.

If you want to catch all exceptions thrown by this library be sure to catch Firstred\PostNL\Exception\PostNLException s. Under normal conditions there is no need to catch all Throwable s. If any other Throwable such as Error, TypeError or PsrCacheInvalidArgumentException is uncaught, it means that there is a bug somewhere in the library. Please file a new issue with all the details you can find (preferably with the original request/response [be sure to scrub personal data]): https://github.com/firstred/postnl-api-php/issues/new.

use Firstred\PostNL\Exception\PostNLException;
use Psr\Cache\InvalidArgumentException as PsrCacheInvalidArgumentException;

try {
    $postnl->getTimeframes(...);
} catch (PostNLException $e) {
    // ...
}

Firstred\PostNL\Exception\ApiException

This groups of exceptions occurs when there is something wrong with the way the API returns an object (likely an unsupported feature or structure), when the API has trouble processing data, is either down or the requested object could not be found.

deprecated Firstred\PostNL\Exception\ApiConnectionException

This happens when the HTTP client has a problem connecting with the API. This exception has been replaced by the Firstred\PostNL\Exception\HttpClientException exception, which allows you to gather more detailed information.

Firstred\PostNL\Exception\CifDownException

This exception is thrown when the CIF API is down.

Firstred\PostNL\Exception\CifException

When the CIF API itself has a fatal error this exception is thrown.

Firstred\PostNL\Exception\NotFoundException

This exception is thrown when the requested object could not be found.

Firstred\PostNL\Exception\ResponseException

This exception is thrown when a response could not be understood by the library. If there was a problem parsing the response, the previous argument might point at the underlying error.

deprecated

Required: False

deprecated Firstred\PostNL\Exception\ShipmentNotFoundException

Occurs when the requested Firstred\PostNL\Entity\Shipment or Firstred\PostNL\Entity\Response\ResponseShipment object could not be found. This exception is deprecated and being replaced by a Firstred\PostNL\Exception\NotFoundException.

Firstred\PostNL\Exception\HttpClientException

All exceptions that occur in underlying HTTP Clients are handled by Firstred\PostNL\Exception\HttpClientException s.

Firstred\PostNL\Exception\InvalidArgumentException

Invalid inputs are handled by the group of Firstred\PostNL\Exception\InvalidArgumentException exceptions.

deprecated Firstred\PostNL\Exception\InvalidApiModeException

When an invalid API mode is selected, this exception is thrown. This exception is deprecated, because the ability to select an API mode will be removed in the future.

Firstred\PostNL\Exception\InvalidBarcodeException

This exception is thrown when there is a problem with generating a barcode. Usually caused by invalid input.

Firstred\PostNL\Exception\InvalidConfigurationException

When a problem occurs due to configuration errors, this exception is thrown. For example, an invalid API key.

Firstred\PostNL\Exception\InvalidMethodException

This happens when an invalid method has been called.

Firstred\PostNL\Exception\NotImplementedException

When a feature has not been implemented, yet, you will see this exception thrown.

Firstred\PostNL\Exception\NotSupportedException

This occurs when a feature is not supported.

Formats

The API can be very inconsistent when it comes to returning times and dates, for example. To standardize how some fields are handled, the library uses different formats.

Dates, Times and DateTimes

This library makes a distinction between Dates, Times and DateTimes. To normalize moments in time, this package returns DateTimeImmutable objects when referring to a single point in time and uses strings for times.

The following definitions and formats are used:

Dates

Dates refer to a specific moment in time; not specifying the time. Can be formatted as 2020-02-03. Is always a DateTimeImmutable object.

Times

Times refer to a certain moment on any given day. Can be formatted as 12:12:12. Is always a string and should always be formatted using the following PHP date format: H:i:s (Hours, minutes and seconds with leading zeros).

DateTimes

DateTimes are referring to a specific date and time. They can be formatted for example as 2021-02-03 12:12:12. Is always a DateTimeImmutable object.

Note

Every DateTimeImmutable object and time string returned by the library is adjusted to the timezone of the PostNL API (Europe/Amsterdam). Make sure your timezone is aligned correctly, or otherwise convert dates and 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'));

SOAP object structure

Sometimes you will notice that the REST API documentation might return property names in singular whereas the library returns the plural version of a property. This is caused by the fact that the SOAP API returns most properties in plural format. An example is the shipping status service when requesting the current status of a shipment. The SOAP API would return an addresses property whereas REST returns address. This is automatically converted to the Firstred\PostNL\Entity\Shipment::$Addresses property by this library. Therefore, when in doubt, you can safely assume that plural is used.

HTTP Client

This library supports almost all available HTTP clients. There are several ways to configure the HTTP client that should 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 in the following order:

1. Guzzle client

2. HTTPlug client, an Asynchronous HTTP client, PSR-18 HTTP clients

3. Built-in cURL client

Setting the HTTP client manually

By default the library will use cURL or Guzzle when available. You can always switch HTTP clients as follows:

<?php

$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.

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 example

This package already requires a Message factory and HTTP factory implementation (guzzlehttp/psr7), so all we 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 it through the HTTPlug bridge.

If you have installed Guzzle already, then you can still configure the PostNL library to use the Symfony HTTP Client. To do this, pass the new client to the Firstred\PostNL\PostNL constructor or Firstred\PostNL\PostNL::setHttpClient method. Example:

<?php

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

Caching

PSR-6 caching is supported, which means you can grab any caching library for PHP that you like and plug it right into this library. Make sure you install a PSR-20 clock implementation as well, e.g.:

composer require symfony/cache symfony/clock

Note that not all services can be cached. At the moment cacheable services are:

• Timeframes webservice

• Location webservice

• DeliveryDate webservice

• ShippingStatus webservice

To enable caching for a certain service you can use the following:

<?php

use Symfony\Component\Clock\NativeClock;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;

$postnl = new PostNL(...);

$deliveryDateService = $postnl->getDeliveryDateService();

// Set a clock first or else it will be automatically set to :php:class:`Symfony\Component\Clock\NativeClock` when available.
$clock = new NativeClock();
$deliveryDateService->clock = $clock;

// Cache in the `/cache` folder relative to this directory
$cache = new FilesystemAdapter(directory: __DIR__.'/cache/');
$deliveryDateService->cache = $cache;

// Set a TTL of 600 seconds
$deliveryDateService->ttl = 600;

// Using a DateInterval (600 seconds)
$deliveryDateService->ttl = new DateInterval('PT600S');

// Setting a deadline instead, useful for the delivery date service, so you can cache until the cut-off-time
$cutOffTime = '18:00:00';

// You can also dynamically retrieve this from a request entity:
// $cutOffTime = $getDeliveryDateRequest->getCutOffTimes()[1]; // Monday cut-off time

$deliveryDateService->ttl = new DateTime('18:00:00');

Here’s a full (recommended) example for all services:

<?php

use Symfony\Component\Clock\NativeClock;
use Symfony\Component\Cache\Adapter\FilesystemAdapter;

$cutOffTimeToday = '18:00:00';

$postnl = new PostNL(...);

$deliveryDateService = $postnl->getDeliveryDateService();
$timeframesService = $postnl->getTimeframesService();
$locationService = $postnl->getLocationService();
$shippingStatusService = $postnl->getDeliveryDateService();

// Set a clock first or else it will be automatically set to :php:class:`Symfony\Component\Clock\NativeClock` when available.
$clock = new NativeClock();

// Cache in the `/cache` folder relative to this directory
$cache = new FilesystemAdapter(directory: __DIR__.'/cache/');

$deliveryDateService->clock = $clock;
$deliveryDateService->cache = $cache;
$deliveryDateService->ttl = new DateTime($cutOffTimeToday);

$timeframesService->clock = $clock;
$timeframesService->cache = $cache;
$timeframesService->ttl = new DateTime($cutOffTimeToday);

$locationService->clock = $clock;
$locationService->cache = $cache;
$locationService->ttl = new DateTime('23:59:59');

$shippingStatusService->clock = $clock;
$shippingStatusService->cache = $cache;
$shippingStatusService->ttl = 5 * 60; // Prevent hitting the rate-limit by retrieving updates at most every 5 minutes

Note

This example used the Symfony (filesystem) cache. An extensive list of supported caches can be found on this page.

Logging

Requests and responses can be logged for debugging purposes. In order to enable logging you will need to pass a PSR-3 compatible logger.

<?php

use Monolog\Handler\StreamHandler;
use Monolog\Level;
use Monolog\Logger;

$logger = new Logger(name: 'postnl_client');
// Set the filename format, we're creating one file for every minute of request/responses
$debugHandler = new StreamHandler(stream: __DIR__.'/logs/'.date(format: 'Y-m-d H:i').'.log', level: Level::Debug);
$formatter = new Monolog\Formatter\LineFormatter(
    format: null,                     // Format of message in log, default [%datetime%] %channel%.%level_name%: %message% %context% %extra%\n
    dateFormat: null,                 // Datetime format
    allowInlineLineBreaks: true,      // allowInlineLineBreaks option, default false
    ignoreEmptyContextAndExtra: true  // ignoreEmptyContextAndExtra option, default false
);
$debugHandler->setFormatter(formatter: $formatter);
$logger->pushHandler(handler: $debugHandler);

// 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 Monolog logger. You can use any logger you like, as long as it implements the PSR-3 standard. To log all responses the level needs to be set at Debug. For error responses you can set the debug level to Error.

Advanced usage

This section describes more advanced ways to use this library. The main class Firstred\PostNL\PostNL and separate service classes (such as Firstred\PostNL\Service\BarcodeService) provide more ways to interact with the API.

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 (deprecated

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 you will be able to detect errors earlier in the process.

1 - Constructor2 - Constructor named args3 - Create (deprecated)4 - Setters

// Your PostNL credentials
$customer = new Customer(
    '11223344',
    'DEVC',
    '123456',
    'Sander',
    'test@voorbeeld.nl',
    'Michael',
    new Address(
        '02',
        'PostNL',
        'Siriusdreef',
        '42',
        '2132WT',
        'Hoofddorp',
        'NL',
    ),
);

Building requests manually

For most cases using the API through the (Firstred\PostNL\PostNL) object would be sufficient. There might be times, however, when the main class does not align with your use case. This section aims to describe the process that is involved in creating requests, sending them and processing the responses.

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 merge option to false and can omit both the format and positions parameters. This will in turn make the library return Firstred\PostNL\Entity\Response\GenerateLabelResponse objects.

These are in line with the Firstred\PostNL\Entity\Response\GenerateLabelResponse nodes generated by the SOAP API, even when using the REST API. The main reason for this standardization is that the initial version of 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 GenerateLabelResponse class 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 and even 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 the Service class of your choice and call the `buildXXXXXXRequest()` functions of a request builder class implementing Firstred\PostNL\Service\RequestBuilder\AbstractRequestBuilder manually. Thanks to the PSR-7 standard used by this library you can use the PsrHttpMessageRequestInterface object that is returned to access the full request that would otherwise be sent directly. To pick up where you left off you can then grab the response and pass it to one of the processXXXXXXXResponse()` functions of the corresponding class implementing Firstred\PostNL\Service\ResponseProcessor\AbstractResponseProcessor. The easiest method is to grab the raw HTTP message and parse it with the included PSR-7 library. An example can be found in the cURL client.

Processing Response objects

Note

This section refers to Response entities 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 entity (Firstred\\PostNL\\Entity\\Response namespace). As mentioned in the Building Requests section, these response entities are based on the SOAP API, regardless of the mode set. The properties of a response entity can be looked up in the code, but it can be a bit confusing at times, since the Response object will likely not contain all properties at once. It often depends on the context of the request. For this reason, you’re better off by having a look at the API documentation directly or by checking out some of the examples in this documentation.

Migrating from v1 to v2

Version 2 of the library has largely stayed compatible with version 1 of the library. Notable changes are the removal of support for the SOAP API and requiring PHP 8.1 as a minimum. It also reintroduces caching.

In order to upgrade, you can follow this guideline, with the help of an IDE:

• Upgrade to the latest version v1.x.x and check for deprecation notices. Avoid anything that is deprecated.

• HTTP clients have changed. If you relied on the HTTPlug client, you will have to either switch to the PSR-18 HTTP client or Async HTTP client. This is due to the deprecation of the synchronous part of the HTTPlug client.

• If you’re using named arguments, check the differences between v1 and v2. There are small, but breaking changes due to different names and or parameter orders.

• Else, if you are not using named arguments, check the parameter orders. This is best done with an IDE with first-class support for PHP.

• If your code is interacting with the internal service classes directly, look for alternatives. You can now use request builders and response processors if you have to. Check the advanced usage section for more details.

API Reference

\Firstred\PostNL

Namespaces

Attribute

\Firstred\PostNL\Attribute

Classes

SerializableProperty

class Firstred\PostNL\Attribute\SerializableProperty

Summary

Methods

• public __construct($type, $isArray, $aliases, $supportedServices)

Methods

public Firstred\PostNL\Attribute\SerializableProperty::__construct( $type, $isArray=false, $aliases=\[\], $supportedServices=\[\])

This indicates that the given property is serializable. All serialization details should

be passed to the attribute, making it completely serializable without relying on reflection

of the property itself.

Parameters

• $type (class-string | "bool" | "int" | "float" | "string") Property type

• $isArray (bool) Should the property be an array

• $aliases (string[]) Property shortname aliases such as Address

• $supportedServices (class-string[]) Supported services, empty array = all

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

Cache

\Firstred\PostNL\Cache

Interfaces

CacheableRequestEntityInterface

interface Firstred\PostNL\Cache\CacheableRequestEntityInterface

Summary

Methods

• public getCacheKey()

Methods

public Firstred\PostNL\Cache\CacheableRequestEntityInterface::getCacheKey()

This method returns a unique cache key for every unique cacheable request as defined by PSR-6.

See

https://www.php-fig.org/psr/psr-6/#definitions

Returns

string

CacheableServiceInterface

interface Firstred\PostNL\Cache\CacheableServiceInterface

Parent

Firstred\PostNL\Service\ServiceInterface

Parent

Firstred\PostNL\Clock\ClockAwareInterface

Summary

Methods

• public cacheResponseItem($item)

• public retrieveCachedResponseItem($cacheableRequestEntity)

• public removeCachedResponseItem($item)

• public getTtl()

• public setTtl($ttl)

• public getCache()

• public setCache($cache)

Methods

public Firstred\PostNL\Cache\CacheableServiceInterface::cacheResponseItem($item)

Cache an item.

Parameters

• $item (Psr\Cache\CacheItemInterface)

Since

2.0.0

public Firstred\PostNL\Cache\CacheableServiceInterface::retrieveCachedResponseItem($cacheableRequestEntity)

Retrieve a cached item.

Parameters

• $cacheableRequestEntity (Firstred\PostNL\Cache\CacheableRequestEntityInterface)

Returns

\Psr\Cache\CacheItemInterface | null

Throws

\Psr\Cache\InvalidArgumentException

Since

2.0.0

public Firstred\PostNL\Cache\CacheableServiceInterface::removeCachedResponseItem($item)

Delete an item from cache.

Parameters

• $item (Psr\Cache\CacheItemInterface)

Since

2.0.0

public Firstred\PostNL\Cache\CacheableServiceInterface::getTtl()

Returns

\DateInterval | \DateTimeInterface | int | null

Since

1.2.0

public Firstred\PostNL\Cache\CacheableServiceInterface::setTtl(\\DateInterval|\\DateTimeInterface|int $ttl=null)

Parameters

• $ttl (DateInterval | \DateTimeInterface | int | null)

Returns

static

Since

1.2.0

public Firstred\PostNL\Cache\CacheableServiceInterface::getCache()

Returns

\Psr\Cache\CacheItemPoolInterface | null

Since

1.2.0

public Firstred\PostNL\Cache\CacheableServiceInterface::setCache($cache=null)

Parameters

• $cache (Psr\Cache\CacheItemPoolInterface | null)

Returns

static

Since

1.2.0

Clock

\Firstred\PostNL\Clock

Interfaces

ClockAwareInterface

interface Firstred\PostNL\Clock\ClockAwareInterface

Summary

Methods

• public getClock()

• public setClock($clock)

Methods

public Firstred\PostNL\Clock\ClockAwareInterface::getClock()

Get the current clock.

Returns

\Psr\Clock\ClockInterface

Since

2.0.0

public Firstred\PostNL\Clock\ClockAwareInterface::setClock($clock)

Set the current clock.

Parameters

• $clock (Psr\Clock\ClockInterface)

Returns

void

Since

2.0.0

Traits

ClockAwareTrait

trait Firstred\PostNL\Clock\ClockAwareTrait

Properties

private static property Firstred\PostNL\Clock\ClockAwareTrait::$clock

Methods

public Firstred\PostNL\Clock\ClockAwareTrait::getClock()

Get the current clock.

Returns

\Psr\Clock\ClockInterface

Since

2.0.0

public Firstred\PostNL\Clock\ClockAwareTrait::setClock($clock)

Set the current clock.

Parameters

• $clock (Psr\Clock\ClockInterface)

Returns

void

Since

2.0.0

Entity

\Firstred\PostNL\Entity

Namespaces

Message

\Firstred\PostNL\Entity\Message

Classes

LabellingMessage

class Firstred\PostNL\Entity\Message\LabellingMessage

Parent

Firstred\PostNL\Entity\Message\Message

Summary

Methods

• public __construct($Printertype, $MessageID, $MessageTimeStamp)

• public getPrintertype()

• public setPrintertype($Printertype)

Properties

protected static property Firstred\PostNL\Entity\Message\LabellingMessage::$Printertype

Type

string | null

Methods

public Firstred\PostNL\Entity\Message\LabellingMessage::__construct($Printertype=\'GraphicFile\|PDF\', $MessageID=null, string|\\DateTimeInterface|null $MessageTimeStamp=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Message\LabellingMessage::getPrintertype()

Returns

string | null

public Firstred\PostNL\Entity\Message\LabellingMessage::setPrintertype($Printertype)

Parameters

• $Printertype (string | null)

Returns

static

Message

class Firstred\PostNL\Entity\Message\Message

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($MessageID, $MessageTimeStamp)

• public getMessageID()

• public setMessageID($MessageID)

• public getMessageTimeStamp()

• public setMessageTimeStamp($MessageTimeStamp)

Properties

protected static property Firstred\PostNL\Entity\Message\Message::$MessageID

Type

string | null

protected static property Firstred\PostNL\Entity\Message\Message::$MessageTimeStamp

Type

\DateTimeInterface | null

Methods

public Firstred\PostNL\Entity\Message\Message::__construct($MessageID=null, string|\\DateTimeInterface|null $MessageTimeStamp=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Message\Message::getMessageID()

Returns

string | null

public Firstred\PostNL\Entity\Message\Message::setMessageID($MessageID)

Parameters

• $MessageID (string | null)

Returns

static

public Firstred\PostNL\Entity\Message\Message::getMessageTimeStamp()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Message\Message::setMessageTimeStamp(string|\\DateTimeInterface|null $MessageTimeStamp=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Request

\Firstred\PostNL\Entity\Request

Classes

GetLocation

class Firstred\PostNL\Entity\Request\GetLocation

Parent

Firstred\PostNL\Entity\AbstractEntity

Implements

Firstred\PostNL\Cache\CacheableRequestEntityInterface

Summary

Methods

• public __construct($LocationCode, $Message, $RetailNetworkID)

• public getLocationCode()

• public setLocationCode($LocationCode)

• public getMessage()

• public setMessage($Message)

• public getRetailNetworkID()

• public setRetailNetworkID($RetailNetworkID)

• public getCacheKey()

Properties

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)

Parameters

• $LocationCode (string | null)

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

• $RetailNetworkID (string | null)

public Firstred\PostNL\Entity\Request\GetLocation::getLocationCode()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetLocation::setLocationCode($LocationCode)

Parameters

• $LocationCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetLocation::getMessage()

Returns

\Firstred\PostNL\Entity\Message\Message | null

public Firstred\PostNL\Entity\Request\GetLocation::setMessage($Message)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GetLocation::getRetailNetworkID()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetLocation::setRetailNetworkID($RetailNetworkID)

Parameters

• $RetailNetworkID (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetLocation::getCacheKey()

This method returns a unique cache key for every unique cacheable request as defined by PSR-6.

See

https://www.php-fig.org/psr/psr-6/#definitions

Returns

string

GetSignature

class Firstred\PostNL\Entity\Request\GetSignature

Parent

Firstred\PostNL\Entity\AbstractEntity

Implements

Firstred\PostNL\Cache\CacheableRequestEntityInterface

Summary

Methods

• public __construct($Shipment, $Customer, $Message)

• public getMessage()

• public setMessage($Message)

• public getCustomer()

• public setCustomer($Customer)

• public getShipment()

• public setShipment($Shipment)

• public getCacheKey()

Properties

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

Methods

public Firstred\PostNL\Entity\Request\GetSignature::__construct($Shipment=null, $Customer=null, $Message=null)

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::getMessage()

Returns

\Firstred\PostNL\Entity\Message\Message | null

public Firstred\PostNL\Entity\Request\GetSignature::setMessage($Message)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GetSignature::getCustomer()

Returns

\Firstred\PostNL\Entity\Customer | null

public Firstred\PostNL\Entity\Request\GetSignature::setCustomer($Customer)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GetSignature::getShipment()

Returns

\Firstred\PostNL\Entity\Shipment | null

public Firstred\PostNL\Entity\Request\GetSignature::setShipment($Shipment)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GetSignature::getCacheKey()

This method returns a unique cache key for every unique cacheable request as defined by PSR-6.

See

https://www.php-fig.org/psr/psr-6/#definitions

Returns

string

GetSentDate

class Firstred\PostNL\Entity\Request\GetSentDate

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($AllowSundaySorting, $City, $CountryCode, $HouseNr, $HouseNrExt, $Options, $PostalCode, $DeliveryDate, $Street, $ShippingDuration)

• public getCity()

• public setCity($City)

• public getCountryCode()

• public setCountryCode($CountryCode)

• public getHouseNr()

• public setHouseNr($HouseNr)

• public getHouseNrExt()

• public setHouseNrExt($HouseNrExt)

• public getOptions()

• public setOptions($Options)

• public getShippingDuration()

• public setShippingDuration($ShippingDuration)

• public getStreet()

• public setStreet($Street)

• public getAllowSundaySorting()

• public getDeliveryDate()

• public getPostalCode()

• public setDeliveryDate($deliveryDate)

• public setPostalCode($postcode)

• public setAllowSundaySorting($AllowSundaySorting)

Properties

protected static property Firstred\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 property Firstred\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, \\DateTimeInterface|string|null $DeliveryDate=null, $Street=null, $ShippingDuration=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Request\GetSentDate::getCity()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetSentDate::setCity($City)

Parameters

• $City (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetSentDate::getCountryCode()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetSentDate::setCountryCode($CountryCode)

Parameters

• $CountryCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetSentDate::getHouseNr()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetSentDate::setHouseNr($HouseNr)

Parameters

• $HouseNr (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetSentDate::getHouseNrExt()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetSentDate::setHouseNrExt($HouseNrExt)

Parameters

• $HouseNrExt (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetSentDate::getOptions()

Returns

array | null

public Firstred\PostNL\Entity\Request\GetSentDate::setOptions($Options)

Parameters

• $Options (array | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetSentDate::getShippingDuration()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetSentDate::setShippingDuration($ShippingDuration)

Parameters

• $ShippingDuration (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetSentDate::getStreet()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetSentDate::setStreet($Street)

Parameters

• $Street (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetSentDate::getAllowSundaySorting()

Returns

bool | null

public Firstred\PostNL\Entity\Request\GetSentDate::getDeliveryDate()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Request\GetSentDate::getPostalCode()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetSentDate::setDeliveryDate(string|\\DateTimeInterface|null $deliveryDate=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Request\GetSentDate::setPostalCode($postcode=null)

Parameters

• $postcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetSentDate::setAllowSundaySorting(string|bool|int|null $AllowSundaySorting=null)

Since

1.0.0

Since

1.0.0

GetLocationsInArea

class Firstred\PostNL\Entity\Request\GetLocationsInArea

Parent

Firstred\PostNL\Entity\AbstractEntity

Implements

Firstred\PostNL\Cache\CacheableRequestEntityInterface

Summary

Methods

• public __construct($Countrycode, $Location, $Message)

• public getCountrycode()

• public setCountrycode($Countrycode)

• public getLocation()

• public setLocation($Location)

• public getMessage()

• public setMessage($Message)

• public getCacheKey()

Properties

protected static property Firstred\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)

Parameters

• $Countrycode (string | null)

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

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

public Firstred\PostNL\Entity\Request\GetLocationsInArea::getCountrycode()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetLocationsInArea::setCountrycode($Countrycode)

Parameters

• $Countrycode (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetLocationsInArea::getLocation()

Returns

\Firstred\PostNL\Entity\Location | null

public Firstred\PostNL\Entity\Request\GetLocationsInArea::setLocation($Location)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GetLocationsInArea::getMessage()

Returns

\Firstred\PostNL\Entity\Message\Message | null

public Firstred\PostNL\Entity\Request\GetLocationsInArea::setMessage($Message)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GetLocationsInArea::getCacheKey()

This method returns a unique cache key for every unique cacheable request as defined by PSR-6.

See

https://www.php-fig.org/psr/psr-6/#definitions

Returns

string

GetNearestLocations

class Firstred\PostNL\Entity\Request\GetNearestLocations

Parent

Firstred\PostNL\Entity\AbstractEntity

Implements

Firstred\PostNL\Cache\CacheableRequestEntityInterface

Summary

Methods

• public __construct($Countrycode, $Location, $Message)

• public getCountrycode()

• public setCountrycode($Countrycode)

• public getLocation()

• public setLocation($Location)

• public getMessage()

• public setMessage($Message)

• public getCacheKey()

Properties

protected static property Firstred\PostNL\Entity\Request\GetNearestLocations::$Countrycode

Type

string | null

protected static property Firstred\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)

Parameters

• $Countrycode (string | null)

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

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

public Firstred\PostNL\Entity\Request\GetNearestLocations::getCountrycode()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetNearestLocations::setCountrycode($Countrycode)

Parameters

• $Countrycode (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetNearestLocations::getLocation()

Returns

\Firstred\PostNL\Entity\Location | null

public Firstred\PostNL\Entity\Request\GetNearestLocations::setLocation($Location)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GetNearestLocations::getMessage()

Returns

\Firstred\PostNL\Entity\Message\Message | null

public Firstred\PostNL\Entity\Request\GetNearestLocations::setMessage($Message)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GetNearestLocations::getCacheKey()

This method returns a unique cache key for every unique cacheable request as defined by PSR-6.

See

https://www.php-fig.org/psr/psr-6/#definitions

Returns

string

CompleteStatusByReference

class Firstred\PostNL\Entity\Request\CompleteStatusByReference

Parent

Firstred\PostNL\Entity\AbstractEntity

Implements

Firstred\PostNL\Cache\CacheableRequestEntityInterface

Summary

Methods

• public __construct($Shipment, $Customer, $Message)

• public getMessage()

• public setMessage($Message)

• public getCustomer()

• public setCustomer($Customer)

• public getShipment()

• public setShipment($Shipment)

• public getCacheKey()

Properties

protected static property Firstred\PostNL\Entity\Request\CompleteStatusByReference::$Message

Type

\Firstred\PostNL\Entity\Message\Message | null

protected static property Firstred\PostNL\Entity\Request\CompleteStatusByReference::$Customer

Type

\Firstred\PostNL\Entity\Customer | null

protected static property Firstred\PostNL\Entity\Request\CompleteStatusByReference::$Shipment

Type

\Firstred\PostNL\Entity\Shipment | null

Methods

public Firstred\PostNL\Entity\Request\CompleteStatusByReference::__construct($Shipment=null, $Customer=null, $Message=null)

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::getMessage()

Returns

\Firstred\PostNL\Entity\Message\Message | null

public Firstred\PostNL\Entity\Request\CompleteStatusByReference::setMessage($Message)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\CompleteStatusByReference::getCustomer()

Returns

\Firstred\PostNL\Entity\Customer | null

public Firstred\PostNL\Entity\Request\CompleteStatusByReference::setCustomer($Customer)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\CompleteStatusByReference::getShipment()

Returns

\Firstred\PostNL\Entity\Shipment | null

public Firstred\PostNL\Entity\Request\CompleteStatusByReference::setShipment($Shipment)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\CompleteStatusByReference::getCacheKey()

This method returns a unique cache key for every unique cacheable request as defined by PSR-6.

See

https://www.php-fig.org/psr/psr-6/#definitions

Returns

string

CompleteStatus

class Firstred\PostNL\Entity\Request\CompleteStatus

Parent

Firstred\PostNL\Entity\AbstractEntity

Implements

Firstred\PostNL\Cache\CacheableRequestEntityInterface

Summary

Methods

• public __construct($Shipment, $Customer, $Message)

• public getMessage()

• public setMessage($Message)

• public getCustomer()

• public setCustomer($Customer)

• public getShipment()

• public setShipment($Shipment)

• public getCacheKey()

Properties

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)

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::getMessage()

Returns

\Firstred\PostNL\Entity\Message\Message | null

public Firstred\PostNL\Entity\Request\CompleteStatus::setMessage($Message)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\CompleteStatus::getCustomer()

Returns

\Firstred\PostNL\Entity\Customer | null

public Firstred\PostNL\Entity\Request\CompleteStatus::setCustomer($Customer)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\CompleteStatus::getShipment()

Returns

\Firstred\PostNL\Entity\Shipment | null

public Firstred\PostNL\Entity\Request\CompleteStatus::setShipment($Shipment)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\CompleteStatus::getCacheKey()

This method returns a unique cache key for every unique cacheable request as defined by PSR-6.

See

https://www.php-fig.org/psr/psr-6/#definitions

Returns

string

GetTimeframes

class Firstred\PostNL\Entity\Request\GetTimeframes

Parent

Firstred\PostNL\Entity\AbstractEntity

Implements

Firstred\PostNL\Cache\CacheableRequestEntityInterface

Summary

Methods

• public __construct($Message, $Timeframes)

• public setTimeframe($timeframes)

• public setTimeframes($timeframes)

• public getTimeframe()

• public getTimeframes()

• public getMessage()

• public setMessage($Message)

• public getCacheKey()

Properties

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)

Parameters

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

• $Timeframes (array | null)

public Firstred\PostNL\Entity\Request\GetTimeframes::setTimeframe($timeframes)

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\Entity\Request\GetTimeframes::setTimeframes(\\Firstred\\PostNL\\Entity\\Timeframe|array|null $timeframes)

Parameters

• $timeframes TimeFrame|Timeframe[]|null

Since

1.2.0

public Firstred\PostNL\Entity\Request\GetTimeframes::getTimeframe()

Returns

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

Since

1.0.0

public Firstred\PostNL\Entity\Request\GetTimeframes::getTimeframes()

Returns

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

Since

1.2.0

public Firstred\PostNL\Entity\Request\GetTimeframes::getMessage()

Returns

\Firstred\PostNL\Entity\Message\Message | null

public Firstred\PostNL\Entity\Request\GetTimeframes::setMessage($Message)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GetTimeframes::getCacheKey()

This method returns a unique cache key for every unique cacheable request as defined by PSR-6.

See

https://www.php-fig.org/psr/psr-6/#definitions

Returns

string

CurrentStatusByReference

class Firstred\PostNL\Entity\Request\CurrentStatusByReference

Parent

Firstred\PostNL\Entity\AbstractEntity

Implements

Firstred\PostNL\Cache\CacheableRequestEntityInterface

Summary

Methods

• public __construct($Shipment, $Customer, $Message)

• public getMessage()

• public setMessage($Message)

• public getCustomer()

• public setCustomer($Customer)

• public getShipment()

• public setShipment($Shipment)

• public getCacheKey()

Properties

protected static property Firstred\PostNL\Entity\Request\CurrentStatusByReference::$Message

Type

\Firstred\PostNL\Entity\Message\Message | null

protected static property Firstred\PostNL\Entity\Request\CurrentStatusByReference::$Customer

Type

\Firstred\PostNL\Entity\Customer | null

protected static property Firstred\PostNL\Entity\Request\CurrentStatusByReference::$Shipment

Type

\Firstred\PostNL\Entity\Shipment | null

Methods

public Firstred\PostNL\Entity\Request\CurrentStatusByReference::__construct($Shipment=null, $Customer=null, $Message=null)

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::getMessage()

Returns

\Firstred\PostNL\Entity\Message\Message | null

public Firstred\PostNL\Entity\Request\CurrentStatusByReference::setMessage($Message)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\CurrentStatusByReference::getCustomer()

Returns

\Firstred\PostNL\Entity\Customer | null

public Firstred\PostNL\Entity\Request\CurrentStatusByReference::setCustomer($Customer)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\CurrentStatusByReference::getShipment()

Returns

\Firstred\PostNL\Entity\Shipment | null

public Firstred\PostNL\Entity\Request\CurrentStatusByReference::setShipment($Shipment)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\CurrentStatusByReference::getCacheKey()

This method returns a unique cache key for every unique cacheable request as defined by PSR-6.

See

https://www.php-fig.org/psr/psr-6/#definitions

Returns

string

GenerateBarcode

class Firstred\PostNL\Entity\Request\GenerateBarcode

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Barcode, $Customer)

• public getCustomer()

• public setCustomer($Customer)

• public getBarcode()

• public setBarcode($Barcode)

Properties

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)

Parameters

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

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

public Firstred\PostNL\Entity\Request\GenerateBarcode::getCustomer()

Returns

\Firstred\PostNL\Entity\Customer | null

public Firstred\PostNL\Entity\Request\GenerateBarcode::setCustomer($Customer)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GenerateBarcode::getBarcode()

Returns

\Firstred\PostNL\Entity\Barcode | null

public Firstred\PostNL\Entity\Request\GenerateBarcode::setBarcode($Barcode)

Parameters

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

Returns

static

CurrentStatus

class Firstred\PostNL\Entity\Request\CurrentStatus

Parent

Firstred\PostNL\Entity\AbstractEntity

Implements

Firstred\PostNL\Cache\CacheableRequestEntityInterface

Summary

Methods

• public __construct($Shipment, $Customer, $Message)

• public getMessage()

• public setMessage($Message)

• public getCustomer()

• public setCustomer($Customer)

• public getShipment()

• public setShipment($Shipment)

• public getCacheKey()

Properties

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)

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::getMessage()

Returns

\Firstred\PostNL\Entity\Message\Message | null

public Firstred\PostNL\Entity\Request\CurrentStatus::setMessage($Message)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\CurrentStatus::getCustomer()

Returns

\Firstred\PostNL\Entity\Customer | null

public Firstred\PostNL\Entity\Request\CurrentStatus::setCustomer($Customer)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\CurrentStatus::getShipment()

Returns

\Firstred\PostNL\Entity\Shipment | null

public Firstred\PostNL\Entity\Request\CurrentStatus::setShipment($Shipment)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\CurrentStatus::getCacheKey()

This method returns a unique cache key for every unique cacheable request as defined by PSR-6.

See

https://www.php-fig.org/psr/psr-6/#definitions

Returns

string

GetUpdatedShipments

class Firstred\PostNL\Entity\Request\GetUpdatedShipments

Parent

Firstred\PostNL\Entity\AbstractEntity

Implements

Firstred\PostNL\Cache\CacheableRequestEntityInterface

Summary

Methods

• public __construct($Customer, $DateTimeFrom, $DateTimeTo)

• public getCustomer()

• public setCustomer($Customer)

• public getDateTimeFrom()

• public setDateTimeFrom($DateTimeFrom)

• public getDateTimeTo()

• public setDateTimeTo($DateTimeTo)

• public getCacheKey()

Properties

protected static property Firstred\PostNL\Entity\Request\GetUpdatedShipments::$Customer

Type

\Firstred\PostNL\Entity\Customer | null

protected static property Firstred\PostNL\Entity\Request\GetUpdatedShipments::$DateTimeFrom

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Request\GetUpdatedShipments::$DateTimeTo

Type

\DateTimeInterface | null

Methods

public Firstred\PostNL\Entity\Request\GetUpdatedShipments::__construct($Customer=null, $DateTimeFrom=null, $DateTimeTo=null)

Parameters

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

• $DateTimeFrom (DateTimeInterface | null)

• $DateTimeTo (DateTimeInterface | null)

public Firstred\PostNL\Entity\Request\GetUpdatedShipments::getCustomer()

Returns

\Firstred\PostNL\Entity\Customer | null

public Firstred\PostNL\Entity\Request\GetUpdatedShipments::setCustomer($Customer)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GetUpdatedShipments::getDateTimeFrom()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Request\GetUpdatedShipments::setDateTimeFrom($DateTimeFrom)

Parameters

• $DateTimeFrom (DateTimeInterface | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetUpdatedShipments::getDateTimeTo()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Request\GetUpdatedShipments::setDateTimeTo($DateTimeTo)

Parameters

• $DateTimeTo (DateTimeInterface | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetUpdatedShipments::getCacheKey()

This method returns a unique cache key for every unique cacheable request as defined by PSR-6.

See

https://www.php-fig.org/psr/psr-6/#definitions

Returns

string

GenerateLabel

class Firstred\PostNL\Entity\Request\GenerateLabel

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Shipments, $Message, $Customer, $LabelSignature)

• public getCustomer()

• public setCustomer($Customer)

• public getMessage()

• public setMessage($Message)

• public getShipments()

• public setShipments($Shipments)

• public getLabelSignature()

• public setLabelSignature($LabelSignature)

• public jsonSerialize()

Properties

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

protected static property Firstred\PostNL\Entity\Request\GenerateLabel::$LabelSignature

Type

string | null

Methods

public Firstred\PostNL\Entity\Request\GenerateLabel::__construct($Shipments=null, $Message=null, $Customer=null, $LabelSignature=null)

Parameters

• $Shipments (array | null)

• $Message (Firstred\PostNL\Entity\Message\LabellingMessage | null)

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

• $LabelSignature (string | null)

public Firstred\PostNL\Entity\Request\GenerateLabel::getCustomer()

Returns

\Firstred\PostNL\Entity\Customer | null

public Firstred\PostNL\Entity\Request\GenerateLabel::setCustomer($Customer)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GenerateLabel::getMessage()

Returns

\Firstred\PostNL\Entity\Message\LabellingMessage | null

public Firstred\PostNL\Entity\Request\GenerateLabel::setMessage($Message)

Parameters

• $Message (Firstred\PostNL\Entity\Message\LabellingMessage | null)

Returns

static

public Firstred\PostNL\Entity\Request\GenerateLabel::getShipments()

Returns

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

public Firstred\PostNL\Entity\Request\GenerateLabel::setShipments($Shipments)

Parameters

• $Shipments (Firstred\PostNL\Entity\Shipment[] | null)

Returns

static

public Firstred\PostNL\Entity\Request\GenerateLabel::getLabelSignature()

Returns

string | null

public Firstred\PostNL\Entity\Request\GenerateLabel::setLabelSignature($LabelSignature)

Parameters

• $LabelSignature (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GenerateLabel::jsonSerialize()

Returns

array

Throws

\Firstred\PostNL\Exception\ServiceNotSetException

SendShipment

class Firstred\PostNL\Entity\Request\SendShipment

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Shipments, $Message, $Customer)

• public getCustomer()

• public setCustomer($Customer)

• public getMessage()

• public setMessage($Message)

• public getShipments()

• public setShipments($Shipments)

• public jsonSerialize()

Properties

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)

Parameters

• $Shipments (array | null)

• $Message (Firstred\PostNL\Entity\Message\LabellingMessage | null)

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

public Firstred\PostNL\Entity\Request\SendShipment::getCustomer()

Returns

\Firstred\PostNL\Entity\Customer | null

public Firstred\PostNL\Entity\Request\SendShipment::setCustomer($Customer)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\SendShipment::getMessage()

Returns

\Firstred\PostNL\Entity\Message\LabellingMessage | null

public Firstred\PostNL\Entity\Request\SendShipment::setMessage($Message)

Parameters

• $Message (Firstred\PostNL\Entity\Message\LabellingMessage | null)

Returns

static

public Firstred\PostNL\Entity\Request\SendShipment::getShipments()

Returns

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

public Firstred\PostNL\Entity\Request\SendShipment::setShipments($Shipments)

Parameters

• $Shipments (Firstred\PostNL\Entity\Shipment[] | null)

Returns

static

public Firstred\PostNL\Entity\Request\SendShipment::jsonSerialize()

Returns

array

Throws

\Firstred\PostNL\Exception\ServiceNotSetException

Confirming

class Firstred\PostNL\Entity\Request\Confirming

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Shipments, $Customer, $Message)

• public getCustomer()

• public setCustomer($Customer)

• public getMessage()

• public setMessage($Message)

• public getShipments()

• public setShipments($Shipments)

• public jsonSerialize()

Properties

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)

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::getCustomer()

Returns

\Firstred\PostNL\Entity\Customer | null

public Firstred\PostNL\Entity\Request\Confirming::setCustomer($Customer)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\Confirming::getMessage()

Returns

\Firstred\PostNL\Entity\Message\Message | null

public Firstred\PostNL\Entity\Request\Confirming::setMessage($Message)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\Confirming::getShipments()

Returns

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

public Firstred\PostNL\Entity\Request\Confirming::setShipments($Shipments)

Parameters

• $Shipments (Firstred\PostNL\Entity\Shipment[] | null)

Returns

static

public Firstred\PostNL\Entity\Request\Confirming::jsonSerialize()

Returns

array

GetDeliveryDate

class Firstred\PostNL\Entity\Request\GetDeliveryDate

Parent

Firstred\PostNL\Entity\AbstractEntity

Implements

Firstred\PostNL\Cache\CacheableRequestEntityInterface

Summary

Methods

• public __construct($AllowSundaySorting, $City, $CountryCode, $CutOffTimes, $HouseNr, $HouseNrExt, $Options, $OriginCountryCode, $PostalCode, $ShippingDate, $ShippingDuration, $Street, $GetDeliveryDate, $Message)

• public getCity()

• public setCity($City)

• public getCountryCode()

• public setCountryCode($CountryCode)

• public getCutOffTimes()

• public setCutOffTimes($CutOffTimes)

• public getHouseNr()

• public setHouseNr($HouseNr)

• public getHouseNrExt()

• public setHouseNrExt($HouseNrExt)

• public getOptions()

• public setOptions($Options)

• public getOriginCountryCode()

• public setOriginCountryCode($OriginCountryCode)

• public getShippingDuration()

• public setShippingDuration($ShippingDuration)

• public getStreet()

• public setStreet($Street)

• public getGetDeliveryDate()

• public setGetDeliveryDate($GetDeliveryDate)

• public getMessage()

• public setMessage($Message)

• public getShippingDate()

• public setShippingDate($shippingDate)

• public getPostalCode()

• public setPostalCode($PostalCode)

• public getAllowSundaySorting()

• public setAllowSundaySorting($AllowSundaySorting)

• public getCacheKey()

Properties

protected static property Firstred\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

Type

string[] | null

protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$OriginCountryCode

Type

string | null

protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$PostalCode

Type

string | null

protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$ShippingDate

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$ShippingDuration

Type

string | null

protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$Street

Type

string | null

protected static property Firstred\PostNL\Entity\Request\GetDeliveryDate::$GetDeliveryDate

Type

self | 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, $OriginCountryCode=null, $PostalCode=null, \\DateTimeInterface|string|null $ShippingDate=null, $ShippingDuration=null, $Street=null, $GetDeliveryDate=null, $Message=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getCity()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setCity($City)

Parameters

• $City (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getCountryCode()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setCountryCode($CountryCode)

Parameters

• $CountryCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getCutOffTimes()

Returns

array | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setCutOffTimes($CutOffTimes)

Parameters

• $CutOffTimes (array | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getHouseNr()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setHouseNr($HouseNr)

Parameters

• $HouseNr (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getHouseNrExt()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setHouseNrExt($HouseNrExt)

Parameters

• $HouseNrExt (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getOptions()

Returns

array | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setOptions($Options)

Parameters

• $Options (string[] | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getOriginCountryCode()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setOriginCountryCode($OriginCountryCode)

Parameters

• $OriginCountryCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getShippingDuration()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setShippingDuration($ShippingDuration)

Parameters

• $ShippingDuration (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getStreet()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setStreet($Street)

Parameters

• $Street (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getGetDeliveryDate()

Returns

static | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setGetDeliveryDate($GetDeliveryDate)

Parameters

• $GetDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getMessage()

Returns

\Firstred\PostNL\Entity\Message\Message | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setMessage($Message)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getShippingDate()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setShippingDate(\\DateTimeInterface|string|null $shippingDate=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getPostalCode()

Returns

string | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setPostalCode($PostalCode=null)

Parameters

• $PostalCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getAllowSundaySorting()

Returns

bool | null

public Firstred\PostNL\Entity\Request\GetDeliveryDate::setAllowSundaySorting(bool|int|string|null $AllowSundaySorting=null)

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\Entity\Request\GetDeliveryDate::getCacheKey()

This method returns a unique cache key for every unique cacheable request as defined by PSR-6.

See

https://www.php-fig.org/psr/psr-6/#definitions

Returns

string

GetSentDateRequest

class Firstred\PostNL\Entity\Request\GetSentDateRequest

Parent

Firstred\PostNL\Entity\AbstractEntity

Implements

Firstred\PostNL\Cache\CacheableRequestEntityInterface

Summary

Methods

• public __construct($GetSentDate, $Message)

• public getGetSentDate()

• public setGetSentDate($GetSentDate)

• public getMessage()

• public setMessage($Message)

• public getCacheKey()

Properties

protected static property Firstred\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)

Parameters

• $GetSentDate (Firstred\PostNL\Entity\Request\GetSentDate | null)

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

public Firstred\PostNL\Entity\Request\GetSentDateRequest::getGetSentDate()

Returns

\Firstred\PostNL\Entity\Request\GetSentDate | null

public Firstred\PostNL\Entity\Request\GetSentDateRequest::setGetSentDate($GetSentDate)

Parameters

• $GetSentDate (Firstred\PostNL\Entity\Request\GetSentDate | null)

Returns

static

public Firstred\PostNL\Entity\Request\GetSentDateRequest::getMessage()

Returns

\Firstred\PostNL\Entity\Message\Message | null

public Firstred\PostNL\Entity\Request\GetSentDateRequest::setMessage($Message)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Request\GetSentDateRequest::getCacheKey()

This method returns a unique cache key for every unique cacheable request as defined by PSR-6.

See

https://www.php-fig.org/psr/psr-6/#definitions

Returns

string

Response

\Firstred\PostNL\Entity\Response

Classes

GetLocationsResult

class Firstred\PostNL\Entity\Response\GetLocationsResult

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($ResponseLocation)

• public getResponseLocation()

• public setResponseLocation($ResponseLocation)

Properties

protected static property Firstred\PostNL\Entity\Response\GetLocationsResult::$ResponseLocation

Type

\Firstred\PostNL\Entity\Response\ResponseLocation[] | null

Methods

public Firstred\PostNL\Entity\Response\GetLocationsResult::__construct($ResponseLocation=null)

Parameters

• $ResponseLocation (array | null)

public Firstred\PostNL\Entity\Response\GetLocationsResult::getResponseLocation()

Returns

\Firstred\PostNL\Entity\Response\ResponseLocation[] | null

public Firstred\PostNL\Entity\Response\GetLocationsResult::setResponseLocation($ResponseLocation)

Parameters

• $ResponseLocation (Firstred\PostNL\Entity\Response\ResponseLocation[] | null)

Returns

static

SignatureResponse

class Firstred\PostNL\Entity\Response\SignatureResponse

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Signature)

• public getSignature()

• public setSignature($Signature)

Properties

protected static property Firstred\PostNL\Entity\Response\SignatureResponse::$Signature

Type

\Firstred\PostNL\Entity\Signature | null

Methods

public Firstred\PostNL\Entity\Response\SignatureResponse::__construct($Signature=null)

Parameters

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

public Firstred\PostNL\Entity\Response\SignatureResponse::getSignature()

Returns

\Firstred\PostNL\Entity\Signature | null

public Firstred\PostNL\Entity\Response\SignatureResponse::setSignature($Signature)

Parameters

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

Returns

static

GetNearestLocationsResponse

class Firstred\PostNL\Entity\Response\GetNearestLocationsResponse

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($GetLocationsResult)

• public getGetLocationsResult()

• public setGetLocationsResult($GetLocationsResult)

• public static jsonDeserialize($json)

• public jsonSerialize()

Properties

protected static property Firstred\PostNL\Entity\Response\GetNearestLocationsResponse::$GetLocationsResult

Type

\Firstred\PostNL\Entity\Response\GetLocationsResult | null

Methods

public Firstred\PostNL\Entity\Response\GetNearestLocationsResponse::__construct($GetLocationsResult=null)

Parameters

• $GetLocationsResult (Firstred\PostNL\Entity\Response\GetLocationsResult | null)

public Firstred\PostNL\Entity\Response\GetNearestLocationsResponse::getGetLocationsResult()

Returns

\Firstred\PostNL\Entity\Response\GetLocationsResult | null

public Firstred\PostNL\Entity\Response\GetNearestLocationsResponse::setGetLocationsResult($GetLocationsResult)

Parameters

• $GetLocationsResult (Firstred\PostNL\Entity\Response\GetLocationsResult | null)

Returns

static

public static Firstred\PostNL\Entity\Response\GetNearestLocationsResponse::jsonDeserialize($json)

Parameters

• $json (stdClass)

Returns

\Firstred\PostNL\Entity\Response\GetNearestLocationsResponse

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.2.0

public Firstred\PostNL\Entity\Response\GetNearestLocationsResponse::jsonSerialize()

Returns

array

Throws

\Firstred\PostNL\Exception\ServiceNotSetException

ResponseShipment

class Firstred\PostNL\Entity\Response\ResponseShipment

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Barcode, $ProductCodeDelivery, $Labels, $DownPartnerBarcode, $DownPartnerID, $DownPartnerLocation, $Warnings, $CodingText)

• public getBarcode()

• public setBarcode($Barcode)

• public getDownPartnerBarcode()

• public setDownPartnerBarcode($DownPartnerBarcode)

• public getDownPartnerID()

• public setDownPartnerID($DownPartnerID)

• public getDownPartnerLocation()

• public setDownPartnerLocation($DownPartnerLocation)

• public getLabels()

• public setLabels($Labels)

• public getProductCodeDelivery()

• public setProductCodeDelivery($ProductCodeDelivery)

• public getWarnings()

• public setWarnings($Warnings)

• public setCodingText($CodingText)

Properties

protected static property Firstred\PostNL\Entity\Response\ResponseShipment::$Barcode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseShipment::$DownPartnerBarcode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseShipment::$DownPartnerID

Type

string | null

protected static property Firstred\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 property Firstred\PostNL\Entity\Response\ResponseShipment::$ProductCodeDelivery

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseShipment::$Warnings

Type

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

protected static property Firstred\PostNL\Entity\Response\ResponseShipment::$CodingText

Type

string | null

Methods

public Firstred\PostNL\Entity\Response\ResponseShipment::__construct($Barcode=null, $ProductCodeDelivery=null, $Labels=null, $DownPartnerBarcode=null, $DownPartnerID=null, $DownPartnerLocation=null, $Warnings=null, $CodingText=null)

Parameters

• $Barcode (string | null)

• $ProductCodeDelivery (string | null)

• $Labels (array | null)

• $DownPartnerBarcode (string | null)

• $DownPartnerID (string | null)

• $DownPartnerLocation (string | null)

• $Warnings (array | null)

public Firstred\PostNL\Entity\Response\ResponseShipment::getBarcode()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseShipment::setBarcode($Barcode)

Parameters

• $Barcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseShipment::getDownPartnerBarcode()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseShipment::setDownPartnerBarcode($DownPartnerBarcode)

Parameters

• $DownPartnerBarcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseShipment::getDownPartnerID()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseShipment::setDownPartnerID($DownPartnerID)

Parameters

• $DownPartnerID (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseShipment::getDownPartnerLocation()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseShipment::setDownPartnerLocation($DownPartnerLocation)

Parameters

• $DownPartnerLocation (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseShipment::getLabels()

Returns

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

public Firstred\PostNL\Entity\Response\ResponseShipment::setLabels($Labels)

Parameters

• $Labels (Firstred\PostNL\Entity\Label[] | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseShipment::getProductCodeDelivery()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseShipment::setProductCodeDelivery($ProductCodeDelivery)

Parameters

• $ProductCodeDelivery (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseShipment::getWarnings()

Returns

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

public Firstred\PostNL\Entity\Response\ResponseShipment::setWarnings($Warnings)

Parameters

• $Warnings (Firstred\PostNL\Entity\Warning[] | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseShipment::setCodingText($CodingText)

Parameters

• $CodingText (string | null)

Returns

static

CompleteStatusResponseEvent

class Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Code, $Description, $DestinationLocationCode, $LocationCode, $RouteCode, $RouteName, $TimeStamp)

• public getCode()

• public setCode($Code)

• public getDescription()

• public setDescription($Description)

• public getDestinationLocationCode()

• public setDestinationLocationCode($DestinationLocationCode)

• public getLocationCode()

• public setLocationCode($LocationCode)

• public getRouteCode()

• public setRouteCode($RouteCode)

• public getRouteName()

• public setRouteName($RouteName)

• public getTimeStamp()

• public setTimeStamp($TimeStamp)

Properties

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$Code

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$Description

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$DestinationLocationCode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$LocationCode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$RouteCode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$RouteName

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::$TimeStamp

Type

\DateTimeInterface | null

Methods

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::__construct($Code=null, $Description=null, $DestinationLocationCode=null, $LocationCode=null, $RouteCode=null, $RouteName=null, $TimeStamp=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::getCode()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::setCode($Code)

Parameters

• $Code (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::getDescription()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::setDescription($Description)

Parameters

• $Description (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::getDestinationLocationCode()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::setDestinationLocationCode($DestinationLocationCode)

Parameters

• $DestinationLocationCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::getLocationCode()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::setLocationCode($LocationCode)

Parameters

• $LocationCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::getRouteCode()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::setRouteCode($RouteCode)

Parameters

• $RouteCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::getRouteName()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::setRouteName($RouteName)

Parameters

• $RouteName (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::getTimeStamp()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent::setTimeStamp(string|\\DateTimeInterface|null $TimeStamp=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

ResponseTimeframes

class Firstred\PostNL\Entity\Response\ResponseTimeframes

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($ReasonNoTimeframes, $Timeframes)

• public getReasonNoTimeframes()

• public setReasonNoTimeframes($ReasonNoTimeframes)

• public getTimeframes()

• public setTimeframes($Timeframes)

• public jsonSerialize()

Properties

protected static property Firstred\PostNL\Entity\Response\ResponseTimeframes::$ReasonNoTimeframes

Type

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

protected static property Firstred\PostNL\Entity\Response\ResponseTimeframes::$Timeframes

Type

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

Methods

public Firstred\PostNL\Entity\Response\ResponseTimeframes::__construct($ReasonNoTimeframes=null, $Timeframes=null)

Parameters

• $ReasonNoTimeframes (array | null)

• $Timeframes (array | null)

public Firstred\PostNL\Entity\Response\ResponseTimeframes::getReasonNoTimeframes()

Returns

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

public Firstred\PostNL\Entity\Response\ResponseTimeframes::setReasonNoTimeframes($ReasonNoTimeframes)

Parameters

• $ReasonNoTimeframes (Firstred\PostNL\Entity\ReasonNoTimeframe[] | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseTimeframes::getTimeframes()

Returns

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

public Firstred\PostNL\Entity\Response\ResponseTimeframes::setTimeframes($Timeframes)

Parameters

• $Timeframes (Firstred\PostNL\Entity\Timeframe[] | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseTimeframes::jsonSerialize()

Returns

array

Throws

\Firstred\PostNL\Exception\ServiceNotSetException

CompleteStatusResponseShipment

class Firstred\PostNL\Entity\Response\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 getAddresses()

• public setAddresses($Addresses)

• public getAmounts()

• public setAmounts($Amounts)

• public getBarcode()

• public setBarcode($Barcode)

• public getCustomer()

• public setCustomer($Customer)

• public getDimension()

• public setDimension($Dimension)

• public getEvents()

• public setEvents($Events)

• public getExpectation()

• public setExpectation($Expectation)

• public getGroups()

• public setGroups($Groups)

• public getMainBarcode()

• public setMainBarcode($MainBarcode)

• public getOldStatuses()

• public setOldStatuses($OldStatuses)

• public getProductCode()

• public setProductCode($ProductCode)

• public getProductDescription()

• public setProductDescription($ProductDescription)

• public getProductOptions()

• public setProductOptions($ProductOptions)

• public getReference()

• public setReference($Reference)

• public getShipmentAmount()

• public setShipmentAmount($ShipmentAmount)

• public getShipmentCounter()

• public setShipmentCounter($ShipmentCounter)

• public getStatus()

• public setStatus($Status)

• public getWarnings()

• public setWarnings($Warnings)

• public getDeliveryDate()

• public setDeliveryDate($DeliveryDate)

• public static jsonDeserialize($json)

Properties

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Addresses

Type

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

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Amounts

Type

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

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Barcode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Customer

Type

\Firstred\PostNL\Entity\Customer | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$DeliveryDate

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Dimension

Type

\Firstred\PostNL\Entity\Dimension | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Events

Type

\Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent[] | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Expectation

Type

\Firstred\PostNL\Entity\Expectation | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Groups

Type

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

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$MainBarcode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$OldStatuses

Type

\Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus[] | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$ProductCode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$ProductDescription

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$ProductOptions

Type

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

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Reference

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$ShipmentAmount

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$ShipmentCounter

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Status

Type

\Firstred\PostNL\Entity\Status | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::$Warnings

Type

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

Methods

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::__construct($Addresses=null, $Amounts=null, $Barcode=null, $Customer=null, \\DateTimeInterface|string|null $DeliveryDate=null, $Dimension=null, $Events=null, $Expectation=null, $Groups=null, $OldStatuses=null, $ProductCode=null, $ProductOptions=null, $Reference=null, $Status=null, $Warnings=null, $MainBarcode=null, $ShipmentAmount=null, $ShipmentCounter=null, $ProductDescription=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getAddresses()

Returns

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

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setAddresses($Addresses)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getAmounts()

Returns

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

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setAmounts($Amounts)

Parameters

• $Amounts (array | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getBarcode()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setBarcode($Barcode)

Parameters

• $Barcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getCustomer()

Returns

\Firstred\PostNL\Entity\Customer | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setCustomer($Customer)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getDimension()

Returns

\Firstred\PostNL\Entity\Dimension | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setDimension($Dimension)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getEvents()

Returns

\Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent[] | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setEvents($Events)

Parameters

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

Returns

\Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getExpectation()

Returns

\Firstred\PostNL\Entity\Expectation | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setExpectation($Expectation)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getGroups()

Returns

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

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setGroups($Groups)

Parameters

• $Groups (array | null)

Returns

\Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getMainBarcode()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setMainBarcode($MainBarcode)

Parameters

• $MainBarcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getOldStatuses()

Returns

\Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus[] | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setOldStatuses($OldStatuses)

Parameters

• $OldStatuses (Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus[] | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getProductCode()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setProductCode($ProductCode)

Parameters

• $ProductCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getProductDescription()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setProductDescription($ProductDescription)

Parameters

• $ProductDescription (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getProductOptions()

Returns

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

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setProductOptions($ProductOptions)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getReference()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setReference($Reference)

Parameters

• $Reference (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getShipmentAmount()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setShipmentAmount($ShipmentAmount)

Parameters

• $ShipmentAmount (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getShipmentCounter()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setShipmentCounter($ShipmentCounter)

Parameters

• $ShipmentCounter (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getStatus()

Returns

\Firstred\PostNL\Entity\Status | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setStatus($Status)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getWarnings()

Returns

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

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::setWarnings($Warnings)

Parameters

• $Warnings (array | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::getDeliveryDate()

Returns

\DateTimeInterface | null

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

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public static Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment::jsonDeserialize($json)

Parameters

• $json (stdClass)

Returns

\Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.2.0

ResponseGroup

class Firstred\PostNL\Entity\Response\ResponseGroup

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($GroupCount, $GroupSequence, $GroupType, $MainBarcode)

• public getGroupCount()

• public setGroupCount($GroupCount)

• public getGroupSequence()

• public setGroupSequence($GroupSequence)

• public getGroupType()

• public setGroupType($GroupType)

• public getMainBarcode()

• public setMainBarcode($MainBarcode)

Properties

protected static property Firstred\PostNL\Entity\Response\ResponseGroup::$GroupCount

Amount of shipments in the ResponseGroup.

Type

string | null

protected static property Firstred\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

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)

Parameters

• $GroupCount (string | null)

• $GroupSequence (string | null)

• $GroupType (string | null)

• $MainBarcode (string | null)

public Firstred\PostNL\Entity\Response\ResponseGroup::getGroupCount()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseGroup::setGroupCount($GroupCount)

Parameters

• $GroupCount (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseGroup::getGroupSequence()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseGroup::setGroupSequence($GroupSequence)

Parameters

• $GroupSequence (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseGroup::getGroupType()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseGroup::setGroupType($GroupType)

Parameters

• $GroupType (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseGroup::getMainBarcode()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseGroup::setMainBarcode($MainBarcode)

Parameters

• $MainBarcode (string | null)

Returns

static

GenerateBarcodeResponse

class Firstred\PostNL\Entity\Response\GenerateBarcodeResponse

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Barcode)

• public getBarcode()

• public setBarcode($Barcode)

Properties

protected static property Firstred\PostNL\Entity\Response\GenerateBarcodeResponse::$Barcode

Type

string | null

Methods

public Firstred\PostNL\Entity\Response\GenerateBarcodeResponse::__construct($Barcode=null)

Parameters

• $Barcode (string | null)

public Firstred\PostNL\Entity\Response\GenerateBarcodeResponse::getBarcode()

Returns

string | null

public Firstred\PostNL\Entity\Response\GenerateBarcodeResponse::setBarcode($Barcode)

Parameters

• $Barcode (string | null)

Returns

static

GetLocationsInAreaResponse

class Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($GetLocationsResult)

• public getGetLocationsResult()

• public setGetLocationsResult($GetLocationsResult)

• public jsonSerialize()

Properties

protected static property Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse::$GetLocationsResult

Type

\Firstred\PostNL\Entity\Response\GetLocationsResult | null

Methods

public Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse::__construct($GetLocationsResult=null)

Parameters

• $GetLocationsResult (Firstred\PostNL\Entity\Response\GetLocationsResult | null)

public Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse::getGetLocationsResult()

Returns

\Firstred\PostNL\Entity\Response\GetLocationsResult | null

public Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse::setGetLocationsResult($GetLocationsResult)

Parameters

• $GetLocationsResult (Firstred\PostNL\Entity\Response\GetLocationsResult | null)

Returns

static

public Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse::jsonSerialize()

Returns

array

Throws

\Firstred\PostNL\Exception\ServiceNotSetException

CurrentStatusResponse

class Firstred\PostNL\Entity\Response\CurrentStatusResponse

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Shipments, $Warnings)

• public getShipments()

• public setShipments($Shipments)

• public getWarnings()

• public setWarnings($Warnings)

Properties

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponse::$Shipments

Type

\Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment[] | null

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponse::$Warnings

Type

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

Methods

public Firstred\PostNL\Entity\Response\CurrentStatusResponse::__construct($Shipments=null, $Warnings=null)

Parameters

• $Shipments (array | null)

• $Warnings (array | null)

public Firstred\PostNL\Entity\Response\CurrentStatusResponse::getShipments()

Returns

\Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment[] | null

public Firstred\PostNL\Entity\Response\CurrentStatusResponse::setShipments($Shipments)

Parameters

• $Shipments (Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment[] | null)

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponse::getWarnings()

Returns

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

public Firstred\PostNL\Entity\Response\CurrentStatusResponse::setWarnings($Warnings)

Parameters

• $Warnings (Firstred\PostNL\Entity\Warning[] | null)

Returns

static

CompleteStatusResponse

class Firstred\PostNL\Entity\Response\CompleteStatusResponse

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Shipments, $Warnings)

• public getShipments()

• public setShipments($Shipments)

• public getWarnings()

• public setWarnings($Warnings)

• public static jsonDeserialize($json)

Properties

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponse::$Shipments

Type

\Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment[] | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponse::$Warnings

Type

\Firstred\PostNL\Entity\Warning | null

Methods

public Firstred\PostNL\Entity\Response\CompleteStatusResponse::__construct($Shipments=null, $Warnings=null)

Parameters

• $Shipments (array | null)

• $Warnings (array | null)

public Firstred\PostNL\Entity\Response\CompleteStatusResponse::getShipments()

Returns

\Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment[] | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponse::setShipments($Shipments)

Parameters

• $Shipments (Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment[] | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponse::getWarnings()

Returns

\Firstred\PostNL\Entity\Warning | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponse::setWarnings($Warnings)

Parameters

• $Warnings (Firstred\PostNL\Entity\Warning | null)

Returns

static

public static Firstred\PostNL\Entity\Response\CompleteStatusResponse::jsonDeserialize($json)

Parameters

• $json (stdClass)

Returns

static

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

ResponseLocation

class Firstred\PostNL\Entity\Response\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, $Sustainability)

• public getAddress()

• public setAddress($Address)

• public getDeliveryOptions()

• public setDeliveryOptions($DeliveryOptions)

• public getDistance()

• public setDistance($Distance)

• public getLatitude()

• public setLatitude($Latitude)

• public getLongitude()

• public setLongitude($Longitude)

• public getName()

• public setName($Name)

• public getOpeningHours()

• public setOpeningHours($OpeningHours)

• public getPartnerName()

• public setPartnerName($PartnerName)

• public getPhoneNumber()

• public setPhoneNumber($PhoneNumber)

• public getLocationCode()

• public setLocationCode($LocationCode)

• public getRetailNetworkID()

• public setRetailNetworkID($RetailNetworkID)

• public getSaleschannel()

• public setSaleschannel($Saleschannel)

• public getTerminalType()

• public setTerminalType($TerminalType)

• public getWarnings()

• public setWarnings($Warnings)

• public getDownPartnerID()

• public setDownPartnerID($DownPartnerID)

• public getDownPartnerLocation()

• public setDownPartnerLocation($DownPartnerLocation)

• public getSustainability()

• public setSustainability($Sustainability)

• public static jsonDeserialize($json)

Properties

protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$Address

Type

\Firstred\PostNL\Entity\Address | null

protected static property Firstred\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 property Firstred\PostNL\Entity\Response\ResponseLocation::$OpeningHours

Type

\Firstred\PostNL\Entity\OpeningHours | null

protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$PartnerName

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$PhoneNumber

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$LocationCode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$RetailNetworkID

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$Saleschannel

Type

string | null

protected static property Firstred\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 property Firstred\PostNL\Entity\Response\ResponseLocation::$DownPartnerID

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$DownPartnerLocation

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseLocation::$Sustainability

Type

\Firstred\PostNL\Entity\Sustainability | null

Methods

public Firstred\PostNL\Entity\Response\ResponseLocation::__construct($Address=null, $DeliveryOptions=null, $Distance=null, $Latitude=null, $Longitude=null, $Name=null, $OpeningHours=null, $PartnerName=null, $PhoneNumber=null, $LocationCode=null, $RetailNetworkID=null, $Saleschannel=null, $TerminalType=null, $Warnings=null, $DownPartnerID=null, $DownPartnerLocation=null, $Sustainability=null)

Parameters

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

• $DeliveryOptions (array | null)

• $Distance (string | null)

• $Latitude (string | null)

• $Longitude (string | null)

• $Name (string | null)

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

• $PartnerName (string | null)

• $PhoneNumber (string | null)

• $LocationCode (string | null)

• $RetailNetworkID (string | null)

• $Saleschannel (string | null)

• $TerminalType (string | null)

• $Warnings (array | null)

• $DownPartnerID (string | null)

• $DownPartnerLocation (string | null)

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

public Firstred\PostNL\Entity\Response\ResponseLocation::getAddress()

Returns

\Firstred\PostNL\Entity\Address | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setAddress($Address)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getDeliveryOptions()

Returns

string[] | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setDeliveryOptions($DeliveryOptions)

Parameters

• $DeliveryOptions (array | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getDistance()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setDistance(int|float|string|null $Distance)

Parameters

• $Distance (int | float | string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getLatitude()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setLatitude(float|string|null $Latitude)

Parameters

• $Latitude (float | string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getLongitude()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setLongitude(float|string|null $Longitude)

Parameters

• $Longitude (float | string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getName()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setName($Name)

Parameters

• $Name (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getOpeningHours()

Returns

\Firstred\PostNL\Entity\OpeningHours | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setOpeningHours($OpeningHours)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getPartnerName()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setPartnerName($PartnerName)

Parameters

• $PartnerName (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getPhoneNumber()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setPhoneNumber($PhoneNumber)

Parameters

• $PhoneNumber (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getLocationCode()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setLocationCode(int|string|null $LocationCode)

Parameters

• $LocationCode (int | string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getRetailNetworkID()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setRetailNetworkID($RetailNetworkID)

Parameters

• $RetailNetworkID (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getSaleschannel()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setSaleschannel($Saleschannel)

Parameters

• $Saleschannel (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getTerminalType()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setTerminalType($TerminalType)

Parameters

• $TerminalType (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getWarnings()

Returns

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

public Firstred\PostNL\Entity\Response\ResponseLocation::setWarnings($Warnings)

Parameters

• $Warnings (Firstred\PostNL\Entity\Warning[] | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getDownPartnerID()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setDownPartnerID($DownPartnerID)

Parameters

• $DownPartnerID (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getDownPartnerLocation()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseLocation::setDownPartnerLocation($DownPartnerLocation)

Parameters

• $DownPartnerLocation (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseLocation::getSustainability()

Returns

\Firstred\PostNL\Entity\Sustainability | null

Since

1.4.2

public Firstred\PostNL\Entity\Response\ResponseLocation::setSustainability($Sustainability)

Parameters

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

Returns

static

Since

1.4.2

public static Firstred\PostNL\Entity\Response\ResponseLocation::jsonDeserialize($json)

Parameters

• $json (stdClass)

Returns

static

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

MergedLabel

class Firstred\PostNL\Entity\Response\MergedLabel

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Barcodes, $Labels)

• public getBarcodes()

• public setBarcodes($Barcodes)

• public getLabels()

• public setLabels($Labels)

Properties

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

Methods

public Firstred\PostNL\Entity\Response\MergedLabel::__construct($Barcodes=null, $Labels=null)

Parameters

• $Barcodes (array | null)

• $Labels (array | null)

public Firstred\PostNL\Entity\Response\MergedLabel::getBarcodes()

Returns

string[] | null

public Firstred\PostNL\Entity\Response\MergedLabel::setBarcodes($Barcodes)

Parameters

• $Barcodes (string[] | null)

Returns

static

public Firstred\PostNL\Entity\Response\MergedLabel::getLabels()

Returns

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

public Firstred\PostNL\Entity\Response\MergedLabel::setLabels($Labels)

Parameters

• $Labels (Firstred\PostNL\Entity\Label[] | null)

Returns

static

GetSentDateResponse

class Firstred\PostNL\Entity\Response\GetSentDateResponse

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($GetSentDate, $Options)

• public setSentDate($SentDate)

• public getOptions()

• public setOptions($Options)

• public getSentDate()

Properties

protected static property Firstred\PostNL\Entity\Response\GetSentDateResponse::$SentDate

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Response\GetSentDateResponse::$Options

Type

string[] | null

Methods

public Firstred\PostNL\Entity\Response\GetSentDateResponse::__construct($GetSentDate=null, $Options=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Response\GetSentDateResponse::setSentDate(string|\\DateTimeInterface|null $SentDate=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Response\GetSentDateResponse::getOptions()

Returns

string[] | null

public Firstred\PostNL\Entity\Response\GetSentDateResponse::setOptions($Options)

Parameters

• $Options (string[] | null)

Returns

static

public Firstred\PostNL\Entity\Response\GetSentDateResponse::getSentDate()

Returns

\DateTimeInterface | null

UpdatedShipmentsResponse

class Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Barcode, $CreationDate, $CustomerNumber, $CustomerCode, $Status)

• public getBarcode()

• public setBarcode($Barcode)

• public getCustomerNumber()

• public setCustomerNumber($CustomerNumber)

• public getCustomerCode()

• public setCustomerCode($CustomerCode)

• public getStatus()

• public setStatus($Status)

• public getCreationDate()

• public setCreationDate($CreationDate)

Properties

protected static property Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::$Barcode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::$CreationDate

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::$CustomerNumber

Type

string | null

protected static property Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::$CustomerCode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::$Status

Type

\Firstred\PostNL\Entity\Status | null

Methods

public Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::__construct($Barcode=null, string|\\DateTimeInterface|null $CreationDate=null, $CustomerNumber=null, $CustomerCode=null, $Status=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::getBarcode()

Returns

string | null

public Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::setBarcode($Barcode)

Parameters

• $Barcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::getCustomerNumber()

Returns

string | null

public Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::setCustomerNumber($CustomerNumber)

Parameters

• $CustomerNumber (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::getCustomerCode()

Returns

string | null

public Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::setCustomerCode($CustomerCode)

Parameters

• $CustomerCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::getStatus()

Returns

\Firstred\PostNL\Entity\Status | null

public Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::setStatus($Status)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::getCreationDate()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse::setCreationDate(string|\\DateTimeInterface|null $CreationDate=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

GetSignatureResponseSignature

class Firstred\PostNL\Entity\Response\GetSignatureResponseSignature

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Barcode, $SignatureDate, $SignatureImage)

• public getBarcode()

• public setBarcode($Barcode)

• public getSignatureImage()

• public setSignatureImage($SignatureImage)

• public getSignatureDate()

• public setSignatureDate($SignatureDate)

Properties

protected static property Firstred\PostNL\Entity\Response\GetSignatureResponseSignature::$Barcode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\GetSignatureResponseSignature::$SignatureDate

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Response\GetSignatureResponseSignature::$SignatureImage

Type

string | null

Methods

public Firstred\PostNL\Entity\Response\GetSignatureResponseSignature::__construct($Barcode=null, $SignatureDate=null, $SignatureImage=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Response\GetSignatureResponseSignature::getBarcode()

Returns

string | null

public Firstred\PostNL\Entity\Response\GetSignatureResponseSignature::setBarcode($Barcode)

Parameters

• $Barcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\GetSignatureResponseSignature::getSignatureImage()

Returns

string | null

public Firstred\PostNL\Entity\Response\GetSignatureResponseSignature::setSignatureImage($SignatureImage)

Parameters

• $SignatureImage (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\GetSignatureResponseSignature::getSignatureDate()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Response\GetSignatureResponseSignature::setSignatureDate(string|\\DateTimeInterface|null $SignatureDate=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

ResponseAmount

class Firstred\PostNL\Entity\Response\ResponseAmount

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($AccountName, $ResponseAmount, $BIC, $Currency, $IBAN, $Reference, $TransactionNumber, $Value, $VerzekerdBedrag)

• public getAccountName()

• public setAccountName($AccountName)

• public getResponseAmountType()

• public setResponseAmountType($ResponseAmountType)

• public getBIC()

• public setBIC($BIC)

• public getCurrency()

• public setCurrency($Currency)

• public getIBAN()

• public setIBAN($IBAN)

• public getReference()

• public setReference($Reference)

• public getTransactionNumber()

• public setTransactionNumber($TransactionNumber)

• public getValue()

• public setValue($Value)

• public getVerzekerdBedrag()

• public setVerzekerdBedrag($VerzekerdBedrag)

Properties

protected static property Firstred\PostNL\Entity\Response\ResponseAmount::$AccountName

Type

string | null

protected static property Firstred\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 property Firstred\PostNL\Entity\Response\ResponseAmount::$TransactionNumber

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseAmount::$Value

Type

string | null

protected static property Firstred\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, $TransactionNumber=null, $Value=null, $VerzekerdBedrag=null)

Parameters

• $AccountName (string | null)

• $ResponseAmount (string | null)

• $BIC (string | null)

• $Currency (string | null)

• $IBAN (string | null)

• $Reference (string | null)

• $TransactionNumber (string | null)

• $Value (string | null)

• $VerzekerdBedrag (string | null)

public Firstred\PostNL\Entity\Response\ResponseAmount::getAccountName()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAmount::setAccountName($AccountName)

Parameters

• $AccountName (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAmount::getResponseAmountType()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAmount::setResponseAmountType($ResponseAmountType)

Parameters

• $ResponseAmountType (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAmount::getBIC()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAmount::setBIC($BIC)

Parameters

• $BIC (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAmount::getCurrency()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAmount::setCurrency($Currency)

Parameters

• $Currency (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAmount::getIBAN()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAmount::setIBAN($IBAN)

Parameters

• $IBAN (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAmount::getReference()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAmount::setReference($Reference)

Parameters

• $Reference (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAmount::getTransactionNumber()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAmount::setTransactionNumber($TransactionNumber)

Parameters

• $TransactionNumber (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAmount::getValue()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAmount::setValue($Value)

Parameters

• $Value (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAmount::getVerzekerdBedrag()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAmount::setVerzekerdBedrag($VerzekerdBedrag)

Parameters

• $VerzekerdBedrag (string | null)

Returns

static

GenerateLabelResponse

class Firstred\PostNL\Entity\Response\GenerateLabelResponse

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($MergedLabels, $ResponseShipments)

• public getMergedLabels()

• public setMergedLabels($MergedLabels)

• public getResponseShipments()

• public setResponseShipments($ResponseShipments)

Properties

protected static property Firstred\PostNL\Entity\Response\GenerateLabelResponse::$MergedLabels

Type

\Firstred\PostNL\Entity\Response\MergedLabel[] | null

protected static property Firstred\PostNL\Entity\Response\GenerateLabelResponse::$ResponseShipments

Type

\Firstred\PostNL\Entity\Response\ResponseShipment[] | null

Methods

public Firstred\PostNL\Entity\Response\GenerateLabelResponse::__construct($MergedLabels=null, $ResponseShipments=null)

Parameters

• $MergedLabels (array | null)

• $ResponseShipments (array | null)

public Firstred\PostNL\Entity\Response\GenerateLabelResponse::getMergedLabels()

Returns

\Firstred\PostNL\Entity\Response\MergedLabel[] | null

public Firstred\PostNL\Entity\Response\GenerateLabelResponse::setMergedLabels($MergedLabels)

Parameters

• $MergedLabels (Firstred\PostNL\Entity\Response\MergedLabel[] | null)

Returns

static

public Firstred\PostNL\Entity\Response\GenerateLabelResponse::getResponseShipments()

Returns

\Firstred\PostNL\Entity\Response\ResponseShipment[] | null

public Firstred\PostNL\Entity\Response\GenerateLabelResponse::setResponseShipments($ResponseShipments)

Parameters

• $ResponseShipments (Firstred\PostNL\Entity\Response\ResponseShipment[] | null)

Returns

static

ResponseAddress

class Firstred\PostNL\Entity\Response\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 getAddressType()

• public setAddressType($AddressType)

• public getArea()

• public setArea($Area)

• public getBuildingname()

• public setBuildingname($Buildingname)

• public getCity()

• public setCity($City)

• public getCompanyName()

• public setCompanyName($CompanyName)

• public getCountrycode()

• public setCountrycode($Countrycode)

• public getDepartment()

• public setDepartment($Department)

• public getDoorcode()

• public setDoorcode($Doorcode)

• public getFirstName()

• public setFirstName($FirstName)

• public getFloor()

• public setFloor($Floor)

• public getHouseNr()

• public setHouseNr($HouseNr)

• public getHouseNrExt()

• public setHouseNrExt($HouseNrExt)

• public getName()

• public setName($Name)

• public getRegion()

• public setRegion($Region)

• public getRemark()

• public setRemark($Remark)

• public getStreet()

• public setStreet($Street)

• public getOther()

• public setOther($other)

• public getZipcode()

• public setZipcode($Zipcode)

Properties

protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$AddressType

PostNL internal applications validate the receiver ResponseAddress. In case the 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 fields will

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 Collection 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

> `Antwoordnummer` 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.

If there is no Customer/ResponseAddress, the message will be rejected.

At least one other AddressType must be specified, other than AddressType 02

In most cases this will be AddressType 01, the receiver ResponseAddress.

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$Area

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$Buildingname

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$City

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ResponseAddress::$CompanyName

Type

string | null

protected static property Firstred\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

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::getAddressType()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setAddressType($AddressType)

Parameters

• $AddressType (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getArea()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setArea($Area)

Parameters

• $Area (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getBuildingname()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setBuildingname($Buildingname)

Parameters

• $Buildingname (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getCity()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setCity($City)

Parameters

• $City (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getCompanyName()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setCompanyName($CompanyName)

Parameters

• $CompanyName (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getCountrycode()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setCountrycode($Countrycode)

Parameters

• $Countrycode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getDepartment()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setDepartment($Department)

Parameters

• $Department (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getDoorcode()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setDoorcode($Doorcode)

Parameters

• $Doorcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getFirstName()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setFirstName($FirstName)

Parameters

• $FirstName (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getFloor()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setFloor($Floor)

Parameters

• $Floor (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getHouseNr()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setHouseNr($HouseNr)

Parameters

• $HouseNr (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getHouseNrExt()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setHouseNrExt($HouseNrExt)

Parameters

• $HouseNrExt (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getName()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setName($Name)

Parameters

• $Name (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getRegion()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setRegion($Region)

Parameters

• $Region (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getRemark()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setRemark($Remark)

Parameters

• $Remark (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getStreet()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setStreet($Street)

Parameters

• $Street (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ResponseAddress::getOther()

Returns

array | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setOther($other)

Parameters

• $other (array | null)

Returns

\Firstred\PostNL\Entity\Response\ResponseAddress

public Firstred\PostNL\Entity\Response\ResponseAddress::getZipcode()

Returns

string | null

public Firstred\PostNL\Entity\Response\ResponseAddress::setZipcode($Zipcode=null)

Parameters

• $Zipcode (string | null)

Returns

static

CurrentStatusResponseShipment

class Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Addresses, $Amounts, $Barcode, $Customer, $DeliveryDate, $Dimension, $Expectation, $Groups, $ProductCode, $ProductOptions, $Reference, $Status, $Warnings, $MainBarcode, $ShipmentAmount, $ShipmentCounter, $ProductDescription)

• public getDeliveryDate()

• public setDeliveryDate($DeliveryDate)

• public getAddresses()

• public setAddresses($Addresses)

• public getAmounts()

• public setAmounts($Amounts)

• public getBarcode()

• public setBarcode($Barcode)

• public getCustomer()

• public setCustomer($Customer)

• public getDimension()

• public setDimension($Dimension)

• public getExpectation()

• public setExpectation($Expectation)

• public getGroups()

• public setGroups($Groups)

• public getMainBarcode()

• public setMainBarcode($MainBarcode)

• public getProductCode()

• public setProductCode($ProductCode)

• public getProductDescription()

• public setProductDescription($ProductDescription)

• public getProductOptions()

• public setProductOptions($ProductOptions)

• public getReference()

• public setReference($Reference)

• public getShipmentAmount()

• public setShipmentAmount($ShipmentAmount)

• public getShipmentCounter()

• public setShipmentCounter($ShipmentCounter)

• public getStatus()

• public setStatus($Status)

• public getWarnings()

• public setWarnings($Warnings)

• public static jsonDeserialize($json)

Properties

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Addresses

Type

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

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Amounts

Type

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

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Barcode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Customer

Type

\Firstred\PostNL\Entity\Customer | null

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$DeliveryDate

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Dimension

Type

\Firstred\PostNL\Entity\Dimension | null

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Expectation

Type

\Firstred\PostNL\Entity\Expectation | null

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Groups

Type

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

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$MainBarcode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$ProductCode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$ProductDescription

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$ProductOptions

Type

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

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Reference

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$ShipmentAmount

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$ShipmentCounter

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Status

Type

\Firstred\PostNL\Entity\Status | null

protected static property Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::$Warnings

Type

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

Methods

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::__construct($Addresses=null, $Amounts=null, $Barcode=null, $Customer=null, \\DateTimeInterface|string|null $DeliveryDate=null, $Dimension=null, $Expectation=null, $Groups=null, $ProductCode=null, $ProductOptions=null, $Reference=null, $Status=null, $Warnings=null, $MainBarcode=null, $ShipmentAmount=null, $ShipmentCounter=null, $ProductDescription=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getDeliveryDate()

Returns

\DateTimeInterface | null

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

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getAddresses()

Returns

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

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setAddresses($Addresses)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getAmounts()

Returns

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

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setAmounts($Amounts)

Parameters

• $Amounts (Firstred\PostNL\Entity\Amount[] | null)

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getBarcode()

Returns

string | null

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setBarcode($Barcode)

Parameters

• $Barcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getCustomer()

Returns

\Firstred\PostNL\Entity\Customer | null

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setCustomer($Customer)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getDimension()

Returns

\Firstred\PostNL\Entity\Dimension | null

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setDimension($Dimension)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getExpectation()

Returns

\Firstred\PostNL\Entity\Expectation | null

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setExpectation($Expectation)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getGroups()

Returns

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

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setGroups($Groups)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getMainBarcode()

Returns

string | null

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setMainBarcode($MainBarcode)

Parameters

• $MainBarcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getProductCode()

Returns

string | null

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setProductCode($ProductCode)

Parameters

• $ProductCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getProductDescription()

Returns

string | null

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setProductDescription($ProductDescription)

Parameters

• $ProductDescription (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getProductOptions()

Returns

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

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setProductOptions($ProductOptions)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getReference()

Returns

string | null

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setReference($Reference)

Parameters

• $Reference (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getShipmentAmount()

Returns

string | null

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setShipmentAmount($ShipmentAmount)

Parameters

• $ShipmentAmount (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getShipmentCounter()

Returns

string | null

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setShipmentCounter($ShipmentCounter)

Parameters

• $ShipmentCounter (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getStatus()

Returns

\Firstred\PostNL\Entity\Status | null

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setStatus($Status)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::getWarnings()

Returns

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

public Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::setWarnings($Warnings)

Parameters

• $Warnings (Firstred\PostNL\Entity\Warning[] | null)

Returns

static

public static Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment::jsonDeserialize($json)

Parameters

• $json (stdClass)

Returns

\Firstred\PostNL\Entity\Response\CurrentStatusResponseShipment

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.2.0

ConfirmingResponseShipment

class Firstred\PostNL\Entity\Response\ConfirmingResponseShipment

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Barcode, $Warnings)

• public getBarcode()

• public setBarcode($Barcode)

• public getWarnings()

• public setWarnings($Warnings)

Properties

protected static property Firstred\PostNL\Entity\Response\ConfirmingResponseShipment::$Barcode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\ConfirmingResponseShipment::$Warnings

Type

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

Methods

public Firstred\PostNL\Entity\Response\ConfirmingResponseShipment::__construct($Barcode=null, $Warnings=null)

Parameters

• $Barcode (string | null)

• $Warnings (array | null)

public Firstred\PostNL\Entity\Response\ConfirmingResponseShipment::getBarcode()

Returns

string | null

public Firstred\PostNL\Entity\Response\ConfirmingResponseShipment::setBarcode($Barcode)

Parameters

• $Barcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\ConfirmingResponseShipment::getWarnings()

Returns

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

public Firstred\PostNL\Entity\Response\ConfirmingResponseShipment::setWarnings($Warnings)

Parameters

• $Warnings (Firstred\PostNL\Entity\Warning[] | null)

Returns

static

GetDeliveryDateResponse

class Firstred\PostNL\Entity\Response\GetDeliveryDateResponse

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($DeliveryDate, $Options)

• public getOptions()

• public setOptions($Options)

• public getDeliveryDate()

• public setDeliveryDate($DeliveryDate)

• public static jsonDeserialize($json)

Properties

protected static property Firstred\PostNL\Entity\Response\GetDeliveryDateResponse::$DeliveryDate

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Response\GetDeliveryDateResponse::$Options

Type

string[] | null

Methods

public Firstred\PostNL\Entity\Response\GetDeliveryDateResponse::__construct(string|\\DateTimeInterface|null $DeliveryDate=null, $Options=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Response\GetDeliveryDateResponse::getOptions()

Returns

string[] | null

public Firstred\PostNL\Entity\Response\GetDeliveryDateResponse::setOptions($Options)

Parameters

• $Options (string[] | null)

Returns

\Firstred\PostNL\Entity\Response\GetDeliveryDateResponse

public Firstred\PostNL\Entity\Response\GetDeliveryDateResponse::getDeliveryDate()

Returns

\DateTimeInterface | null

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

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public static Firstred\PostNL\Entity\Response\GetDeliveryDateResponse::jsonDeserialize($json)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\DeserializationException

SendShipmentResponse

class Firstred\PostNL\Entity\Response\SendShipmentResponse

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($MergedLabels, $ResponseShipments)

• public getMergedLabels()

• public setMergedLabels($MergedLabels)

• public getResponseShipments()

• public setResponseShipments($ResponseShipments)

Properties

protected static property Firstred\PostNL\Entity\Response\SendShipmentResponse::$MergedLabels

Type

\Firstred\PostNL\Entity\Response\MergedLabel[] | null

protected static property Firstred\PostNL\Entity\Response\SendShipmentResponse::$ResponseShipments

Type

\Firstred\PostNL\Entity\Response\ResponseShipment[] | null

Methods

public Firstred\PostNL\Entity\Response\SendShipmentResponse::__construct($MergedLabels=null, $ResponseShipments=null)

Parameters

• $MergedLabels (array | null)

• $ResponseShipments (array | null)

public Firstred\PostNL\Entity\Response\SendShipmentResponse::getMergedLabels()

Returns

\Firstred\PostNL\Entity\Response\MergedLabel[] | null

public Firstred\PostNL\Entity\Response\SendShipmentResponse::setMergedLabels($MergedLabels)

Parameters

• $MergedLabels (Firstred\PostNL\Entity\Response\MergedLabel[] | null)

Returns

static

public Firstred\PostNL\Entity\Response\SendShipmentResponse::getResponseShipments()

Returns

\Firstred\PostNL\Entity\Response\ResponseShipment[] | null

public Firstred\PostNL\Entity\Response\SendShipmentResponse::setResponseShipments($ResponseShipments)

Parameters

• $ResponseShipments (Firstred\PostNL\Entity\Response\ResponseShipment[] | null)

Returns

static

CompleteStatusResponseOldStatus

class Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($StatusCode, $StatusDescription, $PhaseCode, $PhaseDescription, $TimeStamp)

• public getStatusCode()

• public setStatusCode($StatusCode)

• public getStatusDescription()

• public setStatusDescription($StatusDescription)

• public getPhaseCode()

• public setPhaseCode($PhaseCode)

• public getPhaseDescription()

• public setPhaseDescription($PhaseDescription)

• public getTimeStamp()

• public setTimeStamp($TimeStamp)

Properties

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::$StatusCode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::$StatusDescription

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::$PhaseCode

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::$PhaseDescription

Type

string | null

protected static property Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::$TimeStamp

Type

\DateTimeInterface | null

Methods

public Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::__construct($StatusCode=null, $StatusDescription=null, $PhaseCode=null, $PhaseDescription=null, \\DateTimeInterface|string|null $TimeStamp=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::getStatusCode()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::setStatusCode($StatusCode)

Parameters

• $StatusCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::getStatusDescription()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::setStatusDescription($StatusDescription)

Parameters

• $StatusDescription (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::getPhaseCode()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::setPhaseCode($PhaseCode)

Parameters

• $PhaseCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::getPhaseDescription()

Returns

string | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::setPhaseDescription($PhaseDescription)

Parameters

• $PhaseDescription (string | null)

Returns

static

public Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::getTimeStamp()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Response\CompleteStatusResponseOldStatus::setTimeStamp(\\DateTimeInterface|string|null $TimeStamp=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

Classes

CoordinatesSouthEast

class Firstred\PostNL\Entity\CoordinatesSouthEast

Parent

Firstred\PostNL\Entity\Coordinates

Summary

OldStatus

class Firstred\PostNL\Entity\OldStatus

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($PhaseCode, $PhaseDescription, $OldStatusCode, $OldStatusDescription, $TimeStamp)

• public getCurrentPhaseCode()

• public setCurrentPhaseCode($CurrentPhaseCode)

• public getCurrentPhaseDescription()

• public setCurrentPhaseDescription($CurrentPhaseDescription)

• public getCurrentOldStatusCode()

• public setCurrentOldStatusCode($CurrentOldStatusCode)

• public getCurrentOldStatusDescription()

• public setCurrentOldStatusDescription($CurrentOldStatusDescription)

• public getCurrentOldStatusTimeStamp()

• public setCurrentOldStatusTimeStamp($CurrentOldStatusTimeStamp)

Properties

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 property Firstred\PostNL\Entity\OldStatus::$CurrentOldStatusDescription

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)

public Firstred\PostNL\Entity\OldStatus::getCurrentPhaseCode()

Returns

string | null

public Firstred\PostNL\Entity\OldStatus::setCurrentPhaseCode($CurrentPhaseCode)

Parameters

• $CurrentPhaseCode (string | null)

Returns

static

public Firstred\PostNL\Entity\OldStatus::getCurrentPhaseDescription()

Returns

string | null

public Firstred\PostNL\Entity\OldStatus::setCurrentPhaseDescription($CurrentPhaseDescription)

Parameters

• $CurrentPhaseDescription (string | null)

Returns

static

public Firstred\PostNL\Entity\OldStatus::getCurrentOldStatusCode()

Returns

string | null

public Firstred\PostNL\Entity\OldStatus::setCurrentOldStatusCode($CurrentOldStatusCode)

Parameters

• $CurrentOldStatusCode (string | null)

Returns

static

public Firstred\PostNL\Entity\OldStatus::getCurrentOldStatusDescription()

Returns

string | null

public Firstred\PostNL\Entity\OldStatus::setCurrentOldStatusDescription($CurrentOldStatusDescription)

Parameters

• $CurrentOldStatusDescription (string | null)

Returns

static

public Firstred\PostNL\Entity\OldStatus::getCurrentOldStatusTimeStamp()

Returns

string | null

public Firstred\PostNL\Entity\OldStatus::setCurrentOldStatusTimeStamp($CurrentOldStatusTimeStamp)

Parameters

• $CurrentOldStatusTimeStamp (string | null)

Returns

static

StatusAddress

class Firstred\PostNL\Entity\StatusAddress

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($AddressType, $FirstName, $LastName, $CompanyName, $DepartmentName, $Street, $HouseNumber, $HouseNumberSuffix, $Zipcode, $City, $CountryCode, $Region, $District, $Building, $Floor, $Remark, $RegistrationDate)

• public getBuilding()

• public setBuilding($Building)

• public getCity()

• public setCity($City)

• public getCompanyName()

• public setCompanyName($CompanyName)

• public getCountryCode()

• public setCountryCode($CountryCode)

• public getDepartmentName()

• public setDepartmentName($DepartmentName)

• public getDistrict()

• public setDistrict($District)

• public getFirstName()

• public setFirstName($FirstName)

• public getFloor()

• public setFloor($Floor)

• public getHouseNumber()

• public setHouseNumber($HouseNumber)

• public getHouseNumberSuffix()

• public setHouseNumberSuffix($HouseNumberSuffix)

• public getLastName()

• public setLastName($LastName)

• public getRegion()

• public setRegion($Region)

• public getRemark()

• public setRemark($Remark)

• public getStreet()

• public setStreet($Street)

• public getAddressType()

• public getRegistrationDate()

• public getZipcode()

• public setZipcode($Zipcode)

• public setAddressType($AddressType)

• public setRegistrationDate($RegistrationDate)

Properties

protected static property Firstred\PostNL\Entity\StatusAddress::$AddressType

PostNL internal applications validate the receiver address. In case the spelling of

addresses should be different according to our PostNL information, the address details will

be corrected. This can be noticed in Track & Trace.

Please note that the webservice will not add address details. Street and City fields will

only be printed when they are in the call towards the labeling webservice.

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

Code Description

01 Receiver

02 Sender

03 Alternative sender address

04 Collection address (In the orders need to be collected first)

08 Return address*

09 Drop off location (for use with Pick up at PostNL location)

> * When using the ‘label in the box return label’, it is mandatory to use an

> `Antwoordnummer` in AddressType 08.

> This cannot be a regular address

The following rules apply:

If there is no Address specified with AddressType = 02, the data from Customer/Address

will be added to the list as AddressType 02.

If there is no Customer/Address, the message will be rejected.

At least one other AddressType must be specified, other than AddressType 02

In most cases this will be AddressType 01, the receiver address.

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$Building

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$City

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$CompanyName

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$CountryCode

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$DepartmentName

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$District

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$FirstName

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$Floor

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$HouseNumber

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$HouseNumberSuffix

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$LastName

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$Region

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$RegistrationDate

Type

string | null

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

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$Street

Type

string | null

protected static property Firstred\PostNL\Entity\StatusAddress::$Zipcode

Type

string | null

Methods

public Firstred\PostNL\Entity\StatusAddress::__construct($AddressType=null, $FirstName=null, $LastName=null, $CompanyName=null, $DepartmentName=null, $Street=null, $HouseNumber=null, $HouseNumberSuffix=null, $Zipcode=null, $City=null, $CountryCode=null, $Region=null, $District=null, $Building=null, $Floor=null, $Remark=null, \\DateTimeInterface|string|null $RegistrationDate=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\StatusAddress::getBuilding()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setBuilding($Building)

Parameters

• $Building (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getCity()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setCity($City)

Parameters

• $City (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getCompanyName()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setCompanyName($CompanyName)

Parameters

• $CompanyName (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getCountryCode()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setCountryCode($CountryCode)

Parameters

• $CountryCode (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getDepartmentName()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setDepartmentName($DepartmentName)

Parameters

• $DepartmentName (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getDistrict()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setDistrict($District)

Parameters

• $District (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getFirstName()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setFirstName($FirstName)

Parameters

• $FirstName (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getFloor()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setFloor($Floor)

Parameters

• $Floor (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getHouseNumber()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setHouseNumber($HouseNumber)

Parameters

• $HouseNumber (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getHouseNumberSuffix()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setHouseNumberSuffix($HouseNumberSuffix)

Parameters

• $HouseNumberSuffix (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getLastName()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setLastName($LastName)

Parameters

• $LastName (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getRegion()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setRegion($Region)

Parameters

• $Region (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getRemark()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setRemark($Remark)

Parameters

• $Remark (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getStreet()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::setStreet($Street)

Parameters

• $Street (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::getAddressType()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::getRegistrationDate()

Returns

string | null

public Firstred\PostNL\Entity\StatusAddress::getZipcode()

Returns

string | null

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

Parameters

• $Zipcode (string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::setAddressType(int|string|null $AddressType=null)

Parameters

• $AddressType (int | string | null)

Returns

static

public Firstred\PostNL\Entity\StatusAddress::setRegistrationDate(\\DateTimeInterface|string|null $RegistrationDate=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

Warning

class Firstred\PostNL\Entity\Warning

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Code, $Description)

• public getCode()

• public setCode($Code)

• public getDescription()

• public setDescription($Description)

• public static jsonDeserialize($json)

Properties

protected static property Firstred\PostNL\Entity\Warning::$Code

Type

string | null

protected static property Firstred\PostNL\Entity\Warning::$Description

Type

string | null

Methods

public Firstred\PostNL\Entity\Warning::__construct($Code=null, $Description=null)

Parameters

• $Code (string | null)

• $Description (string | null)

public Firstred\PostNL\Entity\Warning::getCode()

Returns

string | null

public Firstred\PostNL\Entity\Warning::setCode($Code)

Parameters

• $Code (string | null)

Returns

static

public Firstred\PostNL\Entity\Warning::getDescription()

Returns

string | null

public Firstred\PostNL\Entity\Warning::setDescription($Description)

Parameters

• $Description (string | null)

Returns

static

public static Firstred\PostNL\Entity\Warning::jsonDeserialize($json)

Parameters

• $json (stdClass)

Returns

\Firstred\PostNL\Entity\Warning

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

ReasonNoTimeframe

class Firstred\PostNL\Entity\ReasonNoTimeframe

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Code, $Date, $Description, $Options, $From, $To, $Sustainability)

• public getCode()

• public setCode($Code)

• public getDescription()

• public setDescription($Description)

• public getOptions()

• public setOptions($Options)

• public getFrom()

• public setFrom($From)

• public getTo()

• public getDate()

• public setTo($To)

• public setDate($date)

• public getSustainability()

• public setSustainability($Sustainability)

• public static jsonDeserialize($json)

Properties

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

protected static property Firstred\PostNL\Entity\ReasonNoTimeframe::$Sustainability

Type

\Firstred\PostNL\Entity\Sustainability | null

Methods

public Firstred\PostNL\Entity\ReasonNoTimeframe::__construct(int|string|null $Code=null, $Date=null, $Description=null, $Options=null, $From=null, $To=null, $Sustainability=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\ReasonNoTimeframe::getCode()

Returns

string | null

public Firstred\PostNL\Entity\ReasonNoTimeframe::setCode(string|int|null $Code)

Parameters

• $Code (string | int | null)

Returns

static

public Firstred\PostNL\Entity\ReasonNoTimeframe::getDescription()

Returns

string | null

public Firstred\PostNL\Entity\ReasonNoTimeframe::setDescription($Description)

Parameters

• $Description (string | null)

Returns

static

public Firstred\PostNL\Entity\ReasonNoTimeframe::getOptions()

Returns

string[] | null

public Firstred\PostNL\Entity\ReasonNoTimeframe::setOptions($Options)

Parameters

• $Options (array | null)

Returns

\Firstred\PostNL\Entity\ReasonNoTimeframe

public Firstred\PostNL\Entity\ReasonNoTimeframe::getFrom()

Returns

string | null

public Firstred\PostNL\Entity\ReasonNoTimeframe::setFrom($From)

Parameters

• $From (string | null)

Returns

static

public Firstred\PostNL\Entity\ReasonNoTimeframe::getTo()

Returns

string | null

public Firstred\PostNL\Entity\ReasonNoTimeframe::getDate()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\ReasonNoTimeframe::setTo($To)

Parameters

• $To (string | null)

Returns

static

public Firstred\PostNL\Entity\ReasonNoTimeframe::setDate(string|\\DateTimeInterface|null $date=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\ReasonNoTimeframe::getSustainability()

Returns

\Firstred\PostNL\Entity\Sustainability | null

Since

1.4.2

public Firstred\PostNL\Entity\ReasonNoTimeframe::setSustainability($Sustainability)

Parameters

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

Returns

static

Since

1.4.2

public static Firstred\PostNL\Entity\ReasonNoTimeframe::jsonDeserialize($json)

Parameters

• $json (stdClass)

Returns

\Firstred\PostNL\Entity\ReasonNoTimeframe

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.2.0

Area

class Firstred\PostNL\Entity\Area

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($CoordinatesNorthWest, $CoordinatesSouthEast)

• public getCoordinatesNorthWest()

• public setCoordinatesNorthWest($CoordinatesNorthWest)

• public getCoordinatesSouthEast()

• public setCoordinatesSouthEast($CoordinatesSouthEast)

Properties

protected static property Firstred\PostNL\Entity\Area::$CoordinatesNorthWest

Type

\Firstred\PostNL\Entity\CoordinatesNorthWest | null

protected static property Firstred\PostNL\Entity\Area::$CoordinatesSouthEast

Type

\Firstred\PostNL\Entity\CoordinatesSouthEast | null

Methods

public Firstred\PostNL\Entity\Area::__construct($CoordinatesNorthWest=null, $CoordinatesSouthEast=null)

Parameters

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

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

public Firstred\PostNL\Entity\Area::getCoordinatesNorthWest()

Returns

\Firstred\PostNL\Entity\CoordinatesNorthWest | null

public Firstred\PostNL\Entity\Area::setCoordinatesNorthWest($CoordinatesNorthWest)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Area::getCoordinatesSouthEast()

Returns

\Firstred\PostNL\Entity\CoordinatesSouthEast | null

public Firstred\PostNL\Entity\Area::setCoordinatesSouthEast($CoordinatesSouthEast)

Parameters

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

Returns

static

Contact

class Firstred\PostNL\Entity\Contact

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($ContactType, $Email, $SMSNr, $TelNr)

• public getContactType()

• public setContactType($ContactType)

• public getEmail()

• public setEmail($Email)

• public getSMSNr()

• public getTelNr()

• public setTelNr($TelNr, $countryCode)

• public setSMSNr($SMSNr, $countryCode)

Properties

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)

Parameters

• $ContactType (string | null)

• $Email (string | null)

• $SMSNr (string | null)

• $TelNr (string | null)

public Firstred\PostNL\Entity\Contact::getContactType()

Returns

string | null

public Firstred\PostNL\Entity\Contact::setContactType($ContactType)

Parameters

• $ContactType (string | null)

Returns

static

public Firstred\PostNL\Entity\Contact::getEmail()

Returns

string | null

public Firstred\PostNL\Entity\Contact::setEmail($Email)

Parameters

• $Email (string | null)

Returns

static

public Firstred\PostNL\Entity\Contact::getSMSNr()

Returns

string | null

public Firstred\PostNL\Entity\Contact::getTelNr()

Returns

string | null

public Firstred\PostNL\Entity\Contact::setTelNr($TelNr=null, $countryCode=null)

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\Entity\Contact::setSMSNr($SMSNr=null, $countryCode=null)

Since

1.0.0

Since

1.0.0

Event

class Firstred\PostNL\Entity\Event

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($CompleteStatusResponseEvent)

• public getCompleteStatusResponseEvent()

• public setCompleteStatusResponseEvent($CompleteStatusResponseEvent)

Properties

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)

public Firstred\PostNL\Entity\Event::getCompleteStatusResponseEvent()

Returns

\Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent | null

public Firstred\PostNL\Entity\Event::setCompleteStatusResponseEvent($CompleteStatusResponseEvent)

Parameters

• $CompleteStatusResponseEvent (Firstred\PostNL\Entity\Response\CompleteStatusResponseEvent | null)

Returns

static

AbstractEntity

class Firstred\PostNL\Entity\AbstractEntity

Implements

JsonSerializable

Summary

Methods

• public __construct()

• public static create($properties)

• public getId()

• public setId($id)

• public setCurrentService($currentService)

• public getCurrentService()

• public getSerializableProperties($withAliases)

• public jsonSerialize()

• public static jsonDeserialize($json)

Properties

protected static property Firstred\PostNL\Entity\AbstractEntity::$id

Type

string

protected static property Firstred\PostNL\Entity\AbstractEntity::$currentService

Type

class-string

Methods

public Firstred\PostNL\Entity\AbstractEntity::__construct()

public static Firstred\PostNL\Entity\AbstractEntity::create( $properties=\[\])

Create an instance of this class without touching the constructor.

Parameters

• $properties (array)

Returns

\Firstred\PostNL\Entity\AbstractEntity

Since

1.0.0

Deprecated

2.0.0 Use the constructor instead with named arguments

public Firstred\PostNL\Entity\AbstractEntity::getId()

Returns

string

public Firstred\PostNL\Entity\AbstractEntity::setId(string|int $id)

Parameters

• $id (string | int)

Returns

static

public Firstred\PostNL\Entity\AbstractEntity::setCurrentService($currentService)

Parameters

• $currentService (class-string)

Returns

static

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

public Firstred\PostNL\Entity\AbstractEntity::getCurrentService()

Returns

class-string

public Firstred\PostNL\Entity\AbstractEntity::getSerializableProperties($withAliases=false)

Returns

array

Since

2.0.0

public Firstred\PostNL\Entity\AbstractEntity::jsonSerialize()

Return a serializable array for `json_encode`.

Returns

array

Throws

\Firstred\PostNL\Exception\ServiceNotSetException

public static Firstred\PostNL\Entity\AbstractEntity::jsonDeserialize($json)

Parameters

• $json (stdClass) {“EntityName”: object}

Returns

static

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.0.0

Label

class Firstred\PostNL\Entity\Label

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Content, $OutputType, $Labeltype)

• public getContent()

• public setContent($Content)

• public getOutputType()

• public setOutputType($OutputType)

• public getContenttype()

• public setContenttype($Contenttype)

• public getLabeltype()

• public setLabeltype($Labeltype)

Constants

FORMAT_A4 = 1

FORMAT_A6 = 2

Properties

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

Base 64 encoded content.

Type

string | null

protected static property Firstred\PostNL\Entity\Label::$OutputType

Type

string | null

protected static property Firstred\PostNL\Entity\Label::$Labeltype

Type

string | null

Methods

public Firstred\PostNL\Entity\Label::__construct($Content=null, $OutputType=null, $Labeltype=null)

Parameters

• $Content (string | null)

• $OutputType (string | null)

• $Labeltype (string | null)

public Firstred\PostNL\Entity\Label::getContent()

Returns

string | null

public Firstred\PostNL\Entity\Label::setContent($Content)

Parameters

• $Content (string | null)

Returns

static

public Firstred\PostNL\Entity\Label::getOutputType()

Returns

string | null

Since

1.4.2

public Firstred\PostNL\Entity\Label::setOutputType($OutputType)

Parameters

• $OutputType (string | null)

Returns

static

Since

1.4.2

public Firstred\PostNL\Entity\Label::getContenttype()

Returns

string | null

Deprecated

1.4.2

public Firstred\PostNL\Entity\Label::setContenttype($Contenttype)

Parameters

• $Contenttype (string | null)

Returns

static

Deprecated

1.4.2

public Firstred\PostNL\Entity\Label::getLabeltype()

Returns

string | null

public Firstred\PostNL\Entity\Label::setLabeltype($Labeltype)

Parameters

• $Labeltype (string | null)

Returns

static

Expectation

class Firstred\PostNL\Entity\Expectation

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($ETAFrom, $ETATo)

• public getETAFrom()

• public setETAFrom($ETAFrom)

• public getETATo()

• public setETATo($ETATo)

Properties

protected static property Firstred\PostNL\Entity\Expectation::$ETAFrom

Type

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Expectation::$ETATo

Type

\DateTimeInterface | null

Methods

public Firstred\PostNL\Entity\Expectation::__construct(\\DateTimeInterface|string|null $ETAFrom=null, \\DateTimeInterface|string|null $ETATo=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Expectation::getETAFrom()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Expectation::setETAFrom(\\DateTimeInterface|string|null $ETAFrom=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Expectation::getETATo()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Expectation::setETATo(\\DateTimeInterface|string|null $ETATo=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

Timeframes

class Firstred\PostNL\Entity\Timeframes

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($timeframes, $timeframetimeframes)

• public getTimeframes()

• public setTimeframes($Timeframes)

• public getTimeframeTimeFrames()

• public setTimeframeTimeFrames($TimeframeTimeFrames)

• public jsonSerialize()

Properties

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)

Parameters

• $timeframes (array | null)

• $timeframetimeframes (array | null)

public Firstred\PostNL\Entity\Timeframes::getTimeframes()

Returns

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

public Firstred\PostNL\Entity\Timeframes::setTimeframes($Timeframes)

Parameters

• $Timeframes (Firstred\PostNL\Entity\Timeframe[] | null)

Returns

static

public Firstred\PostNL\Entity\Timeframes::getTimeframeTimeFrames()

Returns

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

public Firstred\PostNL\Entity\Timeframes::setTimeframeTimeFrames($TimeframeTimeFrames)

Parameters

• $TimeframeTimeFrames (Firstred\PostNL\Entity\TimeframeTimeFrame[] | null)

Returns

static

public Firstred\PostNL\Entity\Timeframes::jsonSerialize()

Returns

array

Throws

\Firstred\PostNL\Exception\ServiceNotSetException

Group

class Firstred\PostNL\Entity\Group

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($GroupCount, $GroupSequence, $GroupType, $MainBarcode)

• public getGroupCount()

• public setGroupCount($GroupCount)

• public getGroupSequence()

• public setGroupSequence($GroupSequence)

• public getGroupType()

• public setGroupType($GroupType)

• public getMainBarcode()

• public setMainBarcode($MainBarcode)

Properties

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)

Parameters

• $GroupCount (string | null)

• $GroupSequence (string | null)

• $GroupType (string | null)

• $MainBarcode (string | null)

public Firstred\PostNL\Entity\Group::getGroupCount()

Returns

string | null

public Firstred\PostNL\Entity\Group::setGroupCount($GroupCount)

Parameters

• $GroupCount (string | null)

Returns

static

public Firstred\PostNL\Entity\Group::getGroupSequence()

Returns

string | null

public Firstred\PostNL\Entity\Group::setGroupSequence($GroupSequence)

Parameters

• $GroupSequence (string | null)

Returns

static

public Firstred\PostNL\Entity\Group::getGroupType()

Returns

string | null

public Firstred\PostNL\Entity\Group::setGroupType($GroupType)

Parameters

• $GroupType (string | null)

Returns

static

public Firstred\PostNL\Entity\Group::getMainBarcode()

Returns

string | null

public Firstred\PostNL\Entity\Group::setMainBarcode($MainBarcode)

Parameters

• $MainBarcode (string | null)

Returns

static

Address

class Firstred\PostNL\Entity\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 getZipcode()

• public setZipcode($Zipcode)

• public getAddressType()

• public setAddressType($AddressType)

• public getArea()

• public setArea($Area)

• public getBuildingname()

• public setBuildingname($Buildingname)

• public getCity()

• public setCity($City)

• public getCompanyName()

• public setCompanyName($CompanyName)

• public getCountrycode()

• public setCountrycode($Countrycode)

• public getDepartment()

• public setDepartment($Department)

• public getDoorcode()

• public setDoorcode($Doorcode)

• public getFirstName()

• public setFirstName($FirstName)

• public getFloor()

• public setFloor($Floor)

• public getHouseNr()

• public setHouseNr($HouseNr)

• public getHouseNrExt()

• public setHouseNrExt($HouseNrExt)

• public getStreetHouseNrExt()

• public setStreetHouseNrExt($StreetHouseNrExt)

• public getName()

• public setName($Name)

• public getRegion()

• public setRegion($Region)

• public getRemark()

• public setRemark($Remark)

• public getStreet()

• public setStreet($Street)

• public getOther()

• public setOther($other)

Properties

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

PostNL internal applications validate the receiver address. In case the spelling of

addresses should be different according to our PostNL information, the address details will

be corrected. This can be noticed in Track & Trace.

Please note that the webservice will not add address details. Street and City fields will

only be printed when they are in the call towards the labeling webservice.

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

Code Description

01 Receiver

02 Sender

03 Alternative sender address

04 Collection address (In the orders need to be collected first)

08 Return address*

09 Drop off location (for use with Pick up at PostNL location)

> * When using the ‘label in the box return label’, it is mandatory to use an

> `Antwoordnummer` in AddressType 08.

> This cannot be a regular address

The following rules apply:

If there is no Address specified with AddressType = 02, the data from Customer/Address

will be added to the list as AddressType 02.

If there is no Customer/Address, the message will be rejected.

At least one other AddressType must be specified, other than AddressType 02

In most cases this will be AddressType 01, the receiver address.

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Deprecated

2.0.0

Methods

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

Parameters

• $AddressType (string | null)

• $FirstName (string | null)

• $Name (string | null)

• $CompanyName (string | null)

• $Street (string | null)

• $HouseNr (string | null)

• $HouseNrExt (string | null)

• $Zipcode (string | null)

• $City (string | null)

• $Countrycode (string | null)

• $Area (string | null)

• $Buildingname (string | null)

• $Department (string | null)

• $Doorcode (string | null)

• $Floor (string | null)

• $Region (string | null)

• $Remark (string | null)

• $StreetHouseNrExt (string | null)

public Firstred\PostNL\Entity\Address::getZipcode()

Returns

string | null

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

Parameters

• $Zipcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getAddressType()

Returns

string | null

public Firstred\PostNL\Entity\Address::setAddressType(int|string|null $AddressType=null)

Parameters

• $AddressType (int | string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getArea()

Returns

string | null

public Firstred\PostNL\Entity\Address::setArea($Area)

Parameters

• $Area (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getBuildingname()

Returns

string | null

public Firstred\PostNL\Entity\Address::setBuildingname($Buildingname)

Parameters

• $Buildingname (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getCity()

Returns

string | null

public Firstred\PostNL\Entity\Address::setCity($City)

Parameters

• $City (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getCompanyName()

Returns

string | null

public Firstred\PostNL\Entity\Address::setCompanyName($CompanyName)

Parameters

• $CompanyName (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getCountrycode()

Returns

string | null

public Firstred\PostNL\Entity\Address::setCountrycode($Countrycode)

Parameters

• $Countrycode (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getDepartment()

Returns

string | null

public Firstred\PostNL\Entity\Address::setDepartment($Department)

Parameters

• $Department (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getDoorcode()

Returns

string | null

public Firstred\PostNL\Entity\Address::setDoorcode($Doorcode)

Parameters

• $Doorcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getFirstName()

Returns

string | null

public Firstred\PostNL\Entity\Address::setFirstName($FirstName)

Parameters

• $FirstName (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getFloor()

Returns

string | null

public Firstred\PostNL\Entity\Address::setFloor($Floor)

Parameters

• $Floor (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getHouseNr()

Returns

string | null

public Firstred\PostNL\Entity\Address::setHouseNr(int|string|null $HouseNr)

Parameters

• $HouseNr (int | string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getHouseNrExt()

Returns

string | null

public Firstred\PostNL\Entity\Address::setHouseNrExt(int|string|null $HouseNrExt)

Parameters

• $HouseNrExt (int | string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getStreetHouseNrExt()

Returns

string | null

public Firstred\PostNL\Entity\Address::setStreetHouseNrExt($StreetHouseNrExt)

Parameters

• $StreetHouseNrExt (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getName()

Returns

string | null

public Firstred\PostNL\Entity\Address::setName($Name)

Parameters

• $Name (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getRegion()

Returns

string | null

public Firstred\PostNL\Entity\Address::setRegion($Region)

Parameters

• $Region (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getRemark()

Returns

string | null

public Firstred\PostNL\Entity\Address::setRemark($Remark)

Parameters

• $Remark (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getStreet()

Returns

string | null

public Firstred\PostNL\Entity\Address::setStreet($Street)

Parameters

• $Street (string | null)

Returns

static

public Firstred\PostNL\Entity\Address::getOther()

Returns

array | null

Deprecated

2.0.0

public Firstred\PostNL\Entity\Address::setOther($other)

Parameters

• $other (array | null)

Returns

static

Deprecated

2.0.0

Customer

class Firstred\PostNL\Entity\Customer

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($CustomerNumber, $CustomerCode, $CollectionLocation, $ContactPerson, $Email, $Name, $Address, $GlobalPackCustomerCode, $GlobalPackBarcodeType)

• public getAddress()

• public setAddress($Address)

• public getCollectionLocation()

• public setCollectionLocation($CollectionLocation)

• public getContactPerson()

• public setContactPerson($ContactPerson)

• public getCustomerCode()

• public setCustomerCode($CustomerCode)

• public getCustomerNumber()

• public setCustomerNumber($CustomerNumber)

• public getGlobalPackCustomerCode()

• public setGlobalPackCustomerCode($GlobalPackCustomerCode)

• public getGlobalPackBarcodeType()

• public setGlobalPackBarcodeType($GlobalPackBarcodeType)

• public getEmail()

• public setEmail($Email)

• public getName()

• public setName($Name)

Properties

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)

• $CollectionLocation (string | null)

• $ContactPerson (string | null)

• $Email (string | null)

• $Name (string | null)

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

• $GlobalPackCustomerCode (string | null)

• $GlobalPackBarcodeType (string | null)

public Firstred\PostNL\Entity\Customer::getAddress()

Returns

\Firstred\PostNL\Entity\Address | null

public Firstred\PostNL\Entity\Customer::setAddress($Address)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Customer::getCollectionLocation()

Returns

string | null

public Firstred\PostNL\Entity\Customer::setCollectionLocation($CollectionLocation)

Parameters

• $CollectionLocation (string | null)

Returns

static

public Firstred\PostNL\Entity\Customer::getContactPerson()

Returns

string | null

public Firstred\PostNL\Entity\Customer::setContactPerson($ContactPerson)

Parameters

• $ContactPerson (string | null)

Returns

static

public Firstred\PostNL\Entity\Customer::getCustomerCode()

Returns

string | null

public Firstred\PostNL\Entity\Customer::setCustomerCode($CustomerCode)

Parameters

• $CustomerCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Customer::getCustomerNumber()

Returns

string | null

public Firstred\PostNL\Entity\Customer::setCustomerNumber($CustomerNumber)

Parameters

• $CustomerNumber (string | null)

Returns

static

public Firstred\PostNL\Entity\Customer::getGlobalPackCustomerCode()

Returns

string | null

public Firstred\PostNL\Entity\Customer::setGlobalPackCustomerCode($GlobalPackCustomerCode)

Parameters

• $GlobalPackCustomerCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Customer::getGlobalPackBarcodeType()

Returns

string | null

public Firstred\PostNL\Entity\Customer::setGlobalPackBarcodeType($GlobalPackBarcodeType)

Parameters

• $GlobalPackBarcodeType (string | null)

Returns

static

public Firstred\PostNL\Entity\Customer::getEmail()

Returns

string | null

public Firstred\PostNL\Entity\Customer::setEmail($Email)

Parameters

• $Email (string | null)

Returns

static

public Firstred\PostNL\Entity\Customer::getName()

Returns

string | null

public Firstred\PostNL\Entity\Customer::setName($Name)

Parameters

• $Name (string | null)

Returns

static

Coordinates

class Firstred\PostNL\Entity\Coordinates

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Latitude, $Longitude)

• public getLatitude()

• public setLatitude($Latitude)

• public getLongitude()

• public setLongitude($Longitude)

Properties

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 | null)

• $Longitude (string | null)

public Firstred\PostNL\Entity\Coordinates::getLatitude()

Returns

string | null

public Firstred\PostNL\Entity\Coordinates::setLatitude($Latitude)

Parameters

• $Latitude (string | null)

Returns

static

public Firstred\PostNL\Entity\Coordinates::getLongitude()

Returns

string | null

public Firstred\PostNL\Entity\Coordinates::setLongitude($Longitude)

Parameters

• $Longitude (string | null)

Returns

static

Signature

class Firstred\PostNL\Entity\Signature

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($GetSignatureResponseSignature, $Warnings)

• public getGetSignatureResponseSignature()

• public setGetSignatureResponseSignature($GetSignatureResponseSignature)

• public getWarnings()

• public setWarnings($Warnings)

Properties

protected static property Firstred\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)

Parameters

• $GetSignatureResponseSignature (Firstred\PostNL\Entity\Response\GetSignatureResponseSignature | null)

• $Warnings (array | null)

public Firstred\PostNL\Entity\Signature::getGetSignatureResponseSignature()

Returns

\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature | null

public Firstred\PostNL\Entity\Signature::setGetSignatureResponseSignature($GetSignatureResponseSignature)

Parameters

• $GetSignatureResponseSignature (Firstred\PostNL\Entity\Response\GetSignatureResponseSignature | null)

Returns

static

public Firstred\PostNL\Entity\Signature::getWarnings()

Returns

\Firstred\PostNL\Entity\Warning | null

public Firstred\PostNL\Entity\Signature::setWarnings($Warnings)

Parameters

• $Warnings (Firstred\PostNL\Entity\Warning[] | null)

Returns

static

Amount

class Firstred\PostNL\Entity\Amount

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($AccountName, $AmountType, $BIC, $Currency, $IBAN, $Reference, $TransactionNumber, $Value, $VerzekerdBedrag)

• public getAccountName()

• public setAccountName($AccountName)

• public getBIC()

• public setBIC($BIC)

• public getCurrency()

• public setCurrency($Currency)

• public getIBAN()

• public setIBAN($IBAN)

• public getReference()

• public setReference($Reference)

• public getTransactionNumber()

• public setTransactionNumber($TransactionNumber)

• public getValue()

• public setValue($Value)

• public getVerzekerdBedrag()

• public setVerzekerdBedrag($VerzekerdBedrag)

• public getAmountType()

• public setAmountType($AmountType)

Properties

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)

• $VerzekerdBedrag (string | null)

public Firstred\PostNL\Entity\Amount::getAccountName()

Returns

string | null

public Firstred\PostNL\Entity\Amount::setAccountName($AccountName)

Parameters

• $AccountName (string | null)

Returns

static

public Firstred\PostNL\Entity\Amount::getBIC()

Returns

string | null

public Firstred\PostNL\Entity\Amount::setBIC($BIC)

Parameters

• $BIC (string | null)

Returns

static

public Firstred\PostNL\Entity\Amount::getCurrency()

Returns

string | null

public Firstred\PostNL\Entity\Amount::setCurrency($Currency)

Parameters

• $Currency (string | null)

Returns

static

public Firstred\PostNL\Entity\Amount::getIBAN()

Returns

string | null

public Firstred\PostNL\Entity\Amount::setIBAN($IBAN)

Parameters

• $IBAN (string | null)

Returns

static

public Firstred\PostNL\Entity\Amount::getReference()

Returns

string | null

public Firstred\PostNL\Entity\Amount::setReference($Reference)

Parameters

• $Reference (string | null)

Returns

static

public Firstred\PostNL\Entity\Amount::getTransactionNumber()

Returns

string | null

public Firstred\PostNL\Entity\Amount::setTransactionNumber($TransactionNumber)

Parameters

• $TransactionNumber (string | null)

Returns

static

public Firstred\PostNL\Entity\Amount::getValue()

Returns

string | null

public Firstred\PostNL\Entity\Amount::setValue($Value)

Parameters

• $Value (string | null)

Returns

static

public Firstred\PostNL\Entity\Amount::getVerzekerdBedrag()

Returns

string | null

public Firstred\PostNL\Entity\Amount::setVerzekerdBedrag($VerzekerdBedrag)

Parameters

• $VerzekerdBedrag (string | null)

Returns

static

public Firstred\PostNL\Entity\Amount::getAmountType()

Returns

string | null

public Firstred\PostNL\Entity\Amount::setAmountType(string|int|null $AmountType=null)

Parameters

• $AmountType (string | int | null)

Returns

static

Dimension

class Firstred\PostNL\Entity\Dimension

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Weight, $Height, $Length, $Volume, $Width)

• public getHeight()

• public setHeight($Height)

• public getLength()

• public setLength($Length)

• public getVolume()

• public setVolume($Volume)

• public getWeight()

• public setWeight($Weight)

• public getWidth()

• public setWidth($Width)

Properties

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

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)

public Firstred\PostNL\Entity\Dimension::getHeight()

Returns

string | null

public Firstred\PostNL\Entity\Dimension::setHeight($Height)

Parameters

• $Height (string | null)

Returns

static

public Firstred\PostNL\Entity\Dimension::getLength()

Returns

string | null

public Firstred\PostNL\Entity\Dimension::setLength($Length)

Parameters

• $Length (string | null)

Returns

static

public Firstred\PostNL\Entity\Dimension::getVolume()

Returns

string | null

public Firstred\PostNL\Entity\Dimension::setVolume($Volume)

Parameters

• $Volume (string | null)

Returns

static

public Firstred\PostNL\Entity\Dimension::getWeight()

Returns

string | null

public Firstred\PostNL\Entity\Dimension::setWeight($Weight)

Parameters

• $Weight (string | null)

Returns

static

public Firstred\PostNL\Entity\Dimension::getWidth()

Returns

string | null

public Firstred\PostNL\Entity\Dimension::setWidth($Width)

Parameters

• $Width (string | null)

Returns

static

Barcode

class Firstred\PostNL\Entity\Barcode

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Type, $Range, $Serie)

• public getType()

• public setType($Type)

• public getRange()

• public setRange($Range)

• public getSerie()

• public setSerie($Serie)

Properties

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

Methods

public Firstred\PostNL\Entity\Barcode::__construct($Type=null, $Range=null, $Serie=\'000000000\-999999999\')

Parameters

• $Type (string | null)

• $Range (string | null)

• $Serie (string | null)

public Firstred\PostNL\Entity\Barcode::getType()

Returns

string | null

public Firstred\PostNL\Entity\Barcode::setType($Type)

Parameters

• $Type (string | null)

Returns

static

public Firstred\PostNL\Entity\Barcode::getRange()

Returns

string | null

public Firstred\PostNL\Entity\Barcode::setRange($Range)

Parameters

• $Range (string | null)

Returns

static

public Firstred\PostNL\Entity\Barcode::getSerie()

Returns

string | null

public Firstred\PostNL\Entity\Barcode::setSerie($Serie)

Parameters

• $Serie (string | null)

Returns

static

Location

class Firstred\PostNL\Entity\Location

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Postalcode, $AllowSundaySorting, $DeliveryDate, $DeliveryOptions, $OpeningTime, $Options, $Coordinates, $CoordinatesNorthWest, $CoordinatesSouthEast, $City, $Street, $HouseNr, $HouseNrExt, $LocationCode, $Saleschannel, $TerminalType, $RetailNetworkID, $DownPartnerID, $DownPartnerLocation)

• public setDeliveryDate($DeliveryDate)

• public setPostalcode($Postalcode)

• public setAllowSundaySorting($AllowSundaySorting)

• public getDeliveryOptions()

• public setDeliveryOptions($DeliveryOptions)

• public getOpeningTime()

• public setOpeningTime($OpeningTime)

• public getOptions()

• public setOptions($Options)

• public getCity()

• public setCity($City)

• public getHouseNr()

• public setHouseNr($HouseNr)

• public getHouseNrExt()

• public setHouseNrExt($HouseNrExt)

• public getStreet()

• public setStreet($Street)

• public getCoordinates()

• public setCoordinates($Coordinates)

• public getCoordinatesNorthWest()

• public setCoordinatesNorthWest($CoordinatesNorthWest)

• public getCoordinatesSouthEast()

• public setCoordinatesSouthEast($CoordinatesSouthEast)

• public getLocationCode()

• public setLocationCode($LocationCode)

• public getSaleschannel()

• public setSaleschannel($Saleschannel)

• public getTerminalType()

• public setTerminalType($TerminalType)

• public getRetailNetworkID()

• public setRetailNetworkID($RetailNetworkID)

• public getDownPartnerID()

• public setDownPartnerID($DownPartnerID)

• public getDownPartnerLocation()

• public setDownPartnerLocation($DownPartnerLocation)

• public getAllowSundaySorting()

• public getDeliveryDate()

• public getPostalcode()

Properties

protected static property Firstred\PostNL\Entity\Location::$AllowSundaySorting

Type

string | null

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

Type

\DateTimeInterface | 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

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

Methods

public Firstred\PostNL\Entity\Location::__construct($Postalcode=null, string|bool|int|null $AllowSundaySorting=null, string|\\DateTimeInterface|null $DeliveryDate=null, $DeliveryOptions=null, $OpeningTime=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)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

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

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Location::setPostalcode($Postalcode=null)

Parameters

• $Postalcode (string | null)

Returns

static

public Firstred\PostNL\Entity\Location::setAllowSundaySorting(string|bool|int|null $AllowSundaySorting=null)

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\Entity\Location::getDeliveryOptions()

Returns

string[] | null

public Firstred\PostNL\Entity\Location::setDeliveryOptions($DeliveryOptions)

Parameters

• $DeliveryOptions (string[] | null)

Returns

static

public Firstred\PostNL\Entity\Location::getOpeningTime()

Returns

string | null

public Firstred\PostNL\Entity\Location::setOpeningTime($OpeningTime)

Parameters

• $OpeningTime (string | null)

Returns

static

public Firstred\PostNL\Entity\Location::getOptions()

Returns

string[] | null

public Firstred\PostNL\Entity\Location::setOptions($Options)

Parameters

• $Options (string[] | null)

Returns

static

public Firstred\PostNL\Entity\Location::getCity()

Returns

string | null

public Firstred\PostNL\Entity\Location::setCity($City)

Parameters

• $City (string | null)

Returns

static

public Firstred\PostNL\Entity\Location::getHouseNr()

Returns

string | null

public Firstred\PostNL\Entity\Location::setHouseNr($HouseNr)

Parameters

• $HouseNr (string | null)

Returns

static

public Firstred\PostNL\Entity\Location::getHouseNrExt()

Returns

string | null

public Firstred\PostNL\Entity\Location::setHouseNrExt($HouseNrExt)

Parameters

• $HouseNrExt (string | null)

Returns

static

public Firstred\PostNL\Entity\Location::getStreet()

Returns

string | null

public Firstred\PostNL\Entity\Location::setStreet($Street)

Parameters

• $Street (string | null)

Returns

static

public Firstred\PostNL\Entity\Location::getCoordinates()

Returns

\Firstred\PostNL\Entity\Coordinates | null

public Firstred\PostNL\Entity\Location::setCoordinates($Coordinates)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Location::getCoordinatesNorthWest()

Returns

\Firstred\PostNL\Entity\CoordinatesNorthWest | null

public Firstred\PostNL\Entity\Location::setCoordinatesNorthWest($CoordinatesNorthWest)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Location::getCoordinatesSouthEast()

Returns

\Firstred\PostNL\Entity\CoordinatesSouthEast | null

public Firstred\PostNL\Entity\Location::setCoordinatesSouthEast($CoordinatesSouthEast)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Location::getLocationCode()

Returns

string | null

public Firstred\PostNL\Entity\Location::setLocationCode($LocationCode)

Parameters

• $LocationCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Location::getSaleschannel()

Returns

string | null

public Firstred\PostNL\Entity\Location::setSaleschannel($Saleschannel)

Parameters

• $Saleschannel (string | null)

Returns

static

public Firstred\PostNL\Entity\Location::getTerminalType()

Returns

string | null

public Firstred\PostNL\Entity\Location::setTerminalType($TerminalType)

Parameters

• $TerminalType (string | null)

Returns

static

public Firstred\PostNL\Entity\Location::getRetailNetworkID()

Returns

string | null

public Firstred\PostNL\Entity\Location::setRetailNetworkID($RetailNetworkID)

Parameters

• $RetailNetworkID (string | null)

Returns

static

public Firstred\PostNL\Entity\Location::getDownPartnerID()

Returns

string | null

public Firstred\PostNL\Entity\Location::setDownPartnerID($DownPartnerID)

Parameters

• $DownPartnerID (string | null)

Returns

static

public Firstred\PostNL\Entity\Location::getDownPartnerLocation()

Returns

string | null

public Firstred\PostNL\Entity\Location::setDownPartnerLocation($DownPartnerLocation)

Parameters

• $DownPartnerLocation (string | null)

Returns

static

public Firstred\PostNL\Entity\Location::getAllowSundaySorting()

Returns

string | null

public Firstred\PostNL\Entity\Location::getDeliveryDate()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Location::getPostalcode()

Returns

string | null

ProductOption

class Firstred\PostNL\Entity\ProductOption

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Characteristic, $Option, $Description)

• public getCharacteristic()

• public setCharacteristic($Characteristic)

• public getOption()

• public setOption($Option)

• public getDescription()

• public setDescription($Description)

Properties

protected static property Firstred\PostNL\Entity\ProductOption::$Characteristic

Type

string | null

protected static property Firstred\PostNL\Entity\ProductOption::$Option

Type

string | null

protected static property Firstred\PostNL\Entity\ProductOption::$Description

Type

string | null

Methods

public Firstred\PostNL\Entity\ProductOption::__construct($Characteristic=null, $Option=null, $Description=null)

Parameters

• $Characteristic (string | null)

• $Option (string | null)

• $Description (string | null)

public Firstred\PostNL\Entity\ProductOption::getCharacteristic()

Returns

string | null

public Firstred\PostNL\Entity\ProductOption::setCharacteristic($Characteristic)

Parameters

• $Characteristic (string | null)

Returns

static

public Firstred\PostNL\Entity\ProductOption::getOption()

Returns

string | null

public Firstred\PostNL\Entity\ProductOption::setOption($Option)

Parameters

• $Option (string | null)

Returns

static

public Firstred\PostNL\Entity\ProductOption::getDescription()

Returns

string | null

public Firstred\PostNL\Entity\ProductOption::setDescription($Description)

Parameters

• $Description (string | null)

Returns

static

Shipment

class Firstred\PostNL\Entity\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 getAddresses()

• public setAddresses($Addresses)

• public getAmounts()

• public setAmounts($Amounts)

• public getBarcode()

• public setBarcode($Barcode)

• public getContacts()

• public setContacts($Contacts)

• public getContent()

• public setContent($Content)

• public getCostCenter()

• public setCostCenter($CostCenter)

• public getCustomerOrderNumber()

• public setCustomerOrderNumber($CustomerOrderNumber)

• public getCustomer()

• public setCustomer($Customer)

• public getCustoms()

• public setCustoms($Customs)

• public getStatusCode()

• public setStatusCode($StatusCode)

• public getPhaseCode()

• public setPhaseCode($PhaseCode)

• public getDateFrom()

• public setDateFrom($DateFrom)

• public getDateTo()

• public setDateTo($DateTo)

• public getDeliveryAddress()

• public setDeliveryAddress($DeliveryAddress)

• public getDimension()

• public setDimension($Dimension)

• public getDownPartnerBarcode()

• public setDownPartnerBarcode($DownPartnerBarcode)

• public getDownPartnerID()

• public setDownPartnerID($DownPartnerID)

• public getDownPartnerLocation()

• public setDownPartnerLocation($DownPartnerLocation)

• public getEvents()

• public setEvents($Events)

• public getGroups()

• public setGroups($Groups)

• public getIDExpiration()

• public setIDExpiration($IDExpiration)

• public getIDNumber()

• public setIDNumber($IDNumber)

• public getIDType()

• public setIDType($IDType)

• public getOldStatuses()

• public setOldStatuses($OldStatuses)

• public getProductCodeCollect()

• public setProductCodeCollect($ProductCodeCollect)

• public getProductCodeDelivery()

• public setProductCodeDelivery($ProductCodeDelivery)

• public getProductOptions()

• public setProductOptions($ProductOptions)

• public getReceiverDateOfBirth()

• public setReceiverDateOfBirth($ReceiverDateOfBirth)

• public getReference()

• public setReference($Reference)

• public getReferenceCollect()

• public setReferenceCollect($ReferenceCollect)

• public getRemark()

• public setRemark($Remark)

• public getReturnBarcode()

• public setReturnBarcode($ReturnBarcode)

• public getReturnReference()

• public setReturnReference($ReturnReference)

• public getCollectionTimeStampEnd()

• public getCollectionTimeStampStart()

• public getDeliveryTimeStampStart()

• public getDeliveryTimeStampEnd()

• public getDeliveryDate()

• public setCollectionTimeStampStart($CollectionTimeStampStart)

• public setCollectionTimeStampEnd($CollectionTimeStampEnd)

• public setDeliveryTimeStampStart($DeliveryTimeStampStart)

• public setDeliveryTimeStampEnd($DeliveryTimeStampEnd)

• public setDeliveryDate($DeliveryDate)

Properties

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

Type

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

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

Type

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

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

Type

string | null

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

Type

\DateTimeInterface | null

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

Type

\DateTimeInterface | null

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

Type

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

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

\Firstred\PostNL\Entity\Customer | null

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

Type

\Firstred\PostNL\Entity\Customs | null

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

Type

string | null

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

Type

int | null

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

Type

\DateTimeInterface | null

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

Type

\DateTimeInterface | null

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

Type

string | null

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

Type

\DateTimeInterface | null

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

Type

\DateTimeInterface | null

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

Type

\DateTimeInterface | null

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

Type

\Firstred\PostNL\Entity\Dimension | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

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

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

Type

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

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

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

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

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

Type

string | null

Methods

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

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

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

Returns

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

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

Parameters

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

Returns

static

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

Returns

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

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

Parameters

• $Amounts (Firstred\PostNL\Entity\Amount[] | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setBarcode($Barcode)

Parameters

• $Barcode (string | null)

Returns

static

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

Returns

\Firstred\PostNL\Entity\Contact | null

public Firstred\PostNL\Entity\Shipment::setContacts($Contacts)

Parameters

• $Contacts (array | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setContent($Content)

Parameters

• $Content (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setCostCenter($CostCenter)

Parameters

• $CostCenter (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setCustomerOrderNumber($CustomerOrderNumber)

Parameters

• $CustomerOrderNumber (string | null)

Returns

static

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

Returns

\Firstred\PostNL\Entity\Customer | null

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

Parameters

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

Returns

static

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

Returns

\Firstred\PostNL\Entity\Customs | null

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

Parameters

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

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setStatusCode($StatusCode)

Parameters

• $StatusCode (string | null)

Returns

static

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

Returns

int | null

public Firstred\PostNL\Entity\Shipment::setPhaseCode($PhaseCode)

Parameters

• $PhaseCode (int | null)

Returns

static

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

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Shipment::setDateFrom($DateFrom)

Parameters

• $DateFrom (DateTimeInterface | null)

Returns

static

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

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Shipment::setDateTo($DateTo)

Parameters

• $DateTo (DateTimeInterface | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setDeliveryAddress($DeliveryAddress)

Parameters

• $DeliveryAddress (string | null)

Returns

static

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

Returns

\Firstred\PostNL\Entity\Dimension | null

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

Parameters

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

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setDownPartnerBarcode($DownPartnerBarcode)

Parameters

• $DownPartnerBarcode (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setDownPartnerID($DownPartnerID)

Parameters

• $DownPartnerID (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setDownPartnerLocation($DownPartnerLocation)

Parameters

• $DownPartnerLocation (string | null)

Returns

static

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

Returns

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

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

Parameters

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

Returns

static

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

Returns

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

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

Parameters

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

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setIDExpiration($IDExpiration)

Parameters

• $IDExpiration (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setIDNumber($IDNumber)

Parameters

• $IDNumber (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setIDType($IDType)

Parameters

• $IDType (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setOldStatuses($OldStatuses)

Parameters

• $OldStatuses (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setProductCodeCollect($ProductCodeCollect)

Parameters

• $ProductCodeCollect (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setProductCodeDelivery($ProductCodeDelivery)

Parameters

• $ProductCodeDelivery (string | null)

Returns

static

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

Returns

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

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

Parameters

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

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setReceiverDateOfBirth($ReceiverDateOfBirth)

Parameters

• $ReceiverDateOfBirth (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setReference($Reference)

Parameters

• $Reference (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setReferenceCollect($ReferenceCollect)

Parameters

• $ReferenceCollect (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setRemark($Remark)

Parameters

• $Remark (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setReturnBarcode($ReturnBarcode)

Parameters

• $ReturnBarcode (string | null)

Returns

static

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

Returns

string | null

public Firstred\PostNL\Entity\Shipment::setReturnReference($ReturnReference)

Parameters

• $ReturnReference (string | null)

Returns

static

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

Returns

\DateTimeInterface | null

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

Returns

\DateTimeInterface | null

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

Returns

\DateTimeInterface | null

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

Returns

\DateTimeInterface | null

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

Returns

\DateTimeInterface | null

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

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

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

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

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

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

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

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

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

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

Status

class Firstred\PostNL\Entity\Status

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($PhaseCode, $PhaseDescription, $StatusCode, $StatusDescription, $TimeStamp)

• public getPhaseCode()

• public setPhaseCode($PhaseCode)

• public getPhaseDescription()

• public setPhaseDescription($PhaseDescription)

• public getStatusCode()

• public setStatusCode($StatusCode)

• public getStatusDescription()

• public setStatusDescription($StatusDescription)

• public getTimeStamp()

• public setTimeStamp($TimeStamp)

Properties

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, string|\\DateTimeInterface|null $TimeStamp=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Status::getPhaseCode()

Returns

string | null

public Firstred\PostNL\Entity\Status::setPhaseCode($PhaseCode)

Parameters

• $PhaseCode (string | null)

Returns

\Firstred\PostNL\Entity\Status

public Firstred\PostNL\Entity\Status::getPhaseDescription()

Returns

string | null

public Firstred\PostNL\Entity\Status::setPhaseDescription($PhaseDescription)

Parameters

• $PhaseDescription (string | null)

Returns

\Firstred\PostNL\Entity\Status

public Firstred\PostNL\Entity\Status::getStatusCode()

Returns

string | null

public Firstred\PostNL\Entity\Status::setStatusCode($StatusCode)

Parameters

• $StatusCode (string | null)

Returns

\Firstred\PostNL\Entity\Status

public Firstred\PostNL\Entity\Status::getStatusDescription()

Returns

string | null

public Firstred\PostNL\Entity\Status::setStatusDescription($StatusDescription)

Parameters

• $StatusDescription (string | null)

Returns

\Firstred\PostNL\Entity\Status

public Firstred\PostNL\Entity\Status::getTimeStamp()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Status::setTimeStamp(string|\\DateTimeInterface|null $TimeStamp=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

Sustainability

class Firstred\PostNL\Entity\Sustainability

Class Sustainability.

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Code, $Description)

• public getCode()

• public setCode($Code)

• public getDescription()

• public setDescription($Description)

Properties

protected static property Firstred\PostNL\Entity\Sustainability::$Code

Type

string | null

protected static property Firstred\PostNL\Entity\Sustainability::$Description

Type

string | null

Methods

public Firstred\PostNL\Entity\Sustainability::__construct($Code=null, $Description=null)

Parameters

• $Code (string | null)

• $Description (string | null)

public Firstred\PostNL\Entity\Sustainability::getCode()

Returns

string | null

Since

1.4.2

public Firstred\PostNL\Entity\Sustainability::setCode($Code)

Parameters

• $Code (string | null)

Returns

static

Since

1.4.2

public Firstred\PostNL\Entity\Sustainability::getDescription()

Returns

string | null

Since

1.4.2

public Firstred\PostNL\Entity\Sustainability::setDescription($Description)

Parameters

• $Description (string | null)

Returns

static

Since

1.4.2

Timeframe

class Firstred\PostNL\Entity\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 getCity()

• public setCity($City)

• public getCountryCode()

• public setCountryCode($CountryCode)

• public getHouseNr()

• public setHouseNr($HouseNr)

• public getHouseNrExt()

• public setHouseNrExt($HouseNrExt)

• public getOptions()

• public setOptions($Options)

• public getStreet()

• public setStreet($Street)

• public getInterval()

• public setInterval($Interval)

• public getTimeframeRange()

• public setTimeframeRange($TimeframeRange)

• public getTimeframes()

• public setTimeframes($Timeframes)

• public getDate()

• public getEndDate()

• public getPostalCode()

• public getStartDate()

• public getSundaySorting()

• public setSundaySorting($SundaySorting)

• public jsonSerialize()

Properties

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

\DateTimeInterface | null

protected static property Firstred\PostNL\Entity\Timeframe::$Street

Type

string | null

protected static property Firstred\PostNL\Entity\Timeframe::$SundaySorting

Type

bool | 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

Methods

public Firstred\PostNL\Entity\Timeframe::__construct( $City=null, $CountryCode=null, string|\\DateTimeInterface|null $Date=null, string|\\DateTimeInterface|null $EndDate=null, $HouseNr=null, $HouseNrExt=null, $Options=\[\], $PostalCode=null, $Street=null, $SundaySorting=\'false\', $Interval=null, $Range=null, $Timeframes=null, string|\\DateTimeInterface|null $StartDate=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\Timeframe::setDate(string|\\DateTimeInterface|null $Date=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Timeframe::setStartDate(string|\\DateTimeInterface|null $StartDate=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Timeframe::setEndDate(string|\\DateTimeInterface|null $EndDate=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\Timeframe::setPostalCode($PostalCode=null)

Parameters

• $PostalCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Timeframe::getCity()

Returns

string | null

public Firstred\PostNL\Entity\Timeframe::setCity($City)

Parameters

• $City (string | null)

Returns

\Firstred\PostNL\Entity\Timeframe

public Firstred\PostNL\Entity\Timeframe::getCountryCode()

Returns

string | null

public Firstred\PostNL\Entity\Timeframe::setCountryCode($CountryCode)

Parameters

• $CountryCode (string | null)

Returns

\Firstred\PostNL\Entity\Timeframe

public Firstred\PostNL\Entity\Timeframe::getHouseNr()

Returns

string | null

public Firstred\PostNL\Entity\Timeframe::setHouseNr($HouseNr)

Parameters

• $HouseNr (string | null)

Returns

\Firstred\PostNL\Entity\Timeframe

public Firstred\PostNL\Entity\Timeframe::getHouseNrExt()

Returns

string | null

public Firstred\PostNL\Entity\Timeframe::setHouseNrExt($HouseNrExt)

Parameters

• $HouseNrExt (string | null)

Returns

\Firstred\PostNL\Entity\Timeframe

public Firstred\PostNL\Entity\Timeframe::getOptions()

Returns

array | null

public Firstred\PostNL\Entity\Timeframe::setOptions($Options)

Parameters

• $Options (array | null)

Returns

\Firstred\PostNL\Entity\Timeframe

public Firstred\PostNL\Entity\Timeframe::getStreet()

Returns

string | null

public Firstred\PostNL\Entity\Timeframe::setStreet($Street)

Parameters

• $Street (string | null)

Returns

static

public Firstred\PostNL\Entity\Timeframe::getInterval()

Returns

string | null

public Firstred\PostNL\Entity\Timeframe::setInterval($Interval)

Parameters

• $Interval (string | null)

Returns

static

public Firstred\PostNL\Entity\Timeframe::getTimeframeRange()

Returns

string | null

public Firstred\PostNL\Entity\Timeframe::setTimeframeRange($TimeframeRange)

Parameters

• $TimeframeRange (string | null)

Returns

static

public Firstred\PostNL\Entity\Timeframe::getTimeframes()

Returns

\Firstred\PostNL\Entity\TimeframeTimeFrame[] | \Firstred\PostNL\Entity\Timeframe[] | null

public Firstred\PostNL\Entity\Timeframe::setTimeframes($Timeframes)

Parameters

• $Timeframes (Firstred\PostNL\Entity\TimeframeTimeFrame[] | \Firstred\PostNL\Entity\Timeframe[] | null)

Returns

static

public Firstred\PostNL\Entity\Timeframe::getDate()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Timeframe::getEndDate()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Timeframe::getPostalCode()

Returns

string | null

public Firstred\PostNL\Entity\Timeframe::getStartDate()

Returns

\DateTimeInterface | null

public Firstred\PostNL\Entity\Timeframe::getSundaySorting()

Returns

bool | null

public Firstred\PostNL\Entity\Timeframe::setSundaySorting(string|bool|int|null $SundaySorting=null)

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\Entity\Timeframe::jsonSerialize()

Returns

array

Throws

\Firstred\PostNL\Exception\ServiceNotSetException

Customs

class Firstred\PostNL\Entity\Customs

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Certificate, $CertificateNr, $Content, $Currency, $HandleAsNonDeliverable, $Invoice, $InvoiceNr, $License, $LicenseNr, $ShipmentType, $TrustedShipperID, $TransactionCode, $TransactionDescription, $ImporterReferenceCode)

• public getCertificate()

• public setCertificate($Certificate)

• public getCertificateNr()

• public setCertificateNr($CertificateNr)

• public getContent()

• public setContent($Content)

• public getCurrency()

• public setCurrency($Currency)

• public getHandleAsNonDeliverable()

• public setHandleAsNonDeliverable($HandleAsNonDeliverable)

• public getInvoice()

• public setInvoice($Invoice)

• public getInvoiceNr()

• public setInvoiceNr($InvoiceNr)

• public getLicense()

• public setLicense($License)

• public getLicenseNr()

• public setLicenseNr($LicenseNr)

• public getShipmentType()

• public setShipmentType($ShipmentType)

• public getTrustedShipperID()

• public setTrustedShipperID($TrustedShipperID)

• public getTransactionCode()

• public setTransactionCode($TransactionCode)

• public getTransactionDescription()

• public setTransactionDescription($TransactionDescription)

• public getImporterReferenceCode()

• public setImporterReferenceCode($ImporterReferenceCode)

Properties

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

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

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, $ImporterReferenceCode=null)

Parameters

• $Certificate (string | null)

• $CertificateNr (string | null)

• $Content (array | 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)

• $ImporterReferenceCode (string | null)

public Firstred\PostNL\Entity\Customs::getCertificate()

Returns

string | null

public Firstred\PostNL\Entity\Customs::setCertificate($Certificate)

Parameters

• $Certificate (string | null)

Returns

static

public Firstred\PostNL\Entity\Customs::getCertificateNr()

Returns

string | null

public Firstred\PostNL\Entity\Customs::setCertificateNr($CertificateNr)

Parameters

• $CertificateNr (string | null)

Returns

static

public Firstred\PostNL\Entity\Customs::getContent()

Returns

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

public Firstred\PostNL\Entity\Customs::setContent($Content)

Parameters

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

Returns

static

public Firstred\PostNL\Entity\Customs::getCurrency()

Returns

string | null

public Firstred\PostNL\Entity\Customs::setCurrency($Currency)

Parameters

• $Currency (string | null)

Returns

static

public Firstred\PostNL\Entity\Customs::getHandleAsNonDeliverable()

Returns

string | null

public Firstred\PostNL\Entity\Customs::setHandleAsNonDeliverable($HandleAsNonDeliverable)

Parameters

• $HandleAsNonDeliverable (string | null)

Returns

static

public Firstred\PostNL\Entity\Customs::getInvoice()

Returns

string | null

public Firstred\PostNL\Entity\Customs::setInvoice($Invoice)

Parameters

• $Invoice (string | null)

Returns

static

public Firstred\PostNL\Entity\Customs::getInvoiceNr()

Returns

string | null

public Firstred\PostNL\Entity\Customs::setInvoiceNr($InvoiceNr)

Parameters

• $InvoiceNr (string | null)

Returns

static

public Firstred\PostNL\Entity\Customs::getLicense()

Returns

string | null

public Firstred\PostNL\Entity\Customs::setLicense($License)

Parameters

• $License (string | null)

Returns

static

public Firstred\PostNL\Entity\Customs::getLicenseNr()

Returns

string | null

public Firstred\PostNL\Entity\Customs::setLicenseNr($LicenseNr)

Parameters

• $LicenseNr (string | null)

Returns

static

public Firstred\PostNL\Entity\Customs::getShipmentType()

Returns

string | null

public Firstred\PostNL\Entity\Customs::setShipmentType($ShipmentType)

Parameters

• $ShipmentType (string | null)

Returns

static

public Firstred\PostNL\Entity\Customs::getTrustedShipperID()

Returns

string | null

public Firstred\PostNL\Entity\Customs::setTrustedShipperID($TrustedShipperID)

Parameters

• $TrustedShipperID (string | null)

Returns

static

public Firstred\PostNL\Entity\Customs::getTransactionCode()

Returns

string | null

public Firstred\PostNL\Entity\Customs::setTransactionCode($TransactionCode)

Parameters

• $TransactionCode (string | null)

Returns

static

public Firstred\PostNL\Entity\Customs::getTransactionDescription()

Returns

string | null

public Firstred\PostNL\Entity\Customs::setTransactionDescription($TransactionDescription)

Parameters

• $TransactionDescription (string | null)

Returns

static

public Firstred\PostNL\Entity\Customs::getImporterReferenceCode()

Returns

string | null

public Firstred\PostNL\Entity\Customs::setImporterReferenceCode($ImporterReferenceCode)

Parameters

• $ImporterReferenceCode (string | null)

Returns

static

TimeframeTimeFrame

class Firstred\PostNL\Entity\TimeframeTimeFrame

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($GetSentDate, $From, $To, $Options, $Sustainability)

• public getDate()

• public setDate($Date)

• public getFrom()

• public setFrom($From)

• public getTo()

• public setTo($To)

• public getOptions()

• public setOptions($Options)

• public getSustainability()

• public setSustainability($Sustainability)

• public static jsonDeserialize($json)

Properties

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::$To

Type

string | null

protected static property Firstred\PostNL\Entity\TimeframeTimeFrame::$Options

Type

string[] | null

protected static property Firstred\PostNL\Entity\TimeframeTimeFrame::$Sustainability

Type

\Firstred\PostNL\Entity\Sustainability | null

Methods

public Firstred\PostNL\Entity\TimeframeTimeFrame::__construct($GetSentDate=null, $From=null, $To=null, $Options=null, $Sustainability=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Entity\TimeframeTimeFrame::getDate()

Returns

string | null

public Firstred\PostNL\Entity\TimeframeTimeFrame::setDate(string|\\DateTimeInterface|null $Date=null)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\TimeframeTimeFrame::getFrom()

Returns

string | null

public Firstred\PostNL\Entity\TimeframeTimeFrame::setFrom($From)

Parameters

• $From (string | null)

Returns

static

public Firstred\PostNL\Entity\TimeframeTimeFrame::getTo()

Returns

string | null

public Firstred\PostNL\Entity\TimeframeTimeFrame::setTo($To)

Parameters

• $To (string | null)

Returns

static

public Firstred\PostNL\Entity\TimeframeTimeFrame::getOptions()

Returns

string[] | null

public Firstred\PostNL\Entity\TimeframeTimeFrame::setOptions($Options)

Parameters

• $Options (string[] | null)

Returns

static

public Firstred\PostNL\Entity\TimeframeTimeFrame::getSustainability()

Returns

\Firstred\PostNL\Entity\Sustainability | null

Since

1.4.2

public Firstred\PostNL\Entity\TimeframeTimeFrame::setSustainability($Sustainability)

Parameters

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

Returns

static

Since

1.4.2

public static Firstred\PostNL\Entity\TimeframeTimeFrame::jsonDeserialize($json)

Parameters

• $json (stdClass)

Returns

\Firstred\PostNL\Entity\TimeframeTimeFrame

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.2.0

CoordinatesNorthWest

class Firstred\PostNL\Entity\CoordinatesNorthWest

Parent

Firstred\PostNL\Entity\Coordinates

Summary

CutOffTime

class Firstred\PostNL\Entity\CutOffTime

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($Day, $Time, $Available)

• public getDay()

• public setDay($Day)

• public getTime()

• public setTime($Time)

• public getAvailable()

• public setAvailable($Available)

Properties

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 | null)

• $Time (string | null)

• $Available (bool | null)

public Firstred\PostNL\Entity\CutOffTime::getDay()

Returns

string | null

public Firstred\PostNL\Entity\CutOffTime::setDay($Day)

Parameters

• $Day (string | null)

Returns

static

public Firstred\PostNL\Entity\CutOffTime::getTime()

Returns

string | null

public Firstred\PostNL\Entity\CutOffTime::setTime($Time)

Parameters

• $Time (string | null)

Returns

static

public Firstred\PostNL\Entity\CutOffTime::getAvailable()

Returns

bool | null

public Firstred\PostNL\Entity\CutOffTime::setAvailable($Available)

Parameters

• $Available (bool | null)

Returns

static

Content

class Firstred\PostNL\Entity\Content

Parent

Firstred\PostNL\Entity\AbstractEntity

Summary

Methods

• public __construct($CountryOfOrigin, $Description, $HSTariffNr, $Quantity, $Value, $Weight, $Content)

• public getCountryOfOrigin()

• public setCountryOfOrigin($CountryOfOrigin)

• public getDescription()

• public setDescription($Description)

• public getHSTariffNr()

• public setHSTariffNr($HSTariffNr)

• public getQuantity()

• public setQuantity($Quantity)

• public getValue()

• public setValue($Value)

• public getWeight()

• public setWeight($Weight)

• public getContent()

• public setContent($Content)

Properties

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 (array | null)

public Firstred\PostNL\Entity\Content::getCountryOfOrigin()

Returns

string | null

public Firstred\PostNL\Entity\Content::setCountryOfOrigin($CountryOfOrigin)

Parameters

• $CountryOfOrigin (string | null)

Returns

static

public Firstred\PostNL\Entity\Content::getDescription()

Returns

string | null

public Firstred\PostNL\Entity\Content::setDescription($Description)

Parameters

• $Description (string | null)

Returns

static

public Firstred\PostNL\Entity\Content::getHSTariffNr()

Returns

string | null

public Firstred\PostNL\Entity\Content::setHSTariffNr($HSTariffNr)

Parameters

• $HSTariffNr (string | null)

Returns

static

public Firstred\PostNL\Entity\Content::getQuantity()

Returns

string | null

public Firstred\PostNL\Entity\Content::setQuantity($Quantity)

Parameters

• $Quantity (string | null)

Returns

static

public Firstred\PostNL\Entity\Content::getValue()

Returns

string | null

public Firstred\PostNL\Entity\Content::setValue($Value)

Parameters

• $Value (string | null)

Returns

static

public Firstred\PostNL\Entity\Content::getWeight()

Returns

string | null

public Firstred\PostNL\Entity\Content::setWeight($Weight)

Parameters

• $Weight (string | null)

Returns

static

public Firstred\PostNL\Entity\Content::getContent()

Returns

\Firstred\PostNL\Entity\Content | null

public Firstred\PostNL\Entity\Content::setContent($Content)

Parameters

• $Content (array | null)

Returns

static

OpeningHours

class Firstred\PostNL\Entity\OpeningHours

Parent

Firstred\PostNL\Entity\AbstractEntity

Implements

ArrayAccess Iterator

Summary

Methods

• public __construct($Monday, $Tuesday, $Wednesday, $Thursday, $Friday, $Saturday, $Sunday)

• public getMonday()

• public setMonday($Monday)

• public getTuesday()

• public setTuesday($Tuesday)

• public getWednesday()

• public setWednesday($Wednesday)

• public getThursday()

• public setThursday($Thursday)

• public getFriday()

• public setFriday($Friday)

• public getSaturday()

• public setSaturday($Saturday)

• public getSunday()

• public setSunday($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()

• private static findCurrentDayString($currentDay)

Properties

private static property Firstred\PostNL\Entity\OpeningHours::$currentDay

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

Type

string[] | null

protected static property Firstred\PostNL\Entity\OpeningHours::$Sunday

Type

string[] | null

Methods

public Firstred\PostNL\Entity\OpeningHours::__construct(array|null $Monday=null, array|null $Tuesday=null, array|null $Wednesday=null, array|null $Thursday=null, array|null $Friday=null, array|null $Saturday=null, array|null $Sunday=null)

Parameters

• $Monday (array | null)

• $Tuesday (array | null)

• $Wednesday (array | null)

• $Thursday (array | null)

• $Friday (array | null)

• $Saturday (array | null)

• $Sunday (array | null)

public Firstred\PostNL\Entity\OpeningHours::getMonday()

Returns

array | null

public Firstred\PostNL\Entity\OpeningHours::setMonday(array|null $Monday)

Parameters

• $Monday (array | null)

Returns

\Firstred\PostNL\Entity\OpeningHours

public Firstred\PostNL\Entity\OpeningHours::getTuesday()

Returns

array | null

public Firstred\PostNL\Entity\OpeningHours::setTuesday(array|null $Tuesday)

Parameters

• $Tuesday (array | null)

Returns

\Firstred\PostNL\Entity\OpeningHours

public Firstred\PostNL\Entity\OpeningHours::getWednesday()

Returns

array | null

public Firstred\PostNL\Entity\OpeningHours::setWednesday(array|null $Wednesday)

Parameters

• $Wednesday (array | null)

Returns

\Firstred\PostNL\Entity\OpeningHours

public Firstred\PostNL\Entity\OpeningHours::getThursday()

Returns

array | null

public Firstred\PostNL\Entity\OpeningHours::setThursday(array|null $Thursday)

Parameters

• $Thursday (array | null)

Returns

\Firstred\PostNL\Entity\OpeningHours

public Firstred\PostNL\Entity\OpeningHours::getFriday()

Returns

array | string | null

public Firstred\PostNL\Entity\OpeningHours::setFriday(array|null $Friday)

Parameters

• $Friday (array | null)

Returns

\Firstred\PostNL\Entity\OpeningHours

public Firstred\PostNL\Entity\OpeningHours::getSaturday()

Returns

array | null

public Firstred\PostNL\Entity\OpeningHours::setSaturday(array|null $Saturday)

Parameters

• $Saturday (array | null)

Returns

\Firstred\PostNL\Entity\OpeningHours

public Firstred\PostNL\Entity\OpeningHours::getSunday()

Returns

array | null

public Firstred\PostNL\Entity\OpeningHours::setSunday(array|null $Sunday)

Parameters

• $Sunday (array | null)

Returns

\Firstred\PostNL\Entity\OpeningHours

public static Firstred\PostNL\Entity\OpeningHours::jsonDeserialize($json)

Parameters

• $json (stdClass)

Returns

\Firstred\PostNL\Entity\OpeningHours

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.0.0

public Firstred\PostNL\Entity\OpeningHours::toArray()

Returns

array{Monday: string[], Tuesday: string[], Wednesday: string[], Thursday: string[], Friday: string[], Saturday: string[], Sunday: string[]}

public Firstred\PostNL\Entity\OpeningHours::offsetExists($offset)

Since

1.2.0

public Firstred\PostNL\Entity\OpeningHours::offsetGet($offset)

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\OpeningHours::offsetSet($offset, $value)

Since

1.2.0

public Firstred\PostNL\Entity\OpeningHours::offsetUnset($offset)

Since

1.2.0

public Firstred\PostNL\Entity\OpeningHours::current()

Returns

mixed

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\OpeningHours::next()

Since

1.2.0

public Firstred\PostNL\Entity\OpeningHours::key()

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\Entity\OpeningHours::valid()

Returns

bool

Since

1.2.0

public Firstred\PostNL\Entity\OpeningHours::rewind()

Since

1.2.0

private static Firstred\PostNL\Entity\OpeningHours::findCurrentDayString(string|int $currentDay)

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

Enum

\Firstred\PostNL\Enum

Exception

\Firstred\PostNL\Exception

Classes

ApiConnectionException

class Firstred\PostNL\Exception\ApiConnectionException

Class ApiConnectionException.

Thrown when there is a problem connecting to the CIF API.

Parent

Firstred\PostNL\Exception\ApiException

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

NotSupportedException

class Firstred\PostNL\Exception\NotSupportedException

Class NotSupportedException.

Thrown when a feature is not supported (anymore).

Parent

Firstred\PostNL\Exception\PostNLException

Summary

ApiException

class Firstred\PostNL\Exception\ApiException

Class ApiException.

Group of API exceptions.

Parent

Firstred\PostNL\Exception\PostNLException

Summary

InvalidMethodException

class Firstred\PostNL\Exception\InvalidMethodException

Class InvalidMethodException.

Thrown when an invalid method is called.

Parent

Firstred\PostNL\Exception\HttpClientException

Summary

DeserializationException

class Firstred\PostNL\Exception\DeserializationException

Parent

Firstred\PostNL\Exception\PostNLException

Summary

Methods

• public __construct($message, $code, $previous, $value)

Methods

public Firstred\PostNL\Exception\DeserializationException::__construct($message=\'\', $code=0, $previous=null, $value=null)

Parameters

• $message (string)

• $code (int)

• $previous (Throwable | null)

• $value (mixed | null)

ResponseException

class Firstred\PostNL\Exception\ResponseException

Class ResponseException.

Thrown when there was a problem with the response returned by the CIF API.

Parent

Firstred\PostNL\Exception\ApiException

Summary

Methods

• public __construct($message, $code, $previous, $response)

• public setResponse($response)

• public getResponse()

Properties

private static property Firstred\PostNL\Exception\ResponseException::$response

Type

\Psr\Http\Message\ResponseInterface

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.

Thrown when an invalid barcode has been passed.

Parent

Firstred\PostNL\Exception\InvalidArgumentException

Summary

ServiceNotSetException

class Firstred\PostNL\Exception\ServiceNotSetException

Parent

Firstred\PostNL\Exception\InvalidConfigurationException

Summary

CifException

class Firstred\PostNL\Exception\CifException

Class CifException.

Thrown when the CIF API has a fatal error.

Parent

Firstred\PostNL\Exception\ApiException

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.

Thrown when the CIF API is down.

Parent

Firstred\PostNL\Exception\ApiException

Summary

PostNLException

class Firstred\PostNL\Exception\PostNLException

Class AbstractException.

Group of exceptions that can be thrown by this library.

Parent

Exception

Summary

InvalidArgumentException

class Firstred\PostNL\Exception\InvalidArgumentException

Class InvalidArgumentException.

Group of exceptions that are the result of an invalid passed argument.

Parent

Firstred\PostNL\Exception\PostNLException

Summary

HttpClientException

class Firstred\PostNL\Exception\HttpClientException

Class HttpClientException.

Thrown when the HTTP Client has an error.

Parent

Firstred\PostNL\Exception\PostNLException

Summary

Methods

• public __construct($message, $code, $previous, $response)

• public setResponse($response)

• public getResponse()

Properties

private static property Firstred\PostNL\Exception\HttpClientException::$response

Methods

public Firstred\PostNL\Exception\HttpClientException::__construct($message=\'\', $code=0, $previous=null, $response=null)

public Firstred\PostNL\Exception\HttpClientException::setResponse($response)

public Firstred\PostNL\Exception\HttpClientException::getResponse()

InvalidConfigurationException

class Firstred\PostNL\Exception\InvalidConfigurationException

Class InvalidConfigurationException.

Thrown when there is a configuration error.

Parent

Firstred\PostNL\Exception\PostNLException

Summary

NotImplementedException

class Firstred\PostNL\Exception\NotImplementedException

Class NotImplementedException.

Thrown when a feature is not implemented (yet).

Parent

Firstred\PostNL\Exception\InvalidArgumentException

Summary

ShipmentNotFoundException

class Firstred\PostNL\Exception\ShipmentNotFoundException

Class InvalidArgumentException.

Thrown when a `Shipment` object could not be found.

Parent

Firstred\PostNL\Exception\NotFoundException

Summary

NotFoundException

class Firstred\PostNL\Exception\NotFoundException

Class NotFoundException.

Thrown when (a) requested object(s) could not be found.

Parent

Firstred\PostNL\Exception\ApiException

Summary

HttpClient

\Firstred\PostNL\HttpClient

Interfaces

HttpClientInterface

interface Firstred\PostNL\HttpClient\HttpClientInterface

Interface ClientInterface.

Parent

Psr\Log\LoggerAwareInterface

Summary

Methods

• public getLogger()

• public addOrUpdateRequest($id, $request)

• public removeRequest($id)

• public clearRequests()

• public doRequest($request)

• public doRequests($requests)

Methods

public Firstred\PostNL\HttpClient\HttpClientInterface::getLogger()

Get the logger.

Returns

\Psr\Log\LoggerInterface

public Firstred\PostNL\HttpClient\HttpClientInterface::addOrUpdateRequest($id, $request)

Adds a request to the list of pending requests

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\HttpClientInterface::removeRequest($id)

Remove a request from the list of pending requests.

Parameters

• $id (string)

public Firstred\PostNL\HttpClient\HttpClientInterface::clearRequests()

Clear all requests.

public Firstred\PostNL\HttpClient\HttpClientInterface::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\HttpClientInterface::doRequests( $requests=\[\])

Do all async requests.

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

CurlHttpClient

class Firstred\PostNL\HttpClient\CurlHttpClient

Class CurlClient.

Parent

Firstred\PostNL\HttpClient\BaseHttpClient

Implements

Firstred\PostNL\HttpClient\HttpClientInterface

Summary

Methods

• public doRequest($request)

• public doRequests($requests)

• protected prepareRequest($curl, $request)

• private handleCurlError($url, $errno, $message)

Properties

protected static property Firstred\PostNL\HttpClient\CurlHttpClient::$defaultOptions

Type

array | callable | null

Methods

public Firstred\PostNL\HttpClient\CurlHttpClient::doRequest($request)

Do a single request.

Exceptions are captured into the result array

Throws

\Firstred\PostNL\Exception\HttpClientException

public Firstred\PostNL\HttpClient\CurlHttpClient::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\CurlHttpClient::prepareRequest($curl, $request)

Parameters

• $curl (resource)

• $request (Psr\Http\Message\RequestInterface)

Throws

\Firstred\PostNL\Exception\HttpClientException

private Firstred\PostNL\HttpClient\CurlHttpClient::handleCurlError($url, $errno, $message)

Parameters

• $url

• $errno (Firstred\PostNL\HttpClient\number)

• $message (string)

Throws

\Firstred\PostNL\Exception\ApiConnectionException

BaseHttpClient

class Firstred\PostNL\HttpClient\BaseHttpClient

Implements

Psr\Log\LoggerAwareInterface

Summary

Methods

• public getTimeout()

• public setTimeout($seconds)

• public getConnectTimeout()

• public setConnectTimeout($seconds)

• public getLogger()

• public setLogger($logger)

• public getMaxRetries()

• public setMaxRetries($maxRetries)

• public setConcurrency($concurrency)

• public getConcurrency()

• public addOrUpdateRequest($id, $request)

• public removeRequest($id)

• public clearRequests()

• public doRequests($requests)

• public getRequestFactory()

• public setRequestFactory($requestFactory)

• public getResponseFactory()

• public setResponseFactory($responseFactory)

• public getStreamFactory()

• public setStreamFactory($streamFactory)

Constants

DEFAULT_TIMEOUT = 80

DEFAULT_CONNECT_TIMEOUT = 30

Properties

protected static property Firstred\PostNL\HttpClient\BaseHttpClient::$timeout

protected static property Firstred\PostNL\HttpClient\BaseHttpClient::$connectTimeout

protected static property Firstred\PostNL\HttpClient\BaseHttpClient::$pendingRequests

protected static property Firstred\PostNL\HttpClient\BaseHttpClient::$logger

protected static property Firstred\PostNL\HttpClient\BaseHttpClient::$maxRetries

protected static property Firstred\PostNL\HttpClient\BaseHttpClient::$concurrency

protected static property Firstred\PostNL\HttpClient\BaseHttpClient::$requestFactory

protected static property Firstred\PostNL\HttpClient\BaseHttpClient::$responseFactory

protected static property Firstred\PostNL\HttpClient\BaseHttpClient::$streamFactory

Methods

public Firstred\PostNL\HttpClient\BaseHttpClient::getTimeout()

public Firstred\PostNL\HttpClient\BaseHttpClient::setTimeout($seconds)

public Firstred\PostNL\HttpClient\BaseHttpClient::getConnectTimeout()

public Firstred\PostNL\HttpClient\BaseHttpClient::setConnectTimeout($seconds)

public Firstred\PostNL\HttpClient\BaseHttpClient::getLogger()

Get logger.

Returns

\Psr\Log\LoggerInterface

public Firstred\PostNL\HttpClient\BaseHttpClient::setLogger($logger)

Set the logger.

Parameters

• $logger (Psr\Log\LoggerInterface)

public Firstred\PostNL\HttpClient\BaseHttpClient::getMaxRetries()

Return max retries.

Returns

int

public Firstred\PostNL\HttpClient\BaseHttpClient::setMaxRetries($maxRetries)

Set the amount of retries.

Parameters

• $maxRetries (int)

Returns

static

public Firstred\PostNL\HttpClient\BaseHttpClient::setConcurrency($concurrency)

Set the concurrency.

Parameters

• $concurrency (int)

Returns

static

public Firstred\PostNL\HttpClient\BaseHttpClient::getConcurrency()

Return concurrency.

Returns

int

public Firstred\PostNL\HttpClient\BaseHttpClient::addOrUpdateRequest($id, $request)

Adds a request to the list of pending requests

Using the ID you can replace a request.

Parameters

• $id (string) Request ID

• $request (Psr\Http\Message\RequestInterface) PSR-7 request

Returns

int | string

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\HttpClient\BaseHttpClient::removeRequest($id)

Remove a request from the list of pending requests.

Parameters

• $id (string)

public Firstred\PostNL\HttpClient\BaseHttpClient::clearRequests()

Clear all pending requests.

public Firstred\PostNL\HttpClient\BaseHttpClient::doRequests( $requests=\[\])

Do all async requests.

Exceptions are captured into the result array

Parameters

• $requests (Psr\Http\Message\RequestInterface[])

Returns

\Firstred\PostNL\Exception\HttpClientException[] | \Psr\Http\Message\ResponseInterface[]

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\HttpClient\BaseHttpClient::getRequestFactory()

Get PSR-7 Request factory.

Throws

\Firstred\PostNL\Exception\NotSupportedException

Since

1.3.0

public Firstred\PostNL\HttpClient\BaseHttpClient::setRequestFactory($requestFactory)

Set PSR-7 Request factory.

Since

1.3.0

public Firstred\PostNL\HttpClient\BaseHttpClient::getResponseFactory()

Get PSR-7 Response factory.

Throws

\Firstred\PostNL\Exception\NotSupportedException

Since

1.3.0

public Firstred\PostNL\HttpClient\BaseHttpClient::setResponseFactory($responseFactory)

Set PSR-7 Response factory.

Since

1.3.0

public Firstred\PostNL\HttpClient\BaseHttpClient::getStreamFactory()

Set PSR-7 Stream factory.

Throws

\Firstred\PostNL\Exception\NotSupportedException

Since

1.3.0

public Firstred\PostNL\HttpClient\BaseHttpClient::setStreamFactory($streamFactory)

Set PSR-7 Stream factory.

Since

1.3.0

GuzzleHttpClient

class Firstred\PostNL\HttpClient\GuzzleHttpClient

Class GuzzleClient.

Parent

Firstred\PostNL\HttpClient\BaseHttpClient

Implements

Firstred\PostNL\HttpClient\HttpClientInterface

Summary

Methods

• public __construct($client, $logger, $concurrency, $maxRetries)

• private setClient($client)

• private getClient()

• public setOption($name, $value)

• public getOption($name)

• public doRequest($request)

• public doRequests($requests)

Constants

DEFAULT_TIMEOUT = 60

DEFAULT_CONNECT_TIMEOUT = 20

Properties

protected static property Firstred\PostNL\HttpClient\GuzzleHttpClient::$defaultOptions

Type

array

private static property Firstred\PostNL\HttpClient\GuzzleHttpClient::$client

Methods

public Firstred\PostNL\HttpClient\GuzzleHttpClient::__construct($client=null, $logger=null, $concurrency=5, $maxRetries=5)

GuzzleClient constructor.

Since

1.3.0 Custom constructor

private Firstred\PostNL\HttpClient\GuzzleHttpClient::setClient($client)

private Firstred\PostNL\HttpClient\GuzzleHttpClient::getClient()

Get the Guzzle client.

Returns

\GuzzleHttp\Client

public Firstred\PostNL\HttpClient\GuzzleHttpClient::setOption($name, $value)

Set Guzzle option.

Parameters

• $name (string)

• $value (mixed)

Returns

\Firstred\PostNL\HttpClient\GuzzleHttpClient

public Firstred\PostNL\HttpClient\GuzzleHttpClient::getOption($name)

Get Guzzle option.

Parameters

• $name (string)

Returns

mixed | null

public Firstred\PostNL\HttpClient\GuzzleHttpClient::doRequest($request)

Do a single request.

Exceptions are captured into the result array

Throws

\Firstred\PostNL\Exception\HttpClientException

public Firstred\PostNL\HttpClient\GuzzleHttpClient::doRequests( $requests=\[\])

Do all async requests.

Exceptions are captured into the result array

Parameters

• $requests (Psr\Http\Message\RequestInterface[])

Returns

\Firstred\PostNL\Exception\HttpClientException[] | \Psr\Http\Message\ResponseInterface[]

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

AsyncHttpClient

class Firstred\PostNL\HttpClient\AsyncHttpClient

Class AsyncHttpClient.

Parent

Firstred\PostNL\HttpClient\BaseHttpClient

Implements

Firstred\PostNL\HttpClient\HttpClientInterface

Summary

Methods

• public __construct($client, $logger, $concurrency, $maxRetries)

• public doRequests($requests)

• public doRequest($request)

• public getClient()

• public setClient($client)

Properties

protected property Firstred\PostNL\HttpClient\AsyncHttpClient::$instance

Type

static

protected static property Firstred\PostNL\HttpClient\AsyncHttpClient::$client

Type

\Http\Client\HttpAsyncClient

Methods

public Firstred\PostNL\HttpClient\AsyncHttpClient::__construct($client=null, $logger=null, $concurrency=5, $maxRetries=5)

HTTPlugClient constructor.

Parameters

• $client (Http\Client\HttpAsyncClient | null)

• $logger (Psr\Log\LoggerInterface | null)

• $concurrency (int)

• $maxRetries (int)

Throws

\Firstred\PostNL\Exception\HttpClientException

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\HttpClient\AsyncHttpClient::doRequests( $requests=\[\])

Do all async requests.

Exceptions are captured into the result array

Parameters

• $requests (Psr\Http\Message\RequestInterface[])

Returns

\Firstred\PostNL\Exception\HttpClientException[] | \Psr\Http\Message\ResponseInterface[]

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\HttpClient\AsyncHttpClient::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\AsyncHttpClient::getClient()

Returns

\Http\Client\HttpAsyncClient

public Firstred\PostNL\HttpClient\AsyncHttpClient::setClient($client)

Parameters

• $client (Http\Client\HttpAsyncClient)

Returns

static

SymfonyHttpClient

class Firstred\PostNL\HttpClient\SymfonyHttpClient

Class SymfonyHttpClient.

Parent

Firstred\PostNL\HttpClient\BaseHttpClient

Implements

Firstred\PostNL\HttpClient\HttpClientInterface

Summary

Methods

• public __construct($client, $logger, $concurrency, $maxRetries)

• private getClient()

• public setOption($name, $value)

• public getOption($name)

• public doRequest($request)

• public doRequests($requests)

• public setMaxRetries($maxRetries)

• public setConcurrency($concurrency)

• private convertPsrRequestToSymfonyHttpClientRequestParams($psrRequest)

• private convertSymfonyHttpClientResponseToPsrResponse($symfonyHttpClientResponse)

Constants

DEFAULT_TIMEOUT = 60

DEFAULT_CONNECT_TIMEOUT = 20

Properties

protected static property Firstred\PostNL\HttpClient\SymfonyHttpClient::$defaultOptions

Type

array

private static property Firstred\PostNL\HttpClient\SymfonyHttpClient::$client

Type

\Symfony\Contracts\HttpClient\HttpClientInterface | null

Methods

public Firstred\PostNL\HttpClient\SymfonyHttpClient::__construct(\\Symfony\\Contracts\\HttpClient\\HttpClientInterface|null $client=null, \\Psr\\Log\\LoggerInterface|null $logger=null, $concurrency=5, $maxRetries=5)

SymfonyHttpClient constructor.

Parameters

• $client (Symfony\Contracts\HttpClient\HttpClientInterface | null)

• $logger (Psr\Log\LoggerInterface | null)

• $concurrency (int)

• $maxRetries (int)

Since

1.3.0 Custom constructor

private Firstred\PostNL\HttpClient\SymfonyHttpClient::getClient()

Get the Symfony HTTP Client.

Returns

\Symfony\Contracts\HttpClient\HttpClientInterface | null

Throws

\Firstred\PostNL\Exception\HttpClientException

public Firstred\PostNL\HttpClient\SymfonyHttpClient::setOption($name, $value)

Set Symfony HTTP Client option.

Parameters

• $name (string)

• $value (mixed)

Returns

static

public Firstred\PostNL\HttpClient\SymfonyHttpClient::getOption($name)

Get Symfony HTTP Client option.

Parameters

• $name (string)

Returns

mixed | null

public Firstred\PostNL\HttpClient\SymfonyHttpClient::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\SymfonyHttpClient::doRequests( $requests=\[\])

Do all async requests.

Exceptions are captured into the result array

Parameters

• $requests (Psr\Http\Message\RequestInterface[])

Returns

\Firstred\PostNL\Exception\HttpClientException[] | \Psr\Http\Message\ResponseInterface[]

public Firstred\PostNL\HttpClient\SymfonyHttpClient::setMaxRetries($maxRetries)

Set the amount of retries.

Parameters

• $maxRetries (int)

Returns

static

public Firstred\PostNL\HttpClient\SymfonyHttpClient::setConcurrency($concurrency)

Set the concurrency.

Parameters

• $concurrency (int)

Returns

static

private Firstred\PostNL\HttpClient\SymfonyHttpClient::convertPsrRequestToSymfonyHttpClientRequestParams($psrRequest)

Parameters

• $psrRequest (Psr\Http\Message\RequestInterface)

Returns

array

Since

1.3.0

private Firstred\PostNL\HttpClient\SymfonyHttpClient::convertSymfonyHttpClientResponseToPsrResponse($symfonyHttpClientResponse)

Parameters

• $symfonyHttpClientResponse (Symfony\Contracts\HttpClient\ResponseInterface)

Returns

\Psr\Http\Message\ResponseInterface

Throws

\Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\TransportExceptionInterface

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Symfony\Contracts\HttpClient\Exception\ClientExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\RedirectionExceptionInterface

Throws

\Symfony\Contracts\HttpClient\Exception\ServerExceptionInterface

Since

1.3.0

HTTPlugHttpClient

class Firstred\PostNL\HttpClient\HTTPlugHttpClient

Class HTTPlugClient.

Parent

Firstred\PostNL\HttpClient\BaseHttpClient

Implements

Firstred\PostNL\HttpClient\HttpClientInterface

Summary

Methods

• public __construct($client, $logger, $concurrency, $maxRetries)

• public doRequests($requests)

• public doRequest($request)

• public getClient()

• public setClient($client)

Properties

protected property Firstred\PostNL\HttpClient\HTTPlugHttpClient::$instance

Type

static

protected static property Firstred\PostNL\HttpClient\HTTPlugHttpClient::$client

Type

\Http\Client\HttpAsyncClient | \Http\Client\HttpClient

Methods

public Firstred\PostNL\HttpClient\HTTPlugHttpClient::__construct(\\Http\\Client\\HttpAsyncClient|\\Http\\Client\\HttpClient $client=null, $logger=null, $concurrency=5, $maxRetries=5)

HTTPlugClient constructor.

Parameters

• $client (Http\Client\HttpAsyncClient | \Http\Client\HttpClient | null)

• $logger (Psr\Log\LoggerInterface | null)

• $concurrency (int)

• $maxRetries (int)

Throws

\Firstred\PostNL\Exception\HttpClientException

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\HttpClient\HTTPlugHttpClient::doRequests( $requests=\[\])

Do all async requests.

Exceptions are captured into the result array

Parameters

• $requests (Psr\Http\Message\RequestInterface[])

Returns

\Firstred\PostNL\Exception\HttpClientException[] | \Psr\Http\Message\ResponseInterface[]

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\HttpClient\HTTPlugHttpClient::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\HTTPlugHttpClient::getClient()

Returns

\Http\Client\HttpAsyncClient | \Http\Client\HttpClient

public Firstred\PostNL\HttpClient\HTTPlugHttpClient::setClient(\\Http\\Client\\HttpAsyncClient|\\Http\\Client\\HttpClient $client)

Parameters

• $client (Http\Client\HttpAsyncClient | \Http\Client\HttpClient)

Returns

static

MockHttpClient

class Firstred\PostNL\HttpClient\MockHttpClient

Class MockClient.

Parent

Firstred\PostNL\HttpClient\BaseHttpClient

Implements

Firstred\PostNL\HttpClient\HttpClientInterface

Summary

Methods

• public setOption($name, $value)

• public getOption($name)

• public setHandler($handler)

• public getHandler()

• public doRequest($request)

• public doRequests($requests)

Constants

DEFAULT_TIMEOUT = 60

DEFAULT_CONNECT_TIMEOUT = 20

Properties

protected static property Firstred\PostNL\HttpClient\MockHttpClient::$defaultOptions

Type

array

private static property Firstred\PostNL\HttpClient\MockHttpClient::$handler

Type

\GuzzleHttp\HandlerStack

Methods

public Firstred\PostNL\HttpClient\MockHttpClient::setOption($name, $value)

Set Guzzle option.

Parameters

• $name (string)

• $value (mixed)

Returns

\Firstred\PostNL\HttpClient\MockHttpClient

public Firstred\PostNL\HttpClient\MockHttpClient::getOption($name)

Get Guzzle option.

Parameters

• $name (string)

Returns

mixed | null

public Firstred\PostNL\HttpClient\MockHttpClient::setHandler($handler)

public Firstred\PostNL\HttpClient\MockHttpClient::getHandler()

public Firstred\PostNL\HttpClient\MockHttpClient::doRequest($request)

Do a single request.

Exceptions are captured into the result array

Throws

\Firstred\PostNL\Exception\HttpClientException

public Firstred\PostNL\HttpClient\MockHttpClient::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[]

Psr18HttpClient

class Firstred\PostNL\HttpClient\Psr18HttpClient

Class Psr18HttpClient.

Parent

Firstred\PostNL\HttpClient\BaseHttpClient

Implements

Firstred\PostNL\HttpClient\HttpClientInterface

Summary

Methods

• public __construct($client, $logger, $concurrency, $maxRetries)

• public doRequests($requests)

• public doRequest($request)

• public getClient()

• public setClient($client)

Properties

protected property Firstred\PostNL\HttpClient\Psr18HttpClient::$instance

Type

static

protected static property Firstred\PostNL\HttpClient\Psr18HttpClient::$client

Type

\Psr\Http\Client\ClientInterface

Methods

public Firstred\PostNL\HttpClient\Psr18HttpClient::__construct($client=null, $logger=null, $concurrency=5, $maxRetries=5)

HTTPlugClient constructor.

Parameters

• $client (Psr\Http\Client\ClientInterface | null)

• $logger (Psr\Log\LoggerInterface | null)

• $concurrency (int)

• $maxRetries (int)

Throws

\Firstred\PostNL\Exception\HttpClientException

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\HttpClient\Psr18HttpClient::doRequests( $requests=\[\])

Do all async requests.

Exceptions are captured into the result array

Parameters

• $requests (Psr\Http\Message\RequestInterface[])

Returns

\Firstred\PostNL\Exception\HttpClientException[] | \Psr\Http\Message\ResponseInterface[]

public Firstred\PostNL\HttpClient\Psr18HttpClient::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\Psr18HttpClient::getClient()

Returns

\Psr\Http\Client\ClientInterface

public Firstred\PostNL\HttpClient\Psr18HttpClient::setClient($client)

Parameters

• $client (Psr\Http\Client\ClientInterface)

Returns

static

Service

\Firstred\PostNL\Service

Namespaces

RequestBuilder

\Firstred\PostNL\Service\RequestBuilder

Namespaces

Rest

\Firstred\PostNL\Service\RequestBuilder\Rest

Classes

LocationServiceRestRequestBuilder

class Firstred\PostNL\Service\RequestBuilder\Rest\LocationServiceRestRequestBuilder

Parent

Firstred\PostNL\Service\RequestBuilder\Rest\AbstractRestRequestBuilder

Implements

Firstred\PostNL\Service\RequestBuilder\LocationServiceRequestBuilderInterface

Summary

Methods

• public buildGetNearestLocationsRequest($getNearestLocations)

• public buildGetLocationsInAreaRequest($getLocations)

• public buildGetLocationRequest($getLocation)

• protected setService($entity)

Constants

LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2\_1/locations\'

SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2\_1/locations\'

Methods

public Firstred\PostNL\Service\RequestBuilder\Rest\LocationServiceRestRequestBuilder::buildGetNearestLocationsRequest($getNearestLocations)

Build the 'get nearest locations' HTTP request.

Parameters

• $getNearestLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\Rest\LocationServiceRestRequestBuilder::buildGetLocationsInAreaRequest($getLocations)

Build the 'get locations in area' HTTP.

Parameters

• $getLocations (Firstred\PostNL\Entity\Request\GetLocationsInArea)

Returns

\Psr\Http\Message\RequestInterface

Since

2.0.0

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Service\RequestBuilder\Rest\LocationServiceRestRequestBuilder::buildGetLocationRequest($getLocation)

Build the 'get single location' HTTP request.

Parameters

• $getLocation (Firstred\PostNL\Entity\Request\GetLocation)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

2.0.0

protected Firstred\PostNL\Service\RequestBuilder\Rest\LocationServiceRestRequestBuilder::setService($entity)

Set this service on the given entity.

This lets the entity know for which service it should serialize.

Parameters

• $entity (Firstred\PostNL\Entity\AbstractEntity)

Returns

void

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

TimeframeServiceRestRequestBuilder

class Firstred\PostNL\Service\RequestBuilder\Rest\TimeframeServiceRestRequestBuilder

Parent

Firstred\PostNL\Service\RequestBuilder\Rest\AbstractRestRequestBuilder

Implements

Firstred\PostNL\Service\RequestBuilder\TimeframeServiceRequestBuilderInterface

Summary

Methods

• public buildGetTimeframesRequest($getTimeframes)

• protected setService($entity)

Constants

LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2\_1/calculate/timeframes\'

SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2\_1/calculate/timeframes\'

Methods

public Firstred\PostNL\Service\RequestBuilder\Rest\TimeframeServiceRestRequestBuilder::buildGetTimeframesRequest($getTimeframes)

Build the 'get timeframes' HTTP request.

Parameters

• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

protected Firstred\PostNL\Service\RequestBuilder\Rest\TimeframeServiceRestRequestBuilder::setService($entity)

Set this service on the given entity.

This lets the entity know for which service it should serialize.

Parameters

• $entity (Firstred\PostNL\Entity\AbstractEntity)

Returns

void

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

ConfirmingServiceRestRequestBuilder

class Firstred\PostNL\Service\RequestBuilder\Rest\ConfirmingServiceRestRequestBuilder

Parent

Firstred\PostNL\Service\RequestBuilder\Rest\AbstractRestRequestBuilder

Implements

Firstred\PostNL\Service\RequestBuilder\ConfirmingServiceRequestBuilderInterface

Summary

Methods

• public buildConfirmRequest($confirming)

• protected setService($entity)

Constants

LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2/confirm\'

SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2/confirm\'

Methods

public Firstred\PostNL\Service\RequestBuilder\Rest\ConfirmingServiceRestRequestBuilder::buildConfirmRequest($confirming)

Build the 'confirm label' HTTP request.

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

protected Firstred\PostNL\Service\RequestBuilder\Rest\ConfirmingServiceRestRequestBuilder::setService($entity)

Set this service on the given entity.

This lets the entity know for which service it should serialize.

Parameters

• $entity (Firstred\PostNL\Entity\AbstractEntity)

Returns

void

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

DeliveryDateServiceRestRequestBuilder

class Firstred\PostNL\Service\RequestBuilder\Rest\DeliveryDateServiceRestRequestBuilder

Parent

Firstred\PostNL\Service\RequestBuilder\Rest\AbstractRestRequestBuilder

Implements

Firstred\PostNL\Service\RequestBuilder\DeliveryDateServiceRequestBuilderInterface

Summary

Methods

• public buildGetDeliveryDateRequest($getDeliveryDate)

• public buildGetSentDateRequest($getSentDate)

• protected setService($entity)

Constants

LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2\_2/calculate/date\'

SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2\_2/calculate/date\'

Methods

public Firstred\PostNL\Service\RequestBuilder\Rest\DeliveryDateServiceRestRequestBuilder::buildGetDeliveryDateRequest($getDeliveryDate)

Build the 'get delivery date' HTTP request.

Parameters

• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\Rest\DeliveryDateServiceRestRequestBuilder::buildGetSentDateRequest($getSentDate)

Build the 'get sent date' HTTP request.

Parameters

• $getSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

protected Firstred\PostNL\Service\RequestBuilder\Rest\DeliveryDateServiceRestRequestBuilder::setService($entity)

Set this service on the given entity.

This lets the entity know for which service it should serialize.

Parameters

• $entity (Firstred\PostNL\Entity\AbstractEntity)

Returns

void

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

AbstractRestRequestBuilder

class Firstred\PostNL\Service\RequestBuilder\Rest\AbstractRestRequestBuilder

Parent

Firstred\PostNL\Service\RequestBuilder\AbstractRequestBuilder

Summary

ShippingServiceRestRequestBuilder

class Firstred\PostNL\Service\RequestBuilder\Rest\ShippingServiceRestRequestBuilder

Parent

Firstred\PostNL\Service\RequestBuilder\Rest\AbstractRestRequestBuilder

Implements

Firstred\PostNL\Service\RequestBuilder\ShippingServiceRequestBuilderInterface

Summary

Methods

• public buildSendShipmentRequest($sendShipment, $confirm)

• protected setService($entity)

Constants

LIVE_ENDPOINT = \'https://api\.postnl\.nl/v1/shipment\'

SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/v1/shipment\'

Methods

public Firstred\PostNL\Service\RequestBuilder\Rest\ShippingServiceRestRequestBuilder::buildSendShipmentRequest($sendShipment, $confirm=true)

Build the 'send shipment' HTTP request.

Parameters

• $sendShipment (Firstred\PostNL\Entity\Request\SendShipment)

• $confirm (bool)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

protected Firstred\PostNL\Service\RequestBuilder\Rest\ShippingServiceRestRequestBuilder::setService($entity)

Set this service on the given entity.

This lets the entity know for which service it should serialize.

Parameters

• $entity (Firstred\PostNL\Entity\AbstractEntity)

Returns

void

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

LabellingServiceRestRequestBuilder

class Firstred\PostNL\Service\RequestBuilder\Rest\LabellingServiceRestRequestBuilder

Parent

Firstred\PostNL\Service\RequestBuilder\Rest\AbstractRestRequestBuilder

Implements

Firstred\PostNL\Service\RequestBuilder\LabellingServiceRequestBuilderInterface

Summary

Methods

• public buildGenerateLabelRequest($generateLabel, $confirm)

• protected setService($entity)

Constants

LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2\_2/label\'

SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2\_2/label\'

Properties

private property Firstred\PostNL\Service\RequestBuilder\Rest\LabellingServiceRestRequestBuilder::$insuranceProductCodes

Type

int[]

Methods

public Firstred\PostNL\Service\RequestBuilder\Rest\LabellingServiceRestRequestBuilder::buildGenerateLabelRequest($generateLabel, $confirm=true)

Build the 'generate label' HTTP request.

Parameters

• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)

• $confirm (bool)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

protected Firstred\PostNL\Service\RequestBuilder\Rest\LabellingServiceRestRequestBuilder::setService($entity)

Set this service on the given entity.

This lets the entity know for which service it should serialize.

Parameters

• $entity (Firstred\PostNL\Entity\AbstractEntity)

Returns

void

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

ShippingStatusServiceRestRequestBuilder

class Firstred\PostNL\Service\RequestBuilder\Rest\ShippingStatusServiceRestRequestBuilder

Parent

Firstred\PostNL\Service\RequestBuilder\Rest\AbstractRestRequestBuilder

Implements

Firstred\PostNL\Service\RequestBuilder\ShippingStatusServiceRequestBuilderInterface

Summary

Methods

• public buildCurrentStatusRequest($currentStatus)

• public buildCompleteStatusRequest($completeStatus)

• public buildGetSignatureRequest($getSignature)

• public buildGetUpdatedShipmentsRequest($getUpdatedShipments)

• protected setService($entity)

Constants

LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v2/status\'

SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v2/status\'

Methods

public Firstred\PostNL\Service\RequestBuilder\Rest\ShippingStatusServiceRestRequestBuilder::buildCurrentStatusRequest(\\Firstred\\PostNL\\Entity\\Request\\CurrentStatusByReference|\\Firstred\\PostNL\\Entity\\Request\\CurrentStatus $currentStatus)

Build the 'get current status' HTTP request.

This function auto-detects and adjusts the following requests:

- CurrentStatus

- CurrentStatusByReference

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\Rest\ShippingStatusServiceRestRequestBuilder::buildCompleteStatusRequest($completeStatus)

Build the 'get complete status' HTTP request.

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

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\Rest\ShippingStatusServiceRestRequestBuilder::buildGetSignatureRequest($getSignature)

Build the 'get signature' HTTP request.

Parameters

• $getSignature (Firstred\PostNL\Entity\Request\GetSignature)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\Rest\ShippingStatusServiceRestRequestBuilder::buildGetUpdatedShipmentsRequest($getUpdatedShipments)

Build the 'get updated shipments' HTTP request.

Parameters

• $getUpdatedShipments (Firstred\PostNL\Entity\Request\GetUpdatedShipments)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

protected Firstred\PostNL\Service\RequestBuilder\Rest\ShippingStatusServiceRestRequestBuilder::setService($entity)

Set this service on the given entity.

This lets the entity know for which service it should serialize.

Parameters

• $entity (Firstred\PostNL\Entity\AbstractEntity)

Returns

void

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

BarcodeServiceRestRequestBuilder

class Firstred\PostNL\Service\RequestBuilder\Rest\BarcodeServiceRestRequestBuilder

Parent

Firstred\PostNL\Service\RequestBuilder\Rest\AbstractRestRequestBuilder

Implements

Firstred\PostNL\Service\RequestBuilder\BarcodeServiceRequestBuilderInterface

Summary

Methods

• public buildGenerateBarcodeRequest($generateBarcode)

• public setService($entity)

Constants

SANDBOX_ENDPOINT = \'https://api\-sandbox\.postnl\.nl/shipment/v1\_1/barcode\'

LIVE_ENDPOINT = \'https://api\.postnl\.nl/shipment/v1\_1/barcode\'

Methods

public Firstred\PostNL\Service\RequestBuilder\Rest\BarcodeServiceRestRequestBuilder::buildGenerateBarcodeRequest($generateBarcode)

Build the 'generate barcode' HTTP request.

Parameters

• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\Rest\BarcodeServiceRestRequestBuilder::setService($entity)

Set this service on the given entity.

This lets the entity know for which service it should serialize.

Parameters

• $entity (Firstred\PostNL\Entity\AbstractEntity)

Returns

void

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

Interfaces

LabellingServiceRequestBuilderInterface

interface Firstred\PostNL\Service\RequestBuilder\LabellingServiceRequestBuilderInterface

Summary

Methods

• public buildGenerateLabelRequest($generateLabel, $confirm)

Methods

public Firstred\PostNL\Service\RequestBuilder\LabellingServiceRequestBuilderInterface::buildGenerateLabelRequest($generateLabel, $confirm=true)

Build the 'generate label' HTTP request.

Parameters

• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)

• $confirm (bool)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

ShippingServiceRequestBuilderInterface

interface Firstred\PostNL\Service\RequestBuilder\ShippingServiceRequestBuilderInterface

Summary

Methods

• public buildSendShipmentRequest($sendShipment, $confirm)

Methods

public Firstred\PostNL\Service\RequestBuilder\ShippingServiceRequestBuilderInterface::buildSendShipmentRequest($sendShipment, $confirm=true)

Build the 'send shipment' HTTP request.

Parameters

• $sendShipment (Firstred\PostNL\Entity\Request\SendShipment)

• $confirm (bool)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

LocationServiceRequestBuilderInterface

interface Firstred\PostNL\Service\RequestBuilder\LocationServiceRequestBuilderInterface

Summary

Methods

• public buildGetNearestLocationsRequest($getNearestLocations)

• public buildGetLocationsInAreaRequest($getLocations)

• public buildGetLocationRequest($getLocation)

Methods

public Firstred\PostNL\Service\RequestBuilder\LocationServiceRequestBuilderInterface::buildGetNearestLocationsRequest($getNearestLocations)

Build the 'get nearest locations' HTTP request.

Parameters

• $getNearestLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\LocationServiceRequestBuilderInterface::buildGetLocationsInAreaRequest($getLocations)

Build the 'get locations in area' HTTP.

Parameters

• $getLocations (Firstred\PostNL\Entity\Request\GetLocationsInArea)

Returns

\Psr\Http\Message\RequestInterface

Since

2.0.0

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\Service\RequestBuilder\LocationServiceRequestBuilderInterface::buildGetLocationRequest($getLocation)

Build the 'get single location' HTTP request.

Parameters

• $getLocation (Firstred\PostNL\Entity\Request\GetLocation)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

2.0.0

TimeframeServiceRequestBuilderInterface

interface Firstred\PostNL\Service\RequestBuilder\TimeframeServiceRequestBuilderInterface

Summary

Methods

• public buildGetTimeframesRequest($getTimeframes)

Methods

public Firstred\PostNL\Service\RequestBuilder\TimeframeServiceRequestBuilderInterface::buildGetTimeframesRequest($getTimeframes)

Build the 'get timeframes' HTTP request.

Parameters

• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

ShippingStatusServiceRequestBuilderInterface

interface Firstred\PostNL\Service\RequestBuilder\ShippingStatusServiceRequestBuilderInterface

Summary

Methods

• public buildCurrentStatusRequest($currentStatus)

• public buildCompleteStatusRequest($completeStatus)

• public buildGetSignatureRequest($getSignature)

• public buildGetUpdatedShipmentsRequest($getUpdatedShipments)

Methods

public Firstred\PostNL\Service\RequestBuilder\ShippingStatusServiceRequestBuilderInterface::buildCurrentStatusRequest(\\Firstred\\PostNL\\Entity\\Request\\CurrentStatusByReference|\\Firstred\\PostNL\\Entity\\Request\\CurrentStatus $currentStatus)

Build the 'get current status' HTTP request.

This function auto-detects and adjusts the following requests:

- CurrentStatus

- CurrentStatusByReference

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\ShippingStatusServiceRequestBuilderInterface::buildCompleteStatusRequest($completeStatus)

Build the 'get complete status' HTTP request.

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

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\ShippingStatusServiceRequestBuilderInterface::buildGetSignatureRequest($getSignature)

Build the 'get signature' HTTP request.

Parameters

• $getSignature (Firstred\PostNL\Entity\Request\GetSignature)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\ShippingStatusServiceRequestBuilderInterface::buildGetUpdatedShipmentsRequest($getUpdatedShipments)

Build the 'get updated shipments' HTTP request.

Parameters

• $getUpdatedShipments (Firstred\PostNL\Entity\Request\GetUpdatedShipments)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

ConfirmingServiceRequestBuilderInterface

interface Firstred\PostNL\Service\RequestBuilder\ConfirmingServiceRequestBuilderInterface

Summary

Methods

• public buildConfirmRequest($confirming)

Methods

public Firstred\PostNL\Service\RequestBuilder\ConfirmingServiceRequestBuilderInterface::buildConfirmRequest($confirming)

Build the 'confirm label' HTTP request.

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

BarcodeServiceRequestBuilderInterface

interface Firstred\PostNL\Service\RequestBuilder\BarcodeServiceRequestBuilderInterface

Summary

Methods

• public buildGenerateBarcodeRequest($generateBarcode)

Methods

public Firstred\PostNL\Service\RequestBuilder\BarcodeServiceRequestBuilderInterface::buildGenerateBarcodeRequest($generateBarcode)

Build the 'generate barcode' HTTP request.

Parameters

• $generateBarcode (Firstred\PostNL\Entity\Request\GenerateBarcode)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

DeliveryDateServiceRequestBuilderInterface

interface Firstred\PostNL\Service\RequestBuilder\DeliveryDateServiceRequestBuilderInterface

Summary

Methods

• public buildGetDeliveryDateRequest($getDeliveryDate)

• public buildGetSentDateRequest($getSentDate)

Methods

public Firstred\PostNL\Service\RequestBuilder\DeliveryDateServiceRequestBuilderInterface::buildGetDeliveryDateRequest($getDeliveryDate)

Build the 'get delivery date' HTTP request.

Parameters

• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\DeliveryDateServiceRequestBuilderInterface::buildGetSentDateRequest($getSentDate)

Build the 'get sent date' HTTP request.

Parameters

• $getSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest)

Returns

\Psr\Http\Message\RequestInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

Classes

AbstractRequestBuilder

class Firstred\PostNL\Service\RequestBuilder\AbstractRequestBuilder

Summary

Methods

• public __construct($apiKey, $sandbox, $requestFactory, $streamFactory)

• public setApiKey($apiKey)

• public isSandbox()

• public setSandbox($sandbox)

• public getRequestFactory()

• public setRequestFactory($requestFactory)

• public getStreamFactory()

• public setStreamFactory($streamFactory)

• protected setService($entity)

Methods

public Firstred\PostNL\Service\RequestBuilder\AbstractRequestBuilder::__construct($apiKey, $sandbox, $requestFactory, $streamFactory)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

• $sandbox (bool)

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

public Firstred\PostNL\Service\RequestBuilder\AbstractRequestBuilder::setApiKey($apiKey)

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\AbstractRequestBuilder::isSandbox()

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\AbstractRequestBuilder::setSandbox($sandbox)

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\AbstractRequestBuilder::getRequestFactory()

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\AbstractRequestBuilder::setRequestFactory($requestFactory)

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\AbstractRequestBuilder::getStreamFactory()

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\AbstractRequestBuilder::setStreamFactory($streamFactory)

Since

2.0.0

protected Firstred\PostNL\Service\RequestBuilder\AbstractRequestBuilder::setService($entity)

Set this service on given entity.

This lets the entity know for which service it should serialize.

Parameters

• $entity (Firstred\PostNL\Entity\AbstractEntity)

Returns

void

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

2.0.0

Traits

RequestBuilderSettersTrait

trait Firstred\PostNL\Service\RequestBuilder\RequestBuilderSettersTrait

Methods

public Firstred\PostNL\Service\RequestBuilder\RequestBuilderSettersTrait::setApiKey($apiKey)

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\RequestBuilderSettersTrait::setSandbox($sandbox)

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\RequestBuilderSettersTrait::setRequestFactory($requestFactory)

Since

2.0.0

public Firstred\PostNL\Service\RequestBuilder\RequestBuilderSettersTrait::setStreamFactory($streamFactory)

Since

2.0.0

ResponseProcessor

\Firstred\PostNL\Service\ResponseProcessor

Namespaces

Rest

\Firstred\PostNL\Service\ResponseProcessor\Rest

Classes

ShippingStatusServiceRestResponseProcessor

class Firstred\PostNL\Service\ResponseProcessor\Rest\ShippingStatusServiceRestResponseProcessor

Parent

Firstred\PostNL\Service\ResponseProcessor\Rest\AbstractRestResponseProcessor

Implements

Firstred\PostNL\Service\ResponseProcessor\ShippingStatusServiceResponseProcessorInterface

Summary

Methods

• public processCurrentStatusResponse($response)

• public processCompleteStatusResponse($response)

• public processGetSignatureResponse($response)

• public processGetUpdatedShipmentsResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\Rest\ShippingStatusServiceRestResponseProcessor::processCurrentStatusResponse($response)

Process the 'get current status' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\CurrentStatusResponse

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\ResponseProcessor\Rest\ShippingStatusServiceRestResponseProcessor::processCompleteStatusResponse($response)

Process the 'get complete status' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\CompleteStatusResponse

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\ResponseProcessor\Rest\ShippingStatusServiceRestResponseProcessor::processGetSignatureResponse($response)

Process the 'get signature' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\ResponseProcessor\Rest\ShippingStatusServiceRestResponseProcessor::processGetUpdatedShipmentsResponse($response)

Process the 'get updated shipments' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse[]

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

TimeframeServiceRestResponseProcessor

class Firstred\PostNL\Service\ResponseProcessor\Rest\TimeframeServiceRestResponseProcessor

Parent

Firstred\PostNL\Service\ResponseProcessor\Rest\AbstractRestResponseProcessor

Implements

Firstred\PostNL\Service\ResponseProcessor\TimeframeServiceResponseProcessorInterface

Summary

Methods

• public processGetTimeframesResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\Rest\TimeframeServiceRestResponseProcessor::processGetTimeframesResponse($response)

Process the 'get timeframes' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\ResponseTimeframes

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

2.0.0

LabellingServiceRestResponseProcessor

class Firstred\PostNL\Service\ResponseProcessor\Rest\LabellingServiceRestResponseProcessor

Parent

Firstred\PostNL\Service\ResponseProcessor\Rest\AbstractRestResponseProcessor

Implements

Firstred\PostNL\Service\ResponseProcessor\LabellingServiceResponseProcessorInterface

Summary

Methods

• public processGenerateLabelResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\Rest\LabellingServiceRestResponseProcessor::processGenerateLabelResponse($response)

Process the 'generate label' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GenerateLabelResponse

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

DeliveryDateServiceRestResponseProcessor

class Firstred\PostNL\Service\ResponseProcessor\Rest\DeliveryDateServiceRestResponseProcessor

Parent

Firstred\PostNL\Service\ResponseProcessor\Rest\AbstractRestResponseProcessor

Implements

Firstred\PostNL\Service\ResponseProcessor\DeliveryDateServiceResponseProcessorInterface

Summary

Methods

• public processGetDeliveryDateResponse($response)

• public processGetSentDateResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\Rest\DeliveryDateServiceRestResponseProcessor::processGetDeliveryDateResponse($response)

Process the 'get delivery date' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GetDeliveryDateResponse

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Since

2.0.0

public Firstred\PostNL\Service\ResponseProcessor\Rest\DeliveryDateServiceRestResponseProcessor::processGetSentDateResponse($response)

Process the 'get sent date' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GetSentDateResponse

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

LocationServiceRestResponseProcessor

class Firstred\PostNL\Service\ResponseProcessor\Rest\LocationServiceRestResponseProcessor

Parent

Firstred\PostNL\Service\ResponseProcessor\Rest\AbstractRestResponseProcessor

Implements

Firstred\PostNL\Service\ResponseProcessor\LocationServiceResponseProcessorInterface

Summary

Methods

• public processGetNearestLocationsResponse($response)

• public processGetLocationsInAreaResponse($response)

• public processGetLocationResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\Rest\LocationServiceRestResponseProcessor::processGetNearestLocationsResponse($response)

Process the 'get nearest locations' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GetNearestLocationsResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

2.0.0

public Firstred\PostNL\Service\ResponseProcessor\Rest\LocationServiceRestResponseProcessor::processGetLocationsInAreaResponse($response)

Process the 'get locations in area' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

2.0.0

public Firstred\PostNL\Service\ResponseProcessor\Rest\LocationServiceRestResponseProcessor::processGetLocationResponse($response)

Process the 'get location' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

2.0.0

BarcodeServiceRestResponseProcessor

class Firstred\PostNL\Service\ResponseProcessor\Rest\BarcodeServiceRestResponseProcessor

Parent

Firstred\PostNL\Service\ResponseProcessor\Rest\AbstractRestResponseProcessor

Implements

Firstred\PostNL\Service\ResponseProcessor\BarcodeServiceResponseProcessorInterface

Summary

Methods

• public processGenerateBarcodeResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\Rest\BarcodeServiceRestResponseProcessor::processGenerateBarcodeResponse($response)

Process the 'generate barcode' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

string

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

AbstractRestResponseProcessor

class Firstred\PostNL\Service\ResponseProcessor\Rest\AbstractRestResponseProcessor

Parent

Firstred\PostNL\Service\ResponseProcessor\AbstractResponseProcessor

Summary

Methods

• protected validateResponse($response)

Methods

protected Firstred\PostNL\Service\ResponseProcessor\Rest\AbstractRestResponseProcessor::validateResponse($response)

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

bool

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

2.0.0

ShippingServiceRestResponseProcessor

class Firstred\PostNL\Service\ResponseProcessor\Rest\ShippingServiceRestResponseProcessor

Parent

Firstred\PostNL\Service\ResponseProcessor\Rest\AbstractRestResponseProcessor

Implements

Firstred\PostNL\Service\ResponseProcessor\ShippingServiceResponseProcessorInterface

Summary

Methods

• public processSendShipmentResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\Rest\ShippingServiceRestResponseProcessor::processSendShipmentResponse($response)

Process the 'send shipment' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\SendShipmentResponse | null

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

ConfirmingServiceRestResponseProcessor

class Firstred\PostNL\Service\ResponseProcessor\Rest\ConfirmingServiceRestResponseProcessor

Parent

Firstred\PostNL\Service\ResponseProcessor\Rest\AbstractRestResponseProcessor

Implements

Firstred\PostNL\Service\ResponseProcessor\ConfirmingServiceResponseProcessorInterface

Summary

Methods

• public processConfirmResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\Rest\ConfirmingServiceRestResponseProcessor::processConfirmResponse($response)

Process the 'confirm label' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\ConfirmingResponseShipment[]

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

Interfaces

TimeframeServiceResponseProcessorInterface

interface Firstred\PostNL\Service\ResponseProcessor\TimeframeServiceResponseProcessorInterface

Summary

Methods

• public processGetTimeframesResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\TimeframeServiceResponseProcessorInterface::processGetTimeframesResponse($response)

Process the 'get timeframes' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\ResponseTimeframes

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

2.0.0

ShippingServiceResponseProcessorInterface

interface Firstred\PostNL\Service\ResponseProcessor\ShippingServiceResponseProcessorInterface

Summary

Methods

• public processSendShipmentResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\ShippingServiceResponseProcessorInterface::processSendShipmentResponse($response)

Process the 'send shipment' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\SendShipmentResponse | null

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

BarcodeServiceResponseProcessorInterface

interface Firstred\PostNL\Service\ResponseProcessor\BarcodeServiceResponseProcessorInterface

Summary

Methods

• public processGenerateBarcodeResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\BarcodeServiceResponseProcessorInterface::processGenerateBarcodeResponse($response)

Process the 'generate barcode' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

string

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

ShippingStatusServiceResponseProcessorInterface

interface Firstred\PostNL\Service\ResponseProcessor\ShippingStatusServiceResponseProcessorInterface

Summary

Methods

• public processCurrentStatusResponse($response)

• public processCompleteStatusResponse($response)

• public processGetSignatureResponse($response)

• public processGetUpdatedShipmentsResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\ShippingStatusServiceResponseProcessorInterface::processCurrentStatusResponse($response)

Process the 'get current status' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\CurrentStatusResponse

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\ResponseProcessor\ShippingStatusServiceResponseProcessorInterface::processCompleteStatusResponse($response)

Process the 'get complete status' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\CompleteStatusResponse

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\ResponseProcessor\ShippingStatusServiceResponseProcessorInterface::processGetSignatureResponse($response)

Process the 'get signature' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

public Firstred\PostNL\Service\ResponseProcessor\ShippingStatusServiceResponseProcessorInterface::processGetUpdatedShipmentsResponse($response)

Process the 'get updated shipments' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\UpdatedShipmentsResponse[]

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

ConfirmingServiceResponseProcessorInterface

interface Firstred\PostNL\Service\ResponseProcessor\ConfirmingServiceResponseProcessorInterface

Summary

Methods

• public processConfirmResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\ConfirmingServiceResponseProcessorInterface::processConfirmResponse($response)

Process the 'confirm label' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\ConfirmingResponseShipment[]

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

LabellingServiceResponseProcessorInterface

interface Firstred\PostNL\Service\ResponseProcessor\LabellingServiceResponseProcessorInterface

Summary

Methods

• public processGenerateLabelResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\LabellingServiceResponseProcessorInterface::processGenerateLabelResponse($response)

Process the 'generate label' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GenerateLabelResponse

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

LocationServiceResponseProcessorInterface

interface Firstred\PostNL\Service\ResponseProcessor\LocationServiceResponseProcessorInterface

Summary

Methods

• public processGetNearestLocationsResponse($response)

• public processGetLocationsInAreaResponse($response)

• public processGetLocationResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\LocationServiceResponseProcessorInterface::processGetNearestLocationsResponse($response)

Process the 'get nearest locations' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GetNearestLocationsResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

2.0.0

public Firstred\PostNL\Service\ResponseProcessor\LocationServiceResponseProcessorInterface::processGetLocationsInAreaResponse($response)

Process the 'get locations in area' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

2.0.0

public Firstred\PostNL\Service\ResponseProcessor\LocationServiceResponseProcessorInterface::processGetLocationResponse($response)

Process the 'get location' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

2.0.0

DeliveryDateServiceResponseProcessorInterface

interface Firstred\PostNL\Service\ResponseProcessor\DeliveryDateServiceResponseProcessorInterface

Summary

Methods

• public processGetDeliveryDateResponse($response)

• public processGetSentDateResponse($response)

Methods

public Firstred\PostNL\Service\ResponseProcessor\DeliveryDateServiceResponseProcessorInterface::processGetDeliveryDateResponse($response)

Process the 'get delivery date' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GetDeliveryDateResponse

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Since

2.0.0

public Firstred\PostNL\Service\ResponseProcessor\DeliveryDateServiceResponseProcessorInterface::processGetSentDateResponse($response)

Process the 'get sent date' server response.

Parameters

• $response (Psr\Http\Message\ResponseInterface)

Returns

\Firstred\PostNL\Entity\Response\GetSentDateResponse

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

2.0.0

Classes

AbstractResponseProcessor

class Firstred\PostNL\Service\ResponseProcessor\AbstractResponseProcessor

Summary

Methods

• protected static getResponseText($response)

Methods

protected static Firstred\PostNL\Service\ResponseProcessor\AbstractResponseProcessor::getResponseText(array|\\Psr\\Http\\Message\\ResponseInterface|\\Firstred\\PostNL\\Exception\\HttpClientException $response)

Get the response.

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Since

2.0.0

Traits

ResponseProcessorSettersTrait

trait Firstred\PostNL\Service\ResponseProcessor\ResponseProcessorSettersTrait

Interfaces

TimeframeServiceInterface

interface Firstred\PostNL\Service\TimeframeServiceInterface

Parent

Firstred\PostNL\Service\ServiceInterface

Parent

Firstred\PostNL\Cache\CacheableServiceInterface

Summary

Methods

• public getTimeframes($getTimeframes)

Methods

public Firstred\PostNL\Service\TimeframeServiceInterface::getTimeframes($getTimeframes)

Get timeframes via REST.

Parameters

• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)

Returns

\Firstred\PostNL\Entity\Response\ResponseTimeframes

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Since

1.0.0

ConfirmingServiceInterface

interface Firstred\PostNL\Service\ConfirmingServiceInterface

Parent

Firstred\PostNL\Service\ServiceInterface

Summary

Methods

• public confirmShipment($confirming)

• public confirmShipments($confirms)

Methods

public Firstred\PostNL\Service\ConfirmingServiceInterface::confirmShipment($confirming)

Generate a single barcode via REST.

Parameters

• $confirming (Firstred\PostNL\Entity\Request\Confirming)

Returns

\Firstred\PostNL\Entity\Response\ConfirmingResponseShipment

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Since

1.0.0

public Firstred\PostNL\Service\ConfirmingServiceInterface::confirmShipments($confirms)

Confirm multiple shipments.

Parameters

• $confirms (Firstred\PostNL\Entity\Request\Confirming[]) [‘uuid’ => Confirming, …]

Returns

\Firstred\PostNL\Entity\Response\ConfirmingResponseShipment[]

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.0.0

LabellingServiceInterface

interface Firstred\PostNL\Service\LabellingServiceInterface

Parent

Firstred\PostNL\Service\ServiceInterface

Summary

Methods

• public generateLabel($generateLabel, $confirm)

• public generateLabels($generateLabels)

Methods

public Firstred\PostNL\Service\LabellingServiceInterface::generateLabel($generateLabel, $confirm=true)

Generate a single barcode via REST.

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Since

1.0.0

public Firstred\PostNL\Service\LabellingServiceInterface::generateLabels($generateLabels)

Generate multiple labels at once.

Parameters

• $generateLabels (array | string,array{0: \Firstred\PostNL\Entity\Request\GenerateBarcode, 1: bool}>)

Returns

array | string,\Firstred\PostNL\Entity\Response\GenerateLabelResponse>

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.0.0

DeliveryDateServiceInterface

interface Firstred\PostNL\Service\DeliveryDateServiceInterface

Parent

Firstred\PostNL\Service\ServiceInterface

Parent

Firstred\PostNL\Cache\CacheableServiceInterface

Summary

Methods

• public getDeliveryDate($getDeliveryDate)

• public getSentDate($getSentDate)

Methods

public Firstred\PostNL\Service\DeliveryDateServiceInterface::getDeliveryDate($getDeliveryDate)

Get the delivery date.

Parameters

• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)

Returns

\Firstred\PostNL\Entity\Response\GetDeliveryDateResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Since

2.0.0

public Firstred\PostNL\Service\DeliveryDateServiceInterface::getSentDate($getSentDate)

Get the shipping date.

Parameters

• $getSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest)

Returns

\Firstred\PostNL\Entity\Response\GetSentDateResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Since

2.0.0

LocationServiceInterface

interface Firstred\PostNL\Service\LocationServiceInterface

Parent

Firstred\PostNL\Service\ServiceInterface

Parent

Firstred\PostNL\Cache\CacheableServiceInterface

Summary

Methods

• public getNearestLocations($getNearestLocations)

• public getLocationsInArea($getLocations)

• public getLocation($getLocation)

Methods

public Firstred\PostNL\Service\LocationServiceInterface::getNearestLocations($getNearestLocations)

Get the nearest locations.

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Since

1.0.0

public Firstred\PostNL\Service\LocationServiceInterface::getLocationsInArea($getLocations)

Get the nearest locations.

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Since

1.0.0

public Firstred\PostNL\Service\LocationServiceInterface::getLocation($getLocation)

Get the location via REST.

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Since

1.0.0

ServiceInterface

interface Firstred\PostNL\Service\ServiceInterface

Summary

BarcodeServiceInterface

interface Firstred\PostNL\Service\BarcodeServiceInterface

Parent

Firstred\PostNL\Service\ServiceInterface

Summary

Methods

• public generateBarcode($generateBarcode)

• public generateBarcodes($generateBarcodes)

Methods

public Firstred\PostNL\Service\BarcodeServiceInterface::generateBarcode($generateBarcode)

Generate a single barcode.

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.0.0

public Firstred\PostNL\Service\BarcodeServiceInterface::generateBarcodes($generateBarcodes)

Generate multiple barcodes at once.

Parameters

• $generateBarcodes (Firstred\PostNL\Entity\Request\GenerateBarcode[])

Returns

string[] Barcodes

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.0.0

ShippingServiceInterface

interface Firstred\PostNL\Service\ShippingServiceInterface

Parent

Firstred\PostNL\Service\ServiceInterface

Summary

Methods

• public sendShipment($sendShipment, $confirm)

Methods

public Firstred\PostNL\Service\ShippingServiceInterface::sendShipment($sendShipment, $confirm=true)

Generate a single Shipping vai REST.

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.2.0

ShippingStatusServiceInterface

interface Firstred\PostNL\Service\ShippingStatusServiceInterface

Parent

Firstred\PostNL\Service\ServiceInterface

Parent

Firstred\PostNL\Cache\CacheableServiceInterface

Summary

Methods

• public currentStatus($currentStatus)

• public currentStatuses($currentStatuses)

• public completeStatus($completeStatus)

• public completeStatuses($completeStatuses)

• public getSignature($getSignature)

• public getSignatures($getSignatures)

• public getUpdatedShipments($customer, $dateTimeFrom, $dateTimeTo)

Methods

public Firstred\PostNL\Service\ShippingStatusServiceInterface::currentStatus(\\Firstred\\PostNL\\Entity\\Request\\CurrentStatusByReference|\\Firstred\\PostNL\\Entity\\Request\\CurrentStatus $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

• $currentStatus (Firstred\PostNL\Entity\Request\CurrentStatus | \Firstred\PostNL\Entity\Request\CurrentStatusByReference)

Returns

\Firstred\PostNL\Entity\Response\CurrentStatusResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Since

1.0.0

public Firstred\PostNL\Service\ShippingStatusServiceInterface::currentStatuses($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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.2.0

public Firstred\PostNL\Service\ShippingStatusServiceInterface::completeStatus(\\Firstred\\PostNL\\Entity\\Request\\CompleteStatusByReference|\\Firstred\\PostNL\\Entity\\Request\\CompleteStatus $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\CompleteStatusResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Since

1.0.0

public Firstred\PostNL\Service\ShippingStatusServiceInterface::completeStatuses($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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.2.0

public Firstred\PostNL\Service\ShippingStatusServiceInterface::getSignature($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\GetSignatureResponseSignature

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Since

1.0.0

public Firstred\PostNL\Service\ShippingStatusServiceInterface::getSignatures($getSignatures)

Get multiple signatures.

Parameters

• $getSignatures (Firstred\PostNL\Entity\Request\GetSignature[])

Returns

\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature[]

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.2.0

public Firstred\PostNL\Service\ShippingStatusServiceInterface::getUpdatedShipments($customer, $dateTimeFrom=null, $dateTimeTo=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\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Since

1.2.0

Classes

AbstractService

class Firstred\PostNL\Service\AbstractService

Class AbstractService.

Implements

Firstred\PostNL\Service\ServiceInterface

Summary

Methods

• public __construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory)

• public setApiKey($apiKey)

• public isSandbox()

• public setSandbox($sandbox)

• public getHttpClient()

• public setHttpClient($httpClient)

• public getRequestFactory()

• public setRequestFactory($requestFactory)

• public getStreamFactory()

• public setStreamFactory($streamFactory)

Methods

public Firstred\PostNL\Service\AbstractService::__construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

• $sandbox (bool)

• $httpClient (Firstred\PostNL\HttpClient\HttpClientInterface)

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

public Firstred\PostNL\Service\AbstractService::setApiKey($apiKey)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\AbstractService::isSandbox()

Returns

bool

Since

2.0.0

public Firstred\PostNL\Service\AbstractService::setSandbox($sandbox)

Parameters

• $sandbox (bool)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\AbstractService::getHttpClient()

Returns

\Firstred\PostNL\HttpClient\HttpClientInterface

public Firstred\PostNL\Service\AbstractService::setHttpClient($httpClient)

Parameters

• $httpClient (Firstred\PostNL\HttpClient\HttpClientInterface)

Returns

\Firstred\PostNL\Service\AbstractService

public Firstred\PostNL\Service\AbstractService::getRequestFactory()

Returns

\Psr\Http\Message\RequestFactoryInterface

Since

2.0.0

public Firstred\PostNL\Service\AbstractService::setRequestFactory($requestFactory)

Parameters

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\AbstractService::getStreamFactory()

Returns

\Psr\Http\Message\StreamFactoryInterface

Since

2.0.0

public Firstred\PostNL\Service\AbstractService::setStreamFactory($streamFactory)

Parameters

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

Returns

static

Since

2.0.0

LocationService

class Firstred\PostNL\Service\LocationService

Parent

Firstred\PostNL\Service\AbstractCacheableService

Implements

Firstred\PostNL\Service\LocationServiceInterface

Used traits

Firstred\PostNL\Service\ResponseProcessor\ResponseProcessorSettersTrait

Summary

Methods

• public __construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory, $cache, $ttl)

• public getNearestLocations($getNearestLocations)

• public getLocationsInArea($getLocations)

• public getLocation($getLocation)

• public setApiKey($apiKey)

• public setSandbox($sandbox)

• public setRequestFactory($requestFactory)

• public setStreamFactory($streamFactory)

Properties

protected static property Firstred\PostNL\Service\LocationService::$requestBuilder

protected static property Firstred\PostNL\Service\LocationService::$responseProcessor

Methods

public Firstred\PostNL\Service\LocationService::__construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory, $cache=null, \\DateInterval|\\DateTimeInterface|int $ttl=null)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

• $sandbox (bool)

• $httpClient (Firstred\PostNL\HttpClient\HttpClientInterface)

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

• $cache (Psr\Cache\CacheItemPoolInterface | null)

• $ttl (DateInterval | \DateTimeInterface | int | null)

public Firstred\PostNL\Service\LocationService::getNearestLocations($getNearestLocations)

Get the nearest locations via REST.

Parameters

• $getNearestLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)

Returns

\Firstred\PostNL\Entity\Response\GetNearestLocationsResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.0.0

public Firstred\PostNL\Service\LocationService::getLocationsInArea($getLocations)

Get the nearest locations via REST.

Parameters

• $getLocations (Firstred\PostNL\Entity\Request\GetLocationsInArea)

Returns

\Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.0.0

public Firstred\PostNL\Service\LocationService::getLocation($getLocation)

Get the location via REST.

Parameters

• $getLocation (Firstred\PostNL\Entity\Request\GetLocation)

Returns

\Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.0.0

public Firstred\PostNL\Service\LocationService::setApiKey($apiKey)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\LocationService::setSandbox($sandbox)

Parameters

• $sandbox (bool)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\LocationService::setRequestFactory($requestFactory)

Parameters

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\LocationService::setStreamFactory($streamFactory)

Parameters

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

Returns

static

Since

2.0.0

ShippingService

class Firstred\PostNL\Service\ShippingService

Parent

Firstred\PostNL\Service\AbstractService

Implements

Firstred\PostNL\Service\ShippingServiceInterface

Used traits

Firstred\PostNL\Service\ResponseProcessor\ResponseProcessorSettersTrait

Summary

Methods

• public __construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory)

• public sendShipment($sendShipment, $confirm)

• public setApiKey($apiKey)

• public setSandbox($sandbox)

• public setRequestFactory($requestFactory)

• public setStreamFactory($streamFactory)

Properties

protected static property Firstred\PostNL\Service\ShippingService::$requestBuilder

protected static property Firstred\PostNL\Service\ShippingService::$responseProcessor

Methods

public Firstred\PostNL\Service\ShippingService::__construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

• $sandbox (bool)

• $httpClient (Firstred\PostNL\HttpClient\HttpClientInterface)

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

Since

2.0.0

public Firstred\PostNL\Service\ShippingService::sendShipment($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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.2.0

public Firstred\PostNL\Service\ShippingService::setApiKey($apiKey)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\ShippingService::setSandbox($sandbox)

Parameters

• $sandbox (bool)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\ShippingService::setRequestFactory($requestFactory)

Parameters

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\ShippingService::setStreamFactory($streamFactory)

Parameters

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

Returns

static

Since

2.0.0

BarcodeService

class Firstred\PostNL\Service\BarcodeService

Parent

Firstred\PostNL\Service\AbstractService

Implements

Firstred\PostNL\Service\BarcodeServiceInterface

Used traits

Firstred\PostNL\Service\ResponseProcessor\ResponseProcessorSettersTrait

Summary

Methods

• public __construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory)

• public generateBarcode($generateBarcode)

• public generateBarcodes($generateBarcodes)

• public setApiKey($apiKey)

• public setSandbox($sandbox)

• public setRequestFactory($requestFactory)

• public setStreamFactory($streamFactory)

Properties

protected static property Firstred\PostNL\Service\BarcodeService::$requestBuilder

protected static property Firstred\PostNL\Service\BarcodeService::$responseProcessor

Methods

public Firstred\PostNL\Service\BarcodeService::__construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

• $sandbox (bool)

• $httpClient (Firstred\PostNL\HttpClient\HttpClientInterface)

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

public Firstred\PostNL\Service\BarcodeService::generateBarcode($generateBarcode)

Generate a single barcode.

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.0

public Firstred\PostNL\Service\BarcodeService::generateBarcodes($generateBarcodes)

Generate multiple barcodes at once.

Parameters

• $generateBarcodes (Firstred\PostNL\Entity\Request\GenerateBarcode[])

Returns

string[] Barcodes

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.0

public Firstred\PostNL\Service\BarcodeService::setApiKey($apiKey)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\BarcodeService::setSandbox($sandbox)

Parameters

• $sandbox (bool)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\BarcodeService::setRequestFactory($requestFactory)

Parameters

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\BarcodeService::setStreamFactory($streamFactory)

Parameters

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

Returns

static

Since

2.0.0

DeliveryDateService

class Firstred\PostNL\Service\DeliveryDateService

Parent

Firstred\PostNL\Service\AbstractCacheableService

Implements

Firstred\PostNL\Service\DeliveryDateServiceInterface

Used traits

Firstred\PostNL\Service\ResponseProcessor\ResponseProcessorSettersTrait

Summary

Methods

• public __construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory, $cache, $ttl)

• public getDeliveryDate($getDeliveryDate)

• public getSentDate($getSentDate)

• public setApiKey($apiKey)

• public setSandbox($sandbox)

• public setRequestFactory($requestFactory)

• public setStreamFactory($streamFactory)

Properties

protected static property Firstred\PostNL\Service\DeliveryDateService::$requestBuilder

protected static property Firstred\PostNL\Service\DeliveryDateService::$responseProcessor

Methods

public Firstred\PostNL\Service\DeliveryDateService::__construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory, $cache=null, \\DateInterval|\\DateTimeInterface|int $ttl=null)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

• $sandbox (bool)

• $httpClient (Firstred\PostNL\HttpClient\HttpClientInterface)

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

• $cache (Psr\Cache\CacheItemPoolInterface | null)

• $ttl (DateInterval | \DateTimeInterface | int | null)

public Firstred\PostNL\Service\DeliveryDateService::getDeliveryDate($getDeliveryDate)

Get the delivery date.

Parameters

• $getDeliveryDate (Firstred\PostNL\Entity\Request\GetDeliveryDate)

Returns

\Firstred\PostNL\Entity\Response\GetDeliveryDateResponse

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.0.0

public Firstred\PostNL\Service\DeliveryDateService::getSentDate($getSentDate)

Get the shipping date.

Parameters

• $getSentDate (Firstred\PostNL\Entity\Request\GetSentDateRequest)

Returns

\Firstred\PostNL\Entity\Response\GetSentDateResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.0.0

public Firstred\PostNL\Service\DeliveryDateService::setApiKey($apiKey)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\DeliveryDateService::setSandbox($sandbox)

Parameters

• $sandbox (bool)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\DeliveryDateService::setRequestFactory($requestFactory)

Parameters

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\DeliveryDateService::setStreamFactory($streamFactory)

Parameters

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

Returns

static

Since

2.0.0

TimeframeService

class Firstred\PostNL\Service\TimeframeService

Parent

Firstred\PostNL\Service\AbstractCacheableService

Implements

Firstred\PostNL\Service\TimeframeServiceInterface

Used traits

Firstred\PostNL\Service\ResponseProcessor\ResponseProcessorSettersTrait

Summary

Methods

• public __construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory, $cache, $ttl)

• public getTimeframes($getTimeframes)

• public setApiKey($apiKey)

• public setSandbox($sandbox)

• public setRequestFactory($requestFactory)

• public setStreamFactory($streamFactory)

Properties

protected static property Firstred\PostNL\Service\TimeframeService::$requestBuilder

protected static property Firstred\PostNL\Service\TimeframeService::$responseProcessor

Methods

public Firstred\PostNL\Service\TimeframeService::__construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory, $cache=null, \\DateInterval|\\DateTimeInterface|int $ttl=null)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

• $sandbox (bool)

• $httpClient (Firstred\PostNL\HttpClient\HttpClientInterface)

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

• $cache (Psr\Cache\CacheItemPoolInterface | null)

• $ttl (DateInterval | \DateTimeInterface | int | null)

public Firstred\PostNL\Service\TimeframeService::getTimeframes($getTimeframes)

Get timeframes via REST.

Parameters

• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)

Returns

\Firstred\PostNL\Entity\Response\ResponseTimeframes

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.0.0

public Firstred\PostNL\Service\TimeframeService::setApiKey($apiKey)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\TimeframeService::setSandbox($sandbox)

Parameters

• $sandbox (bool)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\TimeframeService::setRequestFactory($requestFactory)

Parameters

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\TimeframeService::setStreamFactory($streamFactory)

Parameters

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

Returns

static

Since

2.0.0

AbstractCacheableService

class Firstred\PostNL\Service\AbstractCacheableService

Class AbstractService.

Parent

Firstred\PostNL\Service\AbstractService

Implements

Firstred\PostNL\Cache\CacheableServiceInterface

Used traits

Firstred\PostNL\Clock\ClockAwareTrait

Summary

Methods

• public __construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory, $cache, $ttl)

• public retrieveCachedResponseItem($cacheableRequestEntity)

• public cacheResponseItem($item)

• public removeCachedResponseItem($item)

• public getTtl()

• public setTtl($ttl)

• public getCache()

• public setCache($cache)

Properties

protected static property Firstred\PostNL\Service\AbstractCacheableService::$ttl

TTL for the cache.

`null` disables the cache

`int` is the TTL in seconds

Any `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

protected static property Firstred\PostNL\Service\AbstractCacheableService::$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\AbstractCacheableService::__construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory, $cache=null, \\DateInterval|\\DateTimeInterface|int $ttl=null)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

• $sandbox (bool)

• $httpClient (Firstred\PostNL\HttpClient\HttpClientInterface)

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

• $cache (Psr\Cache\CacheItemPoolInterface | null)

• $ttl (DateInterval | \DateTimeInterface | int | null)

public Firstred\PostNL\Service\AbstractCacheableService::retrieveCachedResponseItem($cacheableRequestEntity)

Retrieve a cached item.

Parameters

• $cacheableRequestEntity (Firstred\PostNL\Cache\CacheableRequestEntityInterface)

Returns

\Psr\Cache\CacheItemInterface | null

Throws

\Psr\Cache\InvalidArgumentException

Since

2.0.0

public Firstred\PostNL\Service\AbstractCacheableService::cacheResponseItem($item)

Cache an item.

Parameters

• $item (Psr\Cache\CacheItemInterface)

Returns

bool

Since

2.0.0

public Firstred\PostNL\Service\AbstractCacheableService::removeCachedResponseItem($item)

Delete an item from cache.

Parameters

• $item (Psr\Cache\CacheItemInterface)

Returns

bool

Throws

\Psr\Cache\InvalidArgumentException

Since

2.0.0

public Firstred\PostNL\Service\AbstractCacheableService::getTtl()

Returns

\DateInterval | \DateTimeInterface | int | null

Since

1.2.0

public Firstred\PostNL\Service\AbstractCacheableService::setTtl(\\DateInterval|\\DateTimeInterface|int|null $ttl=null)

Parameters

• $ttl (DateInterval | \DateTimeInterface | int | null)

Returns

static

Since

1.2.0

public Firstred\PostNL\Service\AbstractCacheableService::getCache()

Returns

\Psr\Cache\CacheItemPoolInterface | null

Since

1.2.0

public Firstred\PostNL\Service\AbstractCacheableService::setCache($cache=null)

Parameters

• $cache (Psr\Cache\CacheItemPoolInterface | null)

Returns

static

Since

1.2.0

ShippingStatusService

class Firstred\PostNL\Service\ShippingStatusService

Parent

Firstred\PostNL\Service\AbstractCacheableService

Implements

Firstred\PostNL\Service\ShippingStatusServiceInterface

Used traits

Firstred\PostNL\Service\ResponseProcessor\ResponseProcessorSettersTrait

Summary

Methods

• public __construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory, $cache, $ttl)

• public currentStatus($currentStatus)

• public currentStatuses($currentStatuses)

• public completeStatus($completeStatus)

• public completeStatuses($completeStatuses)

• public getSignature($getSignature)

• public getSignatures($getSignatures)

• public getUpdatedShipments($customer, $dateTimeFrom, $dateTimeTo)

• public setApiKey($apiKey)

• public setSandbox($sandbox)

• public setRequestFactory($requestFactory)

• public setStreamFactory($streamFactory)

Properties

protected static property Firstred\PostNL\Service\ShippingStatusService::$requestBuilder

protected static property Firstred\PostNL\Service\ShippingStatusService::$responseProcessor

Methods

public Firstred\PostNL\Service\ShippingStatusService::__construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory, $cache=null, \\DateInterval|\\DateTimeInterface|int $ttl=null)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

• $sandbox (bool)

• $httpClient (Firstred\PostNL\HttpClient\HttpClientInterface)

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

• $cache (Psr\Cache\CacheItemPoolInterface | null)

• $ttl (DateInterval | \DateTimeInterface | int | null)

public Firstred\PostNL\Service\ShippingStatusService::currentStatus(\\Firstred\\PostNL\\Entity\\Request\\CurrentStatusByReference|\\Firstred\\PostNL\\Entity\\Request\\CurrentStatus $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

• $currentStatus (Firstred\PostNL\Entity\Request\CurrentStatus | \Firstred\PostNL\Entity\Request\CurrentStatusByReference)

Returns

\Firstred\PostNL\Entity\Response\CurrentStatusResponse

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.0.0

public Firstred\PostNL\Service\ShippingStatusService::currentStatuses($currentStatuses)

Get current statuses.

Parameters

• $currentStatuses (Firstred\PostNL\Entity\Request\CurrentStatus[])

Returns

\Firstred\PostNL\Entity\Response\CurrentStatusResponse[]

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.2.0

public Firstred\PostNL\Service\ShippingStatusService::completeStatus(\\Firstred\\PostNL\\Entity\\Request\\CompleteStatusByReference|\\Firstred\\PostNL\\Entity\\Request\\CompleteStatus $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\CompleteStatusByReference | \Firstred\PostNL\Entity\Request\CompleteStatus)

Returns

\Firstred\PostNL\Entity\Response\CompleteStatusResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.0.0

public Firstred\PostNL\Service\ShippingStatusService::completeStatuses($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\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.2.0

public Firstred\PostNL\Service\ShippingStatusService::getSignature($getSignature)

Gets the signature.

Parameters

• $getSignature (Firstred\PostNL\Entity\Request\GetSignature)

Returns

\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.0.0

public Firstred\PostNL\Service\ShippingStatusService::getSignatures($getSignatures)

Get multiple signatures.

Parameters

• $getSignatures (Firstred\PostNL\Entity\Request\GetSignature[])

Returns

\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature[]

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.2.0

public Firstred\PostNL\Service\ShippingStatusService::getUpdatedShipments($customer, $dateTimeFrom=null, $dateTimeTo=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\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.2.0

public Firstred\PostNL\Service\ShippingStatusService::setApiKey($apiKey)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\ShippingStatusService::setSandbox($sandbox)

Parameters

• $sandbox (bool)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\ShippingStatusService::setRequestFactory($requestFactory)

Parameters

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\ShippingStatusService::setStreamFactory($streamFactory)

Parameters

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

Returns

static

Since

2.0.0

LabellingService

class Firstred\PostNL\Service\LabellingService

Parent

Firstred\PostNL\Service\AbstractService

Implements

Firstred\PostNL\Service\LabellingServiceInterface

Used traits

Firstred\PostNL\Service\ResponseProcessor\ResponseProcessorSettersTrait

Summary

Methods

• public __construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory)

• public generateLabel($generateLabel, $confirm)

• public generateLabels($generateLabels)

• public setApiKey($apiKey)

• public setSandbox($sandbox)

• public setRequestFactory($requestFactory)

• public setStreamFactory($streamFactory)

Properties

protected static property Firstred\PostNL\Service\LabellingService::$requestBuilder

protected static property Firstred\PostNL\Service\LabellingService::$responseProcessor

private property Firstred\PostNL\Service\LabellingService::$insuranceProductCodes

Methods

public Firstred\PostNL\Service\LabellingService::__construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

• $sandbox (bool)

• $httpClient (Firstred\PostNL\HttpClient\HttpClientInterface)

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

public Firstred\PostNL\Service\LabellingService::generateLabel($generateLabel, $confirm=true)

Generate a single barcode.

Parameters

• $generateLabel (Firstred\PostNL\Entity\Request\GenerateLabel)

• $confirm (bool)

Returns

\Firstred\PostNL\Entity\Response\GenerateLabelResponse

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.0.0

public Firstred\PostNL\Service\LabellingService::generateLabels($generateLabels)

Generate multiple labels at once.

Parameters

• $generateLabels (array | string,array{0: \Firstred\PostNL\Entity\Request\GenerateBarcode, 1: bool}>)

Returns

array | string,\Firstred\PostNL\Entity\Response\GenerateBarcodeResponse>

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Since

1.0.0

public Firstred\PostNL\Service\LabellingService::setApiKey($apiKey)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\LabellingService::setSandbox($sandbox)

Parameters

• $sandbox (bool)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\LabellingService::setRequestFactory($requestFactory)

Parameters

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\LabellingService::setStreamFactory($streamFactory)

Parameters

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

Returns

static

Since

2.0.0

ConfirmingService

class Firstred\PostNL\Service\ConfirmingService

Parent

Firstred\PostNL\Service\AbstractService

Implements

Firstred\PostNL\Service\ConfirmingServiceInterface

Used traits

Firstred\PostNL\Service\ResponseProcessor\ResponseProcessorSettersTrait

Summary

Methods

• public __construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory)

• public confirmShipment($confirming)

• public confirmShipments($confirms)

• public setApiKey($apiKey)

• public setSandbox($sandbox)

• public setRequestFactory($requestFactory)

• public setStreamFactory($streamFactory)

Properties

protected static property Firstred\PostNL\Service\ConfirmingService::$requestBuilder

protected static property Firstred\PostNL\Service\ConfirmingService::$responseProcessor

Methods

public Firstred\PostNL\Service\ConfirmingService::__construct($apiKey, $sandbox, $httpClient, $requestFactory, $streamFactory)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

• $sandbox (bool)

• $httpClient (Firstred\PostNL\HttpClient\HttpClientInterface)

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

public Firstred\PostNL\Service\ConfirmingService::confirmShipment($confirming)

Confirm a single shipment via REST.

Parameters

• $confirming (Firstred\PostNL\Entity\Request\Confirming)

Returns

\Firstred\PostNL\Entity\Response\ConfirmingResponseShipment

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Since

1.0.0

public Firstred\PostNL\Service\ConfirmingService::confirmShipments($confirms)

Confirm multiple shipments.

Parameters

• $confirms (array) [‘uuid’ => Confirming, …]

Returns

array

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.0.0

public Firstred\PostNL\Service\ConfirmingService::setApiKey($apiKey)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\ConfirmingService::setSandbox($sandbox)

Parameters

• $sandbox (bool)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\ConfirmingService::setRequestFactory($requestFactory)

Parameters

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

Returns

static

Since

2.0.0

public Firstred\PostNL\Service\ConfirmingService::setStreamFactory($streamFactory)

Parameters

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

Returns

static

Since

2.0.0

Util

\Firstred\PostNL\Util

Classes

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 in RFC 4122 format.

Returns

string

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()

Util

class Firstred\PostNL\Util\Util

Class Util.

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)

• public static compareGuzzleVersion($a, $b)

• public static isAssociativeArray($array)

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

Since

1.0.0

Deprecated

2.0.0

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 orientation The orientation is in FPDF format, so L for Landscape and P for Portrait Sizes are in mm

Since

1.0.0

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

Since

1.0.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

Since

1.0.0

public static Firstred\PostNL\Util\Util::getShippingDaysRemaining($shippingDate, $preferredDeliveryDate)

Calculates amount of days remaining

i.e. preferred delivery date the day tomorrow => today = 0

i.e. preferred delivery date the day after tomorrow => today + tomorrow = 1

i.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 past

anything 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

Since

1.0.0

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)

Since

1.0.0

public static Firstred\PostNL\Util\Util::compareGuzzleVersion(int|float|string $a, int|float|string $b)

Parameters

• $a (int | float | string)

• $b (int | float | string)

Returns

int

Since

1.0.0

public static Firstred\PostNL\Util\Util::isAssociativeArray($array)

Check if the given array is associative.

Parameters

• $array (array)

Returns

bool

Since

2.0.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(string|\\Stringable $message, $context=\[\])

System is unusable.

Parameters

• $message (string | \Stringable)

• $context (array)

Returns

void

public Firstred\PostNL\Util\DummyLogger::alert(string|\\Stringable $message, $context=\[\])

Action must be taken immediately.

Example: Entire website down, database unavailable, etc. This should

trigger the SMS alerts and wake you up.

Parameters

• $message (string | \Stringable)

• $context (array)

Returns

void

public Firstred\PostNL\Util\DummyLogger::critical(string|\\Stringable $message, $context=\[\])

Critical conditions.

Example: Application component unavailable, unexpected exception.

Parameters

• $message (string | \Stringable)

• $context (array)

Returns

void

public Firstred\PostNL\Util\DummyLogger::error(string|\\Stringable $message, $context=\[\])

Runtime errors that do not require immediate action but should typically

be logged and monitored.

Parameters

• $message (string | \Stringable)

• $context (array)

Returns

void

public Firstred\PostNL\Util\DummyLogger::warning(string|\\Stringable $message, $context=\[\])

Exceptional occurrences that are not errors.

Example: Use of deprecated APIs, poor use of an API, undesirable things

that are not necessarily wrong.

Parameters

• $message (string | \Stringable)

• $context (array)

Returns

void

public Firstred\PostNL\Util\DummyLogger::notice(string|\\Stringable $message, $context=\[\])

Normal but significant events.

Parameters

• $message (string | \Stringable)

• $context (array)

Returns

void

public Firstred\PostNL\Util\DummyLogger::info(string|\\Stringable $message, $context=\[\])

Interesting events.

Example: User logs in, SQL logs.

Parameters

• $message (string | \Stringable)

• $context (array)

Returns

void

public Firstred\PostNL\Util\DummyLogger::debug(string|\\Stringable $message, $context=\[\])

Detailed debug information.

Parameters

• $message (string | \Stringable)

• $context (array)

Returns

void

public Firstred\PostNL\Util\DummyLogger::log( $level, string|\\Stringable $message, $context=\[\])

Logs with an arbitrary level.

Parameters

• $level (mixed)

• $message (string | \Stringable)

• $context (array)

Returns

void

Throws

\Psr\Log\InvalidArgumentException

Classes

PostNL

class Firstred\PostNL\PostNL

Class PostNL.

Implements

Psr\Log\LoggerAwareInterface

Summary

Methods

• public __construct($customer, $apiKey, $sandbox)

• public setApiKey($apiKey)

• public getCustomer()

• public setCustomer($customer)

• public getSandbox()

• public setSandbox($sandbox)

• public getHttpClient()

• public setHttpClient($httpClient)

• 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()

• 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 getShippingStatusByBarcode($barcode, $complete)

• public getShippingStatusesByBarcodes($barcodes, $complete)

• public getShippingStatusByReference($reference, $complete)

• public getShippingStatusesByReferences($references, $complete)

• public getUpdatedShipments($dateTimeFrom, $dateTimeTo)

• 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)

Properties

public property Firstred\PostNL\PostNL::$threeSCountries

3S (or EU Pack Special) countries.

Type

list

public property Firstred\PostNL\PostNL::$a6positions

A6 positions

(index = amount of a6 left on the page).

Type

array{1: array{: int, : int}, 2: array{: int, : int}, 3: array{: int, : int}, 4: array{: int, : int}}

protected static property Firstred\PostNL\PostNL::$apiKey

Type

\ParagonIE\HiddenString\HiddenString

protected static property Firstred\PostNL\PostNL::$customer

Type

\Firstred\PostNL\Entity\Customer

protected static property Firstred\PostNL\PostNL::$sandbox

Type

bool

protected static property Firstred\PostNL\PostNL::$httpClient

Type

\Firstred\PostNL\HttpClient\HttpClientInterface

protected static property Firstred\PostNL\PostNL::$logger

Type

\Psr\Log\LoggerInterface

protected static property Firstred\PostNL\PostNL::$requestFactory

Type

\Psr\Http\Message\RequestFactoryInterface

protected static property Firstred\PostNL\PostNL::$responseFactory

Type

\Psr\Http\Message\ResponseFactoryInterface

protected static property Firstred\PostNL\PostNL::$streamFactory

Type

\Psr\Http\Message\StreamFactoryInterface

protected static property Firstred\PostNL\PostNL::$barcodeService

Type

\Firstred\PostNL\Service\BarcodeServiceInterface

protected static property Firstred\PostNL\PostNL::$labellingService

Type

\Firstred\PostNL\Service\LabellingServiceInterface

protected static property Firstred\PostNL\PostNL::$confirmingService

Type

\Firstred\PostNL\Service\ConfirmingServiceInterface

protected static property Firstred\PostNL\PostNL::$shippingStatusService

Type

\Firstred\PostNL\Service\ShippingStatusServiceInterface

protected static property Firstred\PostNL\PostNL::$deliveryDateService

Type

\Firstred\PostNL\Service\DeliveryDateServiceInterface

protected static property Firstred\PostNL\PostNL::$timeframeService

Type

\Firstred\PostNL\Service\TimeframeServiceInterface

protected static property Firstred\PostNL\PostNL::$locationService

Type

\Firstred\PostNL\Service\LocationServiceInterface

protected static property Firstred\PostNL\PostNL::$shippingService

Type

\Firstred\PostNL\Service\ShippingServiceInterface

protected static property Firstred\PostNL\PostNL::$timeframeServiceRequestBuilder

protected static property Firstred\PostNL\PostNL::$locationServiceRequestBuilder

protected static property Firstred\PostNL\PostNL::$deliveryDateServiceRequestBuilder

protected static property Firstred\PostNL\PostNL::$timeframeServiceResponseProcessor

protected static property Firstred\PostNL\PostNL::$locationServiceResponseProcessor

protected static property Firstred\PostNL\PostNL::$deliveryDateServiceResponseProcessor

Methods

public Firstred\PostNL\PostNL::__construct($customer, string|\\ParagonIE\\HiddenString\\HiddenString $apiKey, $sandbox)

PostNL constructor.

Parameters

• $customer (Firstred\PostNL\Entity\Customer) customer object

• $apiKey (string | \ParagonIE\HiddenString\HiddenString) API key or UsernameToken object

• $sandbox (bool) whether the testing environment should be used

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\PostNL::setApiKey(\\ParagonIE\\HiddenString\\HiddenString|string $apiKey)

Parameters

• $apiKey (ParagonIE\HiddenString\HiddenString | string)

Returns

static

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

2.0.0

public Firstred\PostNL\PostNL::getCustomer()

Get PostNL Customer.

Returns

\Firstred\PostNL\Entity\Customer

Since

1.0.0

public Firstred\PostNL\PostNL::setCustomer($customer)

Set PostNL Customer.

Parameters

• $customer (Firstred\PostNL\Entity\Customer)

Returns

static

Since

1.0.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

static

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.0

public Firstred\PostNL\PostNL::getHttpClient()

HttpClient.

Automatically load Guzzle when available

Returns

\Firstred\PostNL\HttpClient\HttpClientInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.0

public Firstred\PostNL\PostNL::setHttpClient($httpClient)

Set the HttpClient.

Parameters

• $httpClient (Firstred\PostNL\HttpClient\HttpClientInterface)

Returns

static

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.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

void

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

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

\Psr\Http\Message\RequestFactoryInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\PostNL::setRequestFactory($requestFactory)

Set PSR-7 Request factory.

Parameters

• $requestFactory (Psr\Http\Message\RequestFactoryInterface)

Returns

static

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

Since

1.2.0

Since

1.2.0

public Firstred\PostNL\PostNL::getResponseFactory()

Get PSR-7 Response factory.

Returns

\Psr\Http\Message\ResponseFactoryInterface

Since

1.2.0

public Firstred\PostNL\PostNL::setResponseFactory($responseFactory)

Set PSR-7 Response factory.

Parameters

• $responseFactory (Psr\Http\Message\ResponseFactoryInterface)

Returns

static

Since

1.2.0

Since

1.2.0

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\PostNL::getStreamFactory()

Set PSR-7 Stream factory.

Returns

\Psr\Http\Message\StreamFactoryInterface

Since

1.2.0

public Firstred\PostNL\PostNL::setStreamFactory($streamFactory)

Set PSR-7 Stream factory.

Parameters

• $streamFactory (Psr\Http\Message\StreamFactoryInterface)

Returns

static

Since

1.2.0

Since

1.2.0

Since

1.2.0

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\PostNL::getBarcodeService()

Barcode service.

Automatically load the barcode service

Returns

\Firstred\PostNL\Service\BarcodeServiceInterface

Since

1.0.0

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

public Firstred\PostNL\PostNL::setBarcodeService($service)

Set the barcode service.

Parameters

• $service (Firstred\PostNL\Service\BarcodeServiceInterface)

Returns

static

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\PostNL::getLabellingService()

Labelling service.

Automatically load the labelling service

Returns

\Firstred\PostNL\Service\LabellingServiceInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.0

public Firstred\PostNL\PostNL::setLabellingService($service)

Set the labelling service.

Parameters

• $service (Firstred\PostNL\Service\LabellingServiceInterface)

Returns

static

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\PostNL::getConfirmingService()

Confirming service.

Automatically load the confirming service

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.0

public Firstred\PostNL\PostNL::setConfirmingService($service)

Set the confirming service.

Parameters

• $service (Firstred\PostNL\Service\ConfirmingServiceInterface)

Returns

static

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\PostNL::getShippingStatusService()

Shipping status service.

Automatically load the shipping status service

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.0

public Firstred\PostNL\PostNL::setShippingStatusService($service)

Set the shipping status service.

Parameters

• $service (Firstred\PostNL\Service\ShippingStatusServiceInterface)

Returns

static

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\PostNL::getDeliveryDateService()

Delivery date service.

Automatically load the delivery date service

Returns

\Firstred\PostNL\Service\DeliveryDateServiceInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.0

public Firstred\PostNL\PostNL::setDeliveryDateService($service)

Set the delivery date service.

Parameters

• $service (Firstred\PostNL\Service\DeliveryDateServiceInterface)

Returns

static

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\PostNL::getTimeframeService()

Timeframe service.

Automatically load the timeframe service

Returns

\Firstred\PostNL\Service\TimeframeServiceInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.0

public Firstred\PostNL\PostNL::setTimeframeService($service)

Set the timeframe service.

Parameters

• $service (Firstred\PostNL\Service\TimeframeServiceInterface)

Returns

static

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\PostNL::getLocationService()

Location service.

Automatically load the location service

Returns

\Firstred\PostNL\Service\LocationServiceInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.0

public Firstred\PostNL\PostNL::setLocationService($service)

Set the location service.

Parameters

• $service (Firstred\PostNL\Service\LocationServiceInterface)

Returns

static

Since

1.0.0

Since

1.0.0

public Firstred\PostNL\PostNL::getShippingService()

Shipping service.

Automatically load the shipping service

Returns

\Firstred\PostNL\Service\ShippingServiceInterface

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.2.0

public Firstred\PostNL\PostNL::setShippingService($service)

Set the shipping service.

Parameters

• $service (Firstred\PostNL\Service\ShippingServiceInterface)

Returns

static

Since

1.2.0

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 | null)

• $serie (string | null)

• $eps (bool)

Returns

string

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

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\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.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 barcodes as string

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidBarcodeException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

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\SendShipmentResponse

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

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{1: bool, 2: bool, 3: bool, 4: bool}) 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 position numbers: ` +-+-+ |2|4| +-+-+ |1|3| +-+-+ ` So, for ` +-+-+ |x|✔| +-+-+ |✔|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\NotSupportedException

Throws

\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\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

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\GenerateLabelResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

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 a

string 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 position numbers: ` +-+-+ |2|4| +-+-+ |1|3| +-+-+ ` So, for ` +-+-+ |x|✔| +-+-+ |✔|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\PostNLException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\PostNLException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\PostNLException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\PostNLException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\PostNLException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\PostNLException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\PostNLException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\PostNLException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\PostNLException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\PostNLException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\PostNLException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\PostNLException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.0.0

public Firstred\PostNL\PostNL::confirmShipment($shipment)

Confirm a single shipment.

Parameters

• $shipment (Firstred\PostNL\Entity\Shipment)

Returns

\Firstred\PostNL\Entity\Response\ConfirmingResponseShipment

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

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\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Since

1.0.0

public Firstred\PostNL\PostNL::getShippingStatusByBarcode($barcode, $complete=false)

Get the current status of the given shipment by barcode.

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\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Since

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

array | \Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment>

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

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\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\NotFoundException

Since

1.2.0

public Firstred\PostNL\PostNL::getShippingStatusesByReferences($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

array | \Firstred\PostNL\Entity\Response\CompleteStatusResponseShipment>

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.2.0

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[]

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.2.0

public Firstred\PostNL\PostNL::getSignatureByBarcode($barcode)

Get the signature of a shipment.

Parameters

• $barcode (string)

Returns

\Firstred\PostNL\Entity\Response\GetSignatureResponseSignature

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

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\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

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\GetDeliveryDateResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

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\GetSentDateResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.0.0

public Firstred\PostNL\PostNL::getTimeframes($getTimeframes)

Get timeframes.

Parameters

• $getTimeframes (Firstred\PostNL\Entity\Request\GetTimeframes)

Returns

\Firstred\PostNL\Entity\Response\ResponseTimeframes

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

1.0.0

public Firstred\PostNL\PostNL::getNearestLocations($getNearestLocations)

Get nearest locations.

Parameters

• $getNearestLocations (Firstred\PostNL\Entity\Request\GetNearestLocations)

Returns

\Firstred\PostNL\Entity\Response\GetNearestLocationsResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

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{timeframes: \Firstred\PostNL\Entity\Response\ResponseTimeframes, locations: \Firstred\PostNL\Entity\Response\GetNearestLocationsResponse, delivery_date: \Firstred\PostNL\Entity\Response\GetDeliveryDateResponse}

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Throwable

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Throwable

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Throwable

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Throwable

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Throwable

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Throwable

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Throwable

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Throwable

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Throwable

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Throwable

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\ApiException

Throws

\Firstred\PostNL\Exception\DeserializationException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\InvalidConfigurationException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Throwable

Since

1.0.0

public Firstred\PostNL\PostNL::getLocationsInArea($getLocationsInArea)

Get locations in area.

Parameters

• $getLocationsInArea (Firstred\PostNL\Entity\Request\GetLocationsInArea)

Returns

\Firstred\PostNL\Entity\Response\GetLocationsInAreaResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

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\GetLocationsInAreaResponse

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Throws

\Firstred\PostNL\Exception\CifDownException

Throws

\Firstred\PostNL\Exception\CifException

Throws

\Firstred\PostNL\Exception\HttpClientException

Throws

\Firstred\PostNL\Exception\NotSupportedException

Throws

\Firstred\PostNL\Exception\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\NotFoundException

Throws

\Psr\Cache\InvalidArgumentException

Throws

\Firstred\PostNL\Exception\ResponseException

Since

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\InvalidBarcodeException

Since

1.0.0

Authors

Maintainers:

• Michael Dekker <git@michaeldekker.nl> (maintainer)

Looking for maintainers! If you’d like to help keep this library up to date please send and email to git@michaeldekker.nl

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)

• rdanklof (contributor)

• Bert Brunekreeft (contributor)

• Daniel Schipper (contributor)

• Joshua Bours (contributor)

• Hidde Schuurman (contributor)

• Mathieu Haverkamp (contributor)

• Jeroen Smit (contributor)