InPost Pay - Woocommerce

 

 

Dokumentacja techniczna wtyczki InPost Pay dla Woocommerce. Wtyczka dodaje do sklepu Woocommerce funkcjonalność dokonywania zamówień przez aplikację InPost przez:

  • Dodanie tabeli w bazie danych,

  • Dodanie przycisku “Utwórz koszyk z InPost Pay” na karcie produktu,

  • Dodanie przycisku “Kup z InPost Pay” na stronie koszyka,

  • Dodanie przycisku “Kup z InPost Pay” na stronie zamówienia,

  • Akcji wykonywanych na standardowe hook’i,

  • Dodaniu pola na stronie zamówienia,

  • Dodaniu sekcji administracyjnej,

  • Udostępnienia REST API,

  • Dołączenia do strony pliku JS serwowanego z webserwera oraz pliku serwowanego z zasobu zewnętrznego.

 

Wtyczka: 06.06.2024r - 1.5.2.8

*Wtyczka obecnie jest jeszcze rozwijana, będą pojawiały się nowe wersje wtyczki, śledź changelog i instaluj nowe wersje, jak tylko będą dostępne.

Changelog:

  • Nowa wersja 06.06.2024r - 1.5.2.8

  • 27.05.2024r - 1.5.2.7

  • 06.05.2024r - 1.5.2.5

  • 15.04.2024r - 1.5.2.2

  • 11.04.2024r - 1.5.2.1

  • 28.03.2024r - 1.5.1.9

  • 21.03.2024r - 1.5.1.8

  • 11.03.2024r - 1.5.1.5

  • 01.03.2024r - 1.5.1.4

  • 18.01.2024r - 1.4.7

  • 13.12.2023r - 1.4.6

  • 01.12.2023r - 1.4.5

  • 24.11.2023r - 1.4.4

  • 26.10.2023r - 1.4.3

  • 23.10.2023r - 1.4.1

  • 16.10.2023r - 1.4.0

  • 12.10.2023r - 1.3.46

  • 04.10.2023r - 1.3.45

  • 25.09.2023r - 1.3.44

  • 31.08.2023r - 1.3.43

  • 28.08.2023r - 1.3.42

  • 23.08.2023r - 1.3.41

  • 23.08.2023r - 1.3.40

  • 17.08.2023r - 1.3.38


Wymagania

 

Do poprawnego działania wtyczka wymaga:

  • Woocommerce w wersji nie niższej niż 7.0.0

  • PHP w wersji nie niższej niż 7.4


 

Instalacja / Aktualizacja

W celu instalacji wtyczki postępuj zgodnie z poniższymi krokami:

  1. Pobierz spakowaną wtyczkę Woocommerce ze strony InPost i nie rozpakowuj jej

  2. Zaloguj się do sekcji administracyjnej swojego sklepu

  3. Z menu po lewej stronie wybierz “Wtyczki” a następnie “Dodaj nową

  4. Na górze strony wybierz “Wyślij wtyczkę na serwer” następnie “Wybierz plik” i odszukaj spakowaną wtyczkę pobraną w punkcie 1

  5. Kliknij “Zainstaluj

  6. W następnym oknie kliknij “Włącz wtyczkę

W celu aktualizacji wtyczki postępuj zgodnie z powyższymi krokami. Przy aktualizacji wtyczki ustawienia nie kasują się.


 

Konfiguracja Testowa

