patryk-sawicki/orlenpaczka-laravel

Orlen Paczka API client for laravel.

0.2.3 2024-03-28 15:30 UTC

Requires

• php: ^8.2
• ext-json: *
• ext-simplexml: *
• laravel/framework: ^10.00

Requires (Dev)

• laravel/laravel: ^10.00 || ^11.00
• phpunit/phpunit: ^9.5

MIT

• Patryk Sawicki

README

Orlen Paczka API client for laravel.

Requirements

• PHP 8.2 or higher with json extensions.

Installation

The recommended way to install is through Composer.

composer require patryk-sawicki/orlenpaczka-laravel

Frontend Usage

Map button

Add map button to your blade file.

<x-op::map-button/>

Important:

1. You must add @stack('after-css') before </head> tag.
2. You must add @stack('after-scripts') before </body> tag.
3. Selected point will be saved in #orlenPointId input.

Backend Usage

Add to env:

OP_API_ID = 'your_partner_id'
OP_API_KEY = 'your_partner_key'
OP_SANDBOX = false // optional - default false
OP_CACHE_DEFAULT_TTL = 86400 // optional - default 86400 seconds

Import class:

use PatrykSawicki\OrlenPaczkaApi\app\Classes\OrlenPaczka;

List of all points.

Get a list of all points.

OrlenPaczka::giveMeAllRUCHWithFilled()->list(); // return array

Result:

[
    [
        'DestinationCode' => 'WS-100001-27-26',
        'StreetName' => 'ANNOPOL 17 TEST',
        'City' => 'Warszawa',
        'District' => 'Warszawa',
        'Latitude' => '52.311519',
        'Longitude' => '21.013830',
        'Province' => 'Mazowieckie',
        'CashOnDelivery' => 'true',
        'OpeningHours' => 'Pn-Pt:00:00-24:00, So:00:00-24:00, Nd:00:00-24:00',
        'Location' => 'Punkt testowy',
        'PSD' => '100001',
        'PointType' => 'PSD',
        'Filled' => 'false',
        'Suggestions' => [],
        'Available' => 'true',
        'ZipCode' => '03-236',
    ],
    ...
]

Generate label business pack

Generate label for business pack.

OrlenPaczka::generateLabelBusinessPack()->pdf(array $data); // return ?

Request:

[
    [
        'DestinationCode' => 'WS-100001-27-26',
        'BoxSize' => 'S', // S, M, L
        'FirstName' => 'Jan',
        'LastName' => 'Kowalski',
        'PhoneNumber' => '123456789',
        'EMail' => '[e-mail]',
        'SenderEMail' => '[e-mail]',
        'SenderFirstName' => 'Jan',
        'SenderLastName' => 'Kowalski',
        'SenderStreetName' => 'Testowa 1',
        'SenderBuildingNumber' => '1',
        'SenderCity' => 'Warszawa',
        'SenderPostCode' => '00-001',
        'SenderPhoneNumber' => '123456789',
        'PrintAdress' => '1', // 1, 2
        'PrintType' => '1', // 1, 2
    ],
    ...
]

Result:

// return pdf

Labels panel

Add a panel for generating labels.

<x-op::labels-panel 
    :destination-code=""
    :firstName=""
    :lastName=""
    :phoneNumber=""
    :email=""
    :senderEMail=""
    :senderFirstName=""
    :senderLastName=""
    :senderStreetName=""
    :senderBuildingNumber=""
    :senderCity=""
    :senderPostCode=""
    :senderPhoneNumber=""
    :disc=""
    :dir=""
    :file=""
/>

Changelog

Changelog is available here.