sylapi/courier-olza

Courier OLZA: GLS, DPD, PPL, Post

v2.0.5 2022-02-07 13:06 UTC

Requires

• php: >=7.4.0
• develart-projects/olza-logisctic-api-client: 1.5.*
• rakit/validation: ^1.4
• sylapi/courier: ^2.0

Requires (Dev)

• phpstan/phpstan: ^0.12.77
• phpunit/phpunit: ^9.5

MIT

• Adrian Zapotoczny

• shipping
• courier
• Olza

README

Methody

Init

    /**
    * @return Sylapi\Courier\Courier
    */
    $courier = CourierFactory::create('Olza',[
        'login' => 'mylogin',
        'password' => 'mypassword',
        'sandbox' => true,
        'requestLanguage' => 'pl',
        'labelType' => 'A4',
        'speditionCode' => 'GLS',
        'shipmentType' => 'WAREHOUSE',
        // 'cod' => [
        //     'codAmount' => 50,
        //     'codReference' => '0123456789' // COD ID numer dla klienta, e.g.: 1122334455 (opcja)
        // ],
        // 'services' => [
            // 'T12' => true,
            // 'XS' => true,
            // 'S12' => true,
            // 'S10' => true,
            // 'SAT' => true,
            // 'PALLET' => true,
            // 'CSP' => true,
            // 'SM2' => '[phone]',
            // 'INS' => 5000
        // ]
    ]);

CreateShipment

    $sender = $courier->makeSender();
    $sender->setFullName('Nazwa Firmy/Nadawca')
        ->setStreet('Ulica')
        ->setHouseNumber('2a')
        ->setApartmentNumber('1')
        ->setCity('Miasto')
        ->setZipCode('66100')
        ->setCountry('Poland')
        ->setCountryCode('pl')
        ->setContactPerson('Jan Kowalski')
        ->setEmail('[e-mail]')
        ->setPhone('48500600700');


    $receiver = $courier->makeReceiver();

    $receiver->setFirstName('Jan')
        ->setSurname('Nowak')
        ->setStreet('Vysoká')
        ->setHouseNumber('15')
        ->setApartmentNumber('1896')
        ->setCity('Ostrava')
        ->setZipCode('70200')
        ->setCountry('Czechy')
        ->setCountryCode('cz')
        ->setContactPerson('Jan Kowalski')
        ->setEmail('[e-mail]')
        ->setPhone('48500600700');

    $parcel = $courier->makeParcel();
    $parcel->setWeight(1.5);

    $shipment = $courier->makeShipment();
    $shipment->setSender($sender)
            ->setReceiver($receiver)
            ->setParcel($parcel)
            ->setContent('Zawartość przesyłki');

    try {
        $response = $courier->createShipment($shipment);
        if($response->hasErrors()) {
            var_dump($response->getFirstError()->getMessage());
        } else {
            var_dump($response->referenceId); // Utworzony wewnetrzny idetyfikator zamowienia
            var_dump($response->shipmentId); // Zewnetrzny idetyfikator zamowienia
        }

    } catch (\Exception $e) {
        var_dump($e->getMessage());
    }

PostShipment

    /**
     * Init Courier
     */
    $booking = $courier->makeBooking();
    $booking->setShipmentId('123456');
    try {
        $response = $courier->postShipment($booking);
        if($response->hasErrors()) {
            var_dump($response->getFirstError()->getMessage());
        } else {
            var_dump($response->shipmentId); // Zewnetrzny idetyfikator zamowienia
            var_dump($response->trackingId); // Zewnetrzny idetyfikator sledzenia przesylki
            var_dump($response->trackingBarcode); // Zewnetrzny idetyfikator sledzenia przesylki
            var_dump($response->trackingUrl); // Zewnetrzny URL sledzenia przesylki
        }
    } catch (\Exception $e) {
        var_dump($e->getMessage());
    }

GetStatus

    /**
     * Init Courier
     */
    try {
        $response = $courier->getStatus('123456');
        if($response->hasErrors()) {
            var_dump($response->getFirstError()->getMessage());
        } else {
            var_dump((string) $response);
        }
    } catch (\Exception $e) {
        var_dump($e->getMessage());
    }

