Versions Compared

Old Version 1

changes.mady.by.user Former user

Saved on

compared with

New Version 18

changes.mady.by.user Michał Machowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Collecting the list of points.

Changes since version 1.7.0:

  1. Entering hard validation for all parameters of Integer, Double, List <Integer> type: in case of incorrect format or incorrect value of API parameter returns error, so far the parameter was ignored.
  2. Removing Polish translations - in the request for a possible function or possible payment method.

Points resource represents the locations in which logistic operatorsthe logistics operator's services are available. Points can be self-service machines (Paczkomat Automatic Parcel Station, LaundromatParcel locker, ParcelPoint) or branches, customer service points. Each of the locations offers specific services - the list of these services is returned in to the response under the functions attribute
Resource location.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#E3FCEF


New environments with authorization

Production environments:

https://api

-shipx-pl

.

easypack24

inpost.

net

pl/v1/points

Panel
bgColor#f0f0f0
titleBGColor#f0f0f0
titleOn this page

Table of Contents
minLevel2
 

Structure

Points resource elements have the following attributes:

AttributeType

Description

 

hrefString

The URI address to the resource of the particular point

 

nameString

Point ID. This is its unique name, e.g. KRA007 (for a Parcel Station)

 

typeArray

Table specifying the kinds of points that are in the given location. Possible types of points:

• parcel_locker - Physical automatic parcel stations and shipment handling points where a parcel machine shipment can be sent.          

• pop - Shipment handling points.     

• parcel_locker_only - Only physical automatic parcel stations.      

• parcel_locker_superpop - Shipment handling points which a parcel machine shipment can be sent to.        

 

status
String

Point status.

 

locationObject

Location object containing information on the geographic location: latitude and longitude.

Sample Location object in the JSON format: 

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

Location type.

 

location_descriptionString

Additional information about point location that may make it easier to reach it.

 

location_description_1
String

Additional description.

location_description_2
String

Additional description.

distance
Integer

Distrance from a relative point stated in the search. If the relative point has not been provided, then it takes null value.

opening_hours
String

Point opening hours

addressObject

Address object containing address information about the point such as: street, postal code, city. Sample Address object in the JSON format:

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

Detailed point address data

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

Point telephone number

payment_point_descr
String

Additional information about the point

functionsArray

Table specifying the functions offered by the point. Possible functions:

parcel=Send and collect standard parcel parcel_send=Standard parcel send parcel_collect=Standard parcel collect parcel_reverse_return_send=Standard parcel reverse return to sender standard_letter_collect=Standard letter collect standard_letter_send=Standard letter send allegro_parcel_collect=Allegro parcel collect allegro_parcel_send=Allegro parcel send allegro_parcel_reverse_return_send=Allegro parcel return to sender allegro_letter_collect=Allegro letter collect allegro_letter_send=Allegro letter send allegro_letter

Generating access

  1. Go to the Parcel Manager website https://manager.paczkomaty.pl

  2. In the login window, enter your login and click: Login

  3. After logging in go to My Account tab

  4. In the Data tab check if all the company data is correctly filled in
    Remember, in order to generate access to API, both your company address and invoice data have to be filled in.

  5. After verification go to the new tab API

  6. To generate a new Point Access, expand the ShipX API tab and click Generate

  7. If you already have a token generated make sure to use a token from the list (Lista tokenów do API InPost (API ShipX oraz API Points)) for authentication. If you do not have such a list you need to generate a new token.

Sandbox Environment:
https://sandbox-api-gateway-pl.easypack24.net/v1/points

Generating access

  1. Go to the Parcel Manager website https://sandbox-manager.paczkomaty.pl/

  2. In the login window, enter your login and click: Login

  3. After logging in go to My Account tab

  4. In the Data tab check if all the company data is correctly filled in
    Remember, in order to generate access to API, both your company address and invoice data have to be filled in.

  5. After verification go to the new tab API

  6. To generate a new Point Access, expand the ShipX API tab and click Generate

  7. If you already have a token generated make sure to use a token from the list (Lista tokenów do API InPost (API ShipX oraz API Points)) for authentication. If you do not have such a list you need to generate a new token.

Info

More information on the available options Display of collection points

On this page

Table of Contents

Structure

Point resource has the following attributes:

Attribute

