Developer Documentations[PL] Shopify

[PL] Shopify

Owned by Paweł Milewski, created
Last updated: Sept 27, 2023

 

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

Wtyczka dostępna jest na app strore Shopify

 

 

Shopify od 1 stycznia 2023 zmieniło zasady przyznawania dostępu dla Carrier Service API co pozwala naszej aplikacji działać dopiero od planu SHOPIFY

Do poprawnego działania Trybu Zaawansowanego (Shopify Plus) należy włączyć checkout.liquid i zainstalować aplikację ponownie

 

 

Wtyczka

17.05.2023

Marketplace Shopify

https://apps.shopify.com/inpost-oficjalna-aplikacja?locale=pl&search_id=d8ba9002-e8bf-4807-8eba-ebfc96402a1c&surface_detail=inpost&surface_inter_position=1&surface_intra_position=8&surface_type=search

 

! Po instalacji wtyczki należy dodać adres webhook w panelu Manager Paczek:

Manager Paczek → Moje Konto → API → Ustawienia Organizacji → Adres Webhook i podajemy:

Produkcja: https://shop-plugin-api.inpost.pl/api/inpost/webhook

Sandbox: https://inpost-dev-api.sintraconsulting.pl/api/inpost/webhook




Na tej stronie:



Autoryzacja

Środowisko produkcyjne

Przed przystąpieniem do instalacji należy posiadać dane dostępowe do połączenia z API:

  • Access Token

  • ID organizacji

Pobierz poradnik wyjaśniający jak szybko we własnym zakresie utworzyć dostęp do API ShipX:

https://inpost.pl/sites/default/files/2022-03/instrukcja-konfiguracji-api-shipx.pdf

Środowisko testowe

Generowanie dostępu

https://sandbox-manager.paczkomaty.pl/ > zakładka Moje konto > API. 

Aby wygenerować Token i ID organizacji należy uzupełnić wszystkie dane, łącznie z danymi do faktury w zakładce Moje konto > Dane. Do utworzenia przesyłki Paczkomat® niezbędne są środki na koncie, konto doładujesz wirtualnie w zakładce Płatności.

Ważne!

  1. Tryb Sandbox dostępny jest tylko wówczas, gdy żadne zamówienie produkcyjne nie zostało jeszcze przeprocesowane przez aplikację.

  2. Z uwagi na ograniczenia wyświetlania punktów POP w mapach testowych w aplikacji zostały użyte mapy produkcyjne, aby umożliwić podgląd wyboru domyślnych Paczkomatów lub Paczkopunktów.

Aby utworzyć przesyłkę w trybie testowym z nadaniem Paczkomat lub POP, należy podać ręcznie dane. 

  • Paczkomat: WAW099, AND01A, BBI01N

  • Paczkopunkt: POP-004-TEST

 

Instalacja wtyczki

 

Zainstaluj aplikację ze sklepu Shopify App Store

Kroki:

  • Zaloguj się do Shopify App Store

  • Znajdź aplikację Inpost, 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:https://help.shopify.com/pl/manual/apps/installing-apps

 

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

 

 

Konfiguracja wtyczki

 

W celu konfiguracji wtyczki przechodzimy do aplikacji InPost. Pojawia się tam kilka zakładek poniżej informację co oznaczają:

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

Po zapisaniu ustawień, pojawi się wiadomość potwierdzająca.

 

Ważne! Gdy pojawi się komunikat “Błędny token” należy usunąć wpisane dane.

  1. Odświeżyć stronę

  2. Przestawić Tryb API na Produkcję

  3. Status wtyczki ustawić na Włączona

  4. Zapisać ustawienia

  5. Teraz można dodać token i ID organizacji

  6. Zapisać ustawienia

Autoryzacja (Dane logowania)

 

ID organizacji

Należy uzupełnić z Manager Paczek (zakładka Moje konto - API, format – 5 cyfr)

Autoryzacja (Token API)

Umożliwia konfigurację dostępu do API ShipX (Produkcyjnego i Sandboxowego). Dane jak ID organizacji oraz token można uzyskać z Manager Paczek. Opisaliśmy to w pierwszej części tej dokumentacji Autoryzacja

