feat(examples): Added examples on how to create Package with COD and …

…with services
AndriyFil · Mar 3, 2022 · 49878d1 · 49878d1
1 parent 278a016
commit 49878d1
Show file tree

Hide file tree

Showing 3 changed files with 180 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -38,6 +38,8 @@ Consult official PPL documentation for methods description
 * [apiCheck.php](examples/apiCheck.php) Simple example to test connection to PPL MyApi
 * [getApiVersion.php](examples/getApiVersion.php) Simple example to show how to get MyApi version
 * [createPackages.php](examples/createPackages.php) Example how to create basic packages
+* [createPackagesWithCod.php](examples/createPackagesWithCod.php) Example how to create packages with COD (Cash On Delivery)
+* [createPackagesWithService.php](examples/createPackagesWithService.php) Example how to create packages with additional services
 * [createPickupOrders.php](examples/createPickupOrders.php) Example how to create Pickup Orders
 * [createOrders.php](examples/createOrders.php) Example how to create Orders
 * [getCitiesRouting.php](examples/getCitiesRouting.php) Example how to get cities routing

diff --git a/examples/createPackagesWithCod.php b/examples/createPackagesWithCod.php
@@ -0,0 +1,79 @@
+<?php declare(strict_types = 1);
+
+require __DIR__.'/vendor/autoload.php';
+
+use Salamek\PplMyApi\Api;
+use Salamek\PplMyApi\Model\Package;
+use Salamek\PplMyApi\Model\Recipient;
+use Salamek\PplMyApi\Enum\Country;
+use Salamek\PplMyApi\Enum\Depo;
+use Salamek\PplMyApi\Enum\Currency;
+use Salamek\PplMyApi\Model\CityRouting;
+use Salamek\PplMyApi\Model\PaymentInfo;
+use Salamek\PplMyApi\Enum\Product;
+
+/**
+ * Creates package/s on PPL MyApi (sends Package object to PPL) with COD (Cash On Delivery) info provided using PaymentInfo class
+ */
+
+/**
+ * 
+It may happen that PPL support staff requires you to omit the ISender while you send the package (not pallet) data. In that case you just use null:
+
+While sending pallet data, Sender is required.
+ */
+
+$username = 'my_api_username';
+$password = 'my_api_password';
+$customerId = 'my_api_customer_id';
+
+$pplMyApi = new Api($username, $password, $customerId);
+
+$country = Country::CZ;
+$city = 'Olomouc';
+$street = 'My Address';
+$zipCode = '77900';
+
+$recipient = new Recipient($city, 'Adam Schubert', $street, $zipCode, '[email protected]', '+420123456789', 'https://www.salamek.cz', $country, '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
+*/
+
+$cityRoutingResponse = $pplMyApi->getCitiesRouting($country, null, $zipCode, $street);
+
+//Get first routing from the response and test (response can contain more records, not 100% sure how this works...)
+if (is_array($cityRoutingResponse)) {
+  $cityRoutingResponse = $cityRoutingResponse[0];
+}
+if (!isset($cityRoutingResponse->RouteCode) || !isset($cityRoutingResponse->DepoCode) || !isset($cityRoutingResponse->Highlighted)) {
+  throw new Exception('Štítek PPL se nepodařilo vytisknout, chybí Routing, pravděpodobně neplatná adresa!');
+}
+
+$cityRouting = new CityRouting(
+    $cityRoutingResponse->RouteCode, 
+    $cityRoutingResponse->DepoCode, 
+    $cityRoutingResponse->Highlighted
+);
+
+
+
+$cashOnDeliveryPrice = 100; // COD price
+$cashOnDeliveryCurrency = Currency::CZK;
+$cashOnDeliveryVariableSymbol = 1234567;
+$paymentInfo = new PaymentInfo($cashOnDeliveryPrice, $cashOnDeliveryCurrency, $cashOnDeliveryVariableSymbol);
+
+
+$package = new Package($packageNumber, Product::PPL_PARCEL_CZ_PRIVATE, 'Testovaci balik s dobirkou', $recipient, $cityRouting, null, Depo::CODE_09, null, $paymentInfo);
+
+try
+{
+    $pplMyApi->createPackages([$package]);
+}
+catch (\Exception $e)
+{
+    echo $e->getMessage() . PHP_EOL;
+}
diff --git a/examples/createPackagesWithService.php b/examples/createPackagesWithService.php
@@ -0,0 +1,99 @@
+<?php declare(strict_types = 1);
+
+require __DIR__.'/vendor/autoload.php';
+
+use Salamek\PplMyApi\Api;
+use Salamek\PplMyApi\Model\Package;
+use Salamek\PplMyApi\Model\Recipient;
+use Salamek\PplMyApi\Enum\Country;
+use Salamek\PplMyApi\Enum\Depo;
+use Salamek\PplMyApi\Model\CityRouting;
+use Salamek\PplMyApi\Enum\Product;
+use Salamek\PplMyApi\Model\PackageService;
+use Salamek\PplMyApi\Enum\PackageService as PackageServiceEnum;
+
+/**
+ * Creates package/s on PPL MyApi (sends Package object to PPL) with Service provided
+ */
+
+/**
+ * 
+It may happen that PPL support staff requires you to omit the ISender while you send the package (not pallet) data. In that case you just use null:
+
+While sending pallet data, Sender is required.
+ */
+
+$username = 'my_api_username';
+$password = 'my_api_password';
+$customerId = 'my_api_customer_id';
+
+$pplMyApi = new Api($username, $password, $customerId);
+
+$country = Country::CZ;
+$city = 'Olomouc';
+$street = 'My Address';
+$zipCode = '77900';
+
+$recipient = new Recipient($city, 'Adam Schubert', $street, $zipCode, '[email protected]', '+420123456789', 'https://www.salamek.cz', $country, 'My Compamy a.s.');
+
+$packageNumber = '40950000114';
+
+$cityRoutingResponse = $pplMyApi->getCitiesRouting($country, null, $zipCode, $street);
+
+//Get first routing from the response and test (response can contain more records, not 100% sure how this works...)
+if (is_array($cityRoutingResponse)) {
+  $cityRoutingResponse = $cityRoutingResponse[0];
+}
+if (!isset($cityRoutingResponse->RouteCode) || !isset($cityRoutingResponse->DepoCode) || !isset($cityRoutingResponse->Highlighted)) {
+  throw new Exception('Štítek PPL se nepodařilo vytisknout, chybí Routing, pravděpodobně neplatná adresa!');
+}
+
+$cityRouting = new CityRouting(
+    $cityRoutingResponse->RouteCode, 
+    $cityRoutingResponse->DepoCode, 
+    $cityRoutingResponse->Highlighted
+);
+
+
+
+$package = new Package(
+        $packageNumber, 
+        Product::PPL_PARCEL_CZ_PRIVATE, 
+        'Testovaci balik se sluzbou', 
+        $recipient, 
+        $cityRouting, 
+        null, 
+        Depo::CODE_09, 
+        null, 
+        null,
+        [],
+        [
+            new PackageService(PackageServiceEnum::ANOTHER_DELIVERY_ATTEMPT), // Service attempt another delivery when first fails
+            new PackageService(PackageServiceEnum::AGE_CHECK_18_UP) // Service check that $recipient is 18+ on delivery
+        ]
+    );
+
+// Or you can use setter if you dont want to put all those nulls and [] stuff in constructor like this
+/*
+$package = new Package(
+        $packageNumber, 
+        Product::PPL_PARCEL_CZ_PRIVATE, 
+        'Testovaci balik se sluzbou', 
+        $recipient, 
+        $cityRouting, 
+    );
+
+$package->setPackageServices([
+    new PackageService(PackageServiceEnum::ANOTHER_DELIVERY_ATTEMPT), // Service attempt another delivery when first fails
+    new PackageService(PackageServiceEnum::AGE_CHECK_18_UP) // Service check that $recipient is 18+ on delivery
+]);
+*/
+
+try
+{
+    $pplMyApi->createPackages([$package]);
+}
+catch (\Exception $e)
+{
+    echo $e->getMessage() . PHP_EOL;
+}