- Created by Krystian Szewczyk, last modified by Michał Machowski on Nov 30, 2022
You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 50 Next »
Zasób Points
reprezentuje lokalizacje, w których dostępne są usługi operatorów logistycznych. Punktami mogą być maszyny samoobsługowe (Paczkomat®) lub oddziały, punkty obsługi klienta. Każda z lokalizacji oferuje określone usługi - lista tych usług zwracana jest w odpowiedzi pod atrybutem functions.
Nowe środowiska z autoryzacją
Środowisko produkcyjne:
https://api.inpost.pl/v1/points
Generowanie dostępu
Wejdź na stronę Managera Paczek https://manager.paczkomaty.pl/
W oknie logowania wpisz swój login i kliknij: Zaloguj
Po zalogowaniu na konto przejdź do zakładki Moje Konto
W zakładce Dane sprawdzić, czy wszystkie dane firmy są prawidłowo uzupełnione
Pamiętaj, aby możliwe było wygenerowanie dostępu do API uzupełnione muszą być zarówno dane adresowe firmy, jak i dane do faktury.Po weryfikacji przejdź do nowej zakładki API
Aby wygenerować nowy dostęp do Zasobu Points, rozwiń zakładkę API ShipX i kliknij Generuj
Jeśli posiadasz już wygenerowany token zwróć uwagę, aby do autoryzacji używać tokenu z listy (Lista tokenów do API InPost (API ShipX oraz API Points)). Jeśli nie posiadasz takiej listy musisz wygenerować nowy token.
Środowisko testowe:
https://sandbox-api-gateway-pl.easypack24.net/v1/points
Generowanie dostępu
Wejdź na stronę Managera Paczek https://sandbox-manager.paczkomaty.pl/
W oknie logowania wpisz swój login i kliknij: Zaloguj
Po zalogowaniu na konto przejdź do zakładki Moje Konto
W zakładce Dane sprawdzić, czy wszystkie dane firmy są prawidłowo uzupełnione
Pamiętaj, aby możliwe było wygenerowanie dostępu do API uzupełnione muszą być zarówno dane adresowe firmy, jak i dane do faktury.Po weryfikacji przejdź do nowej zakładki API
Aby wygenerować nowy dostęp do Zasobu Points, rozwiń zakładkę API ShipX i kliknij Generuj
Jeśli posiadasz już wygenerowany token zwróć uwagę, aby do autoryzacji używać tokenu z listy (Lista tokenów do API InPost (API ShipX oraz API Points)). Jeśli nie posiadasz takiej listy musisz wygenerować nowy token.
Więcej informacji o dostępnych sposobach prezentacji punktów odbioru Prezentowanie punktów odbioru
Na tej stronie
Struktura
Zasób Point
posiada następujące atrybuty:
Atrybut | Typ | Opis | |
---|---|---|---|
| String | ID punktu. Jest to jego unikalna nazwa, np. KRA007 (Dla Paczkomat®) | |
| Array | Tablica określająca jakie rodzaje punktów mieszczą się w danej lokalizacji. Możliwe typy punktów:
| |
| String | Status punktu. | |
| Object | Obiekt Przykład obiektu "latitude": 50.03988, "longitude": 19.92485 | |
| String | Typ lokalizacji. | |
| String | Informacje dodatkowe o lokalizacji punktu, które mogą ułatwić dotarcie do niego. | |
| String | Dodatkowy opis. | |
| String | Dodatkowy opis. | |
| Integer | Odległość od punktu relatywnego podanego w wyszukiwaniu. Jeśli punkt relatywny nie został podany, wtedy przyjmuje wartość | |
| String | Godziny otwarcia punktu. | |
| Object | Obiekt Przykład obiektu "line1": "Kapelanka 14", "line2": null | |
| Object | Dokładne dane adresowe punktu: "city": "Bartoszyce", "province": "Warmińsko-Mazurskie", "post_code": "11-200", "street": null, "building_number": null, "flat_number": null | |
| String | Numer telefonu punktu. | |
| String | Informacje dodatkowe o punkcie. | |
| Array | Tablica określające jakie funkcje posiada punkt. Możliwe funkcje: | |
Identyfikator | Opis funkcji | ||
| Send and collect standard parcel | ||
| Standard parcel send | ||
| Standard parcel collect | ||
| Standard parcel reverse return to sender | ||
| Standard letter collect | ||
| Standard letter send | ||
| Allegro parcel collect | ||
| Allegro parcel send | ||
| Allegro parcel return to sender | ||
| Allegro letter collect | ||
| Allegro letter send | ||
| Allegro letter return to sender | ||
| Allegro courier parcel collect | ||
| Allegro courier parcel send | ||
| Allegro courier parcel return to sender | ||
| Courier parcel collect | ||
| Courier parcel send | ||
| Courier parcel return to sender | ||
| Send and collect baggage from machine on airport | ||
| Send and collect baggage from machine outside of airport | ||
| Reservation collect from cooling machine | ||
| Send and collect laundry | ||
| Avizo collect | ||
| Integer | ID partnera.
| |
| Boolean | Czy jest to Paczkomat® typu NEXT. | |
| Boolean | Dostępność płatności w danym punkcie. Istnieje możliwość wystąpienia payment_available=true razem z payment_type=0, oznacza to, że płatność jest dostępna. | |
| String | virtual. | |
| Integer | Wirtualność punktu. | |
| Array | Rekomendowane inne punkty w pobliżu. | |
| Boolean | Czy Paczkomat® dostępny jest 24/7 (Paczkomat® z parametrem ustawionym na | |
| Boolean | Czy Paczkomat® posiada strefę ułatwionego dostępu. | |
| String | Typ Paczkomat® | |
| String | Opis typu Paczkomat® |
Przykład zasobu Point
w formacie JSON:
{ "href": "https://api-pl-points.easypack24.net/v1/points/KRA02APP", "name": "KRA02APP", "type": [ "parcel_locker" ], "status": "Operating", "location": { "longitude": 19.87325, "latitude": 50.00919 }, "location_type": "Outdoor", "location_date": null, "location_description": "Prywatna posesja wjazd od strony Dobrowolskiego", "location_description_1": null, "location_description_2": null, "distance": null, "opening_hours": "24/7", "address": { "line1": "Dobrowolskiego", "line2": "30-394 Kraków" }, "address_details": { "city": "Kraków", "province": "małopolskie", "post_code": "30-394", "street": "Dobrowolskiego", "building_number": "", "flat_number": null }, "phone_number": null, "payment_point_descr": "Płatność internetowa aplikacją InPost Mobile oraz PayByLink", "functions": [ "allegro_courier_collect", "allegro_courier_reverse_return_send", "allegro_courier_send", "allegro_letter_reverse_return_send", "allegro_letter_send", "allegro_parcel_collect", "allegro_parcel_reverse_return_send", "allegro_parcel_send", "parcel", "parcel_collect", "parcel_reverse_return_send", "parcel_send", "standard_courier_reverse_return_send", "standard_courier_send" ], "partner_id": 0, "is_next": false, "payment_available": true, "payment_type": { "0": "Payments are not supported" }, "virtual": "0", "recommended_low_interest_box_machines_list": null, "apm_doubled": null, "location_247": true, "operating_hours_extended": { "customer": null }, "agency": "IPM5426863", "image_url": "https://static.easypack24.net/points/pl/images/KRA02APP.jpg", "easy_access_zone": true, "air_index_level": null, "physical_type_mapped": "006", "physical_type_description": "Ważne! Swoją paczkę odbierzesz wygodniej z aplikacją InPost" }
Lista punktów
Pobieranie listy punktów. Kolekcja wspiera stronicowanie, które opisane jest na stronie Informacje ogólne.
GET /v1/points |
Przykład zapytania
curl -X GET https://api.inpost.pl/v1/points -H 'Content-Type: application/json' |
Odpowiedź
{ "href": "https://api-pl-points.easypack24.net/v1/points", "count": 19378, "page": 1, "per_page": 25, "total_pages": 776, "items": [ { "href": "https://api-pl-points.easypack24.net/v1/points/ADA01M", "name": "ADA01M", "type": [ "parcel_locker" ], "status": "Operating", "location": { "longitude": 22.26405, "latitude": 51.73834 }, "location_type": "Outdoor", "location_date": null, "location_description": "Przy sklepie Lewiatan", "location_description_1": null, "location_description_2": null, "distance": null, "opening_hours": "24/7", "address": { "line1": "Kościuszki 27", "line2": "21-412 Adamów" }, "address_details": { "city": "Adamów", "province": "lubelskie", "post_code": "21-412", "street": "Kościuszki", "building_number": "27", "flat_number": null }, "phone_number": null, "payment_point_descr": "Płatność internetowa aplikacją InPost Mobile oraz PayByLink", "functions": [ "allegro_courier_collect", "allegro_courier_reverse_return_send", "allegro_courier_send", "allegro_letter_reverse_return_send", "allegro_letter_send", "allegro_parcel_collect", "allegro_parcel_reverse_return_send", "allegro_parcel_send", "parcel", "parcel_collect", "parcel_reverse_return_send", "parcel_send", "standard_courier_reverse_return_send", "standard_courier_send" ], "partner_id": 0, "is_next": false, "payment_available": true, "payment_type": { "0": "Payments are not supported" }, "virtual": "0", "recommended_low_interest_box_machines_list": null, "apm_doubled": null, "location_247": true, "operating_hours_extended": { "customer": null }, "agency": "IPM4633224", "image_url": "https://static.easypack24.net/points/pl/images/ADA01M.jpg", "easy_access_zone": true, "air_index_level": null, "physical_type_mapped": "004", "physical_type_description": null }, {...}, {...}, ] } |
Szczegóły punktu
Pobieranie szczegółów punktu.
GET /v1/points?name=point_name |
Przykład zapytania
curl -X GET https://api.inpost.pl/v1/points?name=KRA012 -H 'Content-Type: application/json' |
Odpowiedź
{ "href": "https://api-pl-points.easypack24.net/v1/points/KRA012", "name": "KRA012", "type": [ "parcel_locker" ], "status": "Operating", "location": { "longitude": 20.00399, "latitude": 50.08913 }, "location_type": "Outdoor", "location_date": null, "location_description": "Stacja paliw Lotos", "location_description_1": null, "location_description_2": "Lotos", "distance": null, "opening_hours": "24/7", "address": { "line1": "Os. Kombatantów 20", "line2": "31-630 Kraków" }, "address_details": { "city": "Kraków", "province": "małopolskie", "post_code": "31-630", "street": "Os. Kombatantów", "building_number": "20", "flat_number": null }, "phone_number": null, "payment_point_descr": "Płatność w Paczkomacie kartą płatniczą lub BLIKIEM oraz internetowo aplikacją InPost Mobile i PayByLink", "functions": [ "allegro_courier_collect", "allegro_courier_reverse_return_send", "allegro_courier_send", "allegro_letter_send", "allegro_parcel_collect", "allegro_parcel_reverse_return_send", "allegro_parcel_send", "parcel", "parcel_collect", "parcel_reverse_return_send", "parcel_send", "standard_courier_reverse_return_send", "standard_courier_send" ], "partner_id": 0, "is_next": false, "payment_available": true, "payment_type": { "2": "Payment by card in the machine" }, "virtual": "0", "recommended_low_interest_box_machines_list": [ "KRA175M", "KRA274M", "KRA227M", "KRA273M", "KRA144M" ], "apm_doubled": null, "location_247": true, "operating_hours_extended": { "customer": null }, "agency": "IPM4956660", "image_url": "https://static.easypack24.net/points/pl/images/KRA012.jpg", "easy_access_zone": false, "air_index_level": null, "physical_type_mapped": "001", "physical_type_description": null } |
Kryteria wyszukiwania
Parametr | Typ | Opis | Przykład |
---|---|---|---|
| String | Wyszukuje punkt o podanej nazwie. |
|
| String | Wyszukuje punkty o podanym typie |
|
| String | Wyszukuje punkty posiadające podaną funkcję. |
|
| Integer | Wyszukuje punkty o podanym partner_id. |
|
| Boolean | Wyszukuje punkty, które są typu NEXT |
|
| Boolean | Filtrowanie listy punktów po dostępności płatności dla punktu. |
|
| String | Wyszukuje punkty, które posiadają podany kod pocztowy. |
|
| String | Wyszukuje punkty, które posiadają podane miasto. |
|
| String | Wyszukuje punkty, które posiadają podane województwo. |
|
| Integer | Wyszukuje punkty o podanej wirtualności. |
|
| Date | Wyszukiwanie punktów wg daty, po której nastąpiła aktualizacja punktu. Jeśli parametr |
|
| Date | Wyszukiwanie punktów wg daty, do której nastąpiła aktualizacja punktu. Wymaga podania |
|
| Boolean | Wyszukiwanie punktów które są dostępne 24/7. (Paczkomat® z parametrem ustawionym na |
|
Wyszukiwanie wg. lokalizacji
| String | Wyszukuje punkty położone najbliżej podanych współrzędnych geograficznych. |
|
| String | Wyszukuje punkty położone najbliżej podanego kodu pocztowego. |
|
| Double | Określa odległość w metrach od podanego w Użycie parametru wymusza sortowanie wg odległości. Domyślna wartość: 10000 (10km) |
|
| Integer | Limit zwracanych punktów w przypadku użycia parametrów w relative_point lub relative_post_code. |
|
Sortowanie wyników
| Sortowanie po nazwie punktów. |
|
| Sortowanie wg. odległości od punktu relatywnego ( |
|
| Sortowanie wg. statusu |
|
Sortowanie może odbywać się w dwóch kierunkach, poprzez użycie parametru sort_order.
Domyślnie wyniki sortowane są rosnąco (asc
) wg nazwy punktów(name).
| Sortuje punkty rosnąco |
|
| Sortuje punkty malejąco |
|
Stronicowanie
| Określa stronę wyników, która powinna zostać zwrócona. |
|
| Określa liczbę wyników wyświetlanych na stronie. Domyślna wartość: 25 |
|
Filtrowanie wyświetlanych pól
| Określa listę atrybutów punktu, która ma zostać wyświetlona na stronie. |
|
- No labels