Page Comparison

Info

title	Uwaga!

Zasób dostępny jest wyłącznie w krajach: PL, IT

Drogi Kliencie,

Z myślą o Tobie oraz Twoich Klientach przygotowaliśmy dedykowany materiał wspierający, dotyczący poprawnej implementacji usług InPost. Syntetyzuje on informacje w zakresie aktualnego brandingu InPost, wytyczne odnośnie implementacji przyjaznego wyszukiwania Paczkomatów i PaczkoPunktów oraz dobre praktyki, warte stosowania przy budowaniu pozytywnego user experience wśród Kupujących online.

Aż 70% Kupujących w sieci[1] deklaruje, że nie boi się powierzyć InPost żadnej przesyłki, a 71%[2] twierdzi, że jesteśmy marką idącą z duchem czasu – stosując aktualny branding, który Kupujący znają już również z innych kanałów, pozwalasz im szybko zorientować się, że dokonując zakupu za pośrednictwem Państwa platformy mogą jednocześnie skorzystać z dostarczenia zamówienia przez firmę, której usług poszukują i do której mają zaufanie, co bezpośrednio przyczynia się do decyzji zakupowych Klientów.

Dzięki prawidłowemu zastosowaniu mapy i listy Paczkomatów – Geowidget – pomagasz swoim Klientom szybko wyszukać pożądane przez nich miejsce dostawy zamówienia, skupiając ich uwagę na tym zadaniu, unikając rozproszeń i zagubienia się w procesie zakupowym. Zapewni to też Twoim Klientom dostęp do aktualnych informacji dotyczących punktu odbioru takich jak: możliwe formy płatności, opis oraz zdjęcie lokalizacji, czy godziny jej dostępności. Jednocześnie zdejmie to z Ciebie obowiązek bieżącego aktualizowania specyfiki każdego z punktów – bazowanie na rozwiązaniu Geowidget daje bieżący dostęp do tych informacji.

Zachęcamy Cię do zapoznania się z „Poradnikiem implementacji dostaw InPost w koszyku e-commerce” znajduje się na stronie Poradnik skutecznej implementacji dostaw InPost w koszyku e-commerce

Zmiany od wersji 1.7.0:

Wprowadzenie twardej walidacji dla wszystkich parametrów typu Integer, Double, List<Integer>: w przypadku nieprawidłowego formatu bądź nieprawidłowej wartości parametru API zwróci błąd; dotychczas: parametr był ignorowany.
Usunięcie polskich tłumaczeń - w zapytaniu o możliwe funkcję lub możliwej metodzie płatności.
Wprowadzenie maksymalnej wartości parametru per_page wynoszącej 500; dotychczas: bez limitu

Panel

bgColor	#f0f0f0
titleBGColor	#f0f0f0
title	Na tej stronie

Table of Contents

minLevel	2

Struktura

Elementy zasobu Points posiadają Zasób Point posiada następujące atrybuty:

Atrybut	Typ	Opis

hrefStringAdres URI do zasobu określonego punktu

Dostępny

name

String

ID punktu. Jest to jego unikalna nazwa, np. KRA007 (Dla Paczkomatu)

PL, IT

type

Array

Tablica określająca jakie rodzaje punktów mieszczą się w danej lokalizacji.

Możliwe typy punktów:

parcel_locker - Fizyczne paczkomaty i punkty obsługi przesyłek do których można nadać przesyłkę paczkomatową.
pop - Punkty obsługi przesyłek.
parcel_locker_only - Tylko fizyczne paczkomaty.
parcel_locker_superpop - Punkty obsługi przesyłek do których można nadać przesyłkę paczkomatową.

PL, IT

status

String

Status punktu.

PL, IT

location

Object

Obiekt Location zawierający informacje o położeniu geograficznym: latitude (szerokość) i longitude (długość).

Przykład obiektu Location w formacie JSON:

Code Block
"latitude": 50.03988, "longitude": 19.92485

PL, IT

location_type String Typ lokalizacji. PL, IT

location_description String Informacje dodatkowe o lokalizacji punktu, które mogą ułatwić dotarcie do niego. PL, IT

location_description_1 String Dodatkowy opis. PL, IT

location_description_2 String Dodatkowy opis. PL, IT

distance Integer Odległość od punktu relatywnego podanego w wyszukiwaniu. Jeśli punkt relatywny nie został podany, wtedy przyjmuje wartość null . PL, IT

opening_hours

String

Godziny otwarcia punktu

PL, IT

address

Object

Obiekt Address zawierający informacje adresowe o punkcie, takie jak: ulica, kod pocztowy, miasto.

Przykład obiektu Address w formacie JSON:

Code Block
"line1": "Kapelanka 14", "line2": null

PL, IT

address_details

Object

Dokładne dane adresowe punktu

Code Block
"city": "Bartoszyce", "province": "Warmińsko-Mazurskie", "post_code": "11-200", "street": null, "building_number": null, "flat_number": null

PL, IT

phone_number

String

Numer telefonu punktu

payment

PL, IT
`payment_point_descr`	String	Informacje dodatkowe o punkcie
`functions`	Array	Tablica określające jakie

fukcje

funkcje posiada punkt.

Identyfikator	Opis funkcji
Możliwe funkcje:		PL, IT
parcel

=

Send

and

collect

standard parcel parcel

standard parcel	PL, IT
parcel_send

=

Standard

parcel send

parcel send	PL, IT
parcel_collect

=

Standard

parcel collect

parcel collect	PL, IT
parcel_reverse_return_send

=

Standard

parcel

reverse

return

to sender

to sender	PL, IT
standard_letter_collect

=

Standard

letter collect

letter collect	PL
standard_letter_send

=

Standard

letter send

letter send	PL
allegro_parcel_collect

=

Allegro

parcel collect

parcel collect	PL
allegro_parcel_send

=

Allegro

parcel send

parcel send	PL
allegro_parcel_reverse_return_send

=

Allegro

parcel

return

to sender

to sender	PL
allegro_letter_collect

=

Allegro

letter collect

letter collect	PL
allegro_letter_send

=

Allegro

letter send

letter send	PL
allegro_letter_reverse_return_send

=

Allegro

letter

return

to sender

to sender	PL
allegro_courier_collect

=

Allegro

courier

parcel collect

parcel collect	PL
allegro_courier_send

=

Allegro

courier

parcel send

parcel send	PL
allegro_courier_reverse_return_send

=

Allegro

courier

parcel

return

to sender

to sender	PL
standard_courier_collect

=

Courier

parcel collect

parcel collect	PL
standard_courier_send

=

Courier

parcel send

parcel send	PL
standard_courier_reverse_return_send

=

Courier

parcel

return

to sender

to sender	PL
air_on_airport

=

Send

and

collect

baggage

from

machine

on airport

on airport	PL
air_outside_airport

=

Send

and

collect

baggage

from

machine

outside

of airport

of airport	PL
cool_parcel_collect

=

Reservation

collect

from

cooling machine laundry=Send and collect laundry avizo=Avizo collect

cooling machine	PL
laundry	Send and collect laundry	PL
avizo	Avizo collect	PL, IT

`partner_id`	Integer	ID partnera.	PL, IT
`is_next`	Boolean	Czy jest to paczkomat typu NEXT	PL, IT
`payment_available`	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.	PL, IT
`payment_type`	String	`virtual`	PL, IT
`virtual`	Integer	Wirtualność punktu	PL, IT
`recommended_low_interest_box_machines_list`	Array	Rekomendowane inne punkty w pobliżu	PL, IT
`location_247`	Boolean	Czy paczkomat dostępny jest 24/7	PL, IT
easy_access_zone	Boolean	Czy paczkomat posiada strefę ułatwionego dostępu	PL, IT

Przykład zasobu Point w formacie JSON:

Code Block

{  
   "href":"http://api-pl-points.easypack24.net/v1/points/KRA011",
   "name":"KRA011",
   "type":[  
      "parcel_locker"
   ],
   "status":"Operating",
   "location":{  
      "latitude":50.09103,
      "longitude":19.9299
   },
   "location_type":null,
   "location_description":"Stacja paliw Lukoil",
   "location_description_1":"",
   "location_description_2":"LUKOIL",
   "distance":null,
   "opening_hours":null,
   "address":{  
      "line1":"Opolska 9",
      "line2":"31-274 Kraków"
   },
   "address_details":{  
      "city":"Kraków",
      "province":"małopolskie",
      "post_code":"31-274",
      "street":"Opolska",
      "building_number":"9",
      "flat_number":null
   },
   "phone_number":null,
   "payment_point_descr":"Płatność internetowa 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":{  
      "0":"Brak obsługi płatności"
   },
   "virtual":"0",
   "recommended_low_interest_box_machines_list":null,
   "easy_access_zone": true
}

Uwierzytelnianie

Dostęp do zasobu nie wymaga uwierzytelnienia.

Lista punktów

Pobieranie listy punktów.

Code Block
GET /v1/points

W odpowiedzi serwer zwróci kolekcję z listą punktów.
Kolekcja wspiera stronicowanie, które Kolekcja wspiera stronicowanie, które opisane jest na stronie API Informacje ogólne.

