Page History

Zasób Points reprezentuje lokalizacje, w których dostępne są usługi operatorów logistycznych. Punktami mogą być maszyny samoobsługowe (Paczkomat, Pralniomat) 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.

Lokalizacja zasobu:

https://api-shipx-pl.easypack24.net/v1/points

Panel

bgColor	#f0f0f0
titleBGColor	#f0f0f0
title	Na tej stronie

Table of Contents

minLevel	2

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 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

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 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

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

phone_number

String

Numer telefonu punktu

payment_point_descr

String

Informacje dodatkowe o punkcie

functions

Array

Tablica określające jakie fukcje posiada punkt.
Możliwe funkcje:

parcel
parcel_send
parcel_collect
parcel_reverse_return_send
standard_letter_collect
standard_letter_send
allegro_parcel_collect
allegro_parcel_send
allegro_parcel_reverse_return_send
allegro_letter_collect
allegro_letter_send
allegro_letter_reverse_return_send
allegro_courier_collect
allegro_courier_send
allegro_courier_reverse_return_send
standard_courier_collect
standard_courier_send
standard_courier_reverse_return_send
air_on_airport
air_outside_airport
cool_parcel_collect
laundry
avizo

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:

"0": "Brak obsługi płatności"
"1": "Płatność gotówką w punkcie płatności"
"2": "Płatność kartą w Paczkomacie"
"3": "Płatność gotówką i kartą"

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: name (domyślne), distance_to_relative_point
`sort_order`	String	Kolejność sortowania wyników. Możliwe wartości: ASC (domyślnie) - sortuj wyniki w kolejności rosnącej, DESC - srotuj wyniki z kolejności malejącej,
`type`	String	Lista typów punktów, oddzielonych przecinkiem, jakie mają zostać zwrócone w odpowiedzi. 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ą.
`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"
    }
  }
}

Page tree

Versions Compared

Old Version 12

New Version Current

Key

Struktura

Uwierzytelnianie

Lista punktów

Szczegóły punktu

Szczegóły punktu