Versions Compared

Old Version 17

changes.mady.by.user anagorski

Saved on

compared with

New Version Current

changes.mady.by.user Michał Machowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Info
titleUwaga!

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:

  1. 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.
  2. Usunięcie polskich tłumaczeń - w zapytaniu o możliwe funkcję lub możliwej metodzie płatności.
  3. Wprowadzenie maksymalnej wartości parametru per_page wynoszącej 500; dotychczas: bez limitu
Panel
bgColor#f0f0f0
titleBGColor#f0f0f0
titleNa tej stronie

Table of Contents
minLevel2
 

Struktura

Zasób Point posiada

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.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#E3FCEF

Nowe środowiska z autoryzacją

Środowisko produkcyjne:

https://api.inpost.pl/v1/points

Generowanie dostępu

  1. Wejdź na stronę Managera Paczek https://manager.paczkomaty.pl/

  2. W oknie logowania wpisz swój login i kliknij: Zaloguj

  3. Po zalogowaniu na konto przejdź do zakładki Moje Konto

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

  5. Po weryfikacji przejdź do nowej zakładki API

  6. Aby wygenerować nowy dostęp do Zasobu Points, rozwiń zakładkę API ShipX i kliknij Generuj

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

  1. Wejdź na stronę Managera Paczek https://sandbox-manager.paczkomaty.pl/

  2. W oknie logowania wpisz swój login i kliknij: Zaloguj

  3. Po zalogowaniu na konto przejdź do zakładki Moje Konto

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

  5. Po weryfikacji przejdź do nowej zakładki API

  6. Aby wygenerować nowy dostęp do Zasobu Points, rozwiń zakładkę API ShipX i kliknij Generuj

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

Info

Więcej informacji o dostępnych sposobach prezentacji punktów odbioru Prezentowanie punktów odbioru

Na tej stronie

Table of Contents


Struktura

Zasób Point posiada następujące atrybuty:

Atrybut

Typ

Opis

Dostępny

name 

String

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

Paczkomatu

Paczkomat®)

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

  • Paczkomat® i

punkty obsługi przesyłek

  • paczkopunkty do których można nadać przesyłkę

paczkomatową

  • Paczkomat®.

  • pop -

Punkty obsługi przesyłek

  • Paczkopunkty.

  • parcel_locker_only - Tylko fizyczne

paczkomaty

  • Paczkomat®.

  • parcel_locker_superpop -

Punkty obsługi przesyłek

  • Paczkopunkty do których można nadać przesyłkę

paczkomatową

  • Paczkomat®.

PL, IT

status 

String

Status punktu.

PL, IT

(Operating, NonOperating, Disabled)

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.

PL, ITpayment

payment_point_descr 

String

Informacje dodatkowe o punkcie.

functions

Array

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

PL, IT

Identyfikator

Opis funkcji

parcel

Send and collect standard parcel 

PL, IT

parcel_send

Standard parcel send 

PL, IT

parcel_collect

Standard parcel collect 

PL, IT

parcel_reverse_return_send

Standard parcel reverse return to sender 

PL, IT

standard_letter_collect

Standard letter collect 

PL

standard_letter_send

Standard letter send 

PL

allegro_parcel_collect

Allegro parcel collect 

PL

allegro_parcel_send

Allegro parcel send 

PL

allegro_parcel_reverse_return_send

Allegro parcel return to sender 

PL

allegro_letter_collect

Allegro letter collect 

PL

allegro_letter_send

Allegro letter send 

PL

allegro_letter_reverse_return_send

Allegro letter return to sender 

PL

allegro_courier_collect

Allegro courier parcel collect 

PL

allegro_courier_send

Allegro courier parcel send 

PL

allegro_courier_reverse_return_send

Allegro courier parcel return to sender 

PL

standard_courier_collect

Courier parcel collect 

PL

standard_courier_send

Courier parcel send 

standard_courier_

