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 9, 2024
1 parent 404a443 commit 60901b1
Show file tree
Hide file tree
Showing 10 changed files with 54 additions and 27 deletions.
81 changes: 54 additions & 27 deletions doc/functionalities.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,8 @@

---
### Introduction

---
DHL International GmbH - a German parcel and logistics company operating in the international courier segment.
It has a worldwide reach.

Expand All @@ -11,56 +13,81 @@ This plugin supports communication with the DHL API, including exporting shippin
and creating ready-made labels to print directly from the order.

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

---
#### Adding Shipping Gate

After installation, users can add the shipping method corresponding to the service provider
to which they want to export shipments.

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

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

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.
<div align="center">
<img src="./images/shipping_gateway.png"/>
</div>
<br>

<p align="center">
<b>It is possible to select:</b>
</p>
Selects the shipping method and completes the form fields accordingly.

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

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

<p align="center">
return label
</p>
<div align="center">
<img src="./images/return_label.jpg"/>
</div>
It is possible to select:

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

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

Choosing a return label:
- Waybill
- BLP label in PDF format
- BLP label in A4 PDF format
- BLP label in Zebra printers format

Form of download return in COD service:
- Cash payment
- Bank transfer

<br>


#### 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.

<div align="center">
<img src="./images/shipping_export.png"/>
</div>
Binary file removed doc/images/return_label.jpg
Binary file not shown.
Binary file modified 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 modified 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_gateway_details.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_details2.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 modified 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 removed doc/images/type_of_package.jpg
Binary file not shown.
Binary file removed doc/images/type_of_request.jpg
Binary file not shown.
Binary file removed doc/images/type_of_transport_service.jpg
Binary file not shown.

0 comments on commit 60901b1

Please sign in to comment.