Page Comparison

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 listingu produktów,

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

• Dodanie przycisku “Utwórz koszyk “Kup z InPost Pay” na stronie koszyka,

• Dodanie przycisku “Utwórz koszyk “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.

Link do wtyczki: (01.01.2023r)

…………………………………………………………..

Changelog:

1.0.0:Wtyczka: 30.09.2024r - 1.5.4.1

*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:

Wymagania

Do poprawnego działania wtyczka wymaga:

• PHP Woocommerce w wersji nie niższej niż 7.0.40 Woocommerce

• PHP w wersji nie niższej niż 7.3.04

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ą”

   Image RemovedImage Added

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 “Aktywuj wtyczkę”

Konfiguracja

1. 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

Image Added

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

Image Added

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

Image Added

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

Image Added

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

Image Added

6. 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.

Image Added

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

Image Added

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

Image Added

9. 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”.

Image Added

10. 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.

Image Added

11. 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.

Image Added

12. 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.

Image Added

13. 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.

Image Added

14. 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”.

Image Added

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.

Image Added

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

Image Added

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.

Image Added

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: [PL] WooCommerce

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.

Image Added

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. Wypełnij pola zgodnie z poniższą tabelą

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.

Opis dostępnych opcji:

Środowisko

Image Added

Pokazuj widget

Image Added

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 odwiedzającym ustaw Wszystkim. W celu pokazania widgetu testerom wybierz Testeromwykonaniu testów konfiguracji ustaw Każdemu.

Client ID

Image Added

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

Image Added

POS ID

Image Added

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

Image Added

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

Image Added

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

Image Added

Uwaga:

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

Status zamówienia dla zamówienia

opłaconego przez InPost Pay

Image Added

Status zamówień

Image Added

Maksymalna liczba produktów sugerowanych

Image Added

Do czego służy:	Jak ustawić:
Określa maksymalną liczbę produktów, jakie zostaną zasugerowane Twojemu klientowi w aplikacji

Inpost

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

Image Added

Ustawienia przekazywanych opisów

Image Added

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

Image Added

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

Image Added

Do czego służy:	Jak ustawić:
Określa opis wyświetlany w aplikacji	Wpisz opis, jaki ma zostać wyświetlony.

Czy wymagane

Image Added

Do czego służy:	Jak ustawić:
Określa czy zgoda jest wymagana	Wpisz wymagalność zgody z listy

Do czego służy:

Jak ustawić:

.

Info
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

Image Added

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

Image Added

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.

Cena:

Opcje dla PWW oraz COD

Cena

Image Added

Dostępne od

Image Added

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

Image Added

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.

Ustawienia GUI

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

Image Added

Wariant

Image Added

Image Added

Image Added

Zaokrąglenie

Image Added

Wyświetlaj

Image Added

Umiejscowienie

Image Added

Do czego służy:	Jak ustawić:
Dla podstron koszyka oraz zamówienia Woocommerce umożliwia dodawanie widgetów w różnych częściach podstronyOkreśla w jakiej części podstrony ma zostać wyświetlony widget. Poprawne działanie każdej z dostępnych opcji uwarunkowana jest poprawną implemenrtacją implementacją przez szablon używany przez Twój sklep.	Wybierz część podstrony z listy rozwijalnej.

Położenie

Image Added

Margines

Image Added

Wariant:

Marketing

W tej sekcji ustawisz możliwość zapisywania atrybucji do zamówienia.

Opis dostępnych opcji:

Włączenie gromadzenia i zapisywania atrybucji

Image Added

Widok w koszyku

Po konfiguracji wtyczki w koszyku przy produktach pojawi się przycisk Utwórz koszyk z InPost Pay:

Image Removed

Dezinstalacja

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

Baza danych

Wtyczka do poprawnego działania wykorzystuje tabelę w bazie danych o strukturze:

Hooks wykorzystywane

Filtry

Zasoby zewnętrzne

Nadpisywanie atrybucji

Image Added

Wyświetlanie w niestandardowym miejscu

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

1. Dla strony produktu

   Code Block
   <?php \Ilabs\Inpost_Pay\Lib\view\DisplayPlaceHolder::displayProductPlaceholder( $id = null, $styles = '' ); ?>

Opis parametrów:

2. Dla strony koszyka

   Code Block
   <?php \Ilabs\Inpost_Pay\Lib\view\DisplayPlaceHolder::displayCartPlaceholder( $styles = '' ); ?>

Opis parametrów:

3. Dla strony checkout

   Code Block
   <?php \Ilabs\Inpost_Pay\Lib\view\DisplayPlaceHolder::displayCheckoutPlaceholder( $styles = '' ); ?>

Opis parametrów:

4. Dla strony logowania

   Code Block
   <?php \Ilabs\Inpost_Pay\Lib\view\DisplayPlaceHolder::displayLoginPagePlaceholder( $styles = '' ); ?>

Opis parametrów:

5. Dla mini koszyka

   Code Block
   <?php \Ilabs\Inpost_Pay\Lib\view\DisplayPlaceHolder::displayMinicartPlaceholder( $styles = '' ); ?>

Opis parametrów:

6. Dla strony zamawiania

   Code Block
   <?php \Ilabs\Inpost_Pay\Lib\view\DisplayPlaceHolder::displayOrderPlaceholder( $styles = '' ); ?>

Opis parametrów:

Programowalne akcje

• Akcja: inpostpay_invoice_details

Przypisanie danych bilingowych do własnego meta w procesie zamówienia. Dzięki tej funkcji możesz zapisać dane bilingowe do własnych danych meta lub danych meta wymaganych przez firmy trzecie. Dane jakie można pobrać za pomocą funkcji:
country_code, tax_id_prefix, tax_id, company_name,  name, surname, city, street, building, flat, postal_code, mail, registration_data_edited, additional_information
Przykładowe użycie:

add_action('inpostpay_invoice_details', 'inpostpay_invoice_details', 10, 2);

	function inpostpay_invoice_details($order, $invoice_details) {
    	if ( isset( $invoice_details->tax_id ) ) {
        	$order->update_meta_data( 'moje_pole_meta_vat', $invoice_details->tax_id_prefix ?? '' . $invoice_details->tax_id );
    	}
	}

• Akcja: inpost_pay_store_custom_cookies

Pozwala zapisać i odtworzyć dodatkowe ciasteczka podczas procesu zamówienia. Niektóre wtyczki afiliacyjne mogą wymagać dodatkowych ciasteczek w celu poprawnego rozliczania kampanii. Domyślnie InPost Pay gromadzi ciasteczka tylko i wyłączenie wymagane do poprawnego działania.
UWAGA: Ta opcja może nie zadziałać na każdym serwerze.

Przykładowe użycie:

add_action(‘inpost_pay_store_custom_cookies’, 'inpost_pay_my_cookies_to_store', 10, 2);

	function inpost_pay_my_cookies_to_store($cookies) {
    	$cookies = [‘nazwa_ciasteczka_1’,’nazwa_ciasteczka_2’]
    	}
	}

Dezinstalacja

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