Open

This instruction presents the process of installing and configuring a plugin that enables the implementation of InPost Pay in a PrestaShop store with Widget 2.0 support.

• Version 3.5.0 (09.10.2026) - compatible with PrestaShop version 9.x, 8.x, and version 1.7.6 onwards.
  Required PHP version: 7.2 or higher

Open

Releases · InPostPay-PrestaShop/prestashop-inpostpay-module-core

• Version 2.8.0 (30.09.2026) - compatible with PrestaShop version from 1.7.1 to 8.x.
  Required PHP version: 7.1 or higher

Open

On this page:

To ensure proper operation, it is necessary to install PrestaShop version not older than 1.7.1. Additionally, the PHP version requirements are specified as follows:

• For module version 3.x: PHP version 7.2 or higher.

• For module version 2.x: PHP version 7.1 or higher.

Follow the steps below to install the plugin:

1. Download the zipped PrestaShop plugin from the InPost website and do not unzip it

2. Log in to the administration section of your store

3. From the menu on the left, select "Modules" and then "Module Manager".

   Open

   

4. At the top of the page, click "Upload a module".

   Open

   

5. Drag the previously downloaded module into the window that opens.

Open

For initial configuration, go to the list of modules and click "Configure" next to the InPost Pay module. Once clicked, a form that allows you to configure the plugin will be displayed.

The "Settings" tab in the module configuration contains the basic module configuration settings.

Open

The environment configuration contains the required fields that need to be filled out first when configuring the plugin.

Open

The environment configuration contains three types of environment:

• UAT - a test environment intended for developers

• Sandbox - a test environment intended for merchants to test the plugin before production launch

• Production - a production environment, to be used only if you have already tested the plugin on the sandbox environment

Widget display

You can set widget visibility in the module configuration.

Open

There are two available options:

• ·everyone - the widget is visible to everyone who makes a purchase in the store, run only if the plugin has already been production-configured and tested

• testers - the widget is visible only when the showIzi=true parameter is added to the page url. Example: https://mystore.pl?showIzi=true

Required configuration field.

Open

Client ID varies depending on the selected environment. To get a sandbox Client ID, please contact us using the contact form. To get a production Client ID, log in to the InPost merchant panel and complete the store details

Open

Client Secret varies depending on the selected environment. To get sandbox Client Secret, please contact us using the contact form. To get production Client Secret, log in to the InPost merchant panel and complete the store details.

Required configuration field.

Open

For sandbox environment, you will receive this value along with Client ID and Client Secret after filling out the form. For production environment, log in to the InPost merchant panel and retrieve the POS ID.

Open

Merchant Client ID is a value assigned by InPost. For sandbox environment, you will receive this value along with Client ID and Client Secret after filling out the form. For production environment, log in to the InPost merchant panel and retrieve the Merchant Client ID.

Settings related to the payment methods available for completing a purchase via the InPost application.

Open

Open

A toggle that enables all available payment methods without the need to select them manually from the list.
When set to "Yes", the InPost Pay application will display all methods available in the configuration of the InPost Merchant account (according to the agreement).

Open

A dropdown list that allows manual selection of specific payment methods to be displayed in the InPost Pay application.
This list is active only when the toggle "Enable all available payment methods" is set to "No".
The methods selected here will be made available to the end user in the mobile app during order finalization.

Once an order is created using InPostPay, you can assign the appropriate order statuses for them in your PrestaShop store.

The initial status for an order created through the InPost app. You can freely change the status by creating your order status in your PrestaShop panel.

Open

The initial status for an order created through the InPost app for cash on delivery payment. You can freely change the status by creating your order status in your PrestaShop panel.

Open

Status for an order that was paid correctly by the customer in the InPost app. You can freely change the status by creating your order status in your PrestaShop panel.

Open

You can display the widget on the order confirmation page through configurations in three hooks. Choose the one that best suits your store template. The widget must be visible at the top of the page immediately upon redirection to the order confirmation page.

Three hooks are available:

• displayPaymentReturn - default hook in PrestaShop visible on the order confirmation page.