W tym rozdziale opisujemy skrócony proces konfiguracji potrzebny do przeprowadzenia testów działania integracji z InPost Pay. W celu wstępnej konfiguracji przejdź do sekcji administracyjnej sklepu i kliknij “InPost Pay” w menu po lewej stronie. Po jego kliknięciu pokaże się formularz umożliwiający konfigurację wtyczki. Wypełnij pola zgodnie z poniższą listą:

 

  1. Wybierz środowisko i opcje wyświetlania
    a. Środowisko ustaw na “Sandbox” - w ten sposób przetestujesz proces zakupowy na środowisku testowym.
    b. Pokazuj widget ustaw na “Testerom” - w ten sposób widget będzie widoczny tylko dla osób, które mają go zobaczyć. Ustawienie innej opcji wyświetli widget działający bądź nie wszystkim osobom odwiedzającym Twój sklep.
    W celu wyświetlenia widgetu w przeglądarce internetowej wpisz adres Twojego sklepu z dopiskiem ?showIzi=true
    Przykład: https://mojsklep.pl?showIzi=true

 

 

  1. Wypełnij dane dostępowe do API, które otrzymałeś od InPost w polach
    a. Client
    b. Client Secret

 

  1. Pole POS ID wypełnij zgodnie z wartością otrzymaną od InPost

 

 

  1. Włącz możliwość płatności

 

  1. Wybierz status zamówienia, jakie zostanie nadane zamówieniom opłaconym poprzez InPost Pay.

  1. Sprawdź czy słownik statusów zamówień jest zgodny z tym, co rzeczywiście prezentujesz w komunikacji klientom. Sekcja ta wykorzystywana jest w sklepach, które mają nietypowy proces zakupowy. Sekcja ta będzie różna w różnych sklepach bo przedstawia statusy w Twoim sklepie.

 

  1. Wpisz ile produktów sugerowanych chcesz prezentować w aplikacji InPost. Szczegółowy opis działania tego mechanizmu opisany jest w rozdziale Produkty sugerowane.

 

 

  1. Dodaj zgody, które będą wymagane w Twoim sklepie. Szczegółowy opis każdej z opcji znajdziesz w rozdziale Pełna Konfiguracja.

 

  1. Ustawienia doliczania VAT dotyczą sklepów, w których istnieje nietypowy system naliczania cen wysyłki. Wróć do tego ustawienia jeśli ceny w aplikacji nie będą pokrywać się z cenami w sklepie. Konfiguracja znajduje się w zakładce “Koszty transportu”.

 

  1. Połącz wysyłkę Kurierem z wysyłką systemową. Po wybraniu z listy rozwijalnej sposobu wysyłki te same reguły dostępności i cen dla wybranej metody będą obowiązywać dla wysyłki Kurierem w aplikacji InPost.

  1. Tę część w podstawowej konfiguracji możesz pominąć. Określa ona ceny dodatkowych opcji wysyłki dla opcji Kurier - Paczka w Weekend oraz płatności przy odbiorze oraz dni i godziny między którymi te opcje będą dostępne dla Twoich klientów. Pełny opis znajdziesz w rozdziale Pełna Konfiguracja.

 

  1. Połącz wysyłkę przez Paczkomat z wysyłką systemową. Po wybraniu z listy rozwijalnej sposobu wysyłki te same reguły dostępności i cen dla wybranej metody będą obowiązywać dla wysyłki Paczkomat w aplikacji InPost.

 

  1. Tę część w podstawowej konfiguracji możesz pominąć. Określa ona ceny dodatkowych opcji wysyłki dla opcji Paczkomat - Paczka w Weekend oraz płatności przy odbiorze oraz dni i godziny między którymi te opcje będą dostępne dla Twoich klientów. Pełny opis znajdziesz w rozdziale Pełna konfiguracja.

 

  1. Określ gdzie widget powinien być dostępny na Twojej stronie. Możesz wyświetlać go na karcie produktu oraz w koszyku. Dla każdego miejsca wyświetlania możesz określić, do której strony przycisk InPost Pay będzie wyrównany. Dla każdego miejsca możesz osobno wybrać, czy tło na stronie jest jasne czy ciemne co zapewnia poprawne wyświetlanie tekstów. Dla każdego miejsca możesz oddzielnie wybrać wariant wyświetlania. Przycisk może być czarny bądź żółty. Całość konfiguruje się w zakładce “Wygląd przycisków”.

 


 

 

Konfiguracja Produkcyjna

Po poprawnej konfiguracji testowej i upewnieniu się, że integracja w środowisku Sandbox działa należy udostępnić InPost Pay wszystkim użytkownikom.

W celu konfiguracji przejdź do listy modułów i kliknij “Konfiguruj” obok modułu InPpost Pay. Po jego kliknięciu pokaże się formularz umożliwiający konfigurację wtyczki.

Zmień konfigurację zgodnie z poniższą listą:

  1. Wybierz środowisko i opcje wyświetlania
    a. Środowisko ustaw na “Produkcyjne” - w ten sposób podczas składania zamówień będą wykonywane produkcyjne płatności
    b. Pokazuj widget ustaw na “Każdemu” - w ten sposób widget będzie widoczny dla wszystkich klientów sklepu.

 

 

  1. Pole POS ID ustaw zgodnie z umową z InPost

 


 

 

