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 z InPost Pay” na stronie koszyka,
Dodanie przycisku “Utwórz koszyk 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:

Na tej stronie

Table of Contents

Instalacja

Podczas instalacji wtyczka dodaje do bazy danych tabelę opisaną w https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/132382721/InPost+Pay+-+Woocommerce#Baza-danych.

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

Pobierz spakowaną wtyczkę Woocommerce ze strony InPost i nie rozpakowuj jej
Zaloguj się do sekcji administracyjnej swojego sklepu
Z menu po lewej stronie wybierz “Wtyczki” a następnie “Dodaj nową”
Na górze strony wybierz “Wyślij wtyczkę na serwer” następnie “Wybierz plik” i
odszukaj spakowaną wtyczkę pobraną w punkcie 1
Kliknij “Zainstaluj”
W następnym oknie kliknij “Aktywuj wtyczkę”

Konfiguracja

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

Nazwa pola

Opis

Środowisko

Którego środowiska dotyczą dane dostępowe

Pokazuj widget

Czy pokazywać widget wszystkim czy osobom, które w adresie strony dodadzą

parametr GET showIzi=true

Client ID

Identyfikator nadany przy zakładaniu konta

Client Secret

Klucz nadany przy zakładaniu konta

Metody płatności

Obsługiwane przez Twój sklep metody płatności

Dodatkowa zgoda

Wybierz stronę, która zawiera zgodę, którą musi zatwierdzić osoba kupująca w aplikacji

Status zamówienia dla AUTHORIZED

Status zamówienia, jakie otrzyma poprawnej płatności w aplikacji

Status zamówienia dla DECLINED

Ustawienie nieużywane

Status zamówienia dla CANCELLED

Ustawienie nieużywane

Status zamówienia dla ERROR

Ustawienie nieużywane

Kurier

Cena transportu jaka użytkownik zobaczy w aplikacji Inpost

Paczkomat

Cena transportu jaka użytkownik zobaczy w aplikacji Inpost

Paczka w Weekend

Cena transportu jaka użytkownik zobaczy w aplikacji Inpost

Pobranie

Cena transportu jaka użytkownik zobaczy w aplikacji Inpost

Umiejscowienie widgetu w koszyku

Wybór umiejscowienia widgetu na stronie koszyka

Umiejscowienie widgetu w zamówieniu

Wybór umiejscowienia widgetu na stronie zamówienia

Środowisko

Do czego służy:	Jak ustawić:
Określa czy sklep wysyła dane do środowiska testowego czy produkcyjnego	Kiedy testujesz integrację ustaw środowisko Testowe. 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ć:

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

W celu pokazania widgetu wszystkim
odwiedzającym ustaw Wszystkim.
W celu pokazania widgetu testerom wybierz
Testerom

Client ID:

Do czego służy:	Jak ustawić:
Dana dostępowa do API	Zgodnie z danymi otrzymanymi od InPost

Client Secret:

Do czego służy:	Jak ustawić:
Dana dostępowa do API	Zgodnie z danymi otrzymanymi od InPost

Metody Płatności:

Do czego służy:	Jak ustawić:
Określa jakie metody płatności będą dostępne dla klientów Twojego sklepu w aplikacji InPost	Zaznacz metody dostępne dla Twoich klientów

Status zamówienia dla zamówienia autoryzowanego:

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

Maksymalna liczba produktów sugerowanych:

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

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ć:
Określa stronę, na którą zostanie przekierowany Twój klient w celu przeczytania zgody	Wybierz jedną ze stron Twojego sklepu z listy rozwijalnej

Opis wyświetlany w aplikacji:

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ć:
Określa czy zgoda jest wymagana	Wpisz wymagalność zgody z listy

Do czego służy:	Jak ustawić:

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:

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

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	Wybierz wysyłkę dostępną w Twoim sklepie z listy rozwijalnej

Cena:

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

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:

Wyświetlaj:

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ć:
Dla podstron koszyka oraz zamówienia Woocommerce umożliwia dodawanie widgetów w różnych częściach podstrony. Poprawne działanie każdej z dostępnych opcji uwarunkowana jest poprawną implemenrtacją przez szablon używany przez Twój sklep	Wybierz część podstrony z listy rozwijalnej

Wyrównanie:

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

Tło:

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 orientację z listy rozwijalnej

Wariant:

Do czego służy:	Jak ustawić:
Widget dostępny jest w 2 wariantach kolorystycznych. Wybierz ten, bardziej odpowiadający Twojemu sklepowi	Wybierz orientację z listy rozwijalnej

