Prezentowanie punktów odbioru


W artykule znajdują się informację w jaki sposób należy poprawnie prezentować punkty dostawy do: Paczkomat® InPost, PaczkoPunktów, Paczkomat® w Żabce, PaczkoPunktów w Żabce.

 

Aby poprawnie umożliwić Klientowi wybór Paczkomat® oraz zaciągnąć dane, które później będą służyć do utworzenia przesyłki, można skorzystać z dwóch rozwiązań:

  • Geowidget

  • Zasób Points w API ShipX

Zalecanym rozwiązaniem jest korzystanie z Geowidgetu. W przypadku gdy Klient nie ma możliwość skorzystania z tej funkcjonalności, dopuszcza się użycie listy punktów, autorskiego Geowidgetu wykonanego na podstawie zasobu Points w API ShipX.


Geowidget

Geowidget v5 to lokalizator i selektor punktów zaprojektowany przez InPost.

Jego główne zadania to:

  •  Wyświetlanie mapy z punktami o różnych typach (np. Paczkomat®, PaczkoPunkty)

  •  Dostarczenie informacji o tych punktach i umożliwienie integracji z zewnętrznymi systemami Klientów

Jest to oprogramowanie typu widget. Oznacza to, że cały kod i przetwarzanie odbywa się na serwerach InPost. Klienci zewnętrzni dołączają tylko link do tego kodu i określają konfigurację, która będzie używana w ich systemach.

Geowidget posiada dedykowane konfiguracje dla opcji dostaw w koszyku:


Opis

Opcja

functions

payment_available

location_247

Typ prezentowanych punktów

Opis

Opcja

functions

payment_available

location_247

Typ prezentowanych punktów

InPost Paczkomat® 24/7

config='parcelCollectInPost'

parcel_locker

Paczkomat®, Paczkomat® w Żabce, PaczkoPunkt

InPost Paczkomat® 24/7 COD

config='parcelCollectPaymentInPost'

parcel_locker

Paczkomat®, Paczkomat® w Żabce, PaczkoPunkt

InPost w Żabce

config='parcelCollectZabka'

parcel_locker

PaczkoPunt w Żabce

InPost w Żabce COD

config='parcelCollectPaymentZabka'

parcel_locker

PaczkoPunt w Żabce

InPost Paczkomat® 24/7 Paczka w Weekend

config='parcelCollect247'

parcel_locker

Paczkomat® dostępne 24/7

Opis

Opcja

functions

payment_available

location_247

Typ prezentowanych punktów

Opis

Opcja

functions

payment_available

location_247

Typ prezentowanych punktów

InPost Paczkomat® 24/7

config='parcelCollect'

parcel_collect

Paczkomat®, Paczkomat® w Żabce, PaczkoPunkt, PaczkoPunt w Żabce

InPost Paczkomat® 24/7 COD

config='parcelCollectPayment'

parcel_collect

Paczkomat®, Paczkomat® w Żabce, PaczkoPunkt, PaczkoPunt w Żabce

InPost Paczkomat® 24/7 Paczka w Weekend

config='parcelCollect247'

parcel_collect

Paczkomat® dostępne 24/7

Prezentowanie punktów nadań

config='parcelSend'

parcel_send

Paczkomat®, Paczkomat® w Żabce, PaczkoPunkt, PaczkoPunt w Żabce

 

Szczegółowa dokumentacja znajduje się na stronie https://dokumentacja-inpost.atlassian.net/wiki/spaces/PL/pages/50069505

 

Przykłady integracji


Środowisko produkcyjne: https://geowidget.inpost.pl/examples/index.html

Środowisko testowe: https://sandbox-easy-geowidget-sdk.easypack24.net/examples/index.html

Przykłady geowidgetu

Środowisko produkcyjne: https://geowidget.inpost.pl/
Środowisko testowe: https://sandbox-easy-geowidget-sdk.easypack24.net/


 

Zasób Points

 

Zasób Points jest dostępny w API ShipX.  Zasób ten skierowany jest do Klientów,  którzy chcą na podstawie API stworzyć swoją wersję Geowidgetu, zaproponować listy z  punktami odbioru, gdy nie mają technicznej możliwości skorzystania z Geowidgetu InPost.