• displayOrderConfirmation - default hook in PrestaShop visible on the order confirmation page

• displayIziThankYou - hook of the InPostPay module that allows you to use the widget anywhere on the thank you page, if the default hooks do not do their job properly. It is required to manually implement such a hook in the templates/checkout/order-confirmation.tpl file by adding {hook h="displayIziThankYou" order=$order}.

You can display the widget on the product card through configurations in three hooks. Choose the one that best suits your store template.

Three hooks are available:

• displayProductActions - default hook in PrestaShop visible on the product page

• displayProductAdditionaInfo - default hook in PrestaShop visible on the product page

• displayIziProductButton – custom hook on the product page. To use this hook, it must be added in the frontend template, for example in: themes/theme_name/templates/catalog/product.tpl by adding {hook h=”displayIziProductButton” product=$product}.

You can display the widget in checkout through configurations in two hooks.

Two hooks are available:

• displayCheckoutSummaryTop

• displayIziCheckoutButton - manual implementation in the template file is required: {hook h="displayIziCheckoutButton"}.

Open

The switch allows you to enable the function of analytics data collection and its transfer to InPost Pay. When activated, the module saves the values of the gclid, fbclid parameters and the user ID from the _ga cookie in cookies. This data is automatically assigned to the shopping basket and sent in the OrderDetails structure when the order is placed. This allows integration with Google Ads, Facebook Ads and Google Analytics campaigns (InPost Pay - Analytics - PrestaShop).

You can change the names of order statuses for orders placed through the InPost app.

Open

If you do not change any order status then it will display the name depending on the relevant status configuration in PrestaShop.

The module allows you to optionally put additional information in the order comments in case the customer chooses delivery to the APM:

Open

The following parameters are available for use in the message template:

• payment_type - code of the payment method selected by the customer

• delivery_point - the number of the selected APM

• delivery_codes - list of codes of additional services selected by the customer

• is_pww - whether the customer selected the Weekend Delivery service (true/false)

• is_cod - whether the customer selected the cash on delivery service (true/false)

The fragments corresponding to the parameter name placed in curly brackets ("{ }") are replaced by the parameter value - e.g. if the customer selected delivery to APM "ABC123", template:

Selected APM: {delivery_point}. will result in a message reading:

Selected APM: ABC123. Logical values are printed as "true" or "false", lists - delimited by square brackets ("[ ]").

Double curly brackets ("{{ }}") allow to print the calculated value of an expression - e.g. a template:

Weekend Delivery: {{ is_pww ? "yes" : "no" }}. will result in a message reading:

Weekend Delivery: yes. or

Weekend Delivery: no. depending on whether the customer has selected the corresponding optional service.

For detailed information on expression syntax, please refer to the documentation of the Expression Language component in the version appropriate for the PrestaShop version you are using (2.x for PS 1.7.0 - 1.7.3, 3.x for other versions of 1.7, 4.x for PS 8.x). The constant function is not available.

This section allows you to define the size and scope of product images that will be sent to the InPost Pay application.

Specifies the image size used in list views — for example, in the cart, order summary, or recommendation sections.
A smaller size is recommended to ensure faster widget loading.

Defines the image size used in the detailed product view within the InPost Pay application.
Helps maintain visual consistency with the product presentation in the store.

Indicates the image size used for zoomed or enlarged product views (e.g., after clicking on the image in the app).
Useful for products that have high-resolution photos.

Determines whether the InPost Pay application should receive only the main (cover) image or the entire product gallery.
Available options:

• Cover image only – only the main product image is sent to the application.

• Full gallery – all product images are sent to the application.

This is a global setting applied to all products, unless it is overridden for a specific product in its edit form (Options → InPost Pay Options tab).

In the module configuration, you can set the maximum number of suggested products to be displayed in the app in the shopping basket view.

Open

When the value is empty, the number of products will be displayed without limit. Suggested products are retrieved from related products that are currently added to the shopping basket. We can find related products on the configuration page of a particular product in the "Basic settings" tab. Related products are the default feature of PrestaShop.

Open

