Display of collection points

In order to allow the customer to select a parcel locker correctly and to download the data which will later be used to create the parcel, two solutions can be used:

• Geowidget

• Points resource in the ShipX API

The recommended solution is to use Geowidget. In case the Customer does not have the possibility to use this functionality, it is acceptable to use a list of points, a proprietary Geowidget made from the Points resource in the ShipX API.

Geowidget

Geowidget GEOv4 is a locator and point selector designed by InPost.

Its main tasks are:

• To show a map of points with several types (for example parcel lockers);

• Providing information about these points and enabling integration with external customer systems.

GEOv4 is a widget-type software, it means that whole code and processing is held on Integer servers, external clients only attach link to this code and specify configuration that will be used on theirs systems.

Possible types of points

Demo live links

1. Basic integration:
   https://geowidget.easypack24.net/examples/basic.html

2. Basic integration with params and callback after point choose:
   https://geowidget.easypack24.net/examples/basic-with-params.html

3. Basic integration with params and callback after point choose, points only with collect function: 
   https://geowidget.easypack24.net/examples/basic-with-collect-only.html

4. Open map as modal:
   https://geowidget.easypack24.net/examples/modal.html

5. Enable Google Maps:
   https://geowidget.easypack24.net/examples/google.html

6. Function searchLockerPoint():
   https://geowidget.easypack24.net/examples/find-locker-point.html

7. Function searchPlace():
   https://geowidget.easypack24.net/examples/search-place.html

Points

The Points resource is available in the ShipX API.  This resource is aimed at Customers who want to create their version of Geowidget on the basis of the API, to propose lists with collection points, when they do not have the technical possibility to use InPost Geowidget.

This option allows you to:

• Retrieve information about the locations where InPost services are available. The points can be: self-service machines (parcel locker) or parcel points;

• Downloading of parcel machines on the basis of coordinates - it is also possible to specify the maximum distance of points from a relative point and to plot these coordinates on a Google map.

In practice, when the user enters e.g. the name of the town or the postal code, Points searches for Parcel Post Offices assigned to it, returns their coordinates and then, based on these coordinates, you can place them on a map, e.g. Google.

Best Practices

Below is a list of parameters containing important information for the customer. Information from these parameters should be placed in the basic information, details (additional information) of the parcel locker.

The following information was retrieved by means of a query:

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

Below is a list of parameters from which information must be extracted and included in the basic information:

• Name of parcel locker: "name": "WAW94A"

• 

  Address details:      
   "address": {                 "line1": "Czerska 8/10",                 "line2": "00-732 Warszawa"     

• Point availability: "opening_hours": "24/7"

• Nearest parcel locker:
      "recommended_low_interest_box_machines_list": [                 "WAW54N",                 "WAW20H",                 "WAW251M",                 "WAW561M"             ],

Below is a list of parameters from which the information should be extracted and included in the detailed information:

• Name of parcel locker: "name": "WAW94A"

• Address details:         
  "address": {                 "line1": "Czerska 8/10",                 "line2": "00-732 Warszawa"  

• Image: "image_url": "https://static.easypack24.net/points/pl/images/WAW94A.jpg"

• Location: "location_description": "Przy biurowcu Agory"

• Opening hours: "opening_hours": "24/7"

• Methods of payment: "payment_point_descr": "Płatność w Paczkomacie kartą płatniczą 
lub BLIKIEM oraz internetowo aplikacją InPost Mobile i PayByLink"

• Nearest parcel locker:
   "recommended_low_interest_box_machines_list": [                 "WAW54N",                 "WAW20H",                 "WAW251M",                 "WAW561M"             ],

• Easy access zone: "easy_access_zone": true
  For more information, see https://inpost.pl/aktualnosci-paczkomatyr-inpost-strefa-ulatwionego-dostepu-dla-osob-niewysokich

Pins, loga

Pins to download	Name, extension
	Parcel locker Geo.png
	Parcel locker max.png
	Parcel locker min.png
	Parcel locker in Żabka.jpg
	ParcelPoint Geo.png
	ParcelPoint max.png
	ParcelPoint min.png
	Parcel locker max.pdf
	Parcel locker min.pdf
	ParcelPoint max.pdf
	ParcelPoint min.pdf
	Parcel locker max.svg
	Parcel locker min.svg
	ParcelPoint max.svg
	ParcelPoint min.svg

Example queries

• In the Points resource it is possible to retrieve the nearest Parcel Post from a relative point based on coordinates:
  

  curl -X GET https://api-shipx-pl.easypack24.net/v1/points?relative_point=52.21472%2C20.95547 -H 'Content-Type: application/json'

• The number of points can be limited by the parameter limit:
  

  curl -X GET https://api-shipx-pl.easypack24.net/v1/points?relative_point=52.21472%2C20.95547&limit=3 -H 'Content-Type: application/json'

• The number of points can be limited by the max_distance parameter (given in metres):
  

  curl -X GET https://api-shipx-pl.easypack24.net/v1/points?relative_point=52.21472%2C20.95547&max_distance=800 -H 'Content-Type: application/json'

• Retrieving the nearest points for a postcode:
  

  curl -X GET https://api-shipx-pl.easypack24.net/v1/points?relative_post_code=37-200&type=parcel_locker -H 'Content-Type: application/json'

• Collection of all parcel lockers and parcel points offices to which you can send your parcel:
  

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

• Collection only of physical lockers:
  

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

• Collection of parcels point to which you can send your parcel:
  

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

• Collection of points that support COD shipments:
  

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

• Collection of points, which are available 24/7, dedicated to the Weekend Parcels service:
  

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