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
|
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Older environments without authorization Production environment: https://api-shipx-pl.easypack24.net/v1/points Sandbox environment: |
Info |
---|
The older environments will eventually be extinguished, so please use the new ones. |
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
|
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 | Partner ID 60 of partner. "partner_id":0 - Parcel points Żabka61 - Parcel lockers ŻabkaLocker "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 | ||||
| Boolean | Does the parcel locker have an easy access zone?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ść 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", "parcel_reverse_return_send", "parcel_send", "standard_courier_reverse_return_send", "standard_courier_send" ], "partner_id": 0, "is_next": false, "payment_available": true, "hrefpayment_type": "https://api-pl-points.easypack24.net/v1/points/KRA012", { "name0": "KRA012"Payments are not supported" }, "typevirtual": [ "0", "recommended_low_interest_box_machines_list": [ "parcel_locker" "KRA106M", ], "status": "OperatingKRA20M", "locationKRA208M":, { "longitudeKRA197M": 20.00399, "latitudeKRA356M": 50.08913 }], "locationapm_typedoubled": "Outdoor"null, "location_date247": nulltrue, "locationoperating_hours_descriptionextended": "Stacja paliw Lotos", { "customer": null "location_description_1": null }, "location_description_2agency": "LotosIPM9988771", "distanceimage_url": null"https://static.easypack24.net/points/pl/images/KRA02APP.jpg", "openingeasy_access_hourszone": "24/7"true, "addressair_index_level": {"GOOD", "line1"physical_type_mapped": "Os. Kombatantów 20006", "line2physical_type_description": "31-630 Kraków" Appkomat InPost – swoją paczkę odbierzesz wygodniej z aplikacją InPost" }, "address_details": { } |
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 | ||
---|---|---|
| ||
{ "cityhref": "Krakówhttps://api-pl-points.easypack24.net/v1/points", "count": 24797, "province"page": "małopolskie"1, "per_page": 25, "total_pages": 992, "post_codeitems": "31-630",[ { "streethref": "Os. Kombatantów", https://api-pl-points.easypack24.net/v1/points/ADA01M", "building_numbername": "20ADA01M", "flat_numbertype": null [ }, "phoneparcel_numberlocker": null, "payment_point_descr": "Płatność w Paczkomacie kartą płatniczą lub BLIKIEM oraz internetowo aplikacją InPost Mobile i PayByLink], "status": "Operating", "functionslocation": [{ "allegro_courier_collect"longitude": 22.26405, "allegro_courier_reverse_return_send", latitude": 51.73834 "allegro_courier_send", }, "location_type": "allegro_letter_sendOutdoor", "allegrolocation_parcel_collect", date": null, "allegro_parcel_reverse_return_send", location_description": "Przy sklepie Lewiatan", "allegrolocation_parceldescription_send1": null, "parcel"location_description_2": null, "parcel_collect", "distance": null, "parcel_reverse_return_sendopening_hours": "24/7", "address": { "parcel_send", "line1": "Kościuszki "standard_courier_reverse_return_send"27", "line2": "standard_courier_send21-412 Adamów" ]}, "partneraddress_iddetails": 0,{ "is_next": false, "payment_availablecity": true,"Adamów", "payment_typeprovince": {"lubelskie", "2post_code": "Payment21-412", by card in the machine" },"street": "Kościuszki", "virtual "building_number": "027", "recommended_low_interest_box_machines_listflat_number": [null }, "KRA175M", "phone_number": null, "KRA274M", payment_point_descr": "Płatność apką InPost oraz PayByLink", "KRA227Mfunctions",: [ "KRA273Mallegro_courier_collect", "KRA144M"allegro_courier_reverse_return_send", ], "allegro_courier_send", "apm_doubled": null, "location_247": true,"allegro_letter_reverse_return_send", "operatingallegro_hoursletter_extendedsend": {, "customer": nullallegro_parcel_collect", }, "allegro_parcel_reverse_return_send", "agency": "IPM4956660", "allegro_parcel_send", "image_url": "https://static.easypack24.net/points/pl/images/KRA012.jpg", "easy_access_zone": false,parcel", "airparcel_index_level": nullcollect", } |
Authentication
Access to the resource does not require authentication.
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-shipx-pl.easypack24.net/v1/points -H 'Content-Type: application/json' |
Response
Code Block | ||
---|---|---|
| ||
{"parcel_reverse_return_send", "href": "https://api-pl-points.easypack24.net/v1/pointsparcel_send", "standard_courier_reverse_return_send", "count": 19378, "page": 1, "perstandard_courier_page": 25,send" "total_pages": 776, ], "items": [ { "partner_id": 0, "href": "https://api-pl-points.easypack24.net/v1/points/ADA01M" "is_next": false, "namepayment_available": "ADA01M"true, "payment_type": [{ "parcel_locker0": "Payments are not supported" ]}, "statusvirtual": "Operating0", "location": { recommended_low_interest_box_machines_list": null, "apm_doubled": null, "longitudelocation_247": 22.26405, true, "latitudeoperating_hours_extended": 51.73834 { }, "location_type"customer": "Outdoor",null "location_date": null}, "location_descriptionagency": "Przy sklepie LewiatanIPM4633224", "locationimage_description_1url": null"https://static.easypack24.net/points/pl/images/ADA01M.jpg", "locationeasy_descriptionaccess_2zone": nulltrue, "distanceair_index_level": null, "openingphysical_type_hoursmapped": "24/7004", "addressphysical_type_description": {null }, {...}, "line1": "Kościuszki 27" {...}, ] } |
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 | ||
---|---|---|
| ||
{ "line2href": "21-412 Adamów" }, https://api-pl-points.easypack24.net/v1/points", "address_detailscount": {1, "page": 1, "per_page": 25, "citytotal_pages": "Adamów"1, "items": [ { "province": "lubelskie", "post_code"href": "21-412https://api-pl-points.easypack24.net/v1/points/KRA02APP", "streetname": "Kościuszki", KRA02APP", "building_numbertype": "27",[ "flatparcel_numberlocker": null }], "phone_numberstatus": null"Operating", "payment_point_descrlocation": "Płatność{ internetowa aplikacją InPost Mobile oraz PayByLink", "functionslongitude": [19.87325, "allegro_courier_collect", "allegro_courier_reverse_return_send",latitude": 50.00919 }, "allegro_courier_send", location_type": "Outdoor", "allegro_letter_reverse_return_send"location_date": null, "allegro_letter_send", location_description": "Prywatna posesja wjazd od strony Dobrowolskiego", "allegrolocation_parceldescription_collect1": null, "allegrolocation_parcel_reverse_return_send"description_2": null, "allegro_parcel_send""distance": null, "opening_hours": "parcel24/7", "address": { "parcel_collect", "line1": "parcel_reverse_return_sendDobrowolskiego", "parcel_sendline2",: "30-394 Kraków" "standard_courier_reverse_return_send", }, "standardaddress_courier_send"details": { ],"city": "Kraków", "partner_idprovince": 0,"małopolskie", "ispost_nextcode": false"30-394", "payment_available "street": true,"Dobrowolskiego", "paymentbuilding_typenumber": {null, "0flat_number": "Payments are not supported" null }, "virtualphone_number": "0"null, "recommendedpayment_low_interest_box_machines_listpoint_descr": null,"Płatność apką InPost "apm_doubled": nulloraz PayByLink", "location_247functions": true,[ "operatingallegro_hourscourier_extendedcollect": {, "customer": null allegro_courier_reverse_return_send", }, "allegro_courier_send", "agency": "IPM4633224", "image_url": "https://static.easypack24.net/points/pl/images/ADA01M.jpg","allegro_letter_reverse_return_send", "easyallegro_accessletter_zone": true,send", "airallegro_indexparcel_levelcollect": null, }, {...}, {...}"allegro_parcel_reverse_return_send", ] } |
Point details
Get point details.
Code Block | ||
---|---|---|
| ||
GET /v1/points/:point_name |
Example request
Code Block | ||
---|---|---|
| ||
curl -X GET https://api-shipx-pl.easypack24.net/v1/points/KRA012 -H 'Content-Type: application/json' |
Response
Code Block | ||
---|---|---|
| ||
{ "href": "https://api-pl-points.easypack24.net/v1/points/KRA012 "allegro_parcel_send", "name": "KRA012parcel", "type": [ "parcel_lockercollect", ], "status": "Operating", "location": { "parcel_reverse_return_send", "longitude": 20.00399, "latitudeparcel_send":, 50.08913 }, "location_type": "Outdoor", "location_date": null,standard_courier_reverse_return_send", "location_description": "Stacja paliw Lotos", "locationstandard_descriptioncourier_1": null,send" "location_description_2": "Lotos" ], "distance": null, "openingpartner_hoursid": "24/7"0, "address": { "line1is_next": "Os. Kombatantów 20", false, "line2payment_available": "31-630 Kraków" true, }, "addresspayment_detailstype": { "city": "Kraków", "province0": "małopolskie",Payments are not supported" "post_code": "31-630", }, "street": "Os. Kombatantów", "building_numbervirtual": "200", "flat_number "recommended_low_interest_box_machines_list": null[ }, "phone_number": null, "payment_point_descr": "Płatność w Paczkomacie kartą płatniczą lub BLIKIEM oraz internetowo aplikacją InPost Mobile i PayByLinkKRA106M", "KRA20M", "functions": [ "allegro_courier_collectKRA208M", "allegro_courier_reverse_return_send "KRA197M", "allegro_courier_send", "allegro_letter_send", KRA356M" "allegro_parcel_collect", ], "allegro_parcel_reverse_return_send", "allegroapm_parcel_send"doubled": null, "parcel", "location_247": true, "parcel_collect", "parceloperating_reversehours_return_sendextended",: { "parcel_send", "standard_courier_reverse_return_send", customer": null "standard_courier_send" ]}, "partner_id": 0, "is_next": false, "payment_availableagency": true"IPM9988771", "payment_type": { "2image_url": "Payment by card in the machine"https://static.easypack24.net/points/pl/images/KRA02APP.jpg", }, "virtual"easy_access_zone": "0",true, "recommendedair_low_interest_box_machines_list": [index_level": "GOOD", "physical_type_mapped": "KRA175M006", "KRA274M", "KRA227M", "physical_type_description": "Appkomat InPost – swoją paczkę odbierzesz wygodniej z aplikacją InPost" "KRA273M",} ], "KRA144Mmeta": { ], "apm_doubledhref": null"https://api-pl-points.easypack24.net/v1/points", "location_247": true, "operating_hours_extended"count": {1, "customerpage": null 1, }, "agencyper_page": "IPM4956660"25, "image_url": "https://static.easypack24.net/points/pl/images/KRA012.jpg", "easytotal_access_zonepages": false,1 "air_index_level": 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 |
|