Professional Parcel Logistic MyApi client in PHP
- PHP 5.6 or higher
Install salamek/PplMyApi using Composer
$ composer require salamek/ppl-my-apior if you want master branch code:
$ composer require salamek/ppl-my-api:dev-masterYou must request MyAPI credentials from PPL IT, it is not same as klient.ppl.cz credentials!
Check if PPL MyApi is in working shape
<?php
require __DIR__.'/vendor/autoload.php';
use Salamek\PplMyApi\Api;
$pplMyApi = new Api();
if ($pplMyApi->isHealthy())
{
echo 'Healthy :)' . PHP_EOL;
}
else
{
echo 'Ill :(' . PHP_EOL;
}Returns version of PPL MyApi
<?php
require __DIR__.'/vendor/autoload.php';
use Salamek\PplMyApi\Api;
$pplMyApi = new Api();
echo $pplMyApi->getVersion() . PHP_EOL;Returns array of parcel shops filtered by $code and $countryCode
<?php
require __DIR__.'/vendor/autoload.php';
use Salamek\PplMyApi\Api;
use Salamek\PplMyApi\Enum\Country;
$pplMyApi = new Api();
$result = $pplMyApi->getParcelShops($code = null, $countryCode = Country::CZ);
print_r($result);Returns array of sprint routes
<?php
require __DIR__.'/vendor/autoload.php';
use Salamek\PplMyApi\Api;
$pplMyApi = new Api();
$result = $pplMyApi->getSprintRoutes();
print_r($result);Creates package/s on PPL MyApi (sends Package object to PPL)
<?php
require __DIR__.'/vendor/autoload.php';
use Salamek\PplMyApi\Api;
use Salamek\PplMyApi\Tools;
use Salamek\PplMyApi\Model\Package;
use Salamek\PplMyApi\Model\PackageNumberInfo;
use Salamek\PplMyApi\Model\Recipient;
use Salamek\PplMyApi\Enum\Country;
use Salamek\PplMyApi\Enum\Depo;
use Salamek\PplMyApi\Enum\Product;
$username = 'my_api_username';
$password = 'my_api_password';
$customerId = 'my_api_customer_id';
$pplMyApi = new Api($username, $password, $customerId);
$recipient = new Recipient('Olomouc', 'Adam Schubert', 'My Address', '77900', '[email protected]', '+420123456789', 'https://www.salamek.cz', Country::CZ, 'My Compamy a.s.');
$packageNumber = '40950000114';
/* Or you can use Tools::generatePackageNumber to get this number only from $packageSeriesNumberId like 114
$packageSeriesNumberId = 114;
$packageNumberInfo = new PackageNumberInfo($packageSeriesNumberId, Product::PPL_PARCEL_CZ_PRIVATE, Depo::CODE_09);
$packageNumber = Tools::generatePackageNumber($packageNumberInfo); //40950000114
*/
$weight = 3.15;
$package = new Package($packageNumber, Product::PPL_PARCEL_CZ_PRIVATE, $weight, 'Testovaci balik', Depo::CODE_09, $recipient);
try
{
$pplMyApi->createPackages([$package]);
}
catch (\Exception $e)
{
echo $e->getMessage() . PHP_EOL;
}It may happen that PPL support staff requires you to ommit the ISender while you send the package (not pallet) data. In that case you just use null:
While sending pallet data, Sender is required.
Creates order/s on PPL MyApi (send Order object to PPL)
<?php
require __DIR__.'/vendor/autoload.php';
use Salamek\PplMyApi\Api;
use Salamek\PplMyApi\Model\Order;
$username = 'my_api_username';
$password = 'my_api_password';
$customerId = 'my_api_customer_id';
$pplMyApi = new Api($username, $password, $customerId);
$order = new Order($countPack, $orderReferenceId, $packProductType, \DateTimeInterface $sendDate, Sender $sender, Recipient $recipient, $customerReference = null, $email = null, $note = null, \DateTimeInterface $sendTimeFrom = null, \DateTimeInterface $sendTimeTo = null);
try
{
$pplMyApi->createOrders([$order]);
}
catch (\Exception $e)
{
echo $e->getMessage() . PHP_EOL;
}Creates pickup order/s on PPL MyApi (send PickupOrder object to PPL)
<?php
require __DIR__.'/vendor/autoload.php';
use Salamek\PplMyApi\Api;
use Salamek\PplMyApi\Model\PickUpOrder;
$username = 'my_api_username';
$password = 'my_api_password';
$customerId = 'my_api_customer_id';
$pplMyApi = new Api($username, $password, $customerId);
$order = new PickUpOrder($orderReferenceId, $customerReference, $countPackages, $note, $email, \DateTimeInterface $sendDate, $sendTimeFrom, $sendTimeTo, Sender $sender);
try
{
$pplMyApi->createPickupOrders([$order]);
}
catch (\Exception $e)
{
echo $e->getMessage() . PHP_EOL;
}Returns cities routing filtered by $countryCode, $dateFrom, $zipCode
<?php
require __DIR__.'/vendor/autoload.php';
use Salamek\PplMyApi\Api;
use Salamek\PplMyApi\Model\PickUpOrder;
use Salamek\PplMyApi\Enum\Country;
$username = 'my_api_username';
$password = 'my_api_password';
$customerId = 'my_api_customer_id';
$pplMyApi = new Api($username, $password, $customerId);
$result = $pplMyApi->getCitiesRouting($countryCode = Country::CZ, \DateTimeInterface $dateFrom = null, $zipCode = null);
print_r($result);Returns package/s info from ppl filtered by $customRefs, $dateFrom, $dateTo, $packageNumbers useful for tracking and checking status of package/s
<?php
require __DIR__.'/vendor/autoload.php';
use Salamek\PplMyApi\Api;
$username = 'my_api_username';
$password = 'my_api_password';
$customerId = 'my_api_customer_id';
$pplMyApi = new Api($username, $password, $customerId);
$result = $pplMyApi->getPackages($customRefs = null, \DateTimeInterface $dateFrom = null, \DateTimeInterface $dateTo = null, array $packageNumbers = []);
print_r($result);Returns PDF with label/s for print on paper, two decompositions are supported, LabelDecomposition::FULL (one A4 Label per page) or LabelDecomposition::QUARTER (one label per 1/4 of A4 page)
Returns ZPL (Zebra printer format) label/s for print on paper
<?php
require __DIR__.'/vendor/autoload.php';
use Salamek\PplMyApi\Tools;
use Salamek\PplMyApi\Model\PackageNumberInfo;
use Salamek\PplMyApi\Model\Package;
use Salamek\PplMyApi\Model\Recipient;
use Salamek\PplMyApi\Model\Sender;
use Salamek\PplMyApi\Enum\Country;
use Salamek\PplMyApi\Enum\Product;
use Salamek\PplMyApi\Enum\Depo;
use Salamek\PplMyApi\PdfLabel;
use Salamek\PplMyApi\ZplLabel;
$sender = new Sender('Olomouc', 'My Compamy s.r.o.', 'My Address', '77900', '[email protected]', '+420123456789', 'https://www.example.cz', Country::CZ);
$recipient = new Recipient('Olomouc', 'Adam Schubert', 'My Address', '77900', '[email protected]', '+420123456789', 'https://www.salamek.cz', Country::CZ, 'My Compamy a.s.');
$packageNumber = 40950000114;
/* Or you can use Tools::generatePackageNumber to get this number only from $packageSeriesNumberId like 114
$packageSeriesNumberId = 114;
$packageNumberInfo = new PackageNumberInfo($packageSeriesNumberId, Product::PPL_PARCEL_CZ_PRIVATE, Depo::CODE_09);
$packageNumber = Tools::generatePackageNumber($packageNumberInfo); //40950000114
*/
$weight = 3.15;
$package = new Package($packageNumber, Product::PPL_PARCEL_CZ_PRIVATE, $weight, 'Testovaci balik', Depo::CODE_09, $sender, $recipient);
// PDF Label
$rawPdf = PdfLabel::generateLabels([$package]);
file_put_contents($package->getPackageNumber() . '.pdf', $rawPdf);
// ZPL Label
$rawZpl = ZplLabel::generateLabels([$package]);
file_put_contents($package->getPackageNumber() . '.zpl', $rawZpl);40990019352
│├┘│└─────┴──── [0019352] SeriesNumber
││ └─────────── [9] IsCashOnDelivery 9==CoD 5== NonCoD
│└───────────── [09] DepoCode
└────────────── [4] ProductType