Versions Compared

Key

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

Poniżej znajduje się dokumentacja do autorskiego rozwiązania InPost Shopify dla usług InPost International. Zawiera informację o instalacji oraz konfiguracji pluginu.

Wtyczka dostępna jest na app store Shopify
Image Added

Below is the documentation for InPost's proprietary Shopify solution for InPost International services. It contains information about the installation and configuration of the plugin.

The plugin is available on the Shopify app store

Panel
panelIconIdatlassian-warning
panelIcon:warning:
bgColor#FFBDAD

Aplikacja dostępna dla klientów Shopify (wymaganie funkcjonalne do działania aplikacji:

sklep musi posiadać dostęp do

App available to Shopify customers (functional requirement for the app to work:

  • store must have access to Carrier Service API

  • plan Advanced lub Shopify opłacony rocznieor Shopify plan paid annually

Info

Wtyczka nie posiada mapy Geowidget →  wymaga od użytkownika podania adresu z poprawnym kodem pocztowym na podstawie którego określone zostaną dostępne punkty odbioruThe plugin does not have a Geowidget map → it requires the user to enter an address with a valid postal code based on which available pick-up points will be determined

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#FFFAE6
Wtyczka

Plugins

XX05.XX02.2025

Marketplace Shopify

https://apps.shopify.com/inpost-oficjalna-aplikacjainternational?locale=pl&search_id=d8ba9002-e8bf-4807-8eba-ebfc96402a1c&surface_detail=inpost&surface_inter_position=1&surface_intra_position=8&surface_type=searchAktualizacja wtyczki następuje automatycznie

The plugin is updated automatically

CHANGELOG

Expand
titleChangelog

Changelog:

XX05.XX02.2025 Udostępnienie wtyczki w App market ShopifyMaking the plugin available in Shopify's app market

Table of Contents

Autoryzacja

Authorization

Środowisko produkcyjne

Production /

testowe

test environment

Info

Przed przystąpieniem do instalacji należy posiadać dane dostępowe do połączenia z Before installing, you must have access credentials to connect to the API:

  • Login oraz hasło

Do połączenia z usługami InPost wymagane jest uzyskanie loginu i hasła.
W celu otrzymania danych autoryzacyjnych należy skontaktować się z InPost poprzez formularz:
Udzielenie dostępu do
  • and password

In order to connect to InPost services, it is required to obtain a login and password.
To obtain authorization data, contact InPost through the form:
Granting Access to API → API International → ŚrodowiskoEnvironment: Produkcja lub Production or Sandbox (wyłącznie do testów usługifor service testing only)

https://inpost.pl/formularz-wsparcie

Połączenie z usługami InPost odbywa się poprzez przekierowanie na stronę www. Prosimy o upewnienie się, że mają Państwo w przeglądarce włączone zezwalanie na wyskakujące okienka.

Instalacja

Zainstaluj aplikację ze sklepu

Connecting to InPost services is done by redirecting to the website. Please make sure that you have pop-up permissions enabled in your browser.


Installation

Install the app from the Shopify App Store

KrokiSteps:

  • Zaloguj się do Log in to the Shopify App Store

  • Znajdź aplikację Find the InPost International, a następnie kliknij ją

  • Na stronie oferty aplikacji kliknij Dodaj aplikację

  • Aby autoryzować korzystanie z aplikacji, kliknij opcję Zainstaluj aplikację w panelu administracyjnym Shopify

Po zainstalowaniu aplikacji możesz ją przeglądać i wykorzystywać na stronie Aplikacje w panelu administracyjnym Shopify.

Więcej informacji
  • app, then click it

  • On the app's offer page, click Add app

  • To authorize the use of the app, click Install app in the Shopify dashboard

Once the app is installed, you can view and use it on the Apps page in the Shopify dashboard.

For more information:https://help.shopify.com/pl/manual/apps/installing-apps

Po instalacji w panelu sklepu pojawi się aplikacja po lewej stronie:

image-20250113-105211.png

Konfiguracja


Configuration -

zakładki

W celu konfiguracji wtyczki przechodzimy do aplikacji InPost International. Pojawia się tam kilka zakładek poniżej wyjaśniamy co oznaczają.

(Wprowadzone zmiany należy zapisywać, przez kliknięcie przycisku Zapisz Ustawienia znajdującemu się na dole ekranu)

Autoryzacja (Dane logowania

tabs

To configure the plug-in, we go to the InPost International application. Several tabs appear there, below we explain what they mean.

(The changes you make should be saved, by clicking the Save Settings button at the bottom of the screen)

Authorization (Login Details)

Wybierz usługi

Użytkownik może aktywować dostępne dla klientów usługi:

  • może zmienić nazwę własną usługi

  • może wybrać liczbę punktów pokazujących się w pobliżu adresu klienta

  • wskazuje dostępy rodzaj punktów odbioru, który wyświetla się w koszyku (Paczkomat/PaczkoPunkt/Paczkomat i Paczkopunk)

  • może zdefiniować koszt dostawy dla usługi

  • może zdefiniować koszt, od którego zaczyna się darmowa dostawa

  • może zdefiniować maksymalną dopuszczalną wagę

  • może wgrać grafikę usługi (lub nadpisać zdefiniowaną), opcja ta możliwa jest wyłącznie w przypadku klientów Plus (wymaga dostępu do checkoutu)

image-20250113-111636.pngImage Removed

Ustawienia nadania

Domyślne parametry tworzonych przesyłek:

  • możliwe jest zdefiniowanie kilku gabarytów

  • domyślny gabaryt podpowiadany jest jako pierwszy podczas tworzenia przesyłki

  • raz użyty gabaryt nie może zostać zmodyfikowany

  • domyślny gabaryt nie może zostać usunięty, zanim inny nie zostanie ustawiony jako domyślny

Note

Należy pamiętać o maksymalnych dostępnych wymiarach obsługiwanych przez usługę

+

Shopify nie zbiera wymiarów produktów; wyłącznie wagi poszczególnych produktów, które są opcjonalne z poziomu produktu

Image Removed

Punkt odbioru przez kuriera

W podobny sposób do wymiarów paczek można zdefiniować dostępne punkty odbioru przesyłek, dla których w kolejnym etapie można tworzyć zlecenia podjazdu:

  • możliwe jest zdefiniowanie kilku punktów

  • domyślny punkt podpowiadany  jest jako pierwszy podczas tworzenia przesyłki

  • raz użyty punkt nie może zostać zmodyfikowany

  • domyślny punkt nie może zostać usunięty, zanim inny nie zostanie ustawiony jako domyślny

NoteRóżne punkty odbioru posiadają różne dostępne godziny, w których może zostać zlecony odbiór przesyłki → sprawdź tutaj

Połącz z kontem InPost

Ten przycisk odpowiada za połączenie z API International. Po naciśnięciu następuje przekierowanie do panelu logowania. Tam należy podać login/email i hasło.

Po wprowadzeniu poprawnych danych użytkownik jest przekierowywany do aplikacji a przycisk staje się nieaktywny oraz wyświetla informacje o aktualnie zalogowanym koncie. Aplikacja nie wymaga ponownego logowania się, powiązanie z kontem jest trwałe.

image-20250113-105759.pngImage Removed

  • [Usuń powiązanie] Istnieje możliwość usunięcia powiązania poprzez wybranie opcji Usuń powiązanie w wyniku której wyświetla się komunikat z prośbą o potwierdzenie usunięcia powiązania konta (konto użytkownika nie jest usuwane a tylko odłączane, pozostałe dane w aplikacji również pozostają nienaruszone). 

Typ API

Środowisko, które jest aktualnie włączone

  • Sandbox - służy do testowania usług InPost. Umożliwia generowanie przesyłek, zlecanie fikcyjnych podjazdów czy pobieranie etykiety bez opłat

  • Produkcja - wykorzystanie wtyczki do faktycznego tworzenie przesyłek i zlecenia odbioru przez kuriera

    This button is responsible for connecting to API International. When pressed, you are redirected to the login panel. There you need to enter login/email and password.

    After entering the correct data, the user is redirected to the application and the button becomes inactive and displays information about the currently logged in account. The application does not require logging in again, the association with the account is permanent.

    image-20250113-105759.pngImage Added

    • [Delete linkage] It is possible to delete the linkage by selecting Delete linkage, as a result of which a message is displayed asking you to confirm the deletion of the account linkage (the user account is not deleted but only disconnected, other data in the application also remains intact).

    Typ API

    The environment that is currently enabled

    • Sandbox - is used to test InPost services. Allows you to generate shipments, order fictitious pick-ups or download the label without payment

    • Production - using the plugin to actually create shipments and order courier pickup

    Panel
    panelIconIdatlassian-info
    panelIcon:info:
    bgColor#FFF0B3

    Środowisko testowe sandbox nie jest wymagane do uruchomienia aplikacji, która może być uruchomiona od razu w trybie produkcyjnym.

    Status wtyczki

    Checkbox pozwalający włączyć lub wyłączyć wtyczkę wraz z widocznością na checkoucie strony

    image-20250113-110745.pngImage Removed

    Usługi

    Zakładka umożliwia konfigurację usług wysyłki

    Note

    Pamiętaj o uzupełnieniu wszystkich sekcji w zakładce Usługi aby aplikacja była możliwa do włączenia udostępnienia użytkownikom. Przed opuszczeniem strony zapisz ustawienia.

    A sandbox test environment is not required to run the application, which can be run immediately in production mode

    Status wtyczki

    Checkbox to enable or disable the plug-in along with visibility on the checkout page

    image-20250113-110745.pngImage Added


    Services

    The tab allows you to configure shipping services

    Note

    Be sure to complete all sections in the Services tab so that the application can be enabled to share with users. Before leaving the page, save your settings

    Wybierz usługi

    The user can activate the services available to customers:

    • can change the service's own name

    • can select the number of points showing near the customer's address

    • indicates the available type of pickup points showing in the shopping cart (Parcel Machine/Parcel Point/Parcel and Parcel Post)

    • can define the delivery cost for the service

    • can define the cost at which free delivery starts

    • can define the maximum allowed weight

    • can upload a graphic of the service (or overwrite the defined one), this option is only possible for Plus customers (requires checkout access)

    image-20250113-111636.pngImage Added

    Ustawienia nadania

    Default parameters for created shipments:

    • several dimensions can be defined

    • the default dimension is the first to be selected when creating the shipment

    • once a dimension is used, it cannot be modified

    • default dimension cannot be deleted until another dimension is set as default.

    Note

    Please note the maximum available dimensions supported by the service

    Shopify does not collect product dimensions; only the weights of individual products, which are optional from the product level

    Image Added

    Punkt odbioru przez kuriera

    In a similar way to parcel dimensions, you can define available pick-up points for which you can create drive-up orders in the next step:

    • several points can be defined

    • the default point is prompted as the first one when creating a shipment

    • once used a point cannot be modified

    • a default point cannot be deleted until another one is set as default

    Note

    Different pickup points have different available hours when you can have your shipment picked up → check here: https://inpost.pl/godziny-odbiorow

    Zadbaj o to aby wprowadzony adres był zrozumiały dla kuriera.Ensure that the address entered is understandable to the courier

    Osoba kontaktowa

    W podobny sposób do wymiarów paczek można zdefiniować osoby kontaktowe powiązane z tworzonymi zleceniami odbioru przesyłek:

  • możliwe jest zdefiniowanie kilku osób kontaktowych

  • domyślny kontakt  jest jako pierwszy podczas tworzenia przesyłki

  • raz użyty kontakt nie może zostać zmodyfikowany

  • domyślny kontakt nie może zostać usunięty, zanim inny nie zostanie ustawiony jako domyślny

  • osoba kontaktowa nie jest widoczna na etykiecie nadawczej

    In a similar way to parcel dimensions, you can define contact persons associated with the created parcel collection orders:

    • it is possible to define several contact persons

    • default contact is as first when creating a shipment

    • once used, the contact cannot be modified

    • default contact cannot be deleted before another one is set as default

    • the contact person is not visible on the shipment label

    Domyślna wartość ubezpieczeniaUmożliwia ustawienia kwoty ubezpieczenia jako domyślna - będzie przypisywać się do każdej z przesyłek

    Allows you to set the insurance amount as the default - it will be assigned to each shipment

    image-20250113-112656.png

    NadawcaDane nadawcy, które pojawią się na etykiecie i w systemie InPost

    Shipper data that will appear on the label and in the InPost system


    Przesyłki

    Shipments -

    zarządzanie Miejsce do zarządzania zamówieniami i przesyłkami. Możemy zarządzać nimi masowo lub wchodząc w poszczególne zamówienia

    management

    A place to manage orders and shipments. We can manage them in bulk or by going into individual orders.

    Panel
    panelIconIdatlassian-info
    panelIcon:info:
    bgColor#FFBDAD

    Uwaga: zamówienie, które korzysta z dostawy InPost  pojawi się automatycznie w aplikacji w zakładce Przesyłki

    Lista/Filtrowanie

    Tabela zawiera następujące kolumny:

    • checkbox do zaznaczania przesyłek pojedynczo lub wszystkich na liście

    • numer przesyłki (link do szczegółów/trackingu, odnośnik zewnętrzny, nowa karta)

    • numer zamówienia, link do szczegółów zamówienia

    • status przesyłki 

    • cena przesyłki

    • usługa

    • cechy przesyłki

    • sposób nadania

    • data stworzenia zamówienia

    • data nadania

    • dane odbiorcy

    • numer referencyjny

    • akcję drukuj dostępną również masowo

    Note: an order that uses InPost delivery will automatically appear in the app under the Shipments tab

    List/Filtering

    The table contains the following columns:

    • checkbox to select shipments individually or all in the list

    • shipment number (link to details/tracking, external link, new tab)

    • order number, link to order details

    • shipment status

    • shipment price

    • service

    • features of the shipment

    • method of shipment

    • date of order creation

    • date of shipment

    • recipient's data

    • reference number

    • print action also available in bulk

    Panel
    panelIconIdatlassian-info
    panelIcon:info:
    bgColor#FFF0B3

    Zapoznanie się z kolejnymi zdarzeniami przesyłki możliwe jest po kliknięciu w pozycję “Nr przesyłki”. Użytkownik przekierowywany jest do systemu śledzenia InPost.
    Status przesyłki wyświetlany w tabeli dotyczy zlecenia odpowiedzialnego za stworzenie przesyłki.

    Image Removed

    Użytkownik ma możliwość przefiltrowania tabeli według następujących filtrów

    • nr przesyłki (pole tekstowe)

    • status przesyłki (lista wyboru)

    • data utworzenia zamówienia (datepicker)

    • data nadania przesyłki (datepicker)

    • usługa (lista wyboru)

    • sposób nadania (lista wyboru)

    • numer telefonu (pole tekstowe)

    • adres email (pole tekstowe)

    • numer referencyjny (pole tekstowe)

    Tworzenie przesyłek

    Poprzez naciśnięcie przycisku image-20250113-114355.pngImage Removed (Przycisk jest dostępny dla zamówień, dla których nie wygenerowano numeru przesyłki) możemy przejść do szczegółowego widoku na konkretne zamówienie w aplikacji InPost International

    • szczegóły zamówienia to specjalny widok wewnątrz aplikacji Shopify, w którym znajduje się pełne podsumowanie zamówienia użytkownika, wliczając w to produkty, całościowy koszt, dane adresowe i billingowe

    Note

    Szczegóły zamówienia aplikacji InPost nie są jednoznaczne ze szczegółami zamówienia Shopify (inny widok)

    Widok szczegółów zamówienia dzieli się na 2 sekcje

    • Sekcja lewa to dane klienta oraz szczegóły zamówienia

    • Sekcja prawa służy do generowania przesyłki

    Użytkownik może

    • zdefiniować usługę → domyślnie zaciągana jest usługa wybrana przez klienta na etapie zamówienia

    • zmienić wybrany przez klienta paczkomat

    • zmienić wybrany przez klienta adres odbioru

    • zdefiniować rozmiar przesyłki

    • zdefiniować wartość ubezpieczenia

    Image Removed

    Po weryfikacji danych należy kliknąć Utwórz przesyłkę - zostanie nadany numer przesyłki w polu “Numer przesyłki”

    Alternatywną ścieżką do utworzenia przesyłki jest:

    1. Otwarcie widoku zamówień Shopify, na którym widoczne są również szczegóły wysyłki do punktu:

    Image RemovedImage Removed

    1. Wyświetlenie szczegółów zamówienia oraz otwarcie menu z wyborem aplikacji “Utwórz przesyłkę InPost International”:

    Image Removed

    Pobieranie etykiet

    Po utworzeniu przesyłki użytkownik może pobrać etykietę  i przejść do śledzenia przesyłki:

    1. Klikamy Pobierz etykietę

    Image Removed

    1. Wybieramy Drukuj - automatycznie rozpocznie się pobieranie etykiety

    Image Removed

    Wyłączone produkty

    Korzystając z tej zakładki istnieje możliwość wyłączenia produktów dla których możliwe jest wybranie dostawy za pomocą InPost International.

    Image Removed

    Checkout - list punktów

    Przykładowy wygląd checkoutu z adresem we Francji:

    image-20250113-131444.pngImage Removed

    Getting acquainted with the consecutive events of the shipment is possible after clicking on the “Shipment No.” item. The user is redirected to the InPost tracking system.
    The shipment status displayed in the table refers to the order responsible for creating the shipment.

    Image Added

    The user can filter the table by the following filters:

    • shipment number (text field)

    • shipment status (selection list)

    • order creation date (datepicker)

    • date of shipment dispatch (datepicker)

    • service (selection list)

    • method of shipment (selection list)

    • phone number (text field)

    • email address (text box)

    • reference number (text field)


    Tworzenie przesyłek

    By pressing the button image-20250113-114355.pngImage Added (The button is available for orders for which a tracking number has not been generated.) We can go to a detailed view of a specific order in the InPost International app

    • order details is a special view inside the Shopify app that provides a full summary of the user's order, including products, total cost, address and billing information

    Note

    InPost app order details are not the same as Shopify order details (different view)

    The order details view is divided into 2 sections:

    • The left section is customer data and order details

    • The right section is used to generate the shipment

    The user can:

    • define a service → the service selected by the customer at the order stage is loaded by default

    • change the parcel machine selected by the customer

    • change the pickup address selected by the customer

    • define shipment size

    • define insurance value

    • method of shipment

    image-20250116-142715.pngImage Added

    After verifying the data, click Create Shipment - a shipment number will be assigned in the “Shipment Number” field

    An alternative path to create a shipment is:

    1. Opening the Shopify orders view, which also shows the shipping details to the point:

    Image AddedImage Added

    1. Display the details of the order and open the menu with the selection of the “Create InPost International shipment” application:

    Image Added


    Downloading labels

    Once the shipment has been created, the user can download the label and proceed to track the shipment:

    1. Click Download Label

    Image Added

    1. Select Print - it will automatically start downloading the label

    Image Added

    Excluded products

    Using this tab, it is possible to exclude products for which it is possible to choose delivery via InPost International

    Image Added


    Checkout - list of points

    An example of how checkout looks with an address in France:

    image-20250113-131444.pngImage Added


    Contact

    If you have any questions, please feel free to use our contact form available at the link https://inpost.pl/formularz-wsparcie . After entering the form, simply select Customer Support from the list, in the category select: InPost International module, and in the field Please provide the name of the module we specify: Shopify