Type

Description

name 

String

Unique point name e.g. KRA007 (Parcel Locker)

type

Array

Table specifying types of points available at the location.

Possible types of points:

  • parcel_locker - Physical parcel locker and parcel points to which you can send your parcel.

  • pop - All parcel points.

  • parcel_locker_only - Only physical parcel locker.

  • parcel_locker_superpop - Parcel points which you can send your parcel. 

status 

String

Point status.

location

Object

Location object including the geographical location latitude and longitude

Location resource example in JSON format:

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


location_type

String

Location type.

location_description

String

Additional location description that may make it easier to reach.

location_description_1

String

Additional description

location_description_2

String

Additional description

distance

Integer

Distance from the relative point location. If the relative point has not been specified, takes null value.

opening_hours 

String

Point opening hours

address

Object

Address object containing the point's address information such as street, post-code, city.

Address object example in JSON format:

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


Code Block
address_details

Object

Detailed point address data

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


phone_number 

String

Point telephone number

payment_point_descr 

String

Additional information about the point

functions

Array

Table specifying the functions offered by the point. Possible functions:

Code Block
parcel=Send and collect standard parcel 
parcel_send=Standard parcel send 
parcel_collect=Standard parcel collect 
parcel_reverse_return_send=Standard parcel reverse return to sender 
standard_letter_collect=Standard letter collect 
standard_letter_send=Standard letter send 
allegro_parcel_collect=Allegro parcel collect 
allegro_parcel_send=Allegro parcel send 
allegro_parcel_reverse_return_send=Allegro
letter
parcel return to sender 
allegro_
courier
letter_collect=Allegro
courier
letter
parcel
collect
collect

allegro_
courier
letter_send=Allegro
courier
letter
parcel
send
send

allegro_
courier
letter_reverse_return_send=Allegro
courier
letter
parcel 
return to sender
standardAvailability of payments in the given point.
allegro_courier_collect=Allegro courier parcel collect 
allegro_courier_send=Allegro courier parcel send 
allegro_courier_reverse_return_send=Allegro courier parcel return to sender 
standard_courier_collect=Courier parcel collect 
standard_courier_send=Courier parcel send 
standard_courier_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

Is it a NEXT automatic parcel station

is_next
Boolean

Partner ID

60 - Parcel points Żabka

61 - Parcel lockers Żabka

is_next 

Boolean

Is it a NEXT automatic parcel station

payment_available 

Boolean

Availability of payment at a given point

There is a possibility of payment_available = true

together

with payment_type = 0,

this

it means

that

the payment is available

.

payment_

availableBoolean

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_typeStringvirtualvirtualIntegerPoint virtuality
recommended_low_interest_box_machines_listArrayRecommended other points nearby

 

Sample Point resource in the JSON format:

Code Block{ "href":"http://api-pl-points.easypack24.net/v1/points/KRA011", "name":"KRA011", "type":[

type 

String

Payment type parameter

virtual 

Integer

Virtual point

recommended_low_interest_box_machines_list 

Array

Other points recommended nearby

location_247 

Boolean

Is the parcel locker available 24/7 (Parcel lockers with the parameter set to true are dedicated service points for the Weekend Parcels service).

physical_type_mapped

String

Type of parcel locker

easy_access_zone

String

Description for type of parcel locker

Point resource in JSON format:

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": "",
                "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",
                "
parcel
standard_courier_
locker
send"
],
"status":"Operating"
],
"location":{
         "
latitude
partner_id":
50.09103
 0,
"longitude":19.9299
},
  
"
location
is_
type
next":
null
 false,
"location_description":"Stacja paliw Lukoil",
"location_description_1":"",
    "
location
payment_
description_2
available":
"LUKOIL"
 true,
"distance":null,
"opening_hours":null,
    "
address
payment_type": {
"line1":"Opolska
9",
       "
line2
0":
"31-274
Kraków
"Payments are not supported"
},
"address_details":{
"city":"Kraków", 
},
"province":"małopolskie",
       "
post_code
virtual": "
31-274
0",
"street":"Opolska",
"building_number":"9",
"recommended_low_interest_box_machines_list": null,
            "
flat
apm_
number
doubled": null,
},
"phone_number":null,
    "
payment_point
location_
descr
247":
"Płatność internetowa PayByLink"
 true,
