Skip to content

Commit a98097a

Browse files
authored
Merge pull request #7 from tomkalon/OP-412
OP-412 - Added functionalities.md
2 parents a21b7aa + 2434c7f commit a98097a

7 files changed

+95
-0
lines changed

README.md

+1
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ Like what we do? Want to join us? Check out our job listings on our [career page
2222
***
2323

2424
* [Overview](#overview)
25+
* [Functionalities](doc/functionalities.md)
2526
* [Support](#we-are-here-to-help)
2627
* [Installation](#installation)
2728
* [Testing](#testing)

doc/functionalities.md

+94
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
# Functionalities
2+
3+
---
4+
### Introduction
5+
6+
---
7+
Poczta Polska is Poland's national postal operator,
8+
which offers letter, parcel, and special delivery services both domestically and internationally.
9+
10+
The plug-in allows you to order postal services from the Poczta Polska Service with a click of the mouse, without having to fill in the data each time.
11+
12+
This plugin supports communication with the PocztaPolska API (Elektroniczny Nadawca wersja), including exporting shipping data
13+
and creating ready-made labels to print directly from the order.
14+
15+
### Usage
16+
17+
---
18+
#### Adding Shipping Gate
19+
20+
After installation, users can add the shipping method corresponding to the service provider
21+
to which they want to export shipments.
22+
23+
<div align="center">
24+
<img src="./images/shipping_method.png"/>
25+
</div>
26+
<br>
27+
28+
It then creates a new "shipping gateway" for the added shipping method.
29+
When a customer selects this shipping method when ordering products, the order will be captured by the gateway.
30+
<div align="center">
31+
<img src="./images/shipping_gateway.png"/>
32+
</div>
33+
<br>
34+
35+
Selects the shipping method and completes the form fields accordingly.
36+
37+
<div align="center">
38+
<img src="./images/shipping_gateway_details.png"/>
39+
</div>
40+
<br>
41+
42+
#### API options
43+
44+
It is possible to select:
45+
46+
<div align="center">
47+
<img src="./images/shipping_gateway_details2.png"/>
48+
</div>
49+
<br>
50+
51+
Determine the payment page:
52+
- Sender
53+
- Recipient
54+
- Third party
55+
56+
Payment method:
57+
- Bank transfer
58+
- Cash payment
59+
60+
Type of request:
61+
- Create the shipment and order the courier
62+
- Order courier
63+
- Creating a shipment without restriction
64+
65+
Type of transport service:
66+
- Domestic shipment
67+
- Service Domestic 09
68+
- Service Domestic 12
69+
- Shipment Connect
70+
- Shipment International
71+
72+
**_Shipment start hour_**:
73+
Specifies the time from which the shipment is ready for collection by the courier
74+
75+
**_Shipment end hour_**:
76+
Specifies the end time by which the courier can arrive to pick up the shipment.
77+
After this hour, the shipment may no longer be available for pickup.
78+
79+
**_Pickup breaking hour_**:
80+
Specifies the cut-off time by which the courier can come to pick up the shipment.
81+
This is the hour after which the collection of the shipment will be postponed to the next business day.
82+
83+
<br>
84+
85+
86+
#### Shipping Exports
87+
Once the shipping method and shipping gateway for the shipping provider are created,
88+
customer can use this shipping method during a checkout. When the order is placed,
89+
user can now go to the 'Export shipping data' section from Sylius Admin Panel and export chosen shipments.
90+
91+
After exporting the shipment, it is possible to download the label for printing.
92+
<div align="center">
93+
<img src="./images/shipping_export.png"/>
94+
</div>

doc/images/shipping_export.png

179 KB
Loading

doc/images/shipping_gateway.png

115 KB
Loading
137 KB
Loading
228 KB
Loading

doc/images/shipping_method.png

271 KB
Loading

0 commit comments

Comments
 (0)