diff --git a/README.md b/README.md index bf2b681..c21d510 100644 --- a/README.md +++ b/README.md @@ -22,6 +22,7 @@ Like what we do? Want to join us? Check out our job listings on our [career page *** * [Overview](#overview) +* [Functionalities](doc/functionalities.md) * [Support](#we-are-here-to-help) * [Installation](#installation) * [Testing](#testing) diff --git a/doc/functionalities.md b/doc/functionalities.md new file mode 100644 index 0000000..b73991d --- /dev/null +++ b/doc/functionalities.md @@ -0,0 +1,94 @@ +# Functionalities + +--- +### Introduction + +--- +Poczta Polska is Poland's national postal operator, +which offers letter, parcel, and special delivery services both domestically and internationally. + +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. + +This plugin supports communication with the PocztaPolska API (Elektroniczny Nadawca wersja), including exporting shipping data +and creating ready-made labels to print directly from the order. + +### Usage + +--- +#### Adding Shipping Gate + +After installation, users can add the shipping method corresponding to the service provider +to which they want to export shipments. + +
+ +
+
+ +It then creates a new "shipping gateway" for the added shipping method. +When a customer selects this shipping method when ordering products, the order will be captured by the gateway. +
+ +
+
+ +Selects the shipping method and completes the form fields accordingly. + +
+ +
+
+ +#### API options + +It is possible to select: + +
+ +
+
+ +Determine the payment page: +- Sender +- Recipient +- Third party + +Payment method: +- Bank transfer +- Cash payment + +Type of request: +- Create the shipment and order the courier +- Order courier +- Creating a shipment without restriction + +Type of transport service: +- Domestic shipment +- Service Domestic 09 +- Service Domestic 12 +- Shipment Connect +- Shipment International + +**_Shipment start hour_**: +Specifies the time from which the shipment is ready for collection by the courier + +**_Shipment end hour_**: +Specifies the end time by which the courier can arrive to pick up the shipment. +After this hour, the shipment may no longer be available for pickup. + +**_Pickup breaking hour_**: +Specifies the cut-off time by which the courier can come to pick up the shipment. +This is the hour after which the collection of the shipment will be postponed to the next business day. + +
+ + +#### Shipping Exports +Once the shipping method and shipping gateway for the shipping provider are created, +customer can use this shipping method during a checkout. When the order is placed, +user can now go to the 'Export shipping data' section from Sylius Admin Panel and export chosen shipments. + +After exporting the shipment, it is possible to download the label for printing. +
+ +
diff --git a/doc/images/shipping_export.png b/doc/images/shipping_export.png new file mode 100644 index 0000000..ad21ca0 Binary files /dev/null and b/doc/images/shipping_export.png differ diff --git a/doc/images/shipping_gateway.png b/doc/images/shipping_gateway.png new file mode 100644 index 0000000..20cb0f8 Binary files /dev/null and b/doc/images/shipping_gateway.png differ diff --git a/doc/images/shipping_gateway_details.png b/doc/images/shipping_gateway_details.png new file mode 100644 index 0000000..f85d56c Binary files /dev/null and b/doc/images/shipping_gateway_details.png differ diff --git a/doc/images/shipping_gateway_details2.png b/doc/images/shipping_gateway_details2.png new file mode 100644 index 0000000..69f6b3a Binary files /dev/null and b/doc/images/shipping_gateway_details2.png differ diff --git a/doc/images/shipping_method.png b/doc/images/shipping_method.png new file mode 100644 index 0000000..234e2da Binary files /dev/null and b/doc/images/shipping_method.png differ