Versions Compared

Old Version 7

changes.mady.by.user Michał Machowski

Saved on

compared with

New Version 8

changes.mady.by.user Michał Machowski

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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.

On this page

Table of Contents

Geowidget

Geowidget GEOv4 v5 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 GEOv5 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

Parameter

Description

Option

Description

functions

Application

payment_available

parcel

location_

locker

Physical parcel locker and parcel points to which you can send your parcel.

For delivery forms in the shopping basket:

  • Payment in advance

parcel_locker_only

Only physical parcel locker.

For delivery forms in the shopping basket:

COD payment - all machines support shipments with COD

parcel_locker_superpop

Parcel points to which you can send your parcel.

For delivery forms in the shopping basket:

  • Payment in advance

pop

All parcel points.

Presentation of collection points.

247

Type of displayed points

InPost Paczkomaty 24/7

config='parcelCollect'

parcel_collect

(error)

(error)

Paczkomat, Paczkomat w Żabce, PaczkoPunkt, PaczkoPunt w Żabce

InPost Paczkomaty 24/7 COD

config='parcelCollectPayment'

parcel_collect

(tick)

(error)

Paczkomat, Paczkomat w Żabce, PaczkoPunkt, PaczkoPunt w Żabce

InPost Paczkomaty 24/7 Paczka w Weekend

config='parcelCollect247'

parcel_collect

(error)

(tick)

Paczkomaty dostępne 24/7

Showing sending points

config='parcelSend'

parcel_send

(error)

(error)

Paczkomat, Paczkomat w Żabce, PaczkoPunkt, PaczkoPunt w Żabce

Info

Detailed documentation can be found at Geowidget

v4 User's Guide (New)Basic integration:

v5 Beta

Examples of integration


Production environment: https://geowidget.

easypack24

inpost.

net

pl/examples/

basic

index.html

Basic integration with params and callback after point choose:

Test environment: https://

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

sandbox-easy-geowidget-sdk.easypack24.net/examples/

basic-with-collect-only

