Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OP-411 - Added functionalities.md #21

Merged
merged 2 commits into from
Aug 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
104 changes: 104 additions & 0 deletions doc/functionalities.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,104 @@
# Functionalities

---
### Introduction

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

The plugin allows you to make a DHL24 (PL) courier order with one click of the mouse, without having to fill in the data each time.

This plugin supports communication with the DHL 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.

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

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>

Selects the shipping method and completes the form fields accordingly.

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

#### API options

It is possible to select:

<div align="center">
<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

**_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.

<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 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_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 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.
Loading