"functions":[
         "
allegro
operating_
courier
hours_
collect",
extended": {
"allegro_courier_reverse_return_send",
       "
allegro_courier_send", 
customer": null
"allegro_letter_send",
"allegro_parcel_collect"
},
"allegro_parcel_reverse_return_send",
        "agency": "
allegro_parcel_send
IPM5426863",
"parcel",
"parcel_collect
"image_url": "https://static.easypack24.net/points/pl/images/KRA02APP.jpg",
"parcel_reverse_return_send",
       "
parcel
easy_access_
send
zone": true,
"standard_courier_reverse_return_send",
       "
standard
air_
courier
index_
send
level": null,
],
"partner_id":0,
    "
is
physical_type_
next
mapped":
false,
"payment_available":true
"006",
"payment_type":{
         "
0
physical_type_description": "
Brak obsługi płatności" },
Ważne! Swoją paczkę odbierzesz wygodniej z aplikacją InPost"
"virtual":"0",
"recommended_low_interest_box_machines_list":null
 }

Authentication

Access to the resource does not require authentication.. 

List of points

Pobieranie listy punktów.

Code Block
GET /v1/points

In the response the server will return a collection with the list of points.
The collection supports paging that is described on page API General.

Sample request

Code Block

List of Points

List of Points retrieval, the collection supports pagination, which can be found in API General information.

Code Block
GET /v1/points

Example request

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

Response

HTTP/1.1 200 OK 
-H 'Content-Type: application/json
'

Response

Code Block
languagejson
{
    
"href": "https://api-pl-points.easypack24.net/v1/points",
    "count":
5363
 19378,
    "page": 1,
    "per_page": 25,
    "total_pages":
215
 776,
    "items": [
        {
            "href": "
http
https://api-pl-points.easypack24.net/v1/points/
ADA01N
ADA01M",
            "name": "
ADA01N
ADA01M",
            "type": [
                "parcel_locker"
            ],
            "status": "Operating",
            "location": {
                "
latitude
longitude":
51
 22.
74455
26405,
                "
longitude
latitude":
22.25847
 51.73834
            },
}
"location_type": "Outdoor",
            "location_
type
date": null,
            "location_description": "Przy sklepie
Groszek
Lewiatan",
            "location_description_1": null,
            "location_description_2":
"Groszek"
 null,
            "distance": null,
            "opening_hours": "24/7",
            "address": {
                "line1": "
Kleeberga
Kościuszki
5B
27",
                "line2": "21-412 Adamów"
            },
            "address_details": {
                "city": "Adamów",
                "province": "lubelskie",
                "post_code": "21-412",
                "street": "
Kleeberga
Kościuszki",
                "building_number": "
5B
27",
                "flat_number": null
            },
            "phone_number": null,
            "payment_point_descr": "Płatność internetowa
PayByLink. Dostępność 24/7",
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":
true
 false,
            "payment_available": true,
            "payment_type": {
                "0": "
Brak
Payments are
obsługi
not
płatności
supported"
            },
            "virtual": "0",
            "recommended_low_interest_box_machines_list": null,
},
{
"apm_doubled": null,
            "
href":"http://api-pl-points.easypack24.net/v1/points/ALK01A"
location_247": true,
"name
   "operating_hours_extended":
"ALK01A",
 {
"type":[
        "customer": null
"parcel_locker"
       },
],
          "
status
agency": "
Operating
IPM4633224",
"location
   "image_url":
{ 
 "https://static.easypack24.net/points/pl/images/ADA01M.jpg",
            
"
latitude
easy_access_zone":
52.8684
 true,
            "
longitude
air_index_level":
18.7031 
 null,
},
          "
location
physical_type_mapped":
null,
 "004",
            "
location_description":"Przy biurze usług ubezpieczeniowych", 
physical_type_description": null
"location_description_1":""
},
    {...},
"location_description_2":""
{...},
  ]
"distance":null, 
}

Point details

Get point details.

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

Example request

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

Response

