[1.23.0] Points

Warning!

The resource is available only in the following countries: PL, IT

Points resource represents the locatons in which the logistics 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.


On this page

 

Production environment:

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

Test encironment:
You can test your implementation on a test environment available at: https://sandbox-api-pl-points.easypack24.net/v1/points




Structure

Point resource has the following attributes:

AttributeTypeDescriptionAvailability

name 

StringUnique point name e.g. KRA007 (Parcel Locker)PL, IT
typeArray

Table specifying types of points available at the 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 - Physical automatic parcel stations only
  • parcel_locker_superpop - Shipment handling points which a parcel machine shipment can be sent to. 
PL, IT

status 

StringPoint status.PL, IT
locationObject

Location object including the geographical location latitude and longitude

Location resource example in JSON format:

"latitude": 50.03988,
"longitude": 19.92485
PL, IT
location_type
StringLocation type.PL, IT
location_descriptionString

Additional location description that may make it easier to reach.

PL, IT
location_description_1
String

Additional description

PL, IT
location_description_2
String

Additional description

PL, IT
distance
Integer

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

PL, IT

opening_hours 

String

Point opening hours

PL, IT
addressObject

Address object containing the points address information such as street, post-code, city.

Address object example in JSON format:

"line1": "Kapelanka 14",
"line2": null
PL, IT
address_details
Object

Detailed point address data

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

phone_number 

StringPoint telephone numberPL, IT

payment_point_descr 

StringAdditional 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_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
PL, IT
partner_idInteger

Partner ID

PL, IT

is_next 

BooleanIs it a NEXT automatic parcel stationPL, IT

payment_available 

Boolean

Availability of payment at a given point

There is a possibility of payment_available = true with payment_type = 0, it means the payment is available

PL, IT
payment_type StringPayment type parameterPL, IT
virtual IntegerVirtual pointPL, IT
recommended_low_interest_box_machines_list ArrayOther points recommended nearbyPL, IT
location_247 BooleanIs the parcel locker available 24/7PL, IT
easy_access_zoneBoolean

Does the parcel locker have an easy access zone?

PL, IT

Point resource in JSON format:

{  
   "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,
   "easy_access_zone": true
}



Authentication

Access to the resource does not require authentication.


List of Points

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

GET /v1/points

Example request

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

Response

{ 
  "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",
		"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,
      "easy_access_zone": true
    },
    {...},
    {...},
  ]
}



Point details

Point details retrieval.

GET /v1/points/:point_name

Example request

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

Response

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,
   "easy_access_zone": true
}



Search criteria

ParameterTypeDescriptionExampleAvailability
nameString
Array

Searches for shipments with given name.

Searches for shipments with given names.

?name=KRA010
?name=Kra010,ADA01N
PL, IT
typeString
Array

Searches for shipments with given type.

Searches for shipments with given types.

?type=parcel_locker
?type=parcel_locker,pop
PL, IT
functionsString
Array

Searches for shipments with given function.

Searches for shipments with given functions.

?functions=parcel
?functions=parcel,parcel_send
PL, IT
partner_id

Integer
Array

Searches for shipments with given partner ID.

Searches for shipments with given partner IDs.

?partner_id=1
?partner_id=1,2
PL, IT
is_nextBoolean

Searches for NEXT parcel locker points

?is_next=truePL, IT

payment_available 

Boolean

Searches by payment availability at the point

?payment_available=truePL, IT
post_codeString
Array

Searches for shipments with given post code.

Searches for shipments with given post codes.

?post_code=11-111
?post_code=11-111,22-222
PL, IT
cityString
Array

Searches for shipments with given city.

Searches for shipments with given cities.

?city=Kraków

?city=Kraków,Warszawa

PL, IT
provinceString
Array

Searches for shipments with given province.

Searches for shipments with given provinces.

?province=Małopolska

?province=Małopolska,Śląsk

PL, IT
virtual

Integer
Array

Searches for shipments with given virtual value.

Searches for shipments with given virtual values.

?virtual=0
?virtual=1,6
PL, IT
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-24PL, IT
updated_to
Date

Searches for points updated before the given date

Requires providing updated_from.

?updated_to=2018-04-26PL, IT

Search by location

relative_point StringSearches for points closest to the given location?relative_point=52.123,19.321PL, IT
relative_post_code StringSearches for points closest to the given post code?relative_post_code=11-111PL, IT
max_distance Double

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

Parameter usage requires sorting by distance.

Default value: 10000 (10km)

Maximum value 50000 (50km)

?relative_point=52.123,19.321&max_distance=10000PL, IT
limit Integer

Point limiting parameter when using relative_point  or relative_post_code 

?limit=10PL, IT

Result sorting

name Sort by point name?sort_by=namePL, IT

distance_to_relative_point

Sort by relative distance (relative_point or relative_post_code)?sort_by=distance_to_relative_pointPL, IT
statusSort by status?sort_by=statusPL, IT

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

ascSorts in ascending order?sort_order=asc&sort_by=statusPL, IT
descSorts in descending order?sort_order=desc&sort_by=statusPL, IT

Pagination

pageDefines the page for which the results should be returnet?page=2PL, IT
per_page

Defines the amount of points returned per page

Default: 25
Maximum:
500

?per_page=100PL, IT

Filtering of returned fields

fieldsDefines the point attributes that should be returned?fields=name,typePL, IT