sendCourier parcel send PLstandard_courier_reverse_return_sendCourier parcel return to sender PLair_on_airportSend and collect baggage from machine on airport PLair_outside_airportSend and collect baggage from machine outside of airport PLcool_parcel_collectReservation collect from cooling machine PLlaundrySend and collect laundry PLavizoAvizo collectPL, ITpartner_idInteger

ID partnera.

PL, IT

is_next 

BooleanCzy jest to paczkomat typu NEXTPL, 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, ITpayment_type StringvirtualPL, ITvirtual IntegerWirtualność punktuPL, ITrecommended_low_interest_box_machines_list ArrayRekomendowane inne punkty w pobliżuPL, ITlocation_247 BooleanCzy paczkomat dostępny jest 24/7PL, ITeasy_access_zoneBooleanCzy paczkomat posiada strefę ułatwionego dostępuPL, IT

Przykład zasobu Point w formacie JSON:

Code Block{ "href":"http

reverse_return_send

Courier parcel return to sender 

air_on_airport

Send and collect baggage from machine on airport 

air_outside_airport

Send and collect baggage from machine outside of airport 

cool_parcel_collect

Reservation collect from cooling machine 

laundry

Send and collect laundry 

avizo

Avizo collect

partner_id

Integer

ID partnera.
"partner_id":0 - Paczkomat®

"partner_id": 33 - PaczkoPunkt z funkcją odbioru przesyłki Paczkomat®

"partner_id": 30 - PaczkoPunkt bez funkcji odbioru przesyłki Paczkomat®, posiada tylko funkcję nadania przesyłek.

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

virtual.

virtual 

Integer

Wirtualność punktu.

recommended_low_interest_box_machines_list 

Array

Rekomendowane inne punkty w pobliżu.

location_247 

Boolean

Czy Paczkomat® dostępny jest 24/7 (Paczkomat® z parametrem ustawionym na true są dedykowanymi punktami do obsługi usługi Paczka w Weekend).

easy_access_zone

Boolean

Czy Paczkomat® posiada strefę ułatwionego dostępu.

physical_type_mapped

String

Typ Paczkomat®

physical_type_description

String

Opis typu Paczkomat®

Przykład zasobu Point w formacie JSON:

Code Block
languagejson
       {
            "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": null,
                "flat_number": null
            },
            "phone_number": null,
            "payment_point_descr": "Płatność apką InPost 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": [
                "KRA106M",
                "KRA20M",
                "KRA208M",
                "KRA197M",
                "KRA356M"
            ],
            "apm_doubled": null,
            "location_247": true,
            "operating_hours_extended": {
                "customer": null
            },
            "agency": "IPM9988771",
            "image_url": "https://static.easypack24.net/points/pl/images/KRA02APP.jpg",
            "easy_access_zone": true,
            "air_index_level": "GOOD",
            "physical_type_mapped": "006",
            "physical_type_description": "Appkomat InPost – 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.

Code Block
languagejson
GET /v1/points

Przykład zapytania

Code Block
languagejson
curl -X GET https://api.inpost.pl/v1/points -H 'Content-Type: application/json'

Odpowiedź

Code Block
languagejson
{
    "href": "https://api-pl-points.easypack24.net/v1/points",
    "count": 24797,
    "page": 1,
    "per_page": 25,
    "total_pages": 992,
    "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ść apką InPost 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.

Code Block
languagejson
GET /v1/points?name=point_name

Przykład zapytania

Code Block
languagejson
curl -X GET https://api.inpost.pl/v1/points?name=KRA02APP -H 'Content-Type: application/json'

Odpowiedź

Code Block
languagejson
{
    "href": "https://api-pl-points.easypack24.net/v1/points",
    "count": 1,
    "page": 1,
    "per_page": 25,
    "total_pages": 1,
    "items": [
        {
            "href": "https://api-pl-points.easypack24.net/v1/points/
KRA011
KRA02APP",
            "name": "
KRA011
KRA02APP",
            "type": [
                "parcel_locker"
],
"status":"Operating"
],
"location":{
         "
latitude
status":
50.09103, 
 "Operating",
"longitude":19.9299
},
    "location
_type
":
null,
 {
"location_description":"Stacja
paliw
Lukoil",
"location_description_1":"", "location_description_2":"LUKOIL",
        "
distance
longitude":
null
 19.87325,
"opening_hours":null,
"address":{
         "
line1
latitude":
"Opolska 9",
 50.00919
"line2":"31-274
Kraków"
    },
"address_details":{
         "
city
location_type": "
Kraków
Outdoor",
"province":"małopolskie",
      
"
post_code":"31-274"
location_date": null,
"street":"Opolska",
       "
building
location_
number
description": "
9",
Prywatna posesja wjazd od strony Dobrowolskiego",
"flat_number":null
},
"phone_number":null, 
   "
payment
location_
point
description_
descr
1":
"Płatność internetowa PayByLink"
 null,
"functions":[
         "
allegro
location_
courier
description_
collect
2": null,
            "
allegro_courier_reverse_return_send"
distance": null,
"allegro_courier_send",
       "
allegro_letter_send
opening_hours": "24/7",
"allegro_parcel_collect",
"allegro_parcel_reverse_return_send", 
"address": {
"allegro_parcel_send",
"parcel",
    "line1": 
"
parcel_collect
Dobrowolskiego",
"parcel_reverse_return_send",
"parcel_send",
       "
standard_courier_reverse_return_send", 
line2": "30-394 Kraków"
"standard_courier_send"
],
"partner_id":0,
},
"is_next":false,
"payment_available":true,
    "
payment
address_
type
details": {
"0":"Brak
obsługi
płatności"
},
    "
virtual
city":
"0", "recommended_low_interest_box_machines_list":null
 "Kraków",
"easy_access_zone":
true
}

Uwierzytelnianie

Dostęp do zasobu nie wymaga uwierzytelnienia. 

Lista punktów

Pobieranie listy punktów. Kolekcja wspiera stronicowanie, które opisane jest na stronie Informacje ogólne.

Code BlockGET
/v1/points

Przykład zapytania

Code Blockcurl
-X
GET
https://api-shipx-pl.easypack24.net/v1/points
-H
'Content-Type:
application/json'

Odpowiedź

Code Block{
    "
href
province":
"https://api-pl-points.easypack24.net/v1/points
 "małopolskie",
"count":5363,
"page":1,
   "
per
post_
page
code":
25,
"total_pages":215
"30-394",
"items":[
{
        "
href
street":
"http://api-pl-points.easypack24.net/v1/points/ADA01N",
 "Dobrowolskiego",
"name":"ADA01N"
         "building_number": null,
"type":[
           "
parcel
flat_
locker
number": null
],
"status":"Operating",
},
"location
   "phone_number":
{
 null,
"latitude":51.74455,
    "payment_point_descr": "Płatność apką InPost oraz
"longitude":22.25847
PayByLink",
},
      
"
location_type
functions":
null,
 [
"location_description":"Przy
sklepie
Groszek",
       "
location
allegro_
description
courier_
1
collect"
:null,
,
"location_description_2":"Groszek
  "allegro_courier_reverse_return_send",
"distance":null,
          "
opening_hours":"24/7
allegro_courier_send",
"address":{
          "
line1":"Kleeberga 5B
allegro_letter_reverse_return_send",
"line2":"21-412
Adamów"
}
"allegro_letter_send",
"address_details":{
          "
city":"Adamów
allegro_parcel_collect",
"province":"lubelskie", 
       "
post_code":"21-412", 
allegro_parcel_reverse_return_send",
"street":"Kleeberga",
 
    "
building_number":"5B
allegro_parcel_send",
"flat_number":null
},
       "
phone_number
parcel"
:null
,
"payment_point_descr":"Płatność
internetowa
PayByLink.
Dostępność
24/7",
"functions":[
  
"
allegro
parcel_
courier_
collect",
"allegro_courier_reverse_return_send", 

                "parcel_reverse_return_send",

                "parcel_send",

                "standard_courier_reverse_return_send",
"standard_courier_send" 

                "standard_courier_send"
            ],
"partner_id":0,
       "
is
partner_
next
id":
true
 0,
"payment_available":true,
       "
payment
is_
type
next":
{
"0":"Brak obsługi płatności" },
false,
            "
virtual
payment_available":
"0", 
 true,
"recommended_low_interest_box_machines_list":null,
        "
easy
payment_
access_zone
type": {
true
},
{...},
{...}, ] }

Szczegóły punktu

Pobieranie szczegółów punktu.

Code Block
GET /v1/points/:point_name

Przykład zapytania

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

Odpowiedź

Code BlockHTTP/1.1 200 OK Content-Type: application/json {
 "0": "Payments are not supported"
            },
            "
href
virtual":
"http://api-pl-points.easypack24.net/v1/points/ADA01N",
 "0",
"name":"ADA01N",
    "
type
recommended_low_interest_box_machines_list": [
"parcel_locker"
],
    "
status":
KRA106M"
Operating"
,
"location":{
           "
latitude
KRA20M"
:51.74455
,
"longitude":22.25847
},
    "
location_type
KRA208M"
:null
,
"location_description":"Przy sklepie Groszek",
"location_description_1":null,
"location_description_2":"Groszek",
    "
distance
KRA197M"
:null
,
"opening_hours":"24/7",
"address":{
         "
line1
KRA356M"
:"Kleeberga
5B",
"line2":"21-412
Adamów"
}
],
"address_details":{
         "
city":"Adamów", 
apm_doubled": null,
"province":"lubelskie",
       "
post
location_
code
247":
"21-412", 
 true,
"street":"Kleeberga",
       "
building
operating_hours_
number
extended":
"5B",
 {
"flat_number":null
},
    "
phone_number
customer": null
,
"payment_point_descr":"Płatność
internetowa
PayByLink.
Dostępność
24/7"
},
"functions":[
         "agency": "
allegro_courier_collect
IPM9988771",
            "
allegro_courier_reverse_return_send
image_url": "https://static.easypack24.net/points/pl/images/KRA02APP.jpg",
"allegro_courier_send",
      
"
allegro_letter_reverse_return_send", 
easy_access_zone": true,
"allegro_letter_send",
       "
allegro
air_
parcel_collect
index_level": "GOOD",
"allegro_parcel_reverse_return_send",
       "
allegro
physical_
parcel_send
type_mapped": "006",
"parcel",
       "
parcel_collect", "parcel_reverse_return_send",
physical_type_description": "Appkomat InPost – swoją paczkę odbierzesz wygodniej z aplikacją InPost"
"parcel_send",
  }
"standard_courier_reverse_return_send"
],
    "meta": {
"standard_courier_send"
],
    "
partner_id
href":
0,
"is_next":true
"https://api-pl-points.easypack24.net/v1/points",
"payment_available":true,
     "
payment_type
count":
{
 1,
        "
0
page":
"Brak
obsługi
1,
płatności"
},
    "
virtual
per_page":
"0",
 25,
        "
recommended_low_interest_box_machines_list":null,
total_pages": 1
"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,parcel_send

PL, ITPL, IT

partner_id

Integer
Array

Wyszukuje punkty o podanym partner_id.
Wyszukuje punkty o podanych partner_id.

?partner_id=1
?partner_id=1,2



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-26PL, IT

do której nastąpiła aktualizacja punktu.

Wymaga podania updated_from.

?updated_to=2018-04-26

location_247

Boolean

Wyszukiwanie punktów które są dostępne 24/7. (Paczkomat® z parametrem ustawionym na true są dedykowanymi punktami do obsługi usługi Paczka w Weekend).

?location_247=true

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

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 listę atrybutów punktu, która ma zostać wyświetlona na stronie.

?fields=name,type

PL, IT