Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
bgColor#f0f0f0titleBGColor#f0f0f0title

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 Stationlocker, LaundromatParcelPoint) 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


Production environment:

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

Panel

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

Info

More information on the available options Display of collection points


On this page

Table of Contents
minLevel2
 

Structure

Points

Point resource

elements have

has the following attributes:

Attribute

Type

Description

href

name 

String

The URI address to the resource of the particular point

nameStringPoint ID. This is its unique name, e.

Unique point name e.g. KRA007 (

for a

Parcel

Station

Locker)

type

Array

Table specifying

the kinds

types of points

that are in

available at the

given

location.

Possible types of points:

  • parcel_locker - Physical

automatic
  • parcel

machine
  • locker and

shipment handling points where a parcel machine shipment can be sent.          

• pop - Shipment handling points.     

  • parcel points to which you can send your parcel.

  • pop - All parcel points.

  • parcel_locker_only - Only physical

automatic
  • parcel

machine
  • locker.

      
  • parcel_locker_superpop -

Shipment handling
  • Parcel points which

a parcel machine shipment can be sent to.        status
  • you can send your parcel. 

status 

String

Point status.

location

Object

Location object

containing information on

including the

geographic

geographical location

:

latitude and longitude

.

Sample

Location

object

resource example in

the

JSON format:

 

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


location_type

String

Location type.

location_description

String

Additional

information about point

location description that may make it easier to reach

it

.

location_description_1

String

Additional description

.

location_description_2

String

Additional description

.

distance

Integer

Distrance

Distance from

a

the relative point

stated in the search

location. If the relative point has not been

provided

specified,

then it

takes null value.

opening_hours 

String

Point opening hours

address

Object

Address object containing the point's address information

about the point

such as

:

street,

postal

post-code, city.

Sample

Address object example in

the

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 parcel return to sender 
allegro_letter_collect=Allegro letter collect 
allegro_letter_send=Allegro letter send 
allegro_letter_reverse_return_send=Allegro letter return to sender 
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

Partner ID

is_next 

Boolean

Is it a NEXT automatic parcel station

is

payment_

next

available 

Boolean

Availability of

payments in the

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":[ "parcel_locker" ], "status":"Operating", "location":{

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

easy_access_zone

Boolean

Does the parcel locker have an easy access zone?

Point resource in JSON format:

Code Block
languagejson
{
            "href": "https://api-pl-points.easypack24.net/v1/points/KRA012",
            "name": "KRA012",
            "
latitude
type":
50.09103,
 [
        
"longitude":19.9299
    
},
    "
location
parcel_
type":null,
locker"
      
"location_description":"Stacja paliw Lukoil",
      ],
      
"location_description_1":"",
      "
location_description_2
status": "
LUKOIL
Operating",
   
"distance":null,
     
"opening_hours":null,
    "
address
location": {
        
"line1":"Opolska
 
9",
       "
line2
longitude":
"31-274 Kraków"
 20.00399,
   
},
    
"address_details":{
         "
city
latitude":
"Kraków",
 50.08913
     
"province":"małopolskie",
       
"post_code":"31-274"
},
      
"street":"Opolska",
      
"
building
location_
number
type": "
9
Outdoor",
            "
flat
location_
number
date": null,
   
},
     
"phone_number":null,
    "
payment
location_
point_descr
description": "
Płatność
Stacja 
internetowa
paliw 
PayByLink
Lotos",
   
"functions":[
         "
allegro
location_
courier
description_
collect
1": null,
      
"allegro_courier_reverse_return_send
      "location_description_2": "Lotos",
      
"allegro_courier_send",
      "
allegro_letter_send"
distance": null,
      
"allegro_parcel_collect",
      "
allegro_parcel_reverse_return_send
opening_hours": "24/7",
      
"allegro_parcel_send",
      
"
parcel
address"
,
: {
     
"parcel_collect",
       
"parcel_reverse_return_send",
    "line1": "Os. Kombatantów 
"parcel_send
20",
      
"standard_courier_reverse_return_send",
       
"standard_courier_send"
   
],
"line2": "31-630 Kraków"
            
"partner_id":0
},
   
"is_next":false,
     
"payment_available":true,
    "
payment
address_
type
details": {
      
"0":"Brak
 
obsługi
 
płatności"
    
},
    "
virtual
city": "
0
Kraków",
   
"recommended_low_interest_box_machines_list":null
             "province": "małopolskie",
                "post_code": "31-630",
                "street": "Os. Kombatantów",
                "building_number": "20",
                "flat_number": null
            },
            "phone_number": null,
            "payment_point_descr": "Płatność w Paczkomacie kartą płatniczą lub BLIKIEM oraz internetowo aplikacją InPost Mobile i 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": {
                "2": "Payment by card in the machine"
            },
            "virtual": "0",
            "recommended_low_interest_box_machines_list": [
                "KRA175M",
                "KRA274M",
                "KRA227M",
                "KRA273M",
                "KRA144M"
            ],
            "apm_doubled": null,
            "location_247": true,
            "operating_hours_extended": {
                "customer": null
            },
            "agency": "IPM4956660",
            "image_url": "https://static.easypack24.net/points/pl/images/KRA012.jpg",
            "easy_access_zone": false,
            "air_index_level": null
        }

Authentication

Access to the resource does not require authentication.


List of

pointsPobieranie listy punktówSample

Points

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

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.

Example request

Code Block
curl -X GET https://api-shipx-pl.easypack24.net/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": {
      
"status":"Operating",
          "
location
longitude":
{
 22.26405,
                "latitude": 51.
74455,
73834
            },
  