Produkty sugerowane

Aplikacja InPost podczas dokonywania zakupów z InPost Pay sugeruje produkty do dodania do koszyka zgodnie z wbudowanym w WooCommerce systemem Produktów Powiązanych.

Jak wyświetlić produkty sugerowane w aplikacji?

W celu pokazania produktów sugerowanych należy uzupełnić sekcję Produktów Powiązanych w konfiguracji produktu WooCommerce.

W tym celu:

1. Przejdź do edycji produktu w Twoim sklepie.

2. W panelu Dane Produktu wybierz sekcję “Powiązane produkty”.

3. Wypełnij sekcje “pu-sell” bądź “cross-sell” - produkty z obu sekcji będą widoczne w aplikacji.

 

 

Dlaczego na stronie widzę produkty sugerowane a w aplikacji nie?

Możliwe, że Twój sklep prezentuje produkty powiązane w niestandardowy sposób. Dzieje się tak na przykład przez to jak działa Twój szablon bądź jedna z zainstalowanych wtyczek. Jeśli Twój sklep prezentuje produkty sugerowane a nie widzisz ich w Aplikacji InPost upewnij się, że Produkty Powiązane są skonfigurowane zgodnie z instrukcją zawartą w akapicie powyżej.


 

Wtyczka logistyczna

InPost dostarcza dedykowaną wtyczkę do integracji z InPost dla Klientów WooCommerce. Wtyczka ta pozwala na w pełni zautomatyzowany przebieg procesu zakupowego łącznie z nadaniem numeru przesyłki i wysłaniem go do Twoich klientów przez aplikację InPost w procesie zakupowym InPost Pay.

Pobierz wtyczkę z: https://wordpress.org/plugins/inpost-for-woocommerce/

Dokumentacja: https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/61833233

 

Jak nadać paczkę jeśli mam wtyczkę logistyczną InPost?

Sposób wysyłki, adres oraz identyfikator paczkomatu automatycznie zostaną przekazane do wtyczki logistycznej. Ty nie musisz znać danych klienta. Musisz nadać paczkę zgodnie z instrukcją wtyczki.

 

Jak nadać paczkę jeśli nie mam wtyczki logistycznej InPost?

Na stronie zamówienia dokonanego przez InPost Pay dostępne są informacje mówiące o sposobie wysyłki oraz numerze paczkomatu w formie okienka. Skopiuj je i postępuj zgodnie z Twoim standardowym procesem nadawania paczek.


 

Pełna konfiguracja

Konfiguracja została podzielona na sekcje umożliwiające dostosowanie działania wtyczki do potrzeb sklepu.

Po instalacji wtyczki w menu po lewej stronie sekcji administracyjnej zobaczysz nowe menu “InPost Pay”. Po jego kliknięciu pokaże się formularz umożliwiający konfigurację wtyczki.

Ustawienia API

 

W tej sekcji ustawia się dane dostępowe do systemu, rodzaje obsługiwanych metod płatności oraz informacja wymieniane między InPost Pay a sklepem.

Dane dostępowe do środowiska sandbox uzyskasz pisząc maila na skrzynkę integracjapay@inpost.pl lub wypełniając formularz kontaktowy w opcji Dla Biznesu i zakładce Sandbox.

Dane produkcyjne otrzymasz po podpisaniu umowy o usługę InPost Pay i wygenerujesz poprzez panel Merchanta zgodnie z instrukcją.

 

Opis dostępnych opcji:

Środowisko

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa czy sklep wysyła dane do
środowiska testowego czy produkcyjnego

Kiedy testujesz integrację ustaw środowisko Sandbox.
Jeśli testy przebiegły pomyślnie i chcesz włączyć możliwość kupna przez InPost Pay ustaw środowisko Produkcyjne

 

Pokazuj widget

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Podczas testów nie chcemy, żeby widget InPost Pay wyświetlał się wszystkim klientom. Niezależnie od tego jakie środowisko zostało ustawione możesz tymczasowo ukryć widget i pokazywać go tylko wybranym osobom. W celu wyświetlenia widgetu w trybie tylko dla testerów wejdź na stronę główną sklepu i dodaj na końcu adresu url ?showIzi=true
Na przykład
https://outofthebox.pl?showIzi=true

Kiedy konfigurujesz integrację wybierz
Testerom.
W celu pokazania widgetu wszystkim już po
wykonaniu testów konfiguracji ustaw
Każdemu.

 

 