Autoryzacja (Token Geowidget) Shopify Plus

Umożliwia dodanie Tokenu do Geowidget (do poprawnego działania mapy z punktami InPost należy wygenerować token Geowiedget)

Tryb API

Sandbox/Produkcja

Status wtyczki

Deaktywacja wtyczki nie wpłynie na procesowane zamówienia. Nowi klienci nie będą mogli korzystać ze zdefiniowanych w ustawieniach metod dostawy.

 

WIDOK NA PANEL GŁÓWNY

Usługi

 

Tryb

Należy wybrać plan, który Państwo posiadają w sklepie:

 

Standard: nie wyświetla mapy Geowidget, nie ma możliwości wgrania logo usługi

Zaawansowany (Shopify Plus): pojawia się mapa Geowidget, jest możliwość wgrania logo usługi

 

 

Standardowy:

Zawansowany:

 

Metody dostawy

Pozwala skonfigurować metody dostawy:

  • nazwa usługi

  • liczba paczkomatów, które wyświetlą się w koszyku (najbliższe od adresu, który podał klient)

  • koszt dostawy

  • próg darmowej dostawy

  • maksymalną dopuszczalną wagę dla produktów przy których ta usługa dostawy będzie się wyświetlać w koszyku

  • pozycjonowanie usług (poprzez kliknięcie w strzałkę do góry lub w dół)

  • logo (tylko przy Shopify Plus)

! Ważne jest ustawienie wagi dla poszczególnych produktów w sklepie

 

Przykład

 

Poradnik implementacji dostaw znajdziesz pod adresem:
https://inpost.pl/sites/default/files/docs/regulaminy/instrukcja-ekspozycji-dostawy-paczkomat-inpost-247-w-twoim-sklepie-777232.pdf

 

Dodatkowo dla Paczki w Weekend nalezy podać:

  • Dostępność od / do  dnia tygodnia

  • Dostępność od / do godziny

Szybkie Zwroty

