Versions Compared

Version Old Version 17 New Version 20
Changes made by

Michał Machowski

Michał Machowski

Saved on

Key

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

Points resource represents the locations in which the logistics operator's services are available. Points can be self-service machines (Parcel locker, ParcelPoint) or branches, customer service points. Each of the locations offers specific services - the list of these services is returned to the response under the functions attribute.

Panel
panelIconIdatlassian-info
panelIcon:info:
bgColor#E3FCEF


New environments with authorization

Production environments:

https://api.inpost.pl/v1/points

Generating access

  1. Go to the Parcel Manager website https://manager.paczkomaty.pl

  2. In the login window, enter your login and click: Login

  3. After logging in go to My Account tab

  4. In the Data tab check if all the company data is correctly filled in
    Remember, in order to generate access to API, both your company address and invoice data have to be filled in.

  5. After verification go to the new tab API

  6. To generate a new Point Access, expand the ShipX API tab and click Generate

  7. If you already have a token generated make sure to use a token from the list (Lista tokenów do API InPost (API ShipX oraz API Points)) for authentication. If you do not have such a list you need to generate a new token.

Sandbox Environment:
https://sandbox-api-gateway-pl.easypack24.net/v1/points

Generating access

  1. Go to the Parcel Manager website https://sandbox-manager.paczkomaty.pl/

  2. In the login window, enter your login and click: Login

  3. After logging in go to My Account tab

  4. In the Data tab check if all the company data is correctly filled in
    Remember, in order to generate access to API, both your company address and invoice data have to be filled in.

  5. After verification go to the new tab API

  6. To generate a new Point Access, expand the ShipX API tab and click Generate

  7. If you already have a token generated make sure to use a token from the list (Lista tokenów do API InPost (API ShipX oraz API Points)) for authentication. If you do not have such a list you need to generate a new token.

Info

More information on the available options Display of collection points

On this page

Table of Contents

Structure

Point resource has the following attributes:

Attribute

Type

Description

name 

String

Unique point name e.g. KRA007 (Parcel Locker)

type

Array

Table specifying types of points available at the location.

Possible types of points:

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

  • pop - All parcel points.

  • parcel_locker_only - Only physical parcel locker.

  • parcel_locker_superpop - Parcel points which you can send your parcel. 

status 

String

Point status.

location

Object

Location object including the geographical location latitude and longitude

Location resource example in JSON format:

Code Block
"latitude": 50.03988,
"longitude": 19.92485


location_type

String

Location type.

location_description

String

Additional location description that may make it easier to reach.

location_description_1

String

Additional description

location_description_2

String

Additional description

distance

Integer

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

opening_hours 

String

Point opening hours

address

Object

Address object containing the point's address information such as street, post-code, city.

Address object example in JSON format:

Code Block
"line1": "Kapelanka 14",
"line2": null


Code Block
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:

Code Block
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

Partner ID

60 - Parcel points Żabka

61 - Parcel lockers Żabkaof partner.

"partner_id":0 - Parcel Locker

"partner_id": 33 - ParcelPoint with parcel locker parcel pick-up function.

"partner_id": 30 - ParcelPoint without parcel locker parcel pick-up function, has only parcel post function.

is_next 

Boolean

Is it a NEXT automatic parcel station

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

payment_type 

String

Payment type parameter

virtual 

Integer

Virtual point

recommended_low_interest_box_machines_list 

Array

Other points recommended nearby

location_247 

Boolean

Is the parcel locker available 24/7 (Parcel lockers with the parameter set to true are dedicated service points for the Weekend Parcels service).

physical_type_mapped

String

Type of parcel locker

easy_access_zone

String

Description for type of parcel locker

Point resource in JSON format:

Code Block
languagejson
{
            "href": "https://api-pl-points.easypack24.net/v1/points/KRA02APP",
            "name": "KRA02APP",
            "type": [
                "parcel_locker"
            ],
            "status": "Operating",
            "location": {
                "longitude": 19.87325,
                "latitude": 50.00919
            },
            "location_type": "Outdoor",
            "location_date": null,
            "location_description": "Prywatna posesja wjazd od strony Dobrowolskiego",
            "location_description_1": null,
            "location_description_2": null,
            "distance": null,
            "opening_hours": "24/7",
            "address": {
                "line1": "Dobrowolskiego",
                "line2": "30-394 Kraków"
            },
            "address_details": {
                "city": "Kraków",
                "province": "małopolskie",
                "post_code": "30-394",
                "street": "Dobrowolskiego",
                "building_number": "",
                "flat_number": null
            },
            "phone_number": null,
            "payment_point_descr": "Płatność internetowa aplikacją InPost Mobile oraz PayByLink",
            "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": false,
            "payment_available": true,
            "payment_type": {
                "0": "Payments are not supported"
            },
            "virtual": "0",
            "recommended_low_interest_box_machines_list": null,
            "apm_doubled": null,
            "location_247": true,
            "operating_hours_extended": {
                "customer": null
            },
            "agency": "IPM5426863",
            "image_url": "https://static.easypack24.net/points/pl/images/KRA02APP.jpg",
            "easy_access_zone": true,
            "air_index_level": null,
            "physical_type_mapped": "006",
            "physical_type_description": "Ważne! Swoją paczkę odbierzesz wygodniej z aplikacją InPost"
        }

List of Points

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

Code Block
GET /v1/points

Example request

Code Block
languagejson
curl -X GET https://api.inpost.pl/v1/points -H 'Content-Type: application/json'

Response