Ta opcja umożliwia:

  • Pobieranie informacji na temat lokalizacji, w których dostępne są usługi firmy InPost. Punktami mogą być:  maszyny samoobsługowe (Paczkomat®) lub paczkopunkty;

  • Pobieranie Paczkomat® na podstawie współrzędnych - można również podać maksymalną odległość, w jakiej znajdują się punkty od punktu relatywnego oraz nanieść te współrzędne na mapę Google.

W praktyce kiedy użytkownik wpisze np. nazwę miejscowości, lub kod pocztowy, Points wyszukuje Paczkomat® przypisane do niego, zwraca ich współrzędne i następnie na ich podstawie można umieścić je na mapie np. Google.

Dedykowane konfiguracje dla opcji dostaw w koszyku

 

InPost Paczkomat® 24/7  & InPost w Żabce

Opis

Konfiguracja za pomocą której należy pobrać pełną listę punktów

Parametry za pomocą którego należy odfiltrować poprawną listę punktów dla form dostawy

Typ prezentowanych punktów

InPost Paczkomat® 24/7

/v1/points?type=parcel_locker

Należy usunąć punkty z  partner_id=60

Paczkomat®, Paczkomat w Żabce, PaczkoPunkty

InPost Paczkomat® 24/7 COD

payment_available=true oraz usunąć punkty z partner_id=60

Paczkomat®, Paczkomat w Żabce, PaczkoPunkty

InPost w Żabce

partner_id=60

PaczkoPunkty w Żabce

InPost w Żabce COD

partner_id=60&payment_available=true

PaczkoPunkty w Żabce

InPost Paczkomat® 24/7 Paczka w Weekend

location_247=true

Paczkomat® dostępne 24/7

Prezentowanie punktów nadań

/v1/points?functions=parcel_send

 functions=parcel_send

Paczkomat®, Paczkomat® w Żabce, PaczkoPunkt, PaczkoPunt w Żabce

 

 

InPost Paczkomat® 24/7

Opis

Konfiguracja za pomocą której należy pobrać pełną listę punktów

Parametry za pomocą których klient będzie filtrował pobraną listę punktów

Typ prezentowanych punktów

InPost Paczkomat® 24/7

/v1/points?type=parcel_locker

 type=parcel_locker

Paczkomat®, Paczkomat® w Żabce, PaczkoPunkt, PaczkoPunkt w Żabce

InPost Paczkomat® 24/7 COD

payment_available=true

Paczkomat®, Paczkomat® w Żabce, PaczkoPunkt, PaczkoPunkt w Żabce

InPost Paczkomat® 24/7 Paczka w Weekend

location_247=true

Paczkomat® dostępne 24/7

Prezentowanie punktów nadań

/v1/points?functions=parcel_send

 functions=parcel_send

Paczkomat®, Paczkomat® w Żabce, PaczkoPunkt, PaczkoPunkt w Żabce

Dobre Praktyki

Poniżej przedstawiamy listę parametrów za pomocą których należy umieścić informację w szczegółach punktu.

Poniższe informacje zostały pobrane za pomocą zapytania:

1 curl -X GET https://api.inpost.pl/v1/points?name=WAW94A -H 'Content-Type: application/json'

 

Paczkomat® InPost

Pola wyświetlane

Pola w API

Paczkomat®

Jeśli "partner_id":0 ustaw "Paczkomat®"

Nazwa Paczkomat®

"name": "WAW94A"

Dane adresowe