The page whose address will be used if no other address has been indicated in the discount configuration. If both the default page and the page assigned to the discount are absent, the promotion information will not be transferred to the mobile application.

Note: If you configure a group of stores with basket and order sharing enabled (so-called multistore with sharing), it is recommended that the discount codes be available in all stores belonging to the group. Restricting a discount code to only one store in such a configuration may result in its automatic removal from the shopping basket – for example, when updating the contents of the basket or after the customer visits another store in the same group where the code is not available. This can lead to the customer unexpectedly losing the discount just before finalizing the order.

In the "Consents" tab, we can add consents that will be displayed in the InPost app at the order placement stage. When adding a consent, there is an option to specify additional links to be displayed next to it in the mobile app. New consents can be added by selecting the "Add another consent" button.

Open

In the "Description displayed in the app" field – we enter the contents of the relevant consent to be displayed in the InPost app. This field is multilingual.

Open

Consent may be mandatorily required in order to place an order or it may be optional.

Open

The field accepts the following values:

· Optional - consent is not required at the order placement stage

· Always required - consent is required every time at the order placement stage

· Required once - consent is required only once at the order placement stage.

Unique link ID. In the consent description, the fragments created by adding the prefix "#" to the ID will be replaced by corresponding links.

Open

In the "Consent address" field, select the CMS page the link to which is to be included in the relevant consent in order to read information about the relevant consent.

Open

The text that will be displayed on the consent link button. If the field is left blank, the text "link" will be displayed.

Open

The "Transport Price" tab contains configuration fields for mapping delivery methods, costs and delivery availability. Configurations are to be set separately for the "Courier" and "APM" services.

Open

The Estimated delivery time field is available in both the Courier and Parcel Locker service configurations, and its value is set separately for each. It defines the delivery time in hours (from 1 to 1440, default 48). Based on this value, the estimated delivery date is calculated and shown to the customer in the InPost app.
Only business days between 9:00 and 17:00 count toward the delivery time, and weekends are skipped.

Courier service configuration.

Open

The Carrier Mapping field is responsible for mapping the delivery method from PrestaShop for the Courier service. In case there is a separate delivery method for the Courier service and cash on delivery option, we perform the mapping of this service in the Carrier Mapping (Cash on Delivery) field.

Open

The Cash on Delivery (Additional cost) field contains the net value of the amount to be added if the service is selected.

The additional cost will not be added if the "Add handling costs" option is disabled for the carrier.

To ensure the additional cost is applied, go to the carrier's edit view in the PrestaShop admin panel, and in the "Shipping locations and costs" step make sure the "Add handling costs" toggle is set to "Yes".

Open

APM service configuration.

Open

The Carrier Mapping field is responsible for mapping the delivery method from PrestaShop for the APM service. In a situation where there are separate delivery methods in PrestaShop for the additional options for delivery to APM: Cash on Delivery and Weekend Delivery, we perform the mapping in the corresponding fields Carrier Mapping (Cash on Delivery), Carrier Mapping (Weekend Delivery), Carrier Mapping (Cash on Delivery + Weekend Delivery).

Open

The Cash on Delivery (Additional cost) field contains the net value of the amount to be added if the service is selected.

The additional cost will not be added if the "Add handling costs" option is disabled for the carrier.

To ensure the additional cost is applied, go to the carrier's edit view in the PrestaShop admin panel, and in the "Shipping locations and costs" step make sure the "Add handling costs" toggle is set to "Yes".

Open

The Weekend Delivery (Additional Cost) field is responsible for the net cost of the APM - Weekend Delivery service. The VAT rate is taken from the configuration of the carrier mapped in the "APM" field.

Open

The availability fields are responsible for the availability of the "APM - Weekend Delivery" service. "Available from" - "Available to" specifies the time period from which the weekend delivery service is to be available in the InPost app.

Open

Open

This option enables the display of a gift wrapping choice for orders in the mobile application.

The feature is available only if the “Offer gift wrapping” option is enabled in the order settings. If this option is disabled, the feature will not be available in the application.