Code Block
languagejson
{
    "href": "https://api-pl-points.easypack24.net/v1/points",
    "count": 19378,
    "page": 1,
    "per_page": 25,
    "total_pages": 776,
    "items": [
        {
            "href": "https://api-pl-points.easypack24.net/v1/points/ADA01M",
            "name": "ADA01M",
            "type": [
                "parcel_locker"
            ],
            "status": "Operating",
            "location": {
                "longitude": 22.26405,
                "latitude": 51.73834
            },
            "location_type": "Outdoor",
            "location_date": null,
            "location_description": "Przy sklepie Lewiatan",
            "location_description_1": null,
            "location_description_2": null,
            "distance": null,
            "opening_hours": "24/7",
            "address": {
                "line1": "Kościuszki 27",
                "line2": "21-412 Adamów"
            },
            "address_details": {
                "city": "Adamów",
                "province": "lubelskie",
                "post_code": "21-412",
                "street": "Kościuszki",
                "building_number": "27",
                "flat_number": null
            },
            "phone_number": null,
            "payment_point_descr": "Płatność internetowa aplikacją InPost Mobile oraz PayByLink",
            "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": false,
            "payment_available": true,
            "payment_type": {
                "0": "Payments are not supported"
            },
            "virtual": "0",
            "recommended_low_interest_box_machines_list": null,
            "apm_doubled": null,
            "location_247": true,
            "operating_hours_extended": {
                "customer": null
            },
            "agency": "IPM4633224",
            "image_url": "https://static.easypack24.net/points/pl/images/ADA01M.jpg",
            "easy_access_zone": true,
            "air_index_level": null,
            "physical_type_mapped": "004",
            "physical_type_description": null
        },
    {...},
    {...},
  ]
}

Point details

Get point details.

Code Block
languagejson
GET /v1/points/:?name=point_name

Example request

Code Block
languagejson
curl -X GET https://api.inpost.pl/v1/points/?name=KRA012 -H 'Content-Type: application/json'

Response

Code Block
languagejson
{
    "href": "https://api-pl-points.easypack24.net/v1/points/KRA012",
    "name": "KRA012",
    "type": [
        "parcel_locker"
    ],
    "status": "Operating",
    "location": {
        "longitude": 20.00399,
        "latitude": 50.08913
    },
    "location_type": "Outdoor",
    "location_date": null,
    "location_description": "Stacja paliw Lotos",
    "location_description_1": null,
    "location_description_2": "Lotos",
    "distance": null,
    "opening_hours": "24/7",
    "address": {
        "line1": "Os. Kombatantów 20",
        "line2": "31-630 Kraków"
    },
    "address_details": {
        "city": "Kraków",
        "province": "małopolskie",
        "post_code": "31-630",
        "street": "Os. Kombatantów",
        "building_number": "20",
        "flat_number": null
    },
    "phone_number": null,
    "payment_point_descr": "Płatność w Paczkomacie kartą płatniczą lub BLIKIEM oraz internetowo aplikacją InPost Mobile i 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": {
        "2": "Payment by card in the machine"
    },
    "virtual": "0",
    "recommended_low_interest_box_machines_list": [
        "KRA175M",
        "KRA274M",
        "KRA227M",
        "KRA273M",
        "KRA144M"
    ],
    "apm_doubled": null,
    "location_247": true,
    "operating_hours_extended": {
        "customer": null
    },
    "agency": "IPM4956660",
    "image_url": "https://static.easypack24.net/points/pl/images/KRA012.jpg",
    "easy_access_zone": false,
    "air_index_level": null,
    "physical_type_mapped": "001",
            "physical_type_description": null
}

Search criteria

Parameter

Type

Description

Example

name

String
Array

Searches for shipments with given name.

Searches for shipments with given names.

?name=KRA010
?name=Kra010,ADA01N

type

String
Array

Searches for shipments with given type.

Searches for shipments with given types.

?type=parcel_locker
?type=parcel_locker,pop

functions

String
Array

Searches for shipments with given function.

Searches for shipments with given functions.

?functions=parcel
?functions=parcel,parcel_send

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

is_next

Boolean

Searches for NEXT parcel locker points

?is_next=true

payment_available 

Boolean

Searches by payment availability at the point

?payment_available=true

post_code

String
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

city

String
Array

Searches for shipments with given city.

Searches for shipments with given cities.

?city=Kraków

?city=Kraków,Warszawa

province

String
Array

Searches for shipments with given province.

Searches for shipments with given provinces.

?province=Małopolska

?province=Małopolska,Śląsk

virtual

Integer
Array

Searches for shipments with given virtual value.

Searches for shipments with given virtual values.

?virtual=0
?virtual=1,6

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

updated_to

Date

Searches for points updated before the given date

Requires providing updated_from.

?updated_to=2018-04-26

Search by location

relative_point 

String

Searches for points closest to the given location

?relative_point=52.123,19.321

relative_post_code 

String

Searches for points closest to the given post code

?relative_post_code=11-111

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=10000

limit 

Integer

Point limiting parameter when using relative_point  or relative_post_code 

?limit=10

Result sorting

name 

Sort by point name

?sort_by=name

distance_to_relative_point

Sort by relative distance (relative_point or relative_post_code)

?sort_by=distance_to_relative_point

status

Sort by status

?sort_by=status

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

asc

Sorts in ascending order

?sort_order=asc&sort_by=status

desc

Sorts in descending order

?sort_order=desc&sort_by=status

Pagination

page

Defines the page for which the results should be returnet

?page=2

per_page

Defines the amount of points returned per page

Default: 25
Maximum: 500

?per_page=100

Filtering of returned fields

fields

Defines the point attributes that should be returned

?fields=name,type