"longitude":22.25847
          
}
"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 obsługi
 
płatności
"Payments are not supported"
      
},
      },
   
"virtual":"0",
         
"recommended_low_interest_box_machines_list
"virtual":
null }, {
 "0",
            "
href":"http://api-pl-points.easypack24.net/v1/points/ALK01A"
recommended_low_interest_box_machines_list": null,
         
"name
   "apm_doubled":
"ALK01A"
 null,
         
"type
   "location_247":
[
 true,
            
"
parcel
operating_hours_
locker
extended": {
        
],
        
"
status
customer":
"Operating",
 null
         
"location":{
   },
            "
latitude
agency":
52.8684
 "IPM4633224",
            
"longitude":18.7031
"image_url": "https://static.easypack24.net/points/pl/images/ADA01M.jpg",
         
},
   
"location_type":null
"easy_access_zone": true,
         
"location_description":"Przy biurze usług ubezpieczeniowych",
   "air_index_level": null
        },
   
"location_description_1":""
 {...},
    {...},
  ]
"location_description_2":"",
}

Point details

Get point details.

Code Block
languagejson
GET /v1/points/:point_name

Example request

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

Response

Code Block
languagejson
{
    
"
distance
href":
null,
 
"opening_hours":"24/7", "address":{
"https://api-pl-points.easypack24.net/v1/points/KRA012",
    "
line1
name": "
Słowackiego 131
KRA012",

    
"
line2
type":
"87-700
 
Aleksandrów
[
Kujawski"
        "parcel_locker"
 
},
   ],
    
"
address_details
status":
{
 "Operating",
    "location": {
     
"city":"Aleksandrów Kujawski",
   "longitude": 20.00399,
        "
province
latitude":
"kujawsko-pomorskie",
 50.08913
    },
    
"
post
location_
code
type": "
87-700
Outdoor",
    "location_date": null,
    
"
street
location_description": "
Słowackiego
Stacja paliw Lotos",
    "location_description_1": null,
    
"
building
location_description_
number
2": "
131
Lotos",

    "distance": null,
    "
flat
opening_
number
hours":
null
 "24/7",
    "address": {
     
],
   
[...] }

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 {
"line1": "Os. Kombatantów 20",
        "line2": "31-630 Kraków"
    },
    "address_details": {
        "
href
city":
"http://api-pl-points.easypack24.net/v1/points/ADA01N
 "Kraków",
   
"name":"ADA01N",
     "
type
province":
[
 "małopolskie",
        "
parcel
post_
locker
code"
]
: "31-630",
   
"status":"Operating",
     "
location
street":
{
 "Os. Kombatantów",
        "
latitude
building_number":
51.74455,
 "20",
        "
longitude
flat_number":
22.25847
 null
    },
    "
location
phone_
type
number": null,
    "
location
payment_point_
description
descr":
"Przy sklepie Groszek
 "Płatność w Paczkomacie kartą płatniczą lub BLIKIEM oraz internetowo aplikacją InPost Mobile i PayByLink",
    "
location_description_1
functions":
null,
 [
        "
location
allegro_
description_2":"Groszek
courier_collect",
   
"distance":null,
     "
opening_hours":"24/7"
allegro_courier_reverse_return_send",
   
"address":{
     "allegro_courier_send",
        "
line1":"Kleeberga 5B",
allegro_letter_send",
        "
line2":"21-412 Adamów"
allegro_parcel_collect",
    
},
    "
address_details":{
allegro_parcel_reverse_return_send",
        "
city":"Adamów"
allegro_parcel_send",
        "
province":
parcel"
lubelskie"
,
        "
post_code":"21-412
parcel_collect",
      
"street":"Kleeberga",
  "parcel_reverse_return_send",
        "
building
parcel_
number":
send"
5B"
,
        "
flat_number":null
standard_courier_reverse_return_send",
   
},
    
"phone_number":null,
 
"
payment
standard_
point
courier_
descr
send"
:"Płatność

 
internetowa
 
PayByLink.
 
Dostępność
 
24/7"
],
    "
functions
partner_id":
[
 0,
    
"
allegro
is_
courier_collect",
next": false,
    "
allegro_courier_reverse_return_send",
payment_available": true,
    "
allegro
payment_
courier_send",
type": {
        "
allegro_letter_reverse_return_send", "allegro_letter_send",
2": "Payment by card in the machine"
    
"allegro_parcel_collect"
},
    "virtual": 
"allegro_parcel_reverse_return_send
"0",

    "
allegro_parcel_send",
recommended_low_interest_box_machines_list": [
     
"parcel",
   
"
parcel_collect
KRA175M",
      
"parcel_reverse_return_send
  "KRA274M",
        "
parcel_send
KRA227M",
      
"standard_courier_reverse_return_send
  "KRA273M",
      
"standard_courier_send
  "KRA144M"
    ],
    "
partner
apm_
id
doubled":
0
 null,
    "
is
location_
next
247": true,
    "
payment
operating_hours_
available
extended":
true,
 {
        "
payment_type
customer":
{
 null
    },
    "
0
agency": "
Brak
IPM4956660",
obsługi
 
płatności"
   
}
"image_url": "https://static.easypack24.net/points/pl/images/KRA012.jpg",
    "
virtual
easy_access_zone":
"0"
 false,
    "
recommended
air_
low_interest_box_machines_list
index_level": 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

Pagination

page

Specifies

Defines the

results

page

,

for which the results should be

returned.

returnet

?page=2

per_page

Specifies

Defines the

number of results displayed on the page.

amount of points returned per page

Default

value

: 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