Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Below is the documentation for the proprietary InPost OpenCart plugin. It contains information about installation and configuration of the plugin.

Version compatible with all versions of OpenCart 3.0

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFFAE6

Plugin: (latest version 15.06.2023r)

https://inpost.pl/sites/default/files/2023-06/ocs.inpostshipping.ocmod_.zip

Info

If you have problems with the installation of the plugin (failure to save some files), you need to install the add-on:

https://www.opencart.com/index.php?route=marketplace/extension/info&extension_id=33410&filter_search=Ocmod%20installer&filter_license=0

It is required to refresh the page and reinstall the module



Na tej stronie:

Table of Contents


Authorization

Production environment

Info

You must have access credentials to connect to the ShipX API before installation:

  • Access Token (key)

  • ID organization

and

  • Access Token for Geowidget

Download a tutorial explaining how to quickly create access to the ShipX API and Geowidget on your own:

https://inpost.pl/sites/default/files/2022-03/instrukcja-konfiguracji-api-shipx.pdf

Test environment

Access generation

https://sandbox-manager.paczkomaty.pl/ > tab Moje konto > API

To generate a Token and an organization ID, you need to complete all the data, including billing details under My Account > Data. In order to create a Parcel Locker® shipment you need funds in your account, you will top up your account virtually in the Payments tab

Geowidget:

  • Access Token do Geowidget > tab Moje konto > API > Geowidget


Plugin installation

Log in to the administration panel of your store on the OpenCart platform

  1. Go to the Extensions tab and select Installer

2. Click Upload and select 2 zip files of the installation plugin. You should install them one by one.

3. After installation, the plug-in will appear in the tab below in the list of installed plug-ins ExtensionsExtensions


Plugin configuration

Searching for a module for further configuration is done under Extensions Extensions

In this tab, select InPost Shipping → Edit

Image RemovedImage Added

Zakładki

