[ENG] Magento 2.0

Open

Below you will find the plugin and documentation on our proprietary InPost plugin for Magento 2.

The documentation describes the installation of the module, configuration and discusses the various functionalities of the module such as creating shipments and generating labels.

Changelog:

On this page:

Installation

The module should be installed first on a development or test installation and only after testing on a production store. The installation and enabling of the module should be done by a developer experienced with Magento 2 system

1. The module files should be copied to the /app/code/Smartmage/Inpost directory

2. Then run the following commands in the console, in the main Magento directory:

• php bin/magento module:enable Smartmage_Inpost

• php bin/magento setup:upgrade

• php bin/magento setup:di:compile

• php bin/magento setup:static-content:deploy pl_PL

• php bin/magento cache:flush

Configuration

1. The configuration of the module is divided into two areas visible in the Magento admin panel:

• Stores → Configuration → Sales → Delivery settings → InPost section - here you can configure all general settings of the module and default values

• Stores → Configuration → Sales → Delivery methods → InPost - Parcel Post section and InPost - Courier Delivery section - here you can configure all available delivery methods

2. After installing the module, the configuration should start from:

→ Stores → Configuration → Sales → Delivery settings → InPost section

Here you need to fill in the fields "Organization ID" and "Access Token" and save the configuration. Only after completing and saving the data to the API can you configure the other fields from this section

Configure delivery methods

In the next step, configure and enable the selected delivery methods in:

→ Stores → Configuration → Sales → Delivery methods → InPost - Parcel Machines section and InPost - Courier Delivery section

InPost Parcel Machine method configuration section

In the Magento admin panel, in:

Stores → Configuration → Sales → Delivery Methods → InPost - Parcel Machines section → you will find the following configuration fields regarding Parcel Machines delivery methods

Enabled - this field allows you to enable Parcel Machines delivery methods. Each of the Parcel Machines delivery methods also has its own field to be enabled, and in order to be visible in the order process they must both be set to Yes

Only show delivery on the weekend when active - if set to Yes then while the weekend Parcel Machine delivery is active the regular Parcel Machine delivery method is not visible in the order process. If set to No then while the Parcel Machine delivery method is active it is visible in the order process along with the regular Parcel Machine delivery method.

Title - the title of the delivery method

Open

Below are the groups for each of the Parcel Machine delivery methods:

InPost Paczkomat® 24/7

In this section you will find the configuration fields for the Parcel Machine delivery method (the service in the API is inpost_locker_standard):

InPost Paczkomat® 24/7 - cash on delivery

This section contains the same fields as the one described above.

They concern the delivery method to the Parcel Machine on delivery (the service in the API is inpost_locker_standard).

If you have selected this delivery method in the order process, the amount of COD will be automatically set equal to the order total when creating the shipment

InPost Paczkomat® 24/7 - weekend delivery + payment on delivery

This section contains the same fields as in the InPost Paczkomat® 24/7 section, plus some additional ones described below. Here you can enable the delivery method for Parcel Machines with weekend delivery

This method can be visible in the order process only during the set time interval because parcels will be delivered to customers on the weekend

When configuring the time frame for the activity of this delivery method, so remember that it is the moment of sending and not the moment of placing the order by the customer that is important

The fields that allow you to configure the time interval are as follows:

Weekday of the week for weekend delivery - allows you to select on which day of the week the weekend delivery method will start to be active

Weekend delivery start time - allows you to select at what time on the day set in the earlier field the weekend delivery method will start to be active

Weekday of the weekend delivery end - allows you to select on which day of the week the weekend delivery method will cease to be active

Weekend delivery end time - allows you to select at what time on the day set in the earlier field the weekend delivery method will cease to be active

InPost Paczkomat® 24/7 - Paczka Ekonomiczna + cash on delivery

This section contains the same fields as the one described above. They concern the delivery method to the Parcel Machine in the option "Economy Parcel".

When enabling this delivery method in the ordering process, make sure that after selecting it, the corresponding payment method will be available which is not part of this module

InPost Courier method configuration section

In the Magento admin panel, in:

Stores → Configuration → Sales → Delivery Methods → InPost - Courier Delivery section, you will find the following configuration fields regarding courier delivery methods.

Enabled - the field allows you to enable courier delivery methods. In addition, each delivery method has its own field to be enabled, and in order for it to be visible in the order process they must both be set to Yes

Title - the title of the delivery method

Below are the groups for each courier delivery method separately. You can enable and configure the selected ones

InPost przesyłka kurierska standardowa

InPost przesyłka kurierska standardowa - cash on delivery

In this section you will find the same fields as in the one described above

If you have selected this delivery method in the order process, then when you create the shipment, the collection amount equal to the order total will be automatically set. When enabling this delivery method in the order process, make sure that after selecting it, the corresponding payment method which is not part of this module will be available

InPost - Kurier C2C + cash on delivery

In this section you will find the same fields as in the one described above

Cash on delivery - If you have selected this delivery method in the order process, the amount of cash on delivery equal to the order total will be automatically set when creating the shipment. When enabling this delivery method in the order process, make sure that after selecting it, there will be an appropriate payment method available which is not part of this module

