Get the complete list of available points.

######################

TRY IT NOT ENABLED

The "try it" feature isn't enabled for this use case due to technical limit (feature not support fixed query parameters). Try this with Postman.

######################

Query parameters

?relative_post_code=20068&max_distance=2000

Use cases couldn't be tested in the right column.

Basic info

GEOv4 (also known as Geowidget v4) is a point locator and picker designed by Integer sp. z o.o. It's main goal is to show map of points with several types (for example machines), provide informations about this points and give possibility to integrate with clients external systems. GEOv4 is a widget-type software, it means that whole code and processing is held on InPost servers, external clients only attach link to this code and specify configuration that will be used on theirs systems.

Data source

Data made available in the widget are extracted from the italian production environment: https://api-it-local-points.easypack24.net/v1/points

Design (RWD)

Desktop view

Mobile views

Integration

1. Geowidget v4 can be easily integrated into any system or web page. Client web page should insert script in tag:

<script async src="https://geowidget.easypack24.net/js/sdk-for-javascript.js"></script>
<link rel="stylesheet" href="https://geowidget.easypack24.net/css/easypack.css"/>

2. Include the widget configuration in Javascript

<script type="text/javascript">
  window.easyPackAsyncInit = function () {
    easyPack.init({});  // Configuration object
    var map = easyPack.mapWidget('easypack-map', function(point){
      console.log(point);
    });
  };
</script>

3. Include the widget with a simple HTML tag inside your page.

   IMPORTANT the ID shouldn't be changed and should correspond to the ID used in the previous script.

<div id="easypack-map"></div>

4. If you want to configure the widget, you can simply add your configurations in the Configuration Object included during the step 2. Here's an example of configuration, you can find parameter's details in the next charapter.

easyPack.init({
  defaultLocale: 'pl',
  points: {
    types: ['parcel_locker']
  },
  map: {
    defaultLocation: [51.507351, -0.127758],
    initialTypes: ['parcel_locker']
  }
});

5. Check some example of the final result before to proceed:

• Basic Widget Example
• Customized Widget Example

Configuration parameters

ParameterName	Description	Default value
paymentFilter	-	false
listItemFormat	Allows to change default layout of point information on points list.	["<b>{name}</b>", "<strong>{address_details.street}</strong> {address_details.building_number}"]
addressFormat	A string that rapresent address format	'{street} {building_number} {post_code} {city}'
apiEndpoint	URL to API Points which will be connected to Geowidget	it: https://api-it-local-points.easypack24.net/v1/
searchType	Setup search type, available to use Open Street Map Nominatim or Google Maps Autocomplete. Available parameters: osm, google ⚠️ For 'google' option map.googleKey is required.	'osm'
points	Setup points details Available parameters: parcel - points with functions send and collect parcel_send - points with functions send only parcel_collect - points with functions collect only	{ types: ['pop', 'parcel_locker'], allowedToolTips: ['pok', 'pop'], functions: [] }
mapType	Setup map type, available to use Open Street Map or Google Maps. Available parameters: osm, google ⚠️ For 'google' option map.googleKey is required.	'osm'
map	Setup map details.	{ googleKey: '', useGeolocation: true, initialZoom: 13, detailsMinZoom: 15, /*minimum zoom after marker click*/ autocompleteZoom: 14, visiblePointsMinZoom: 13, defaultLocation: [52.229807, 21.011595], initialTypes: ['pop', 'parcel_locker'], /*which type should be selected by default. Options: parcel_locker_only, parcel_locker, pop */}
mobileSize	Screen width below which mobile version is triggered.	768
instance	Override default config by config prepared for instance. Available parameters:	pl
mobileFiltersAsCheckbox	Option set to false make filter option as radio in mobile, option true as checkobx.	true
locales	Languages that will be displayed as list in front layer. They can be dynamically changed.	['pl','uk']
defaultLocale	Geowidget language that will be uses in front-end. Available parameters: pl,uk	'pl'
display	Enable/disable visible type filters and search bar	{ showTypesFilters: true, showSearchBar: true }
langSelection	Determines if language selection bar should be displayed.	false
filters	Determines if filters (functions) bar should be displayed.	false
customDetailsCallback	Allows to set custom callback for details action Example: function(point){...}, false	false
customMapAndListInRow	Allow to change layout where list of point is below map. Points on list were paginated, number of point per page can be configured.	{ enabled: false, itemsPerPage: 8 }

Common use-cases

• If you wants to get point data that user selected on Geowidget, you can configure callback like this:

  var map = easyPack.mapWidget('easypack-map', function(point) {
    alert(point.name);
  });
  

  Example 1 Example 2

• Show Geowidget inside modal:

  easyPack.modalMap(function(point, modal) {
    modal.closeModal();
    console.log(point);
  }, { width: 500, height: 600 });
  

  Example

• Show Geowidget as dropdown:

  easyPack.dropdownWidget('easypack-widget', function(point) {
    console.log(point)
  });
  

  Example

• Enable Google Maps:

  • Google API Key is required. The key should have the following interfaces enabled:

    • Geocoding API
    • Geolocation API
    • Google Cloud APIs
    • Maps JavaScript API
    • Places API

  • Then, you need to initialize the widget like that:

    easyPack.init({
      mapType: 'google',
      searchType: 'google',
      map: {
        googleKey: 'your-google-api-key'
      }
    });
    

  Example

• Function for search point by name and show it on map:

  map.searchLockerPoint('PointName');
  

  Example

• Function for search place by name and show it on map:

  map.searchPlace('Wroclaw');
  

  Example

• Display points with different types

  • PARCEL_LOCKER_ONLY - In results we have points - physical machines only

    points: {
      types: [‘parcel_locker_only']
    },
    map: {
      initialTypes: [‘parcel_locker_only']
    }
    

    

  • POP - In results we have points with types 'pop' and 'super_pop'

    points: {
      types: [‘pop']
    },
    map: {
      initialTypes: [‘pop']
    }
    

    

  • PARCEL_LOCKER - In results we have points -physical machines and 'super_pop' type

    points: {
      types: [‘parcel_locker']
    },
    map: {
      initialTypes: [‘parcel_locker']
    }
    

    

  • PARCEL_LOCKER_SUPERPOP - In results we have points - 'super_pop' type only

    points: {
      types: [‘parcel_locker_superpop']
    },
    map: {
      initialTypes: [‘parcel_locker_superpop']
    }
    

    

  • PARCEL LOCKER + POP - In results we have points - physical machines, 'pop' and 'super_pop' types

    points: {
      types: [‘parcel_locker', 'pop']
    },
    map: {
      initialTypes: [‘parcel_locker', 'pop']
    }
    

    

  • PARCEL LOCKER + POP - In results we have points - physical machines, 'pop' and 'super_pop' types but selected is only 'parcel_locker' and 'super_pop' type

    points: {
      types: [‘parcel_locker, pop']
    },
    map: {
      initialTypes: [‘parcel_locker']
    }
    

    

  • PARCEL LOCKER + POP - In results we have points - physical machines, 'pop' and 'super_pop' types but selected is only 'pop' and 'super_pop' type

    points: {
      types: [‘parcel_locker, pop']
    },
    map: {
      initialTypes: [‘pop']
    }
    

    

Get the complete list of shipments for current organization_id.