afosto/postnl-ecs

Afosto PostNL ECS Client

PostNL ECS

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:, _(*1)

• 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., _(*2)

Prerequisites

What things you need to install the software and how to install them - PHP5.5+ - Composer (for installation), _(*3)

Installing

Installing is easy through Composer., _(*4)

composer require afosto/ecs

Examples

Now, to insert a product at ECS, use the following code., _(*5)

First set some configuration parameters:, _(*6)

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

Initialze the application with the configuration, _(*7)

App::init($config);

Send a product

Build the product object, _(*8)

$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:, _(*9)

$message = new ProductMessage(1);

Insert a single product or add multiple:, _(*10)

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

Now send the message:, _(*11)

$message->send();

For debugging you can also download or show the XML file:, _(*12)

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

Now the product should be available in ECS., _(*13)

Stock updates

To parse a batch of stock messages, use the following code., _(*14)

$stockListUpdates = new StockList();

Load the messages (XML files from the SFTP server):, _(*15)

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):, _(*16)

$stockListUpdates->markAsRead();

Other examples

In the examples directory you will find more examples of this project., _(*17)

Versioning

We use SemVer for versioning. For the versions available, see the tags on this repository., _(*18)

License

This project is licensed under the Apache License 2.0 - see the LICENSE.md file for details, _(*19)