Client ID

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Dana dostępowa do API umożliwiająca działanie wtyczki.

Zgodnie z danymi otrzymanymi od InPost.

Client Secret

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Dana dostępowa do API umożliwiająca działanie wtyczki.

Zgodnie z danymi otrzymanymi od InPost.

 

POS ID

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Dana dostępowa do API

Zgodnie z danymi otrzymanymi od InPost.

 

Włącz płatności zgodne z podpisaną umową z Aion

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa, czy Twoi klienci będą mogli dokonywać płatności przez bramki płatnicze, które są zawarte w Twojej umowie z Aion takie jak Blik, Apple Pay, płatność kartą.

Zaznacz Tak jeśli metody mają być dostępne.

 

Włącz płatność przy odbiorze zgodnie z podpisaną umową z InPost

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa, czy Twoi klienci będą mogli dokonywać płatności przy odbiorze zgodnie z umową z InPost

Zaznacz Tak jeśli metoda ma być dostępna.

 

Wybierz dostępne metody płatności w aplikacji

 

Uwaga:

Opcja ta pojawi się dopiero po wprowadzeniu danych dostępowych do API i zapisaniu ustawień.

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa, jakie metody płatności będą widoczne dla klienta w aplikacji InPost.

Wybierz z listy dostępne metody płatności.

Status zamówienia dla zamówienia opłaconego przez InPost Pay

 

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa jaki status mają mieć zamówienia, które zostaną opłacone przez InPost Pay

Wybierz z listy status jakie mają mieć zamówienia opłacone.

 

Status zamówień

 

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa jakie nazwy statusów mają pojawić się w aplikacji InPost Pay (kolumna po prawej) dla zamówień w Twoim sklepie (kolumna po prawej)

Zweryfikuj czy poniższe statusy odpowiadają statusom, które Twój klient otrzymuje w komunikacji dotyczącej zamówienia.

 

Maksymalna liczba produktów sugerowanych

 

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa maksymalną liczbę produktów, jakie zostaną zasugerowane Twojemu klientowi w aplikacji InPost do produktów jakie już ma w koszyku. Produkty sugerowane pobierane są ze standardowego mechanizmu WooCommerce.

Wpisz maksymalną liczbę produktów.

 

Szybkość odpowiedzi SSE

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa co ile sekund będą pobierane i zwracane dane dla koszyka InPost od strony sklepu. A więc jak szybko nastąpi aktualizacji np. ilości produktów na przycisku, czy stan sparowania koszyka.

Wpisz liczbę w zakresie od 0,1 do 3,0

W przypadku szybkich serwerów zaleca się ustawienie mniejszego czasu, w przypadku wolniejszych wyższego czasu.

 

Ustawienia przekazywanych opisów

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa czy ma być pobierany pełny opis czy opis skrócony

Wybierz “Pełny opis” lub “Krótki Opis”

 


 

Zgody

Sekcja służy do ustawienia zgód wyświetlanych klientom w aplikacji InPost podczas zakupów z InPost Pay.

Dodawanie:
Po każdym zapisie formularze będziesz mógł dodać kolejną zgodę.

Usuwanie:
W celu usunięcia zgody pozostaw jej opis pusty i zapisz formularz.

 

Opis dostępnych opcji:

Adres zgody

 

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa stronę, na którą zostanie przekierowany Twój klient w celu przeczytania zgody. Strony widoczne na liście to standardowe strony dostępne w Wordpress.

Wybierz jedną ze stron Twojego sklepu z listy rozwijalnej.

Opis wyświetlany w aplikacji

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa opis wyświetlany w aplikacji

Wpisz opis, jaki ma zostać wyświetlony.

Czy wymagane

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa czy zgoda jest wymagana

Wpisz wymagalność zgody z listy.

 

Wskazówka:
Jeśli chcesz utworzyć jeden checkbox w aplikacji służący do akceptacji więcej niż jednego dokumentu stwórz stronę, na której umieścisz odnośniki do wszystkich wymaganych zgód.


 

Cena transportu netto

Sekcja odpowiedzialna za mapowanie form transportu oraz określenie dostępności i cen opcji dodatkowych transportu

Opis dostępnych opcji:
Ustawienia tej sekcji są analogiczne dla wszystkich typów wysyłki i dla wszystkich opcji
Poniżej generyczny opis gdzie jako typ wysyłki zostało użyte typ oraz opcja dla opcji wysyłki:

 

