diff --git a/README.md b/README.md index 4902388..a9d38f9 100644 --- a/README.md +++ b/README.md @@ -13,8 +13,10 @@ 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) +* [Usage](#usage) * [About us](#about-us) * [Community](#community) * [Demo](#demo) @@ -81,7 +83,9 @@ Update your database schema ```bash bin/console doctrine:schema:update --force --complete ``` - +# Usage +### Important! +If non-existent postal codes are provided - both in the "shipping gateway" and during the order, export of the shipment will not be possible. For the plugin to work properly, it is also necessary to add the weight of the products. # About us --- diff --git a/doc/functionalities.md b/doc/functionalities.md new file mode 100644 index 0000000..d8c7036 --- /dev/null +++ b/doc/functionalities.md @@ -0,0 +1,60 @@ +# Functionalities + +--- +### Introduction + +--- +DPD Poland is part of Geopost, the second-largest international courier network, +which delivers parcels around the world every day in a sustainable manner. + +The plugin allows you to make a DPD (PL) courier order with one click of the mouse, without having to fill in the data each time. +This plugin supports communication with the DPD_PL API, 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. + +
+ +
+
+ +It is possible to add return shipment handling and select a guaranteed delivery time: +- Standard +- Delivery before 9:30 +- Delivery before 12:00 +- Delivery on Saturday + +
+ +
+
+ +#### 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/return_delivery_guarantee.png b/doc/images/return_delivery_guarantee.png new file mode 100644 index 0000000..d99d161 Binary files /dev/null and b/doc/images/return_delivery_guarantee.png differ diff --git a/doc/images/shipping_export.png b/doc/images/shipping_export.png new file mode 100644 index 0000000..5f4a093 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..fe8b405 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..1b972b6 Binary files /dev/null and b/doc/images/shipping_gateway_details.png differ diff --git a/doc/images/shipping_method.png b/doc/images/shipping_method.png new file mode 100644 index 0000000..b64a79c Binary files /dev/null and b/doc/images/shipping_method.png differ