GetLabel

    try {
        /**
         * Shipment musi zostac potwierdzony (postShipment) 
         * w przeciwnym wypadku otrzymamy błąd
         * o "Brak odpowiedniej przesyłki"
        */
        $response = $courier->getLabel('123456');
        if($response->hasErrors()) {
            var_dump($response->getFirstError()->getMessage());
        } else {
            var_dump((string) $response);
        }
    } catch (\Exception $e) {
        var_dump($e->getMessage());
    }

Zásilkovna (miejsce odbioru)

Init

    /**
    * @return Sylapi\Courier\Courier
    */
    $courier = CourierFactory::create('Olza',[
        'login' => 'mylogin',
        'password' => 'mypassword',
        'sandbox' => true,
        'requestLanguage' => 'pl',
        'labelType' => 'A4',
        'speditionCode' => 'ZAS',
        'shipmentType' => 'WAREHOUSE',
        'pickupPlaceId' => '1231' //ID Punktu odbioru
    ]);

Dostępne są dwa sposoby, jak można wdrożyć punkty odbioru z grupy Packeta w sklepie internetowym:

1. Gotowy widget https://widget.packeta.com/v5/#/

Packeta udostępnia w tym celu konfigurator, który można wykorzystać do wdrożenia punktów odbioru.

• Konfigurator https://widget.packeta.com/www/configurator/

• Konfigurator z użyciem własnych stylów CSS https://widget.packeta.com/www/style-configurator/

Dzięki niemu można zdefiniować właściwości widgetu, który pojawi się na stronie i zdobyć kod do podpięcia w koszyku zakupowym.

Manual dotyczący implementacji widgetu znajdziemy pod linkiem: https://docs.packetery.com/01-pickup-point-selection/02-widget-v6.html

1. Lista punktów z pliku online

Można skonfigurować pola wyboru punktów odbioru we własnym zakresie, można posłużyć się plikiem online, który zawiera listę wszystkich punktów odbioru niezależnie od kraju docelowego. Dostępne formaty plików oraz adresy URL są opisane w dokumentacji Packeta pod tym linkiem https://docs.packetery.com/01-pickup-point-selection/04-branch-export-v4.html

Informacje dotyczące zarządzanie punktami odbioru: https://docs.packetery.com/05-eshop-providers/01-eshop-provider.html#toc-pick-up-point-management

ENUMS

ShipmentType

WARTOŚĆ	OPIS
DIRECT	Bezpośrednia przesyłka
WAREHOUSE	Z magazynu OlzaLogistic

SpeditionCode

WARTOŚĆ	OPIS
GLS	GLS
CP	Poczta Czeska - list polecony
CP-RR	Poczta Czeska - list polecony
CP-NP	Poczta Czeska - paczka na pocztę
SP	Poczta Słowacka - kurier ekspresowy
DPD	DPD
PPL	PPL - paleta
ZAS	Zásilkovna - miejsce odbioru
ZAS-P	Zásilkovna - przesyłka pocztowa na adres
ZAS-K	Zásilkovna - przesyłka kurierska na adres
ZAS-D	Zásilkovna - na adres DPD
ZAS-C	Zásilkovna - Cargus
ZAS-B	Zásilkovna - best delivery
ZAS-COL	Coletaria - pick-up point
GEIS-P	Geis - przesyłka na palecie
BMCG-IPK	InPost Kuriér
BMCG-IPKP	InPost - Paczkomaty
BMCG-DHL	DHL
BMCG-PPK	Pocztex Kurier 48
BMCG-PPE	Pocztex Ekspres 24
BMCG-UC	Cargus
BMCG-HUP	Maďarská Pošta - business parcel
BMCG-FAN	FAN Courier - home delivery
BMCG-INT	WE
BMCG-INT-PP	WE
ZAS-ECONT-HD	Econt - home delivery
ZAS-ECONT-PP	Econt - pick-up point
ZAS-ACS-HD	ACS - home delivery
ZAS-ACS-PP	ACS - pick-up point
ZAS-SPEEDY-PP	Speedy - pick-up point
ZAS-SPEEDY-HD	Speedy - home delivery

Komendy

KOMENDA	OPIS
composer tests	Testy
composer phpstan	PHPStan
composer coverage	PHPUnit Coverage
composer coverage-html	PHPUnit Coverage HTML (DIR: ./coverage/)