Dolicz VAT do ceny transportu

 

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa, czy doliczać podatek VAT do kosztów wysyłki.

Sprawdź czy kwoty wysyłki w aplikacji są takie same jak w sklepie.

Ceny i dostępności wysyłki typ mapuj z

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa, która z dostępnych w sklepie metod wysyłki określa ceny i zasady dla wysyłki typ. Lista zawiera standardowe, dostępne w Woocommerce metody wysyłki.

Wybierz wysyłkę dostępną w Twoim sklepie z listy rozwijalnej.

 

Opcje dla PWW oraz COD

Pamiętaj!
Poniższe opcje ustaw zgodnie z umową z InPost.

Cena

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Cena netto opcji wysyłki

Wpisz kwotę określającą cenę

 

Dostępne od

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa. od którego dnia tygodnia, i której godziny opcja jest dostępna.

Wybierz dzień i godzinę, od których opcja będzie dostępna dla Twoich klientów.

 

Dostępne do

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa do którego dnia tygodnia i której godziny opcja jest dostępna.

Wybierz dzień i godzinę, do których opcja będzie dostępna dla Twoich klientów.

 

 

 

 

Wygląd przycisków

Tu ustawisz czy i gdzie wyświetlać widget InPost Pay. Sekcja została podzielona na podsekcje odpowiadające różnym podstronom Twojego sklepu.

 

Opis dostępnych opcji:

Tło

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa czy widget znajduje się na jasnym czy ciemnym tle. Ustawienie ma wpływ na kolor czcionki.

Wybierz z listy rozwijalnej.

 

Wariant

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Widget dostępny jest w 2 wariantach kolorystycznych. Wybierz ten bardziej odpowiadający Twojemu sklepowi.

Wybierz wariant z listy rozwijalnej.

 

Zaokrąglenie

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Parametr, który określa styl ramek widgetu. Domyślnie widget jest prostokątny.

Wybierz zaokrąglenie z listy rozwijalnej.

 

Wyświetlaj

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa czy widget ma wyświetlać się na danej podstronie .

Zaznacz jeśli widget ma się wyświetlać.

 

Umiejscowienie

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa w jakiej części podstrony ma zostać wyświetlony widget. Poprawne działanie każdej z dostępnych opcji uwarunkowana jest poprawną implementacją przez szablon używany przez Twój sklep.

Wybierz część podstrony z listy rozwijalnej.

 

Położenie

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa orientację widgetu w dostępnej dla niego przestrzeni. Jeśli Twój szablon przeznacza wąską przestrzeń na widget ustawienie nie będzie miało wpływu na wygląd.

Wybierz orientację z listy rozwijalnej.

Margines

 

Do czego służy:

Jak ustawić:

Do czego służy:

Jak ustawić:

Określa marginesy widgetu na stronie koszyka.

W razie niepoprawnego wyświetlania widgetu na stronie koszyka dostosuj wyświetlanie dodając margines.


Wyświetlanie w niestandardowym miejscu

W celu wyświetlenia widgetu w niestandardowym miejscu użyj poniższego kodu w swoim szablonie:

\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' );

 

Opis parametrów:

Parametr

Opis

Wartości

Parametr

Opis

Wartości

productId

Id produktu, który zostanie dodany do koszyka przed parowaniem

int

name

Imię klienta, które otrzymujesz z API

string

maskedPhoneNumber

Zamaskowany numer telefonu, który otrzymujesz z API

string

inpost_basket_id

ID koszyka, który otrzymujesz z API

string

echo

Czy wyświetlać?

bool

addBasketId

Czy wyświetlać id koszyka w HTML?

bool

variationId

ID wariantu

int

count

Liczba produktów w koszyku

int

dark

Czy wyświetlić w ciemnym trybie?

bool

yellow

Czy wyświetlić wariant żółty?
Amarantowy zostanie wyświetlony domyślnie

bool

cart

Czy znajdujemy się na stronie koszyka?

bool

float

CSS float

left | right | center

bindingPlace

Miejsce parowania

PRODUCT_CARD |
BASKET_POPUP |
BASKET_SUMMARY

 


 

Dezinstalacja

 

Dezinstalacja wtyczki usuwa pliki wtyczki. Baza danych i dane nie zostają zmienione.