Code Block
languagejson
{
    "
opening_hours
href":
"24/7", 
 "https://api-pl-points.easypack24.net/v1/points/KRA012",
    "name": "
address
KRA012"
:{
,
    "type": [
        "
line1":"Słowackiego 131",
parcel_locker"
    ],
    
"
line2
status":
"87-700 Aleksandrów Kujawski"
 "Operating",
}, 
"location": {
        "
address_details
longitude":
{ 
 20.00399,
        
"
city
latitude":
"Aleksandrów Kujawski", 
 50.08913
    },
    "
province
location_type": "
kujawsko-pomorskie
Outdoor",
    "location_date": null,
    
"
post
location_
code
description":
"87-700
 "Stacja paliw Lotos",
    
"location_description_1": null,
    "
street
location_description_2": "
Słowackiego
Lotos",
    
"distance": null,
    
"
building
opening_
number
hours": "
131",
24/7",
    "address": {
        "
flat_number
line1":
null
 "Os. Kombatantów 20",
],
"line2": "31-630 Kraków"
[...]
 },

Point details

Collecting point details.

Code Block
GET /v1/points/:nazwa_punktu

In the response the server will return point details.

Sample request

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

Response

Code BlockHTTP/1.1 200 OK Content-Type: application/json {
 "address_details": {
        "city": "Kraków",
        "province": "małopolskie",
        "
href
post_code": "
http://api-pl-points.easypack24.net/v1/points/ADA01N",
31-630",
        "
name
street": "
ADA01N
Os. Kombatantów",
        "
type
building_number":
[
 "20",
        "
parcel
flat_
locker"
number": null
    },
]
"phone_number": null,
    "
status
payment_point_descr": "
Operating",
Płatność w Paczkomacie kartą
"location":{
płatniczą lub BLIKIEM oraz internetowo aplikacją InPost Mobile i
"latitude":51.74455, 
PayByLink",
    
"
longitude
functions":
22.25847
 [
},
    "
location
allegro_courier_
type
collect"
:null
,
"location_description":"Przy sklepie Groszek",
     "
location_description_1":null,
allegro_courier_reverse_return_send",
        "
location
allegro_
description
courier_
2":
send"
Groszek"
,
"distance":null,
     "
opening_hours":"24/7", "address":{
allegro_letter_send",
        "
line1":"Kleeberga 5B",
allegro_parcel_collect",
        "
line2":"21-412 Adamów"
allegro_parcel_reverse_return_send",
},
    "
address
allegro_parcel_
details
send"
:{
,
        "
city":"Adamów
parcel",
        "
province":"lubelskie",
parcel_collect",
        "
post_code":"21-412",
parcel_reverse_return_send",
        "
street":"Kleeberga",
parcel_send",
        "
building_number":"5B
standard_courier_reverse_return_send",
        "
flat
standard_courier_
number
send"
:null
}
],
    "
phone
partner_
number
id":
null
 0,
    "
payment
is_
point_descr
next":
"Płatność internetowa PayByLink. Dostępność 24/7",
 false,
    "
functions
payment_available":
[
 
true,
    "
allegro
payment_
courier_collect
type"
,
:
"allegro_courier_reverse_return_send",
{
"allegro_courier_send", "allegro_letter_reverse_return_send"
"2": "Payment by card in the machine"
    },
    
"virtual": "
allegro_letter_send
0",
"allegro_parcel_collect",
"recommended_low_interest_box_machines_list": [
        "
allegro_parcel_reverse_return_send
KRA175M",
        "
allegro_parcel_send
KRA274M",
        "
parcel
KRA227M",
        "
parcel_collect
KRA273M",
"parcel_reverse_return_send",
  "KRA144M"
    ],
    "
parcel
apm_
send
doubled": null,
    "location_247": true,
    "
standard
operating_
courier_reverse_return_send",
hours_extended": {
        "
standard_courier_send
customer": null
]
},
    "
partner_id
agency":
0
 "IPM4956660",
    "
is_next":true,
image_url": "https://static.easypack24.net/points/pl/images/KRA012.jpg",
    "
payment
easy_access_
available
zone":
true
 false,
    "
payment
air_index_
type
level":
{
 null,
"0
"physical_type_mapped": "
Brak
001",
obsługi
płatności"
},
"virtual":"0",
    "
recommended
physical_
low_interest_box_machines_list
type_description": null
}

Search criteria

Parameter

Type

Description

Example

name

String
Array

Point

Searches for shipments with

the name specified in the search

given name.

Searches for shipments with given names.