"address": {
         "line1": "Czerska 8/10",
    "line2": "00-732 Warszawa"

Dodatkowy opis

"location_description": "Przy biurowcu Agory"

Godziny otwarcia

"opening_hours": "24/7"

Pin

Dedykowane piny znajdują się w dolnej części artykułu.

 


PaczkoPunkt

Pola wyświetlane

Pola w API

PaczkoPunkt

Jeśli "partner_id": 33 ustaw "PaczkoPunkt"

Nazwa PaczkoPunktu

"name": "POP-WAW206"

Dane adresowe

 "address": {
         "line1": "Kierbedzia 8 LOK. U301",
         "line2": "00-728 Warszawa"

Dodatkowy opis

"location_description": "EKOPARTY"

Godziny otwarcia

"opening_hours": "PN-PT 10-18 SB 10-14"

Pin

Dedykowane piny znajdują się w dolnej części artykułu.


 

Paczkomat® w Żabce

Pola wyświetlane

Pola w API

Paczkomat®

Jeśli "partner_id": 61 ustaw "Paczkomat®"

Nazwa Paczkomat®

"name": "WAW41ZIH"

Dane adresowe

  "address": {                 "line1": "Bobrowiecka 10 lok. U7",                 "line2": "00-728 Warszawa"

Dodatkowy opis

"location_description": "W sklepie Żabka"

Godziny otwarcia

"opening_hours": "PN-SB 06-23"

Pin

Dedykowane piny znajdują się w dolnej części artykułu.

 

PaczkoPunkt

Pola wyświetlane

Pola w API

PaczkoPunkt w Żabce

Jeśli "partner_id": 60 ustaw "PaczkoPunkt w Żabce"

Nazwa PaczkoPunktu

"name": "POP-WAW06Z"

Dane adresowe

 "address": {                 "line1": "Branickiego 11/192",                 "line2": "02-797 WARSZAWA"

Dodatkowy opis

"location_description": "ŻABKA"

Godziny otwarcia

"opening_hours": "PN-SB 06-23 ND Sprawdź w sklepie"

Pin

Dedykowane piny znajdują się w dolnej części artykułu.

 

Paczkomat® Appkomat

Dla nowego typu Paczkomat® należy wyświetlić w dymku dodatkową poniższą informację:

Pola wyświetlane

Pola w API

Ważne! Swoją paczkę odbierzesz wygodniej z aplikacją InPost

Jeśli "physical_type_mapped": "006" wyświetl informację z pola "physical_type_description"

 

 

 

Oznaczenie na mapie

Piny do pobrania

Nazwa, rozszerzenie

Piny do pobrania

Nazwa, rozszerzenie

Paczkomat® Geo.png

Paczkomat® max.png

Paczkomat® min.png

Paczkomat® w Żabce.png

PaczkoPunkt Geo.png

PaczkoPunkt max.png

PaczkoPunkt min.png

PaczkoPunkt w Żabce.png

 

Paczkomat® max.pdf

Paczkomat® min.pdf

PaczkoPunkt max.pdf

 

PaczkoPunkt min.pdf

Paczkomat® max.svg

Paczkomat® min.svg

PaczkoPunkt max.svg

PaczkoPunkt min.svg

 

Przykładowe zapytania

  • W zasobie Points istnieje możliwość pobrania najbliższych Paczkomat® od punktu relatywnego na podstawie współrzędnych:

    1 curl -X GET https://api-shipx-pl.easypack24.net/v1/points?relative_point=52.21472%2C20.95547 -H 'Content-Type: application/json'
  • Liczbę punktów można ograniczyć parametrem limit:

    1 curl -X GET https://api-shipx-pl.easypack24.net/v1/points?relative_point=52.21472%2C20.95547&limit=3 -H 'Content-Type: application/json'
  • Liczbę punktów można ograniczyć parametrem max_distance(podajemy w metrach)

    1 curl -X GET https://api-shipx-pl.easypack24.net/v1/points?relative_point=52.21472%2C20.95547&max_distance=800 -H 'Content-Type: application/json'
  • Pobieranie najbliższych punktów dla kodu pocztowego:

    1 curl -X GET https://api-shipx-pl.easypack24.net/v1/points?relative_post_code=37-200&type=parcel_locker -H 'Content-Type: application/json'
  • Pobranie wszystkich fizycznych Paczkomat® i paczkopunktów do których można nadać przesyłkę Paczkomat®:

    1 curl -X GET https://api-shipx-pl.easypack24.net/v1/points?type=parcel_locker -H 'Content-Type: application/json'
  • Pobranie tylko fizycznych Paczkomat®:

    1 curl -X GET https://api-shipx-pl.easypack24.net/v1/points?type=parcel_locker_only -H 'Content-Type: application/json'
  • Pobranie paczkopunktów do których można nadać przesyłkę Paczkomat®:

    1 curl -X GET https://api-shipx-pl.easypack24.net/v1/points?type=parcel_locker_superpop -H 'Content-Type: application/json'
  • Pobranie punktów które obsługują przesyłki COD

    1 curl -X GET https://api-shipx-pl.easypack24.net/v1/points?payment_available=true -H 'Content-Type: application/json'
  • Pobranie punktów które są dostępne 24/7, dedykowane dla usługi Paczka w Weekend

    1 curl -X GET https://api-shipx-pl.easypack24.net/v1/points?location_247=true -H 'Content-Type: application/json'