salamek/ppl-my-api

Professional Parcel Logistic MyApi client in PHP

2.7.4 2024-06-29 20:53 UTC

Requires

• php: >=7.3.0
• tecnickcom/tcpdf: ^6.2

Requires (Dev)

• phpunit/phpunit: ^9.5

LGPL-3.0-only

• Adam Schubert

• api
• PPL
• Professional Parcel Logistic

README

Warning

This project is deprecated and no new features will be implemented due to PPL pushing out new (and better designed) REST based API (MyApi2) so if you are implementing new PPL integration please use MyApi2 for example ~implemented by https://github.com/szymsza/php-ppl-create-package-label-api (this project is not drop-in replacement for PplMyApi and is missing some features but it is good building block to start)

Professional Parcel Logistic MyApi client in PHP with PDF and ZPL label generator

Please consider sponsoring if you're using this package commercially, my time is not free :) You can sponsor me by clicking on "Sponsor" button in top button row. Thank You./Prosím pouvažujte nad sponzorováním tohoto projektu pokud používáte tento projekt komerčně, můj čas není zadarmo :) Sponzorovat můžete kliknutím na tlačítko "Sponsor" v horní řadě tlačítkek. Děkuji.

Professional Parcel Logistic MyApi client in PHP with PDF and ZPL label generator

Requirements

• PHP 7.3 or higher

Installation

Install salamek/PplMyApi using Composer

$ composer require salamek/ppl-my-api

or if you want master branch code:

$ composer require salamek/ppl-my-api:dev-master

Credentials

You must request MyAPI credentials from PPL IT, it is not same as klient.ppl.cz credentials!

Usage

Consult official PPL documentation for methods description

~Runnable examples of code are in examples folder of this project.

• apiCheck.php Simple example to test connection to PPL MyApi
• getApiVersion.php Simple example to show how to get MyApi version
• createPackages.php Example how to create basic packages
• createPackagesWithCod.php Example how to create packages with COD (Cash On Delivery)
• createPackagesWithService.php Example how to create packages with additional services
• createPickupOrders.php Example how to create Pickup Orders
• createOrders.php Example how to create Orders
• getCitiesRouting.php Example how to get cities routing
• getLabel.php Example to show how to generate PDF and ZPL labels for print
• getPackages.php Example to show how to get list of created packages
• getParcelShops.php Example to show how to get list of parcel shops
• getSprintRoutes.php Example to show how to get list of sprint routes

PPL Package number format

40990019352
│├┘│└─────┴──── [0019352] SeriesNumber
││ └─────────── [9] IsCashOnDelivery 9==CoD & 5== NonCoD (for some product it is 8==CoD & 0=NonCoD)
│└───────────── [09] DepoCode
└────────────── [4] ProductType