InPost - Przesyłka kurierska 10:00/12:00/17:00

Service for delivery of shipments to the specified time

Here you will find the same fields as described in the section InPost standard Kurier delivery and have analogous purpose

Checkout

The module is adapted to the standard order process available in the default Magento 2 Luma template. Therefore, if your store uses a different store template or order process, it may require adjustment to function properly. First of all, you should pay attention to ensuring the validation of the Parcel Locker selection for Parcel Locker delivery methods and the correct operation of the selected Parcel Locker record

In the ordering process, after configuring the module and enabling selected services, the currently active delivery methods will appear

Depending on the configuration, delivery methods to the Parcel Locker may be visible both in the standard version and with weekend delivery, or alternatively - either standard or weekend delivery. For each delivery method to the Parcel Locker, there is a button that allows you to open a map (Geowidget) to search for a selected point

• Courier delivery methods do not have any additional options - they are simply available if you have enabled them in the configuration

• In addition, each delivery method displays the logo corresponding to the type of service

Transactional emails

After placing the order, the customer receives only the name of the selected delivery method in the standard e-mail template with order confirmation, e.g. "InPost Kurier - Kurier - delivery until 12:00". However, you can add information about the selected Parcel Locker to the email template using the following code in the template content:

{{trans "Parcel locker number: %paczkomat" paczkomat=$order.inpost_locker_id}}

However, remember to add conditions checking whether the appropriate delivery method has been selected in which the Parcel Locker has been selected

Order preview in the administrator panel

In the administrator panel, in the order preview, there is a new section "Przesyłki InPost" which displays a drop-down list with available InPost services and a button that takes you to the shipment generation form

The service that was selected by the customer in the ordering process (if it was a service provided by this module) is selected by default in the drop-down list

If there are already generated shipments for a given order, a table with a list and details of the shipments will appear in the "InPost Shipments" section

Right after generating the shipments, the data in this table may be incomplete due to the asynchronous process of assigning tracking numbers in the API ShipX

As a result, tracking numbers will appear with a delay. The shipment list in Magento is refreshed cyclically every 30 minutes or can be manually refreshed by clicking the "Refresh list" button in the admin panel in Sales → InPost Shipment List.

For parcels delivered to a Parcel Locker, the table allows you to preview the selected Parcel Locker or POP point on the map after clicking the "Show on map" link

Additionally, for each shipment it is possible to download the shipment label by clicking the "Print label" button - the label generated for a given shipment will be downloaded in the size and format set in the configuration

The last column also shows the "Return" button - for courier shipments, it generates a return label that will be downloaded after clicking it. For parcel locker shipments, clicking it redirects you to https://szybkiezwroty.pl/

The button is unavailable for the "Standard courier delivery for individual customers" services (inpost_courier_c2c and inpost_courier_c2ccod)

If a link to this website is set in the configuration, it will be used for redirection

Generating an InPost parcel

In the order preview in the admin panel by clicking on the "Send" button in the "InPost shipments" section, you will be redirected to the shipment generation form which will look different depending on the selected service

For courier services it will look as follows:

The following fields are located here:

After filling in all the data, click the "Create shipment" button which will redirect to the order preview with the corresponding message

If any errors occur during shipment generation, the operator will be returned to the shipment generation form with the information provided and a message describing the error:

If the "Automatically create shipment to order" box is checked to "Yes" in the module configuration, then after the InPost shipment is created and the tracking number is downloaded to it, a shipment to order will be created for the corresponding order

Generate InPost Parcel for multiple orders

In the list of orders in the admin panel, it is possible to generate shipments for multiple orders at once. This can be done by selecting the selected orders and selecting "Create InPost shipments" or "Create InPost shipments and print" from the "Operations" drop-down list (which will print the labels right away).

The mechanism of generating multiple shipments at the same time is based on the following assumptions:

• InPost shipments are generated only for orders that have one of the delivery methods provided by this module selected (if the operator would like to generate an InPost shipment for an order that has a different delivery method selected, it is still possible to do so individually in the order preview)

• For each order, a shipment is generated using the service selected by the customer

• All data needed to generate a shipment are taken from the order or from the module's default settings, so you must first configure all the default settings of the module and delivery methods

• If errors occur when creating a shipment for any of the orders, that particular order will be omitted, but subsequent orders will still have shipments created.

• If any errors occur while generating the shipment, they will all be listed in messages after the process is completed

After completing the process of generating shipments, appropriate messages will appear with information about the generated shipments and the reasons why others were not generated:

Shipment list

The administrator panel contains a list of shipments that are available to the operator after configuring API access data in the module configuration.

The list is available in the Sales menu → InPost Shipments List

The table visible in this view is refreshed by a cron job (which should be properly configured for the Magento system) every 30 minutes. Additionally, you can use the “Refresh List” button to update it.

The table contains the following columns:

After selecting the appropriate shipments with the checkbox in the first column, the following operations will also be available:

Contact

If you have any questions, please use the Integration Department's contact form, which is available here: https://inpost.pl/formularz-wsparcie  

 After entering the form, just select "Wsparcie Klienta” from the list, in the category select: Moduł InPost, and in the field "Proszę podać nazwę modułu” enter: Magento