?name=KRA010
?name=Kra010,ADA01N

type

String
Array

List of types of points, comma separated, which are to be returned in the response

Searches for shipments with given type.

Searches for shipments with given types.

?type=parcel_locker
?type=parcel_locker,pop

functions

String
Array

Searches for

points

shipments with

the stated

given function.

Searches for

points

shipments with

all the listed

given functions.

?functions=parcel
?functions=

parcel

parcel,parcel_send

partner_id

Integer
Array

Searches for

points

shipments with

the stated

given partner

_id

ID.

Searches for

points

shipments with

the stated

given partner

_id

IDs.

?partner_id=1
?partner_id=1,2

is_next

Boolean

Searches for NEXT parcel locker points

that are NEXT

?is_next=true

payment_available 

Boolean

Filtering the list of points on the availability of payments for

Searches by payment availability at the point

.

?payment_available=true

post_code

String
Array

Searches for

points which have the stated postal

shipments with given post code.

Searches for

points which have the stated postal

shipments with given post codes.

?post_code=11-111
?post_code=11-111,22-222

city

String
Array

Searches for

points which have the stated

shipments with given city.

Searches for

points which have the stated city

shipments with given cities.

?city=Kraków

?city=Kraków,Warszawa

province

String
Array

Searches for

points which have the stated voivodeship. Searches for points which have the stated voivodeships

shipments with given province.

Searches for shipments with given provinces.

?province=Małopolska

?province=Małopolska,Śląsk

virtual

Integer
Array

Searches for

points with the stated virtuality. Searches for points with the stated virtualities.?virtual=0
?virtual=1,6 updated_from
Date

Search for points by the date when the point update was made. The parameter should be provided together with updated_to.

If the updated_to parameter has not been specified, the date cannot be earlier than 3 days back counting from the current date.

?updated_from=2018-04-24 updated_to
Date

Search for points by the date when the point update was made. The parameter should be provided together with updated_from.

If the updated_from parameter has not been specified, the date cannot be later than 3 days back counting from the updated_from parameter

shipments with given virtual value.

Searches for shipments with given virtual values.

?virtual=0
?virtual=1,6

updated_from

Date

Searches for points updated after the given date

If updated_to  has not been given the date cannot be earlier than 3 days before the current date

?updated_from=2018-04-24

updated_to

Date

Searches for points updated before the given date

Requires providing updated_from.

?updated_to=2018-04-26

Search by location

relative_point 

String

Searches for points

located as close as possible

closest to the

stated geographical coordinates.

given location

?relative_point=52.123,19.321

relative_post_code 

String

Searches for points

located as close as possible

closest to the

stated postal

given post code

.

?relative_post_code=11-111

max_distance 

Double

Specifies distance in meters from the point stated in .

Searches for points in distance up to the given value from relative_point or relative_post_code

.Using the parameter forces

 

Parameter usage requires sorting by distance.

 

Default value: 10000 (10km)

Maximum value

:

50000 (50km)

?relative_point=52.123,19.321&max_distance=10000

limit 

Integer

Limit of returned points

Point limiting parameter when using

parameters in

relative_point  or relative_post_code

.

 

?limit=10

Sorting results

Result sorting

name 

Sorting

Sort by point name

.

?sort_by=name

distance_to_relative_point

Sorting

Sort by relative distance

from the relative point

(relative_point or relative_post_code)

?sort_by=distance_to_relative_point

status

Sorting

Sort by status

?sort_by=status

Sorting

Sort ordering can be

done in both directions, using the sort_order parameter:

set using sort_order  attribute. By default the results are sorted in an ascending order using the name field.

asc

Sorts

points

in ascending order

?sort_order=asc&sort_by=status

desc

Sorts

points

in descending order

?sort_order=desc&sort_by=status

By default, the results are sorted ascending (asc) by point name (name).

Paging

pageSpecifies the results page, which should be returned.

Pagination

page

Defines the page for which the results should be returnet

?page=2

per_page

Specifies

Defines the

number of results displayed on the page.

 

Default value

amount of points returned per page

Default: 25
Maximum

value

: 500

?per_page=100

Filtering

displayed

of returned fields

fields

Specifies

Defines the

list of

point attributes

to be displayed on page.

that should be returned

?fields=name,type