Baza danych

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

Nazwa	Typ	Funkcja
`id`	MEDIUMINT	Klucz główny.
`session_id`	TEXT	Dane sesji użytkownika potrzebne do manipulacji koszykiem przez REST API.
`cart_id`	VARCHAR(255)	Identyfikator koszyka InPost Pay.
`order_id`	INT	ID zamówienia Woocommerce.
`redirect_id`	VARCHAR(255)	URL strony z podziękowaniem za zamówienie.

Hooks wykorzystywane

Hook	Zastosowanie
`woocommerce_add_to_cart`	Wysyłamy zawartość koszyka Woocommerce do InPost Pay.
`woocommerce_update_cart_action_cart_updated`	Wysyłamy zawartość koszyka Woocommerce do InPost Pay.
`woocommerce_cart_item_removed`	Wysyłamy zawartość koszyka Woocommerce do InPost Pay.
`woocommerce_cart_item_set_quantity`	Wysyłamy zawartość koszyka Woocommerce do InPost Pay.
`woocommerce_after_shop_loop_item`	Wyświetlamy przycisk “Utwórz koszyk z InPost Pay”.
`woocommerce_checkout_process`	Do zamówienia dodajemy billing_phone wydzielony połączony z prefiksu oraz numeru telefonu. Pola dodane w https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/132382721/InPost+Pay+-+Woocommerce#Filtry
`woocommerce_thankyou_order_received_text`	Dodajemy podziękowanie za zakupy renderowane przez kod z https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/132382721/InPost+Pay+-+Woocommerce#Zasoby-zewn%C4%99trzne
`woocommerce_set_cart_cookies`	Zapisujemy sesje użytkownika w bazie danych.
`woocommerce_before_cart` `woocommerce_before_cart_table` `woocommerce_before_cart_contents` `woocommerce_cart_contents` `woocommerce_cart_coupon` `woocommerce_after_cart_contents` `woocommerce_after_cart_table` `woocommerce_cart_collaterals` `woocommerce_before_cart_totals` `woocommerce_cart_totals_before_shipping` `woocommerce_before_shipping_calculator` `woocommerce_after_shipping_calculator` `woocommerce_cart_totals_after_shipping` `woocommerce_cart_totals_before_order_total` `woocommerce_cart_totals_after_order_total` `woocommerce_proceed_to_checkout` `woocommerce_after_cart_totals` `woocommerce_after_cart`	Wyświetlamy przycisk “Utwórz koszyk z InPost Pay” w jednym z wybranych miejsc. Hook możliwy do wyboru w sekcji administracyjnej.
`woocommerce_before_checkout_form` `woocommerce_checkout_before_customer_details` `woocommerce_before_checkout_billing_form` `woocommerce_after_checkout_billing_form` `woocommerce_before_checkout_shipping_form` `woocommerce_after_checkout_shipping_form` `woocommerce_before_order_notes` `woocommerce_after_order_notes` `woocommerce_checkout_after_customer_details` `woocommerce_checkout_before_order_review` `woocommerce_review_order_before_cart_contents` `woocommerce_review_order_after_cart_contents` `woocommerce_review_order_before_shipping` `woocommerce_review_order_after_shipping` `woocommerce_review_order_before_order_total` `woocommerce_review_order_after_order_total` `woocommerce_review_order_before_payment` `woocommerce_review_order_before_submit` `woocommerce_review_order_after_submit` `woocommerce_review_order_after_payment` `woocommerce_checkout_after_order_review` `woocommerce_after_checkout_form`	Wyświetlamy przycisk “Utwórz koszyk z InPost Pay” w jednym z wybranych miejsc. Hook możliwy do wyboru w sekcji administracyjnej.

Versions Compared

Old Version 10

New Version 11

Key

Wymagania

Instalacja

Konfiguracja

Środowisko

Pokazuj widget:

Client ID:

Client Secret:

Metody Płatności:

Status zamówienia dla zamówienia autoryzowanego:

Zgody

Adres zgody:

Opis wyświetlany w aplikacji:

Czy wymagane:

Cena transportu netto

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

Cena:

Dostępne od:

Dostępne do:

Ustawienia GUI

Wyświetlaj:

Umiejscowienie:

Wyrównanie:

Tło:

Wariant:

Widok w koszyku

Dezinstalacja

Baza danych

Hooks wykorzystywane

Filtry

Zasoby zewnętrzne