Skip to content

Commit

Permalink
OP-411 - Added functionalities.md
Browse files Browse the repository at this point in the history
  • Loading branch information
tomkalon committed Aug 8, 2024
1 parent 71a487b commit 19be403
Show file tree
Hide file tree
Showing 9 changed files with 61 additions and 0 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,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)
* [About us](#about-us)
* [Community](#community)
Expand Down
60 changes: 60 additions & 0 deletions doc/functionalities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# Functionalities

---

This plugin supports communication with the DHL API, including exporting shipping data
and creating ready-made labels to print directly from the order.

After installation, the user can add a shipping method corresponding to the service provider he wants to ship to.

<div align="center">
<img src="./images/shipping_method.png"/>
</div>

Then he create a new "shipping gateway" for the added shipping method.

<div align="center">
<img src="./images/shipping_gateway.png"/>
</div>

<p align="center">
<b>It is possible to select:</b>
</p>

<p align="center">
type of request
</p>
<div align="center">
<img src="./images/type_of_request.jpg"/>
</div>

<p align="center">
type of transport service
</p>
<div align="center">
<img src="./images/type_of_transport_service.jpg"/>
</div>

<p align="center">
return label
</p>
<div align="center">
<img src="./images/return_label.jpg"/>
</div>

<p align="center">
type of package
</p>
<div align="center">
<img src="./images/type_of_package.jpg"/>
</div>

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.

<div align="center">
<img src="./images/shipping_export.png"/>
</div>
Binary file added doc/images/return_label.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/shipping_export.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/shipping_gateway.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/shipping_method.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/type_of_package.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/type_of_request.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/images/type_of_transport_service.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 19be403

Please sign in to comment.