Struktura
Elementy zasobu Points
posiadają następujące atrybuty:
Atrybut | Typ | Opis | ||
---|---|---|---|---|
href | String | Adres URI do zasobu określonego punktu | ||
name | String | ID punktu. Jest to jego unikalna nazwa, np. KRA007 (Dla Paczkomatu) | ||
type | Array | Tablica określające jakie rodzaje punktów mieszczą się w danej lokalizacji. | ||
status | String | Status punktu. | ||
location | Object | Obiekt Przykład obiektu
| ||
location_description | String | Informacje dodatkowe o lokalizacji punktu, które mogą ułatwić dotarcie do niego. | ||
opening_hours | String | Godziny otwarcia punktu | ||
address | Object | Obiekt Przykład obiektu
| ||
address_details | Object | Dokładne dane adresowe punktu
| ||
phone_number | String | Numer telefonu punktu | ||
payment_point_descr | String | Informacje dodatkowe o punkcie | ||
functions | Array | Tablica określające jakie fukcje posiada punkt.
| ||
partner_id | Integer | Numer partnera. | ||
is_next | Boolean | Czy jest to paczkomat typu NEXT | ||
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. | ||
payment_type | String | Typ płatności. Możliwe typy płatności:
|
Przykład zasobu Point
w formacie JSON:
Code Block |
---|
{ "href": "https://api-pl-points.easypack24.net/v1/points/BAR162", "name": "BAR162", "type": [ "parcel_locker" ], "location": { "latitude": 54.24325, "longitude": 20.80758 }, "location_description": null, "opening_hours": null, "address": { "line1": "", "line2": "11-200 Bartoszyce" }, "address_details": { "city": "Bartoszyce", "province": "Warmińsko-Mazurskie", "post_code": "11-200", "street": null, "building_number": null, "flat_number": null }, "phone_number": null, "payment_point_descr": "Płatności gotówką można dokonać na stacji Lotos przy której zlokalizowany jest paczkomat. Dostępność: 24/7\nPłatność kartą wyłącznie w paczkomacie. Dostępność: 24/7", "functions": [ "parcel" ], "partner_id": "0", "is_next": null, "payment_available": false, "payment_type": { "0": "Brak obsługi płatności" } } |
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 opisane jest na stronie API Informacje ogólne.
Parametry
Parametr | Typ | Opis |
---|---|---|
name | String | Punkt o podanej w wyszukiwaniu nazwie. |
fields | String | Lista pól, oddzielonych przecinkiem, jakie mają zostać zwrócone w odpowiedzi. Pozwala na ograniczenie ilości danych przesyłanych do klienta. |
sort_by | String | Nazwa pola, po którym zostaną posortowane wyniki w kolekcji. Możliwe wartości:
|
sort_order | String | Kolejność sortowania wyników. Możliwe wartości:
|
type | String | Lista typów punktów, oddzielonych przecinkiem, jakie mają zostać zwrócone w odpowiedzi.
|
relative_point | Decimal | Punkt relatywny, od którego zostaną obliczone odległości do punktów zwróconych w odpowiedzi (distance_from_relative_point ) |
relative_post_code | String | Wyszukianie punktów wg położenia kodu pocztowego, od którego będzie liczona odległość do każdego z punktów. |
max_distance | Integer | Maksymalna odległość punktu od puntu relatywnego (relative_point ).Ma zastosowanie tylko z parametrem relative_point - jeśli nie zostanie on określony, serwer zwróci błąd invalid_parameter . |
limit | Integer | Limit ilości zwracanych punktów zastępujący stronicowanie w przypadku użycia parametru max_distance. |
functions | String | Lista funkcji punktów, oddzielonych przecinkiem, jakie mają zostać zwrócone w odpowiedzi. |
payment_available | Boolean | Filtrowanie listy punktów po dostępności płatności dla punktu. |
updated_from | Date | Wyszukiwanie punktów wg daty, po której nastąpiła aktualizacja punktu. |
updated_to | Date | Wyszukiwanie punktów wg daty, do której nastąpiła aktualizacja punktu. |
Stronnicowanie
Parametr | Typ | Opis |
---|---|---|
per_page | Integer | Ilość punktów wyświetlanych na stronie. |
page | Integer | Numer strony wyświetlanych punktów. |
Przykład zapytania
Code Block |
---|
GET https://api-shipx-pl.easypack24.net/v1/points HTTP/1.1 Host: api-shipx-pl.easypack24.net |
Odpowiedź
Code Block |
---|
HTTP/1.1 200 OK
Content-Type: application/json
{
"href":"https://api-pl-points.easypack24.net/v1/points",
"count":2158,
"page":1,
"per_page":25,
"total_pages":87,
"items":[
{
"href":"https://api-pl-points.easypack24.net/v1/points/AAB001",
"name":"AAB001",
"type":[
"parcel_locker"
],
"status": "Operating",
"location":{
"latitude":50.0834,
"longitude":20.03868
},
"location_description":null,
"opening_hours":null,
"address":{
"line1":"Jakaś ulica 12",
"line2":"30-432 Kraków"
},
"address_details":{
"city":"Kraków",
"province":"Malopolska",
"post_code":"30-432",
"street":"Jakaś ulica",
"building_number":"12",
"flat_number":null
},
"phone_number":null,
"payment_point_descr":null,
"functions":[
"parcel"
],
"partner_id":"0",
"is_next":null,
"payment_available": true,
"payment_type":{
"3":"Płatność gotówką i kartą"
}
},
{
"href":"https://api-pl-points.easypack24.net/v1/points/ABC123N",
"name":"ABC123N",
"type":[
"parcel_locker"
],
"location":{
"latitude":50.00933,
"longitude":19.89795
},
"location_description":null,
"opening_hours":null,
"address":{
"line1":"ul. Zawiła 65L",
"line2":"30-390 Kraków"
},
"address_details":{
"city":"Kraków",
"province":"Małopolska",
"post_code":"30-390",
"street":"ul. Zawiła",
"building_number":"65L",
"flat_number":null
},
"phone_number":null,
"payment_point_descr":null,
"functions":[
"parcel"
],
"partner_id":"0",
"is_next":true,
""payment_available": true,
"payment_type":{
"2":"Płatność kartą w Paczkomacie"
}
},
[...]
}
|
Szczegóły punktu
Pobieranie szczegółów punktu.
Code Block |
---|
GET /v1/points/:nazwa_punktu |
W odpowiedzi serwer zwróci szczegóły punktu.
Przykład zapytania
Code Block |
---|
GET https://api-shipx-pl.easypack24.net/v1/points/AAB001 HTTP/1.1
Host: api-shipx-pl.easypack24.net |
Odpowiedź
Code Block |
---|
HTTP/1.1 200 OK
Content-Type: application/json
{
"point": {
"href": "/v1/points/AAB001",
"name": "AAB001",
"type": [
"parcel_locker"
],
"status": "Operating",
"location": {
"latitude": 50.05449,
"longitude": 19.95255
},
"location_type": null,
"location_description": null,
"location_description_1": null,
"location_description_2": null,
"opening_hours": null,
"address": {
"line1": "Jakaśulica 22",
"line2": "30-432 Kraków"
},
"address_details": {
"city": "Kraków",
"province": "Malopolska",
"post_code": "30-432",
"street": "Jakaśulica",
"building_number": "22",
"flat_number": null
},
"phone_number": null,
"payment_point_descr": null,
"functions": [
"parcel",
"parcel_collect",
"parcel_send"
],
"partner_id": 0,
"is_next": false,
"payment_available": false,
"payment_type": {
"0": "Brak obsługi płatności"
}
}
} |
Szczegóły punktu
Pobieranie szczegółów punktu.
Code Block |
---|
GET /v1/points/:nazwa_punktu |
W odpowiedzi serwer zwróci szczegóły punktu.
Przykład zapytania
Code Block |
---|
GET https://api-shipx-pl.easypack24.net/v1/points/AAB001 HTTP/1.1
Host: api-shipx-pl.easypack24.net |
Odpowiedź
HTTP/1.1 200 OK
Content-Type: application/json
{
"point": {
"href": "/v1/points/AAB001",
"name": "AAB001",
"type": [
"parcel_locker"
],
"status": "Operating",
"location": {
"latitude": 50.05449,
"longitude": 19.95255
},
"location_type": null,
"location_description": null,
"location_description_1": null,
"location_description_2": null,
"opening_hours": null,
"address": {
"line1": "Jakaśulica 22",
"line2": "30-432 Kraków"
},
"address_details": {
"city": "Kraków",
"province": "Malopolska",
"post_code": "30-432",
"street": "Jakaśulica",
"building_number": "22",
"flat_number": null
},
"phone_number": null,
"payment_point_descr": null,
"functions": [
"parcel",
"parcel_collect",
"parcel_send"
],
"partner_id": 0,
"is_next": false,
"payment_available": false,
"payment_type": {
"0": "Brak obsługi płatności"
}
}
}