The "GUI Settings" tab is responsible for configuring the display of the button widget on the product page and the in shopping basket. The view buttons are refreshed dynamically to present the current appearance of the button with the relevant settings. Remember to click on the "Save" button to save the current changes made in the configuration

Open

The button widget is displayed on the basket page and allows you to connect your basket to the InPost app and redeem it from within the app.

The button widget is displayed on the product page and allows you to connect your basket with the InPost application. Selecting the button simultaneously adds the product to the basket. It also allows you to limit the display of the basket pairing widget on product pages based on type, default category, manufacturer or attributes of the product.

The button widget is displayed on the login page under the login form.

The widget is displayed on the registration page above the registration form.

The button widget is displayed on the order completion page above the order summary.

The button widget is displayed on the basket view. It requires the use of a non-standard hook – it is necessary to implement {hook h="displayIziCartPreviewButton"} in the template.

The fields for widget configuration on the basket and product pages are the same. However, the appearance of each button may differ and the module gives you the option to configure these fields separately for each placement.

The module allows you to disable the display of that button on the product page and the basket page. In order to increase conversions, it is recommended to make the widget visible on the basket page as well as on the product card.

Open

Determines the orientation of the widget in the space available to it. If the template allocates a narrow space for the widget, this setting will not affect its appearance.

Open

Available alignment options:

• To the left - causes the widget to be shifted to the left side

• Centered - causes the widget to be centered

• To the right - causes the widget to be shifted to the right side

Determines whether the widget is on a light or dark background in your store. The setting affects the font color, make sure it is visible.

Open

The widget background includes two options:

• Light - choose this option if the button is displayed on a light background

• Dark - choose this option if the button is displayed on a dark background

The widget is available in 2 color variants. Choose the one that better matches the color scheme of your store.

Open

The widget variant includes two options to choose from:

• Yellow - choose this option if you want the button to be yellow in color

• Black - choose this option if you want the button to have black color

This configuration field specifies in what style the button should be displayed on the store page.

Open

The frame style configuration includes three options:

• Square - select this option if you want the button to have no rounded corners

• Rounded - select this option if you want the corners to be slightly rounded

• Round - select this option if you want the corners to be heavily rounded.

This setting allows you to adjust the size of the widget to best fit the layout of the page and provide a comfortable user experience.

Open

Available options:

• Very small - compact format, ideal for limited spaces.

• Small- a subtle size that works well in minimalist layouts.

• Medium - a versatile size, providing good visibility and intuitive use.

• Large - a more prominent widget, better visible on the page.

• Extra large - maximum size, providing the highest readability and user experience.

The module makes it possible to set the following for the widget:

• maximum width value - a value between 220 and 1200.

In the field we enter only numeric values without the "px" suffix.

If the button is misaligned or "touches" other UI elements on the store page, you have the option to specify the margins for the widget.

Open

All margin fields take a numeric value without the "px" suffix.

Allows to configure the conditions when the widget will not be displayed on product pages.

Open

Open

Defines how the module should respond to products subject to restriction rules (e.g., based on category, brand, feature, or product type).Allows blocking the ability to place an order in the mobile application if the cart contains a product that meets any of the following conditions.

Available options:

• Do not display the widget
  The widget does not appear on the product page or in the cart for products that meet the defined restrictions.
  The user cannot interact with the module for this product.

• Do not allow ordering
  A restricted product cannot be added to the cart or purchased.
  A message informing about the unavailability of the product for purchase may appear on the product page.

• Do not allow courier delivery
  The product can be ordered, but the courier delivery method will be disabled or hidden during checkout.
  In the mobile application and on the cart page, the product will be marked as unavailable for courier delivery.

• Do not allow delivery to a parcel locker
  The product can be added to the cart, but InPost parcel locker delivery will be disabled.
  In the InPost Pay application, the customer will not see this delivery option for the restricted product.

The configuration field specifies the types of products for which the widget will not be displayed.

Open

The product type configuration has six options:

• Check all fields - selects all the following fields.

• Standard products - a basic product type that has no options or variants to choose from

• Products with combinations - products that have different variants, such as sizes, colors, or other characteristics that affect price and availability

