EGcs Mendrix API client

Usage:

Works with client_credentials OAuth2. Only Client-ID and Secret are needed.

$api = new MendrixApi($client_id, $client_secret);
//test server connection
$user = $api->getServerdate();
//get user data
$user = $api->getUser();

View orders

$from = '2020-01-04T23:00:00+01:00';
$to = '2020-01-07T22:59:59+01:00';
$page = 1;
$limit = 10;
$orders = $api->getOrders($from, $to, $page, $limit);
//returns ['total', 'page', 'limit', 'items',]

Create new order

try {
    $result = $api->createOrder([
        'Contact' => 'Contact Persoon Logique',
        'Notes' => 'Notities Logique',
        'GoodList' => [
            [
                'Packing' => 'Produkt', //required
                'Barcode' => '',
                'Comments' => 'Comment',
                'Depth' => '1',
                'Height' => '1',
                'Width' => '1',
                'Parts' => '1',
                'Volume' => '1',
                'VolumeWeight' => '1',
                'ArticleWeight' => '1', //required
                'Weight' => '1'
            ]
        ],
        'PickUp' => [
            'Instructions' => 'Ophaalinstructies',
            'ReferenceOur' => '#8746',
            'ReferenceYour' => 'ref-1234',
            'Requested' => [
                'DateTimeBegin' => '2020-01-04T09:00:00',
                'DateTimeEnd' => '2020-01-04T17:00:00'
            ]
        ],
        'Delivery' => [
            'Address' => [
                'Name' => 'Piet Klant', //required
                'Premise' => 'expeditie',
                'Street' => 'Straatweg', //required
                'Number' => '123',
                'PostalCode' => '1234 AB', //required
                'Place' => 'Ede', //required
                'Country' => 'Nederland', //required
                'CountryCode' => 'NL' //required
            ],
            'ContactName' => 'Piet Klant',
            'Instructions' => 'Instructies afleveren',
            'ReferenceOur' => '#8746',
            'ReferenceYour' => 'ref-1234',
            'Requested' => [
                'DateTimeBegin' => '2020-01-05T09:00:00',
                'DateTimeEnd' => '2020-01-05T17:00:00'
            ],
            'Connectivity' => [
                'Email' => 'piet@klant.nl',
                'Phone' => '012-2345678',
                'Mobile' => '06-12345678'
            ]
        ]
    ]);

} catch (MendrixApiException $e) {
    if ($data = $e->getResponseData()) {
        $error = $data['message'];
    } else {
        $error = $e->getMessage();
    }
}

Get order details

$orderId = 1234;
$order = $api->getOrderById($orderId);
//returns complete Mendrix order object

Get order label

$orderId = 1234;
$response = $api->getLabel($orderId);

header("Content-Disposition: attachment; filename=\"Collo-etiket-$orderId.pdf\"");
header("Content-Type: application/pdf");
header("Content-Length: " . $response->getSize());
echo $response->getContents();
die();
//returns pdf file stream

Get order Track And Trace

$orderId = 1234;
$taskType = 'delivery'; //all, pickup or delivery
$order = $api->getOrderTrackAndTrace($orderId, $taskType);
//returns array of track and trace urls, task types and goods descriptions 
// [['type', 'packing', 'trace_url',],]

Use with file-cache for tokens:

$api->setTokenPath('secure/path/tokens.json');

See https://packagist.org/packages/kamermans/guzzle-oauth2-subscriber for more storage options.

Demo

To use this demo, install with composer:

git clone git@github.com:Bixie/egcs-client.git
cd egcs-client
composer install

Mount this directory to a web-root or run a temporary server via php:

php -S localhost:8000

The demo provides a minimal implementation of the API, without proper security/data validation. Do NOT use this code in production!