README

Use this client to convieniently interact with PostNL ECS . This PHP package was developed by Afosto to make a reliable connection between Afosto (Retail Software) and PostNL ECS and provides the following functionality:

send product information to ECS
send order information to ECS
receive stock information (mutations or full list)
receive shipment updates (track&trace codes)

Getting Started

Simply follow the installation instructions. You will need an account at PostNL ECS that is set up for you to use.

Prerequisites

What things you need to install the software and how to install them

PHP5.5+
Composer (for installation)

Installing

Installing is easy through Composer.

composer require afosto/ecs

Examples

Now, to insert a product at ECS, use the following code.

First set some configuration parameters:

$config = [
    'host'       => 'sftp-postnlint-accp.xs4.mendix.net',
    'port'       => 22,
    'username'   => '',
    'privateKey' => '',
    'root'       => '/home/{username}/' 
];

Initialze the application with the configuration

App::init($config);

Send a product

Build the product object

$product = new Product();
$product->sku = 'ART-1-TEST';
$product->shortDescription = 'Test article';
$product->ean = '1000000000016';
$product->height = $product->weight = $product->depth = $product->width = 1;

Make a message container and insert a message number (in this case 1) and add the product and send the message:

$message = new ProductMessage(1);

Insert a single product or add multiple:

$message->addMessagePart($product);
$message->addMessagePart([$product2, $product3]);

Now send the message:

$message->send();

For debugging you can also download or show the XML file:

$message->show();
$message->download();

Now the product should be available in ECS.

Stock updates

To parse a batch of stock messages, use the following code.

$stockListUpdates = new StockList();

Load the messages (XML files from the SFTP server):

foreach ($stockListUpdates->getUpdates() as $model) {
    //Do something with the message
    $message = [
        'sku'   => $model->sku, 
        'count' => $model->count,
    ];
}

Mark the processed messages as read (they will be deleted):

$stockListUpdates->markAsRead();

Other examples

In the examples directory you will find more examples of this project.

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository.

License

This project is licensed under the Apache License 2.0 - see the LICENSE.md file for details

afosto / postnl-ecs

Maintainers

Details