Versions Compared
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 | ||||||
---|---|---|---|---|---|---|
| ||||||
Production environments: https://api.inpost.pl/v1/points Generating access
Sandbox Environment: Generating access
|
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 | ||||
---|---|---|---|---|---|---|
| String | Unique point name e.g. KRA007 (Parcel Locker) | ||||
| Array | Table specifying types of points available at the location. Possible types of points:
| ||||
| String | Point status. | ||||
| Object |
| ||||
| String | Location type. | ||||
| String | Additional location description that may make it easier to reach. | ||||
| String | Additional description | ||||
| String | Additional description | ||||
| Integer | Distance from the relative point location. If the relative point has not been specified, takes null value. | ||||
| String | Point opening hours | ||||
| Object |
| ||||
| Object | Detailed point address data
| ||||
| String | Point telephone number | ||||
| String | Additional information about the point | ||||
| Array | Table specifying the functions offered by the point. Possible functions:
| ||||
| Integer | ID of 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. | ||||
| Boolean | Is it a NEXT automatic parcel station | ||||
| 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 | ||||
| String | Payment type parameter | ||||
| Integer | Virtual point | ||||
| Array | Other points recommended nearby | ||||
| 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). | ||||
| String | Type of parcel locker | ||||
| String | Description for type of parcel locker |
Point
resource in JSON format:
Code Block | ||
---|---|---|
| ||
{ "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": ""null, "flat_number": null }, "phone_number": null, "payment_point_descr": "Płatność internetowaapką 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 [ "KRA106M", "apm_doubled": null, "KRA20M", "location_247": true,KRA208M", "operating_hours_extended": {KRA197M", "customerKRA356M": null }], "agencyapm_doubled": "IPM5426863"null, "imagelocation_url247": "https://static.easypack24.net/points/pl/images/KRA02APP.jpg"true, "easyoperating_accesshours_zoneextended": true,{ "air_index_levelcustomer": null, "physical_type_mapped": "006"}, "physical_type_descriptionagency": "Ważne!IPM9988771", 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 | ||
---|---|---|
| ||
curl -X GET https://api.inpost.pl/v1/points -H 'Content-Type: application/json' |
Response
Code Block | ||
---|---|---|
| ||
{ "href": "https://api-pl-points.easypack24.net/v1/points", "count": 19378, "page": 1, "per_page": 25, "total_pages": 776, "items": ["image_url": "https://static.easypack24.net/points/pl/images/KRA02APP.jpg", "easy_access_zone": true, "air_index_level": "GOOD", "physical_type_mapped": "006", "physical_type_description": "Appkomat InPost – 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 | ||
---|---|---|
| ||
curl -X GET https://api.inpost.pl/v1/points -H 'Content-Type: application/json' |
Response
Code Block | ||
---|---|---|
| ||
{ "href": "https://api-pl-points.easypack24.net/v1/points", "count": 24797, "page": 1, "per_page": 25, "total_pages": 992, "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ść apką InPost 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", "href": "https://api-pl-points.easypack24.net/v1/points/ADA01M "parcel_reverse_return_send", "name": "ADA01Mparcel_send", "type": [ "standard_courier_reverse_return_send", "parcelstandard_courier_lockersend" ], "statuspartner_id": "Operating"0, "locationis_next": { false, "payment_available": true, "longitudepayment_type": 22.26405,{ "latitude0": 51.73834 "Payments are not supported" }, "location_typevirtual": "Outdoor0", "location_daterecommended_low_interest_box_machines_list": null, "locationapm_descriptiondoubled": "Przy sklepie Lewiatan"null, "location_description_1247": nulltrue, "locationoperating_descriptionhours_2extended": null,{ "distance": null, "opening_hourscustomer": "24/7",null "address": {}, "line1agency": "Kościuszki 27IPM4633224", "line2"image_url": "21-412 Adamów""https://static.easypack24.net/points/pl/images/ADA01M.jpg", }"easy_access_zone": true, "addressair_index_detailslevel": { null, "cityphysical_type_mapped": "Adamów004", "provincephysical_type_description": "lubelskie",null }, {...}, "post_code": "21-412" {...}, ] } |
Point details
Get point details.
Code Block | ||
---|---|---|
| ||
GET /v1/points?name=point_name |
Example request
Code Block | ||
---|---|---|
| ||
curl -X GET https://api.inpost.pl/v1/points?name=KRA02APP -H 'Content-Type: application/json' |
Response
Code Block | ||
---|---|---|
| ||
{ "streethref": "Kościuszki", "building_number": "27https://api-pl-points.easypack24.net/v1/points", "count": 1, "page": 1, "flatper_numberpage": null25, "total_pages": 1, },"items": [ "phone_number": null,{ "payment_point_descrhref": "Płatność internetowa aplikacją InPost Mobile oraz PayByLinkhttps://api-pl-points.easypack24.net/v1/points/KRA02APP", "functionsname": [ "allegro_courier_collect"KRA02APP", "allegro_courier_reverse_return_send","type": [ "allegroparcel_courier_sendlocker", "allegro_letter_reverse_return_send"], "allegro_letter_send", "status": "Operating", "allegro_parcel_collect",location": { "allegro_parcel_reverse_return_send"longitude": 19.87325, "allegro_parcel_send", latitude": 50.00919 "parcel"}, "parcel_collect"location_type": "Outdoor", "location_date": null, "parcel_reverse_return_send", "location_description": "Prywatna posesja wjazd od strony Dobrowolskiego"parcel_send", "standardlocation_courier_reverse_return_send"description_1": null, "standardlocation_courierdescription_send2": null, ] "distance": null, "partneropening_idhours": 0"24/7", "is_nextaddress": false,{ "payment_availableline1": true,"Dobrowolskiego", "payment_typeline2": { "30-394 Kraków" }, "0": "Payments are not supported" "address_details": { }, "virtualcity": "0Kraków", "recommended_low_interest_box_machines_list "province": null,"małopolskie", "apmpost_doubledcode": null,"30-394", "location_247street": true,"Dobrowolskiego", "operating_hoursbuilding_extendednumber": {null, "customerflat_number": null }, "agencyphone_number": "IPM4633224"null, "imagepayment_point_urldescr": "https://static.easypack24.net/points/pl/images/ADA01M.jpg", "easy_access_zone": truePłatność apką InPost oraz PayByLink", "air_index_levelfunctions": null, [ "physical_type_mapped": "004", "physicalallegro_typecourier_descriptioncollect":, null }, {...}, {...} "allegro_courier_reverse_return_send", ] } |
Point details
Get point details.
Code Block | ||
---|---|---|
| ||
GET /v1/points?name=point_name |
Example request
Code Block | ||
---|---|---|
| ||
curl -X GET https://api.inpost.pl/v1/points?name=KRA012 -H 'Content-Type: application/json' |
Response
Code Block | ||
---|---|---|
| ||
{ "href": "https://api-pl-points.easypack24.net/v1/points/KRA012",allegro_courier_send", "allegro_letter_reverse_return_send", "name": "KRA012 "allegro_letter_send", "type": [ "allegro_parcel_lockercollect", ], "status": "Operatingallegro_parcel_reverse_return_send", "location": { "longitude": 20.00399,allegro_parcel_send", "latitudeparcel":, 50.08913 }, "location_type": "Outdoor", "locationparcel_date": null,collect", "location_description": "Stacja paliw Lotos", "locationparcel_reverse_descriptionreturn_1send": null, "location_description_2": "Lotos", "distance": null, "opening_hours": "24/7parcel_send", "address": { "line1": "Os. Kombatantów 20",standard_courier_reverse_return_send", "line2": "31-630 Kraków"standard_courier_send" }, ], "address_details": { "citypartner_id": "Kraków"0, "province "is_next": "małopolskie", false, "postpayment_codeavailable": "31-630",true, "streetpayment_type": "Os. Kombatantów",{ "building_number0": "20", Payments are not supported" "flat_number": null }, "phone_number": null, "payment_point_descrvirtual": "Płatność0", w Paczkomacie kartą płatniczą lub BLIKIEM oraz internetowo aplikacją InPost Mobile i PayByLink", "functionsrecommended_low_interest_box_machines_list": [ "allegro_courier_collect "KRA106M", "allegro_courier_reverse_return_send", "allegro_courier_sendKRA20M", "allegro_letter_send", "allegro_parcel_collectKRA208M", "allegro_parcel_reverse_return_send", "allegro_parcel_sendKRA197M", "parcel", "parcel_collectKRA356M", "parcel_reverse_return_send", ], "parcel_send", "standard_courier_reverse_return_send",apm_doubled": null, "standardlocation_courier_send"247": true, ], "partneroperating_hours_idextended": 0,{ "is_next": false, "payment_available": true, "payment_typecustomer": {null "2": "Payment by card}, in the machine" }, "virtualagency": "0IPM9988771", "recommended_low_interest_box_machines_list": [ "KRA175M"image_url": "https://static.easypack24.net/points/pl/images/KRA02APP.jpg", "KRA274M", "easy_access_zone": true, "KRA227Mair_index_level": "GOOD", "KRA273M", "physical_type_mapped": "006", "KRA144M" ], "apmphysical_type_doubleddescription": "Appkomat null,InPost – swoją paczkę "location_247": true, "operating_hours_extended": {odbierzesz wygodniej z aplikacją InPost" } "customer": null ], }, "meta": { "agency": "IPM4956660", "image_urlhref": "https://staticapi-pl-points.easypack24.net/points/pl/images/KRA012.jpgv1/points", "easy_access_zone "count": false1, "air_index_levelpage": null1, "physicalper_type_mappedpage": "001"25, "total_pages": 1 "physical_type_description": null } } |
Search criteria
Parameter | Type | Description | Example |
---|---|---|---|
| String | Searches for shipments with given name. Searches for shipments with given names. |
|
| String | Searches for shipments with given type. Searches for shipments with given types. |
|
| String | Searches for shipments with given function. Searches for shipments with given functions. |
|
| Integer | Searches for shipments with given partner ID. Searches for shipments with given partner IDs. |
|
| Boolean | Searches for NEXT parcel locker points |
|
| Boolean | Searches by payment availability at the point |
|
| String | Searches for shipments with given post code. Searches for shipments with given post codes. |
|
| String | Searches for shipments with given city. Searches for shipments with given cities. |
|
| String | Searches for shipments with given province. Searches for shipments with given provinces. |
|
| Integer | Searches for shipments with given virtual value. Searches for shipments with given virtual values. |
|
| Date | Searches for points updated after the given date If |
|
| Date | Searches for points updated before the given date Requires providing |
|
Search by location
| String | Searches for points closest to the given location |
|
| String | Searches for points closest to the given post code |
|
| Double | Searches for points in distance up to the given value from Parameter usage requires sorting by distance. Default value: 10000 (10km) Maximum value 50000 (50km) |
|
| Integer | Point limiting parameter when using |
|
Result sorting
| Sort by point name |
|
| Sort by relative distance ( |
|
| 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.
| Sorts in ascending order |
|
| Sorts in descending order |
|
Pagination
| Defines the page for which the results should be returnet |
|
| Defines the amount of points returned per page Default: 25 |
|
Filtering of returned fields
| Defines the point attributes that should be returned |
|