Umożliwia konfigurację usługi Szybkie Zwroty

  1. W konfiguracji wtyczki należy podać link do formularza Szybkich Zwrotów (np. https://szybkiezwroty.pl/pl/Nazwa_sklepu). Link tworzy się po założeniu konta w tej usłudze poprzez Przedstawiciela Handlowego

  2. Po dodaniu skróconej nazwy zostanie wygenerowany kod. Kod umożliwia wyświetlenie przycisku przycisk Zwróć w panelu klienta skepu. Kod należy skopiować i dodać w szablonie sklepu zgodnie z poniższą instrukcją.

* Uzupełnij skróconą nazwę swojego konta założonego w serwisie Szybkie Zwroty

* Po dodaniu skróconej nazwy zostanie wygenerowany kod. Kod umożliwia wyświetlenie przycisku przycisk 'zwróć' w panelu klienta skepu. Kod należy skopiować i dodać w szablonie sklepu zgodnie z poniższą instrukcją.

 

1. Zapoznaj się z instrukcją Shopify Edytowanie kodu szablonu · Centrum Pomocy Shopify Z panelu administracyjnego Shopify przejdź do opcji: Sklep online > Szablony.

2. Upewniamy się, że nasz sklep korzysta z klasycznego panelu klienta oraz czy masz dostęp do edycji kodu szablonu.

 

3. Zweryfikuj, który z poniższych plików możesz edytować w Twoim sklepie

 

Ścieżka dla templates/customers/order.json

1. Znajdujemy w pliku templates/customers/order.json nazwę sekcji, której używa nasz szablon

 

 

2. W powyższym przypadku jest to main-order, a więc ścieżka do pliku sekcji jest następująca: sections/main-order.liquid

Edytujemy plik sections/main-order.liquid dodając kod embed z aplikacji pod tabelą ze szczegółami zamówienia.

 

 

Ścieżka dla templates/customers/order.liquid

Edytujemy plik templates/customers/order.liquid dodając kod embed z aplikacji pod tabelą ze szczegółami zamówienia.

 

 

EFEKT:

 

 

Zwroty dokonywane poprzez formularz posiadają 2 opcje akceptacji:

  1. Automatyczny - klient w momencie uzupełnienia formularza otrzymuje kod zwrotu, który musi podać będąc przy maszynie

  2. Ręczna akceptacja - klient składa formularz ale to Państwo akceptują bądź nie dany zwrot. Dopiero po akceptacji klient otrzymuje kod zwrotu

 

Domyślna wartość ubezpieczenia

Domyślna kwota, która będzie wyświetlać się podczas tworzenia przesyłek InPost (puste wskazuje 0)

Ustawienia nadania

  • pozwala ustawić domyślny rozmiar paczki, który będzie automatycznie podstawiał się podczas tworzenia paczki

  • domyślny sposób nadania przesyłek paczkomatowych

  • domyślny paczkomat nadawczy dla przesyłek paczkomatowych

  • domyślny punkt POP

Punkt odbioru

Miejsce do zdefiniowania punkt odbioru paczek podczas tworzenia zlecenia podjazdu

Można punkty dodawać, usuwać i edytować

Nadawca

Należy określić nadawcę paczek - wszystkie pola muszą być uzupełnione

 

 

Przesyłki - 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.

Uwaga: zamówienie, które korzysta z dostawy InPost  pojawi się automatycznie w aplikacji

Jest widok na wszystkie ważne informację - nr przesyłki, nr zamówienia, status, cena, usługa, sposób nadania, nr telefonu, email odbiorcy, czy nadano paczkę i data.

 

Filtrowanie przesyłek

  • Sposób nadania

  • Status

  • Usługa

  • Ilość pokazanych przesyłek na stroniw

  • Nr referencyjny

  • Nr zamówienia

  • Nr telefonu

  • E-mail odbiorcy

 

Lista przesyłek

Na liście przesyłek dostępne są kolumny:

 

Checkbox — służy do wykonywania grupowych akcji jak:

 

  • Zamawianie podjazdu 

  • Drukowanie etykiet

  • Drukowanie etykiet zwrotnych

  • Drukuj zleceń odbioru

 

 

Nr przesyłki:

 

  • Nr przesyłki utworzony: kliknięcie przenosi do śledzenia przesyłki

  • Nr przesyłki nie utworzony: kliknięcie w ‘+’ przenosi do ustawień danego zamówienia

Nr zam:

  • Unikatowy numer zamówienia dla systemu InPost

  • Jest to inny numer zamówienia, niż w danym sklepie Shopify

 

Status — status przesyłki danego zamówienia

Cena — łączna wartość zamówienia

Usługa — wybrana usługa dostawy

Sposób nadania — wybrany sposób nadania

Nr tel. - dane klienta, który złożył dane zamówienia

E-mail odbiorcy — dane klienta, który złożył dane zamówienia

Nadano — data nadania

Utworzono — data utworzenia

  • Drukuj etykietę

    • Akcja pozwala na wygenerowanie etykiet w 3 formatach PDF, format A6 / EPL / ZPL

    • Akcja jest dostępna po utworzeniu przesyłki

  • Drukuj etykietę zwrotną

    • Akcja dostępna tylko dla usług kurierskich

  • Drukuj zlecenie odbioru

    • Opcja dostępna po zamówieniu podjazdu

  • Zamów podjazd

    • Opcja umożliwia, zamówienie podjazdu dla wprowadzonych miejsc odbioru paczek. Wymagane jest wybranie lub zdefiniowanie miejsca odbioru

    • Opcja jest dostępna po wygenerowaniu numeru przesyłki

 

Dostępność akcji dla danego zamówienia, jest zależna od statusu. Np. jeżeli nie została utworzona przesyłka, wtedy żadne akcje nie są dostępne

 

Przesyłki - tworzenie przesyłek

 

Z poziomu Aplikacji w zakładce Przesyłki

W zakładce przesyłki znajdują się wszystkie zamówienia złożone w sklepie, dla których wybrana została forma dostawy InPost

 

Aby utworzyć przesyłkę należy:

  1. W kolumnie ‘Nr przesyłki ‘ należy kliknąć przycisk ‘+’

 

  • Przycisk jest dostępny dla zamówień, dla których nie wygenerowano numeru przesyłki

 

  1. Admin zostaje przeniesiony do szczegółów danego zamówienia. 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.

 

W panelu obsługi przesyłki admin może:

 

  • Usługa — zweryfikować lub zmienić wybraną formę dostawy

  • Paczkomat odbiorczy klienta — zweryfikować lub zmienić Paczkomat odbiorczy klienta

  • Status przesyłki — podgląd statusu przesyłki

  • Domyślny rozmiar paczki — wybrać rozmiar paczki, która zostanie nadana

  • Wartość ubezpieczenia — zmienić domyślną wartość ubezpieczenia [podaną w zakładce usługi

  •  Numer referencyjny

  • Sposób nadania

  • Punkt odbioru — lista punktów odbiorów dostępna dla danego sposobu nadania, punkty są dodawane w zakładce ‘usługi’

  • Numer przesyłki — Numer przesyłki zostanie automatycznie nadany po utworzeniu przesyłki

    1. Po wygenerowaniu numeru przesyłki można przejść bezpośrednio do  śledzenia przesyłki https://inpost.pl/sledzenie-przesylek  

    2. Po wygenerowaniu numeru przesyłki można również pobrać etykiety paczki

 

Z poziomu danego zamówienia

 

Przesyłkę InPost można utworzyć bezpośrednio z poziomu zamówienia, aby to zrobić należy:

  1. Wejść w dane zamówienie

  2. W prawym górnym rogu wybrać opcję ‘ More Actions’ > ‘Utwórz przesyłkę InPost’

  3. Admin zostanie przeniesiony do panelu tworzenia przesyłki w aplikacji Inpost

 

 

Zlecenia - podjazd kuriera

Panel do podglądu złożonych zleceń podjazdu

Kolumny: nr przesyłki, data nadania, punkty odbioru, status

 

 

Produkt

W każdym z produktów należy ustawić wagę by w zamówieniu można było wygenerować przesyłkę:

 

 

Pomoc

Miejsce z informacjami o dokumentacji (powyższej) i formularzem kontaktowym w celu dodatkowych pytań

 

 

 

Częste problemy

Uwaga ! Podano błędny token

Należy zweryfikować czy dane, które podajemy są poprawne. Jeśli tak to:

  1. Proszę usunąć wpisane dane

  2. Odświeżyć stronę

  3. Przestawić Tryb API na Produkcję

  4. Status wtyczki ustawić na Włączona

  5. Zapisać ustawienia

  6. Teraz można dodać token i ID organizacji

  7. Zapisać ustawienia

 

Podawanie numeru telefonu przy wybieraniu punkty odbioru

 

Problem z przekazywaniem numeru telefonu do aplikacji można rozwiązać poprzez umożliwienie podania numeru telefonu w sekcji 'dane adresowe' w kasie sklepu.

 

Aby włączyć opcję, należy w panelu admin sklepu przejść do "Ustawienia" >> "Realizacja zakupu". W sekcji "Informacje dotyczące klienta" należy zaznaczyć opcje dotyczące wymagania podania adresu e-mail lub numeru telefonu przez klientów.

Jeżeli dane o numerze telefonu są podane w koszyku, automatycznie zaczytują się do pola 'numer telefonu' w aplikacji

Brak usług w koszyku


Problem się pojawia gdy w ustawieniach sklepu w zakładce “Wysyłka i dostawa” nie są zaznaczone opcje InPost i nie ma odznaczonej opcji “Standard”

 

 

Kontakt

W przypadku pytań zapraszamy do skorzystania z formularza kontaktowego Działu integracji, który dostępny jest tu: https://inpost.pl/formularz-wsparcie  

 Po wejściu w formularz wystarczy z listy wybrać opcję "Wsparcie Klienta”, w kategorii wybrać: Moduł InPost, a w polu "Proszę podać nazwę modułu” podajemy: Shopify