Ogólne– umożliwia konfigurację dostępu do API (Produkcyjnego i Sandboxowego

Tabs

General - allows you to configure access to the API (Production and Sandbox)

GeoWidget- umożliwia dodanie Tokenu do Geowidget (do poprawnego działania mapy z punktami InPost należy wygenerować token GeowiedgetAllows you to add a Token to Geowidget (you need to generate a Geowiedget token for the map with InPost points to work properly)

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFEBE6

Ważne! Gdy w koszyku w Geowidget pokazuje się błąd “Brak dostępu, sprawdź czy token został wygenerowany dla odpowiedniej witryny” należy ponownie wygenerować token do Geowidget w Manager Paczek ale podając poprawny adres witryny sklepu. Błąd dotyczy podania błędnego adresu url sklepu.

Ustawienia - po dodaniu formy dostawy w Usługi Dostaw umożliwia ustawienie ceny, logo, darmowej dostawy, podatku i maksymalnych wymiarów przesyłek

Dane nadawcy – dane można uzupełnić lub automatycznie pobrać z API

Metody wysyłki – umożliwia konfigurację domyślnych Punktów Odbioru/Paczkomat® i ustawienia domyślnej wartości ubezpieczenia

Usługi dostawy– miejsce do dodania i skonfigurowania usług Paczkomat® i Kurierskich

Paczka w Weekend – pozwala na konfigurację usługi Paczka w Weekend (dni i godziny dostępności usługi)

Punkty Odbioru– umożliwia dodanie/usuwanie/edycję Punktów OdbioruZamówienia– znajdują się tu opcje dodatkowe do obsługi zamówień, możemy wybrać status, przy którym w profilu klienta pojawi się przycisk do Szybkich Zwrotów

Szybkie Zwroty – umożliwia konfigurację usługi Szybkie Zwroty (mając utworzone konto w tym serwisie - Przedstawiciel Handlowy)

Autoryzacja

W tym miejscu możesz uzupełnić dane dostępowe do API (Token, ID organizacji), która można wygenerować samemu w Managerze Paczek w zakładce „API”
Dostęp do środowisk znajduje się na początku tej dokumentacji

Możliwe jest użycie tylko trybu Sandbox po przełączeniu switch’a i uzupełnieniu danych sandboxowych

Geowidget

Do poprawnego działania mapy z punktami InPost w koszyku należy dodać token Geowidget do konfiguracji Produkcyjnej lub Sandboxowej

Token należy wygenerować w Manager Paczek w zakładce Moje kontoAPI → Geowidet(podając domenę sklepu)

Usługi dostaw - konfiguracja metody dostawy w koszyku

W tym miejscu możesz skonfigurować metody dostaw, jakie pojawią się w Twoim sklepie
Kliknij Dodaj usługę -> uzupełnij usługę, która jest importowana z API, domyślną metodę nadania, określ domyślne wymiary przesyłki lub gabaryt ( w zależności od użytego serwisu), następnie nadaj poprawną nazwę usługi zgodnie z wytycznymi zawartymi w „Poradniku skutecznej implementacji dostaw InPost w koszyku e-commerce” i kliknij Save

 

Info

Poradnik implementacji dostaw znajdziesz pod adresemImportant! When the shopping cart in Geowidget shows the error "No access, check if the token has been generated for the correct site" you must re-generate the token for Geowidget in the Parcel Manager but with the correct shop site address.

Settings - after adding a delivery form in Delivery Services, it allows you to set price, logo, free delivery, tax and maximum shipment dimensions

Sender’s details - data can be completed or automatically downloaded from the API

Shipment method - allows you to configure the default Pickup Points/Packet Machine® and set the default insurance value

Delivery services - a place to add and configure Parcel Post® and Courier services

Weekend Package - allows you to configure the Parcel on Weekend service (days and hours of service availability)

Pickup Points - allows you to add/remove/edit Pickup Points

Orders - here you will find additional options for handling orders, we can select the status at which a button for Quick Returns will appear in the customer profile

Quick Returns - allows you to configure the Quick Returns service (having created an account in this service - Sales Representative)

Authorization

Here you can complete the API access data (Token, organization ID), which can be generated yourself in the Parcel Manager under the "API "Access to environments is at the beginning of this documentation

It is possible to use only Sandbox mode after switching the switch and completing the sandbox data

Geowidget

For proper operation of the map with InPost points in the shopping cart, you need to add the Geowidget token to the Production or Sandbox configuration.

Generate the token in Parcel Manager under My Account → API → Geowidget (specifying the store domain)

Delivery services - configure the delivery method in the shopping cart

Here you can configure the delivery methods that will appear in your store

Click Add Service -> fill in the service that is imported from the API, the default shipping method, specify the default shipment dimensions or size ( depending on the service used), then give the correct name of the service according to the guidelines in "Guide to the effective implementation of InPost deliveries in e-commerce shopping cart" and click Save

Info

You can find a delivery implementation guide at:
https://inpost.pl/sites/default/files/docs/Przewodnik-skutecznej-implementacji-dostaw-InPost-w-koszyku-e-commerce.

Image Removed

Po dodaniu usługi masz możliwość dalszej konfiguracji metody dostawy. Można to zrobić od razu po kliknięciu Save - pojawi się okno do konfiguracji logo, cen, wagi lub po przejściu do zakładki Ustawienia

Image Removed

Ceny ustawiamy w Miejsca i koszty wysyłki

Poniżej przykład cen w zależności od wagi produktu (wagę ustawiamy bezpośrednio w produkcie zakładka Dane → Waga)

StrukturaImage Added

After adding a service, you have the option to further configure the delivery method. This can be done immediately after clicking Save - a window to configure logos, prices, weight will appear, or after going to the Settings tab.

Image Added

Prices are set in Shipping locations and costs

Below is an example of prices depending on the weight of the product (set the weight directly in the product tab Data → Weight)

Structure: 3:8.99, 10:10.99,25:13.99 → cena do price up to 3 kg to is 8,99, cena do price up to 10 kg is 10,99, cena do price to 25kg 13:99

Image Removed

Pozycjonowanie usług dostawy w koszyku

Tutaj możesz pozycjonować usługi InPost w koszyku klienta

  1. W konfiguracji wtyczki należy przejść do zakładki Ustawienia

  2. Wybrać Edit w konkretnej formie dostawy i w edycji Kolejność sortowania uzupełnić kolejność licząc od 0 (pierwsza pozycja)

Szybkie Zwroty

Usługa pozwala klientom na zwrot przesyłki zamówionej w sklepie poprzez Paczkomat®

  1. W konfiguracji wtyczki zakładka Szybkie Zwroty należy podać skróconą nazwę do formularza Szybkich Zwrotów. Link tworzy się po założeniu konta w tej usłudze poprzez Przedstawiciela Handlowego

  2. Klient, który jest zalogowania w sklepie w zakładce zamówienia widzi nowy przycisk Zwrot to pozwala na przeniesienie się do Państwa formularza gdzie może dokonać zwrotu

! Ważne jest by w zakładce Zamówienia ustawić kiedy takie przycisk ma być widoczny - w zależność od statusu zamówienia.

Obsługa zamówień/wysyłki

Obsługa zamówienia

Zakładka - Sprzedaż → Zamówienia

  1. Otwiera podgląd na zamówienia złożone przez klientów. Przechodzimy do zamówienia klikając Widok (zaznaczone na czerwono)

Image Removed

2. W zamówieniu pojawia się tabelka z usługami InPost i numerem Paczkomat® gdzie możemy utworzyć przesyłkę. Umożliwia generowanie etykiet, tworzenie przesyłek, drukowanie zleceń odbioru

Image Removed

3. Po kliknięciu na przycisk Nowa dostawa otwiera się panel do edycji danych podanych przez klienta jak i ich akceptacji

Image Removed

4. Jeśli dane są poprawne klikamy utwórz Utwórz przesyłkę okno się zamyka a numer trackingowy po kilkunastu sekundach pojawia się w miejscu Numer przesyłki

Drukowanie i format etykiet

Po utworzeniu przesyłki można pobrać etykietę klikając Print Label

Image Removed

Wybieramy format etykieta, która nas interesuje

Obsługa wysyłki - utworzenie podjazdu

Obsługa paczek i ich wysyłka jest dostępna w dwóch miejscach.

  1. Bezpośrednio w zamówieniu po wygenerowaniu paczki pojawia się przycisk Disptach Order (

Image Removed

2. W liście przesyłek - do tej zakładki możemy się dostać poprzez przycisk Wyświetl listę przesyłek w zamówieniu w InPost Shipping lub poprzez zakładkę do konfiguracji wtyczki w prawym górnym rogu Wyświetl listę przesyłek:

Image Removed

Lista przesyłek

Podgląd na wszystkie wygenerowane przesyłki. Po prawej stronie są dostępne akcje w zależności od metody dostawy i formy nadania paczki.

Image Removed

Produkty szablony

W produkcie jest możliwość określenia wymiarów przesyłki dla konkretnego produktu (te dane automatycznie podstawiają się podczas tworzenia przesyłki w zamówieniu)

Należy przejść do zakładki Katalog Produkty → wybrać konkretny produkt

Produkt - zakładka Dane - dla metody wysyłki InPost Kurier możemy ustawić wymiary i wagę

Image Removed

Produkt - zakładka Wysyłka - pozwala ustawić dla jakiej metody dostawy dany produkt będzie dostępny + możemy określić gabaryt przesyłki (A,B,C) dla usługi InPost Paczkomat® (automatycznie będzie podstawiał się podczas tworzenia przesyłki Paczkomat®

Image Removed

Kontakt

W przypadku pytań zapraszamy do skorzystania z formularza kontaktowego Działu integracji, który dostępny jest tuImage Added

Positioning of delivery services in the shopping cart

Here you can position InPost services in the customer's shopping cart

  1. In the plug-in configuration, go to the Settings tab

2. Select Edit in the specific delivery form and in the Sort order edit, complete the order counting from 0 (first item)

Quick Returns

The service allows customers to return shipments ordered from the store via Parcel Locker®.

In the configuration of the plugin Quick Returns tab, provide a short name for the Quick Returns form. The link is created after setting up an account for this service through the Sales Representative

The customer who is logged in to the store in the order tab sees a new Return button this allows you to move to your form where they can make a return

! It is important to set in the Orders tab when such a button should be visible - depending on the status of the order.


Order processing/shipping

Order handling

Tab - Sales → Orders

  1. Opens a preview of orders placed by customers. Navigate to the order by clicking View (highlighted in red)

Image Added

2. In the order, a table appears with InPost services and Parcel Locker® number where we can create a shipment. Allows you to generate labels, create shipments, print pickup orders

Image Added

3. fter clicking on the New Shipment button, a panel opens for editing the data provided by the customer as well as accepting them

Image Added

4. If the data is correct click Create Shipment the window closes and the tracking number appears in the Shipment Number space after several seconds

Printing and label format

Once the shipment is created, you can download the label by clicking Print Label

Image Added

We choose the format of the label we are interested in



Handling dispatch - creating a disptach order

Parcel handling and shipping is available at two locations.

  1. Disptach Order button appears directly in the order after the package is generated

Image Added

2. In the list of shipments - this tab can be accessed through the View list of shipments button in the order in InPost Shipping or through the tab to configure the plugin in the upper right corner View list of shipments:

Image Added

List of shipments

A preview of all generated shipments. On the right are the available actions depending on the delivery method and the form of shipment of the package.

Image Added


Products templates

In the product, it is possible to specify the dimensions of the shipment for a specific product (these data are automatically substituted when creating the shipment in the order)

Go to Catalog → Products → select a specific product

Product - Data tab - for InPost Courier shipping method we can set the dimensions and weight

Image Added

Product - Shipping tab - allows you to set for which delivery method the product will be available + we can specify the shipment size (A,B,C) for the InPost Paczkomat® service (it will automatically substitute itself when creating a parcel Paczkomat® shipment

Image Added


Contact

If you have any questions, please use the Integration Department's contact form, which is available here: https://inpost.pl/formularz-wsparcie   Po wejściu w formularz wystarczy z listy wybrać opcję "Wsparcie Klienta”, w kategorii wybrać: Moduł InPost, a w polu "Proszę podać nazwę modułu” podajemy: OpenCart 

After entering the form, just select "Customer Support" from the list, in the category select: InPost module, and in the field "Please specify the name of the module" specify: OpenCart