Wstęp

Dokumentacja techniczna wtyczki InPost Pay dla Woocommerce z obsługą Widget 2.0.

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: 02.04.2025r - 2.0.0.1

Changelog

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

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

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

4. Pole Merchant ID wypełnij zgodnie z wartością otrzymaną od InPost
   

   

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

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

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

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

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

10. Określ, które wysyłkowe metody bazowe, wspiera proces zakupowy Twojego sklepu.

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

12. Tę część w podstawowej konfiguracji możesz pominąć. Określa ona ceny dodatkowych opcji wysyłki dla opcji Kurier. Pełny opis znajdziesz w rozdziale Pełna Konfiguracja.

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

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

15. Tę część w podstawowej konfiguracji możesz pominąć. Określa ona czy dostępność metod wysyłki ma być dodatkowo sprawdzana dla produktów w koszyku na podstawie szczegółowych ustawień wtyczki logistycznej InPost. Pozostaw tę opcję wyłączoną, jeżeli nie korzystasz z oficjalnej wtyczki logistycznej InPost.

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

2. Uzupełnij pola Client ID, Client Secret, POS ID oraz Merchant ID wartościami pobranymi z panelu merchanta. Pełną instrukcję generowania danych dostępowych do API dla środowiska produkcyjnego znajdziesz tutaj.

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: [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.

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.

Opis dostępnych opcji:

Środowisko

Pokazuj widget

Client ID

Client Secret

POS ID

Merchant ID

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

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

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

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

Status zamówień

Maksymalna liczba produktów sugerowanych

Ustawienia przekazywanych opisów

Zgody

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

Dodawanie:
Zgody można dodać za pomocą przycisku “+Dodaj zgodę”. Maksymalnie możesz dodać 10 zgód.
Usuwanie:
W celu usunięcia zgody naciśnij przycisk “Usuń” umieszczony przy danej zgodzie.

Dodawanie dodatkowych linków do zgód:
W celu dodania dodatkowego linku do zgody należy nacisnąć przycisk “+Dodaj dodatkowy link”. Maksymalnie w jednej zgodzie mogą być dodane 3 linki. Minimum jeden link jest wymagany.

Opis dostępnych opcji:

Adres zgody

Identyfikator linku

Tekst linku

Opisy widoczne w aplikacji

Czy wymagane

Koszt transportu

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

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

Wybierz metody dostawy

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

Mapuj z metodą wysyłki

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

Włącz lub wyłącz opcje dostawy

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

Sposób obliczania ceny dla dodatkowej opcji dostawy

Mapuj z metodą wysyłki (dla opcji dostawy)

Pamiętaj!
Jeżeli kupujący wybierze w aplikacji więcej niż 1 opcję (np. Pobranie + Paczka w weekend) wtedy w zamówieniu Woocommerce będzie widoczna metoda bazowa.

Dodatkowa prowizja

Dostępne od

Dostępne do

Ograniczenie dostawy Paczkomatem dla paczek powyżej 25kg

Integracja z wtyczką logistyczną InPost

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

Wariant

Zaokrąglenie

Widget size

Wyświetlaj

Umiejscowienie

Położenie

Margines

Marketing

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

Opis dostępnych opcji:

Włączenie gromadzenia i zapisywania atrybucji

Nadpisywanie atrybucji

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

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

Opis parametrów:

2. Dla strony koszyka

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

Opis parametrów:

3. Dla strony checkout

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

Opis parametrów:

4. Dla strony logowania

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

Opis parametrów:

5. Dla mini koszyka

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

Opis parametrów:

6. Dla strony zamawiania

   <?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->add_cookies( ['nazwa_ciasteczka_1','nazwa_ciasteczka_2'] );
    	}

• Akcja: inpostpay_delivery_point_details

Pozwala nadpisać pole z numerem paczkomatu według własnego uznania, np. wpisać je dodatkowo pod inną nazwą.
UWAGA: Ta opcja może nie zadziałać na każdym serwerze.

Przykładowe użycie:

add_action('inpostpay_delivery_point_details', 'save_custom_inpay_delivery_point', 10, 2); 

function save_custom_inpay_delivery_point($order, $delivery_point) {

    if ( ! empty( $delivery_point ) ) {

           $order->update_meta_data( 'deliveryPointId', $delivery_point );

    }

} 

Dezinstalacja

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