index.html

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

    • Enable Google Maps:

    Geowidget examples

    Production environment: https://geowidget.

    easypack24

    inpost.

    net/examples/google.htmlFunction searchLockerPoint():

    pl/
    Test environment: https://

    geowidget.easypack24.net/examples/find-locker-point.htmlFunction searchPlace():
    https://geowidget

    sandbox-easy-geowidget-sdk.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.

    Info

    Production environment:

    https://api-shipx-pl.easypack24inpost.netpl/v1/points

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

    Detailed documentation can be found at[1.23.0] Points

    Dedicated configurations for shopping cart delivery options

    InPost Paczkomaty 24/7  & InPost w Żabce

    Opis

    Configuration to download the full list of points

    Parameters to be used by the client to filter the downloaded list of points

    Type of presented points

    InPost Paczkomaty 24/7

    /v1/points?type=parcel_locker

    Remove points witth  partner_id=60

    Paczkomaty, PaczkoPunkty

    InPost Paczkomaty 24/7 COD

    payment_available=true and remove the points with partner_id=60

    Paczkomaty, PaczkoPunkty

    InPost w Żabce

    partner_id=60

    PaczkoPunkty w Żabce

    InPost w Żabce COD

    partner_id=60&payment_available=true

    PaczkoPunkty w Żabce

    Prezentowanie punktów odbioru dla zamówień Paczka w Weekend

    location_247=true

    Paczkomaty dostępne 24/7

    Showing sending points

    /v1/points?functions=parcel_send

     functions=parcel_send

    Paczkomat, Paczkomat w Żabce, PaczkoPunkt, PaczkoPunt w Żabce

    Best Practices

    Below

    Transition model

    InPost Paczkomaty 24/7

    Description

    Configuration to download the full list of points

    Parameters to be used by the client to filter the downloaded list of points

    Type of presented points

    InPost Paczkomaty 24/7

    /v1/points?type=parcel_locker

     type=parcel_locker

    Paczkomat, Paczkomat w Żabce, PaczkoPunkt, PaczkoPunt w Żabce

    InPost Paczkomaty 24/7 COD

    payment_available=true

    Paczkomat, Paczkomat w Żabce, PaczkoPunkt, PaczkoPunt w Żabce

    InPost Paczkomaty 24/7 Paczka w Weekend

    location_247=true

    Paczkomaty dostępne 24/7

    Showing sending points

    /v1/points?functions=parcel_send

     functions=parcel_send

    Paczkomat, Paczkomat w Żabce, PaczkoPunkt, PaczkoPunt w Żabce

    Best Practices

    The 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 by which to include the information in the point details.

    The below information was retrieved using a query:

    Code Block
    languagejson
    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: 
    Paczkomaty InPost
    Displayed fields
    Parameters in API
    Paczkomat
    If "partner_id":0 set "Paczkomat"
    Parcel Locker Name
    "name": "WAW94A"
    Image Removed
    Address 
     details:      
    data
     
    "address": {
                     

             "line1": "Czerska 8/10",
                     

         "line2": "00-732 Warszawa"
         Point availability: 
    Additional description
    "location_description": "Przy biurowcu Agory"
    Opening hours
    "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:
    Image Removed
    Name of parcel locker: 
    Pin
    Dedicated pins are located at the bottom of the article.
     Image Added
     
    PaczkoPunkt
    Displayed fields
    Parameters in API
    PaczkoPunkt
    If "partner_id": 33 set "PaczkoPunkt"
    Name of PaczkoPunkt
    "name": "POP-WAW206"
    Address data
     "address": {
              "line1": "Kierbedzia 8 LOK. U301",
              "line2": "00-728 Warszawa"
    Additional description
    "location_description": "EKOPARTY"
    Opening hours
    "opening_hours": "PN-PT 10-18 SB 10-14"
    Pin
    Dedicated pins are located at the bottom of the article.
     
    Image Added
     
    Paczkomat w Żabce
    Displayed fields
    Parameters in API
    Paczkomat
    If "partner_id": 61 set "Paczkomat"
    Parcel Locker Name
    "name": "
    WAW94A
    WAW41ZIH"
    Address 
     details:         
    data
      "address": {                 "line1": "
    Czerska 8/10
    Bobrowiecka 10 lok. U7",                 "line2": "00-
    732 Warszawa
    728 Warszawa"
      
  • Image: "image_url": "https://static.easypack24.net/points/pl/images/WAW94A.jpg"
    • Location: 
    Additional description
    "location_description": "
    Przy biurowcu Agory
    W sklepie Żabka"
    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 
    PN-SB 06-23"
    Pin
    Dedicated pins are located at the bottom of the article.
     
    Image Added
     
    PaczkoPunkt
    Displayed fields
    Parameters in API
    PaczkoPunkt w Żabce
    If "partner_id": 60 set "PaczkoPunkt w Żabce"
    Name of PaczkoPunkt
    "name": "POP-WAW06Z"
    Address data
     "address": {                 "line1": "Branickiego 11/192",                 "line2": "02-797 WARSZAWA"
    Additional description
    "location_description": "ŻABKA"
    Opening hours
    "opening_hours": "PN-SB 06-23 ND Sprawdź w sklepie"
    Pin
    Dedicated pins are located at the bottom of the article.
     
    Image Added
    Pins, loga
     Info
    Logo to download: https://inpost.pl/do-pobrania 
    Pins to download
    Name, extension
    Image RemovedImage Added
    Parcel locker Geo.png
    Image RemovedImage Added
    Parcel locker max.png
    Parcel locker min.png
    ParcelPoint Geo.png
    ParcelPoint max.png
    Image RemovedImage Added
    ParcelPoint min.png
     View file
    namePaczkomat max.pdf
    Parcel locker max.pdf
     View file
    namePaczkomat min.pdf
    Parcel locker min.pdf
     View file
    namePaczkoPunkt max.pdf
    ParcelPoint max.pdf
     View file
    namePaczkoPunkt min.pdf
    ParcelPoint min.pdf
    Image RemovedImage Added
    Parcel locker max.svg
    Image RemovedImage Added
    Parcel locker min.svg
    Image RemovedImage Added
    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:
       Code Block
      languagejson
      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 parameterlimit:
       Code Block
      languagejson
      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):
       Code Block
      languagejson
      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:
       Code Block
      languagejson
      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:
       Code Block
      languagejson
      curl -X GET https://api-shipx-pl.easypack24.net/v1/points?type=parcel_locker -H 'Content-Type: application/json'
    • Collection only of physical lockers:
       Code Block
      languagejson
      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:
       Code Block
      languagejson
      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:
       Code Block
      languagejson
      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:
       Code Block
      languagejson
      curl -X GET https://api-shipx-pl.easypack24.net/v1/points?location_247=true -H 'Content-Type: application/json'