• Customizable products - products that may be customized by the customer, e.g. by adding custom engravings or prints

• Product bundles - a group of products sold together as a bundle, often with a lower price than buying individual products separately

• Virtual products - products that do not physically exist, such as downloads, subscriptions or online services.

This configuration field specifies the brand of products for which the widget will not be displayed.

Open

The number of displayed variants depends on the individual number of brands in the store.

This configuration field specifies products with attributes for which the widget will not be displayed.

Open

The number of displayed variants depends on the individual number of attributes in a given store.

This configuration field allows you to indicate the product characteristics whose presence will result in the widget being hidden.

Open

The number of variants displayed depends on the individual number of characteristics in a given store.

This configuration field specifies product categories for which the widget will not be displayed.

Open

The number of displayed variants depends on the individual number of categories in a given store.

The "Support" tab contains useful information, including the plugin status indicating whether the plugin has been configured correctly. It allows to enable debugging mode and retrieve logs with useful information, which can help to solve the problem when contacting support.

Open

The plugin status tells us whether the module is configured correctly. If the module is configured correctly, it displays "OK" status.

Open

If there are any problems with the configuration, the "ERROR" status is displayed and the module provides information about the configuration error.

The module allows you to retrieve plugin data and module logs to help you troubleshoot plugin-related problems.

Open

Enabling debugging mode increases the amount of information that is contained in module logs. It can be useful for plugin support purposes, where any information contained in the logs can help in troubleshooting.

Open

Open

The Extensions section allows the installation or update of additional module components.

The table contains the following columns:

• Name – the name of the extension,

• Description – a short description of the functionality,

• Recommended – information about suggested installation,

• Version – the available version of the extension,

• Actions – available operations for the extension.

• Installed – may offer an update to a newer version,

• Recommended – extensions linked to a module already present in the shop, installation available,

• Other – extensions whose related modules are not available in the shop, displayed for informational purposes only.

The gift wrapping option allows customers to request that their order be wrapped as a gift.

To enable the option:

1. In the PrestaShop back office, go to Preferences → Orders → Gift options.

2. Enable Allow gift wrapping.

3. (Optional) Set an additional fee for gift wrapping.

Once enabled:

• A Gift wrapping checkbox will appear in the InPost Pay application cart.

• When selected, the gift wrapping information will be saved in the order details in PrestaShop.

• If a fee is configured, it will be automatically added to the total order amount.

The discount coupon feature allows you to create promotions in the PrestaShop store, which are then automatically synchronized with the InPost Pay application. This enables the customer to activate or remove a coupon directly in the application, while the discount value always remains consistent with the store configuration.

To make a coupon available in the InPost Pay application, it must first be added in the PrestaShop back office:

Open

1. Go to Catalog → Discounts → Cart rules.

2. Click Add new cart rule.

3. Fill in the required fields:

   • Code (e.g. inposway),

   • Reduction type (e.g. amount),

   • Discount value,

   • Validity period,

   • Status = active.

4. Save the settings.

After being saved in PrestaShop, the coupon is automatically synchronized with the InPost Pay application:

• the coupon can be activated directly in the application,

  Open

  

• the discount applied is identical to the one configured in the store,

• the coupon can also be removed from within the application.

  Open

  

For orders placed via InPost Pay, a unique masked email address assigned to the specific order is displayed in the order details in the Back Office.

The same address is also automatically added to the order message, so it can be used during further order processing, including integrations with external systems.

Open

If you need to read the email address from within the code - for example, to pass this data in a request to an external API or to expose it in a PrestaShop API field handled by the integration in use with an external system - you can use the getOrderData() method of the izi\prestashop\Repository\OrderDataRepositoryInterface service. For a given order ID, the method returns an object representing the contents of the order creation request sent to the Merchant API. The service is registered as public, so it can be accessed directly through the DI container. As an example, using the container available via the \Context object within a PrestaShop API request:

A detailed description of masked email addresses on orders can be found in the Changelog - Handling user emails in orders.

Starting with version 3.4.6, support for the InPost Plus program has been introduced - InPost Plus Program Support.