Page Comparison

Collecting the list of points.

Changes since version 1.7.0:

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.
Removing Polish translations - in the request for a possible function or possible payment method.

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

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

Panel

bgColor	#f0f0f0
titleBGColor	#f0f0f0
title	On this page

Table of Contents

minLevel	2

Structure

Points resource elements have the following attributes:

Attribute

Type

Description

href

String

The URI address to the resource of the particular point

name

String

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

type

Array

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

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

• pop - Shipment handling points.

• parcel_locker_only - Only physical automatic parcel stationsmachine.

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

status

String

Point status.

location

Object

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_description

String

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

address

Object

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

functions

Array

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

Is it a NEXT automatic parcel station

is_next

Boolean

Availability of payments in the given point.

There is a possibility of payment_available=true together with payment_type=0, this means that payment is available.

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

recommended_low_interest_box_machines_list Array Recommended 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":{  
      "latitude":50.09103,
      "longitude":19.9299
   },
   "location_type":null,
   "location_description":"Stacja paliw Lukoil",
   "location_description_1":"",
   "location_description_2":"LUKOIL",
   "distance":null,
   "opening_hours":null,
   "address":{  
      "line1":"Opolska 9",
      "line2":"31-274 Kraków"
   },
   "address_details":{  
      "city":"Kraków",
      "province":"małopolskie",
      "post_code":"31-274",
      "street":"Opolska",
      "building_number":"9",
      "flat_number":null
   },
   "phone_number":null,
   "payment_point_descr":"Płatność internetowa 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":{  
      "0":"Brak obsługi płatności"
   },
   "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
GET https://api-shipx-pl.easypack24.net/v1/points HTTP/1.1 Host: api-shipx-pl.easypack24.net

Response

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

{  
   "href":"https://api-pl-points.easypack24.net/v1/points",
   "count":5363,
   "page":1,
   "per_page":25,
   "total_pages":215,
   "items":[  
      {  
         "href":"http://api-pl-points.easypack24.net/v1/points/ADA01N",
         "name":"ADA01N",
         "type":[  
            "parcel_locker"
         ],
         "status":"Operating",
         "location":{  
            "latitude":51.74455,
            "longitude":22.25847
         },
         "location_type":null,
         "location_description":"Przy sklepie Groszek",
         "location_description_1":null,
         "location_description_2":"Groszek",
         "distance":null,
         "opening_hours":"24/7",
         "address":{  
            "line1":"Kleeberga 5B",
            "line2":"21-412 Adamów"
         },
         "address_details":{  
            "city":"Adamów",
            "province":"lubelskie",
            "post_code":"21-412",
            "street":"Kleeberga",
            "building_number":"5B",
            "flat_number":null
         },
         "phone_number":null,
         "payment_point_descr":"Płatność internetowa PayByLink. Dostępność 24/7",
         "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,
         "payment_available":true,
         "payment_type":{  
            "0":"Brak obsługi płatności"
         },
         "virtual":"0",
         "recommended_low_interest_box_machines_list":null
      },
      {  
         "href":"http://api-pl-points.easypack24.net/v1/points/ALK01A",
         "name":"ALK01A",
         "type":[  
            "parcel_locker"
         ],
         "status":"Operating",
         "location":{  
            "latitude":52.8684,
            "longitude":18.7031
         },
         "location_type":null,
         "location_description":"Przy biurze usług ubezpieczeniowych",
         "location_description_1":"",
         "location_description_2":"",
         "distance":null,
         "opening_hours":"24/7",
         "address":{  
            "line1":"Słowackiego 131",
            "line2":"87-700 Aleksandrów Kujawski"
         },
         "address_details":{  
            "city":"Aleksandrów Kujawski",
            "province":"kujawsko-pomorskie",
            "post_code":"87-700",
            "street":"Słowackiego",
            "building_number":"131",
            "flat_number":null
        
   ],
   [...]
}

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 Block

HTTP/1.1 200 OK
Content-Type: application/json
{  
   "href":"http://api-pl-points.easypack24.net/v1/points/ADA01N",
   "name":"ADA01N",
   "type":[  
      "parcel_locker"
   ],
   "status":"Operating",
   "location":{  
      "latitude":51.74455,
      "longitude":22.25847
   },
   "location_type":null,
   "location_description":"Przy sklepie Groszek",
   "location_description_1":null,
   "location_description_2":"Groszek",
   "distance":null,
   "opening_hours":"24/7",
   "address":{  
      "line1":"Kleeberga 5B",
      "line2":"21-412 Adamów"
   },
   "address_details":{  
      "city":"Adamów",
      "province":"lubelskie",
      "post_code":"21-412",
      "street":"Kleeberga",
      "building_number":"5B",
      "flat_number":null
   },
   "phone_number":null,
   "payment_point_descr":"Płatność internetowa PayByLink. Dostępność 24/7",
   "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,
   "payment_available":true,
   "payment_type":{  
      "0":"Brak obsługi płatności"
   },
   "virtual":"0",
   "recommended_low_interest_box_machines_list":null
}

Search criteria

Parameter	Type	Description	Example
`name`	String Array	Point with the name specified in the search.	?name=KRA010 ?name=Kra010,ADA01N
`type`	String Array	List of types of points, comma separated, which are to be returned in the response.	?type=parcel_locker ?type=parcel_locker,pop
`functions`	String Array	Searches for points with the stated function. Searches for points with all the listed functions.	?functions=parcel ?functions=parcel,parcel_send
`partner_id`	Integer Array	Searches for points with the stated partner_id. Searches for points with the stated partner_id.	?partner_id=1 ?partner_id=1,2
`is_next`	Boolean	Searches for points that are NEXT	?is_next=true
payment_available	Boolean	Filtering the list of points on the availability of payments for the point.	?payment_available=true
`post_code`	String Array	Searches for points which have the stated postal code. Searches for points which have the stated postal codes.	?post_code=11-111 ?post_code=11-111,22-222
`city`	String Array	Searches for points which have the stated city. Searches for points which have the stated city.	?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.	?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.	?updated_to=2018-04-26

Search by location

relative_point	String	Searches for points located as close as possible to the stated geographical coordinates.	?relative_point=52.123,19.321
relative_post_code	String	Searches for points located as close as possible to the stated postal code.	?relative_post_code=11-111
max_distance	Double	Specifies distance in meters from the point stated in .relative_point or relative_post_code. Using the parameter forces 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 when using parameters in relative_point or relative_post_code.	?limit=10

Sorting results

`name`	Sorting by point name.	?sort_by=name
`distance_to_relative_point`	Sorting by distance from the relative point (relative_point or relative_post_code)	?sort_by=distance_to_relative_point
`status`	Sorting by status	?sort_by=status

Sorting can be done in both directions, using the sort_order parameter:

`asc`	Sorts points ascending	?sort_order=asc&sort_by=status
`desc`	Sorts points descending	?sort_order=desc&sort_by=status

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

Paging

page

Specifies the results page, which should be returned.

?page=2

per_page

Specifies the number of results displayed on the page.

Default value: 25

Maximum value: 500

?per_page=100

Filtering displayed fields

fields Specifies the list of point attributes to be displayed on page. ?fields=name,type

Versions Compared

Old Version 1

New Version 2

Key

Structure

Authentication

List of points

Point details

Search criteria