Code Block
GET /v1/points

Przykład zapytania

Code Block
curl -X GET https://api-shipx-pl.easypack24.net/v1/points HTTP/1.1 Host: api-shipx-pl.easypack24.net

Odpowiedź

HTTP/1.1 200 OK

-H 'Content-Type: application/json

{

Odpowiedź

Code Block
{

"href":"https://api-pl-points.easypack24.net/v1/points",


  "count":5363,


  "page":1,


  "per_page":25,


  "total_pages":215,

"items":[

 
      "href":"http://api-pl-points.easypack24.net/v1/points/ADA01N",

"name":"ADA01N",

"type":[

"parcel_locker"

],

"status":"Operating",

"location":{

"latitude":51.74455,

"longitude":22.25847

},

"location_type":null,

"location_description":"Przy sklepie Groszek",

"location_description_1":null,

"location_description_2":"Groszek",

"distance":null,

"opening_hours":"24/7",

"address":{

"

"line1":"Kleeberga 5B",


        "line2":"21-412 Adamów"

},

"address_details":{

"city":"Adamów",

"province":"lubelskie",

"post_code":"21-412",

"street":"Kleeberga",

"building_number":"5B",

"flat_number":null

},

"phone_number":null,

"payment_point_descr":"Płatność internetowa PayByLink. Dostępność 24/7",

"functions":[

		"allegro_courier_collect",

		"allegro_courier_reverse_return_send",

"allegro_courier

		"parcel_reverse_return_send",

"allegro_letter

		"parcel_send",
		"standard_courier_reverse_return_send",

"allegro_letter

		"standard_courier_send"

,

],

allegro

partner_

parcel_collect

id":0,

"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":true, "payment_available":true, "payment_type":{ "0":"Brak obsługi płatności" }, "virtual":"0", "recommended_low_interest_box_machines_list":null }, { "href":"http://api-pl-points.easypack24.net/v1/points/ALK01A", "name":"ALK01A", "type":[ "parcel_locker" ], "status":"Operating", "location":{ "latitude":52.8684, "longitude":18.7031 }, "location_type":null, "location_description":"Przy biurze usług ubezpieczeniowych", "location_description_1":"", "location_description_2":"", "distance":null, "opening_hours":"24/7", "address":{ "line1":"Słowackiego 131", "line2":"87-700 Aleksandrów Kujawski" }, "address_details":{ "city":"Aleksandrów Kujawski", "province":"kujawsko-pomorskie", "post_code":"87-700",

"is_next":true,
      "payment_available":true,
      "

street

payment_type":

"Słowackiego",

{ 
		"0":"Brak obsługi płatności"
	  },

building_number

virtual":"

131

0",
      "recommended_low_interest_box_machines_list":null,
      "

flat

easy_access_

number

zone":

null

 true
    },
    {...},

],

{...},

[...

]
}

Szczegóły punktu

Pobieranie szczegółów punktu.

Code Block
GET /v1/points/:nazwa_punktu

W odpowiedzi serwer zwróci szczegóły punktu.

point_name

Przykład zapytania

Code Block
curl -X GET https://api-shipx-pl.easypack24.net/v1/points/AAB001 HTTP/1.1 Host: api-shipx-pl.easypack24.net-H 'Content-Type: application/json'

Odpowiedź

Code Block

HTTP/1.1 200 OK
Content-Type: application/json
{  
   "href":"http://api-pl-points.easypack24.net/v1/points/ADA01N",
   "name":"ADA01N",
   "type":[  
      "parcel_locker"
   ],
   "status":"Operating",
   "location":{  
      "latitude":51.74455,
      "longitude":22.25847
   },
   "location_type":null,
   "location_description":"Przy sklepie Groszek",
   "location_description_1":null,
   "location_description_2":"Groszek",
   "distance":null,
   "opening_hours":"24/7",
   "address":{  
      "line1":"Kleeberga 5B",
      "line2":"21-412 Adamów"
   },
   "address_details":{  
      "city":"Adamów",
      "province":"lubelskie",
      "post_code":"21-412",
      "street":"Kleeberga",
      "building_number":"5B",
      "flat_number":null
   },
   "phone_number":null,
   "payment_point_descr":"Płatność internetowa PayByLink. Dostępność 24/7",
   "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":true,
   "payment_available":true,
   "payment_type":{  
      "0":"Brak obsługi płatności"
   },
   "virtual":"0",
   "recommended_low_interest_box_machines_list":null_list":null,
   "easy_access_zone": true
}

Kryteria wyszukiwania

Parametr	Typ	Opis	Przykład	Dostępny
`name`	String Array	Wyszukuje punkt o podanej nazwie. Wyszukuje punkty o podanych nazwach.	?name=KRA010 ?name=Kra010,ADA01N	PL, IT
`type`	String Array	Wyszukuje punkty o podanym typie Wyszukuje punkty o podanych typach	?type=parcel_locker ?type=parcel_locker,pop	PL, IT
`functions`	String Array	Wyszukuje punkty posiadające podaną funkcję. Wyszukuje punkty posiadające wszystkie wymienione funkcje.	?functions=parcel ?functions=parcel,parcel_send	PL, IT
`partner_id`	Integer Array	Wyszukuje punkty o podanym partner_id. Wyszukuje punkty o podanych partner_id.	?partner_id=1 ?partner_id=1,2	PL, IT
`is_next`	Boolean	Wyszukuje punkty, które są typu NEXT	?is_next=true	PL, IT
`payment_available`	Boolean	Filtrowanie listy punktów po dostępności płatności dla punktu.	?payment_available=true	PL, IT
`post_code`	String Array	Wyszukuje punkty, które posiadają podany kod pocztowy. Wyszukuje punkty, które posiadają podane kody pocztowe.	?post_code=11-111 ?post_code=11-111,22-222	PL, IT
`city`	String Array	Wyszukuje punkty, które posiadają podane miasto. Wyszukuje punkty, które posiadają podane miasta.	?city=Kraków ?city=Kraków,Warszawa	PL, IT
`province`	String Array	Wyszukuje punkty, które posiadają podane województwo. Wyszukuje punkty, które posiadają podane województwa.	?province=Małopolska ?province=Małopolska,Śląsk	PL, IT
`virtual`	Integer Array	Wyszukuje punkty o podanej wirtualności. Wyszukuje punkty o podanych wirtualnościach.	?virtual=0 ?virtual=1,6	PL, IT
`updated_from`	Date	Wyszukiwanie punktów wg daty, po której nastąpiła aktualizacja punktu. Jeśli parametr `updated_to` nie został podany data nie może być wcześniejsza, niż 3 dni wstecz licząc od aktualnej daty.

.

?updated_from=2018-04-24

PL, IT

updated_to

Date

Wyszukiwanie punktów wg daty, do której nastąpiła aktualizacja punktu.

Wymaga podania updated_from.

?updated_to=2018-04-26

PL, IT

Wyszukiwanie wg. lokalizacji

`relative_point`	String	Wyszukuje punkty położone najbliżej podanych współrzędnych geograficznych.	?relative_point=52.123,19.321	PL, IT
`relative_post_code`	String	Wyszukuje punkty położone najbliżej podanego kodu pocztowego.	?relative_post_code=11-111	PL, IT
`max_distance`	Double	Określa odległość w metrach od podanego w `relative_point` lub `relative_post_code` punktu. Użycie parametru wymusza sortowanie wg odległości. Domyślna wartość: 10000 (10km) Maksymalna wartość: 50000 (50 km).	?relative_point=52.123,19.321&max_distance=10000	PL, IT
`limit`	Integer	Limit zwracanych punktów w przypadku użycia parametrów w relative_point lub relative_post_code.	?limit=10	PL, IT

Sortowanie wyników

`name`	Sortowanie po nazwie punktów.	?sort_by=name	PL, IT
`distance_to_relative_point`	Sortowanie wg. odległości od punktu relatywnego (`relative_point` lub `relative_post_code`)	?sort_by=distance_to_relative_point	PL, IT
`status`	Sortowanie wg. statusu	?sort_by=status	PL, IT

Sortowanie może odbywać się w dwóch kierunkach, poprzez użycie parametru parametru sort_order:. Domyślnie wyniki sortowane są rosnąco (asc) wg nazwy punktów(name).

`asc`	Sortuje punkty rosnąco	?sort_order=asc&sort_by=status	PL, IT
`desc`	Sortuje punkty malejąco	?sort_order=desc&sort_by=status

Domyślnie wyniki sortowane są rosnąco (asc) wg nazwy punktów(name).

PL, IT

Stronicowanie

page Określa stronę wyników, która powinna zostać zwrócona. ?page=2 PL, IT

per_page

Określa liczbę wyników wyświetlanych na stronie.

Domyślna wartość: 25
Maksymalna wartość: 500

?per_page=100

PL, IT

Filtrowanie wyświetlanych pól

fields Określa

liste

listę atrybutów punktu, która ma zostać wyświetlona na stronie.

?fields=name,type

PL, IT

Versions Compared

Old Version 16

New Version 17

Key

Struktura

Uwierzytelnianie

Lista punktów

Szczegóły punktu

Kryteria wyszukiwania