Page Comparison

Technical documentation of the InPost Pay plugin for PrestraShop. The plugin adds the functionality of ordering via the InPost application to the
PrestaShop store by:

• Adding a table in the database,

• Adding the "Create cart from InPost Pay" button in the product listing,

• Adding the "Create cart with InPost Pay" button in the product card,

• Adding the "Create cart from InPost Pay" button in the shopping cart page,

• Adding the "Create cart with InPost Pay" button in the order page,

• Actions performed on standard hooks,

• Adding a field in the order page,

• Adding an administrative section,

• Providing REST API,

• Attaching a JS file served from the webserver and a file served from an external resource to the website.

Plugin: (12.09.2023) version 1.3.13:

Requirements

In order for the plugin to operate properly, it requires:

• PrestaShop version not lower than 1.7.81.x0

• PHP version not lower than 7.41

Installation

During installation, the plugin adds to the database the table described in

Follow the steps below to install the plugin:

1. Download the packed PrestaShop plugin from InPost and do not unpack it

2. Log in to your store's admin section

3. From the menu on the left, select “Modules” → “Module Manager” and then “Load Module”
   

   

4. Place the module in the frame and the plug-in is installed

5. Select "Configure" - and configure the plugin

Test Config

In this chapter, we describe the shortened configuration process required to perform functional tests of InPost Pay integration.

For initial setup, go to the module list and click “Configure” next to the Inpost Pay module.

After clicking it, a form will appear allowing you to configure the plugin.

Fill in the fields according to the list below

1. Select the environment and display options
   a. Set the environment to “Sandbox” - this way no money will be debited from the account during the tests.
   b. Set the Show widget to “Testers” - this way the widget will be visible only to those people, who are supposed to see it. Setting another option will display the widget, no matter funcitioning, or not, to all visitors to your store.
    In order to display the widget in a web browser, enter the address of
    your store, adding ?showIzi=true.
   Example: https://mystore.com?showIzi=true

   

2. Fill in the API access data you received from InPost in the fields
   a. Client
   b. Client Secret.

   

3. Enable payment option

   

4. From the list, select the addresses of consents required for your store. For example, terms and conditions. Hold down the CTRL key to select more than one.

   

5. Enter the text that will be displayed in the InPost application next to the link to the required consents.

   

6. Select the order status that will be given to orders paid via InPost Pay

   

7. Connect the courier shipment with the system shipment. After selecting the shipping method from the drop-down list, the same availability and pricing rules for the selected method will apply to shipping by Courier in the InPost application

   

8. Connect the shipment via the Parcel Locker with the system shipment. After selecting the shipping method from the drop-down list, the same availability and pricing rules for the selected method will apply to parcel locker shipping in the InPost application.

   

9. Specify where the widget should be available on your website.

You can display it in the product list, product card and in the cart.

For each display location, you can specify which side the InPost Pay button will align to.

For each place, you can select separately whether the background on the page is light or dark, which will ensure the correct display of texts.

For each location, you can select the display option separately. The button can be amaranth or yellow.

Production Config

After the correct test configuration and making sure that the integration works in the Sandbox, InPost Pay should be made available to all users.

For setup, go to the module list and click “Configure” next to the Inpost Pay module. After clicking it, a form will appear allowing you to configure the plugin. Change the configuration according to the list below:

1. Select the environment and display options
   a. Set the environment to “Oridyctuib” - this way money will be debited from the account during the tests
   b. Set the show widget to “All”

Full Config

After installing the plugin for configuration, go to "Modules" → "Module Manager" and enter Inpost in the search engine. Select the "InPost Pay" plugin. After clicking, a form will appear allowing you to configure the plugin.

This section sets the system access data, the types of payment methods supported and the information exchanged between InPost Pay and the store.

Access data to the sandbox environment can be obtained by writing at integracjapay@inpost.pl

You will receive production data after signing the InPost Pay service agreement,

Description of available options:

Environment

Show widget

Client ID

Client Secret

POS ID

Enable payments according to the contract concluded with Aion

Enable payment on delivery according to the contract concluded with InPost

Order status for order paid by InPost Pay

Order status

Maximum number of suggested products

Consents

The section is used to set the consents displayed to customers in the InPost application when shopping with InPost Pay.

Description of available options:

Required consents

Required consents Text

Consents required once

Consents required once Text

Additional consents

Additional consents Text

Order status

Net transport price

Section responsible for mapping forms of transport and determining the availability and prices of additional transport options.

Description of available options:
The settings of this section are analogous for all shipping types and for all options
 Below is a generic description of where the shipping type was used and the option for shipping options:

Courier/Parcel Locker

Options for PWW oaz COD

Courier/Parcel Locker [option] net:

Courier/Parcel Locker [option] available from (date)

Courier/Parcel Locker [option] available from (hour)

Courier/Parcel Locker [option] available to (day)

Courier/Parcel Locker [option] available to (hour)

GUI Settings

Here you can set whether and where to display the InPost Pay widget. The section has been divided into subsections corresponding to the different subpages of your store.

Please Remember!
We set the GUI according to the Merchant Guide you received in the email from InPost.

Description of available options:

 Display

 Alignment

Background

Variant

Margin

Cart View

After configuring the plugin, the Create cart with InPost Pay button will appear in the cart, next to the products:

Display in a custom location

To display the widget in a custom place, use the code below in your template:

\izi\InPostIzi::render(
 $productId = null,
$name = '',
$maskedPhoneNumber = '',
$inpost_basket_id = '',
$echo = true,
$addBasketId = false,
$variationId = '',
$count = 0,
$dark = false,
$yellow = false,
$cart = false,
$float = 'left',
$bindingPlace = 'BASKET_POPUP'
);

Parameter description:

Uninstallation

Uninstalling the plugin deletes the plugin files. The database and data remain unchanged.

External resources

The plugin uses a JS file from an external resource located at https://izi.inpost.pl/inpostizi.js. The file contains the functions required to support the InPost Pay functionality.