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.Production environment
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
Production environments: |
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
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:
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 | Partner ID of partner. | ||||
| Boolean | Is it a NEXT automatic parcel station | ||||
payment_"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 | ||||
| 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", "href": "https://api-pl-points.easypack24.net/v1/points/KRA012", "standard_courier_send" "name": "KRA012"], "typepartner_id": [0, "parcelis_lockernext": false, ]"payment_available": true, "status": "Operating",payment_type": { "location0": {"Payments are not supported" "longitude": 20.00399}, "virtual": "0", "latitude": 50.08913 "recommended_low_interest_box_machines_list": [ }, "location_type": "OutdoorKRA106M", "location_dateKRA20M":, null, "location_description": "Stacja paliw Lotos"KRA208M", "location_description_1": null, "KRA197M", "location_description_2": "LotosKRA356M", "distance": null], "openingapm_hoursdoubled": "24/7"null, "addresslocation_247": { true, "line1operating_hours_extended": "Os.{ Kombatantów 20", "line2": "31-630 Kraków" "customer": null }, "address_detailsagency": { "IPM9988771", "city"image_url": "Krakówhttps://static.easypack24.net/points/pl/images/KRA02APP.jpg", "easy_access_zone": true, "provinceair_index_level": "małopolskieGOOD", "post_code"physical_type_mapped": "31-630006", "street"physical_type_description": "Os. Kombatantów", Appkomat InPost – swoją paczkę odbierzesz wygodniej z aplikacją InPost" "building_number": "20", } |
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 | ||
---|---|---|
| ||
{ "flat_number": null }, href": "https://api-pl-points.easypack24.net/v1/points", "phone_numbercount": null24797, "page": 1, "paymentper_point_descrpage": "Płatność25, w Paczkomacie kartą płatniczą lub BLIKIEM oraz internetowo aplikacją InPost Mobile i PayByLink", "total_pages": 992, "functionsitems": [ "allegro_courier_collect", { "allegro_courier_reverse_return_send"href": "https://api-pl-points.easypack24.net/v1/points/ADA01M", "allegro_courier_send"name": "ADA01M", "allegro_letter_send","type": [ "allegro_parcel_collectlocker", "allegro_parcel_reverse_return_send", ], "status": "allegro_parcel_sendOperating", "parcellocation",: { "parcel_collect"longitude": 22.26405, "parcel_reverse_return_send",latitude": 51.73834 }, "parcel_sendlocation_type": "Outdoor", "standard_courier_reverse_return_send", location_date": null, "standard_courier_send"location_description": "Przy sklepie Lewiatan", ]"location_description_1": null, "partnerlocation_description_id2": 0null, "is_nextdistance": falsenull, "paymentopening_availablehours": true"24/7", "payment_typeaddress": { "2line1": "Kościuszki 27"Payment, by card in the machine" }, "line2": "21-412 Adamów" "virtual": "0" }, "recommended_low_interest_box_machines_listaddress_details": [{ "city": "KRA175MAdamów", "KRA274Mprovince": "lubelskie", "post_code": "KRA227M21-412", "KRA273M"street": "Kościuszki", "KRA144M"building_number": "27", ], "flat_number": null "apm_doubled": null }, "locationphone_247number": truenull, "operatingpayment_hourspoint_extendeddescr": {"Płatność apką InPost oraz PayByLink", "customerfunctions": null[ }, "allegro_courier_collect", "agency": "IPM4956660", "allegro_courier_reverse_return_send", "image_url": "https://static.easypack24.net/points/pl/images/KRA012.jpg", "easyallegro_accesscourier_zone": false,send", "air_index_level": nullallegro_letter_reverse_return_send", } |
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 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 | ||
---|---|---|
| ||
{"allegro_letter_send", "href": "https://api-pl-points.easypack24.net/v1/points",allegro_parcel_collect", "count": 19378allegro_parcel_reverse_return_send", "page": 1, "per_page": 25, "totalallegro_parcel_pagessend":, 776, "items": [ {"parcel", "href": "https://api-pl-points.easypack24.net/v1/points/ADA01M", "parcel_collect", "name": "ADA01Mparcel_reverse_return_send", "typeparcel_send":, [ "parcel_locker""standard_courier_reverse_return_send", ], "standard_courier_send" "status": "Operating" ], "locationpartner_id": { 0, "longitudeis_next": 22.26405false, "payment_available": true, "latitude": 51.73834 "payment_type": { }, "location_type0": "Outdoor",Payments are not supported" "location_date": null}, "location_descriptionvirtual": "Przy sklepie Lewiatan0", "location_description_1recommended_low_interest_box_machines_list": null, "locationapm_description_2doubled": null, "distancelocation_247": nulltrue, "openingoperating_hours": "24/7",_extended": { "addresscustomer": {null }, "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", "physical_type_description": null "province": "lubelskie", }, {...}, {...}, ] "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 | ||
---|---|---|
| ||
{ "street"href": "Kościuszki", https://api-pl-points.easypack24.net/v1/points", "building_numbercount": "27"1, "page": 1, "per_page": 25, "flattotal_numberpages": null1, "items": [ }, { "phone_numberhref": null"https://api-pl-points.easypack24.net/v1/points/KRA02APP", "payment_point_descrname": "Płatność internetowa aplikacją InPost Mobile oraz PayByLinkKRA02APP", "functionstype": [ "allegroparcel_courier_collect"locker" ], "status": "Operating", "allegro_courier_reverse_return_send", "location": { "allegro_courier_send"longitude": 19.87325, "allegro_letter_reverse_return_send","latitude": 50.00919 }, "allegro_letter_send", location_type": "Outdoor", "allegrolocation_parcel_collect", date": null, "allegro_parcel_reverse_return_send", location_description": "Prywatna posesja wjazd od strony Dobrowolskiego", "allegrolocation_parceldescription_send1": null, "parcel", "location_description_2": null, "parcel_collect"distance": null, "parcel_reverse_return_send"opening_hours": "24/7", "address": { "parcel_send", "line1": "standard_courier_reverse_return_send"Dobrowolskiego", "line2": "standard_courier_send30-394 Kraków" ]}, "partner_id": 0,address_details": { "is_nextcity": false,"Kraków", "payment_availableprovince": true"małopolskie", "paymentpost_typecode": {"30-394", "0street": "Dobrowolskiego"Payments, are not supported" }, "building_number": null, "virtual": "0", "flat_number": null "recommended_low_interest_box_machines_list": null }, "apmphone_doublednumber": null, "locationpayment_point_247descr": true "Płatność apką InPost oraz PayByLink", "operating_hours_extendedfunctions": {[ "customer": nullallegro_courier_collect", },"allegro_courier_reverse_return_send", "agency": "IPM4633224", "allegro_courier_send", "image_url": "https://static.easypack24.net/points/pl/images/ADA01M.jpg",allegro_letter_reverse_return_send", "easyallegro_accessletter_zone": true,send", "airallegro_indexparcel_level": null collect", }, {...}, {...}, ] } |
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 | ||
---|---|---|
| ||
{"allegro_parcel_reverse_return_send", "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": nullstandard_courier_reverse_return_send", "location_description": "Stacja paliw Lotos", "location_description_1": null, "locationstandard_descriptioncourier_2send": "Lotos", "distance": null, "opening_hours": "24/7", ], "address": { "line1partner_id": "Os. Kombatantów 20",0, "line2is_next": "31-630 Kraków" false, }, "addresspayment_detailsavailable": true, { "citypayment_type": "Kraków",{ "province": "małopolskie", "post_code0": "31-630",Payments are not supported" "street": "Os. Kombatantów"}, "building_number "virtual": "200", "flat_numberrecommended_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 PayByLink",KRA106M", "functions": [ KRA20M", "allegro_courier_collect", "allegro_courier_reverse_return_sendKRA208M", "allegro_courier_send", "allegro_letter_sendKRA197M", "allegro_parcel_collect", "allegro_parcel_reverse_return_send",KRA356M" "allegro_parcel_send", ], "parcel", "parcelapm_collectdoubled": null, "parcel_reverse_return_send",location_247": true, "parceloperating_hours_sendextended",: { "standard_courier_reverse_return_send", "standard_courier_sendcustomer": null ], "partner_id": 0, "is_next": false,}, "payment_available": true, "payment_typeagency": {"IPM9988771", "2image_url": "Payment by card in the machine""https://static.easypack24.net/points/pl/images/KRA02APP.jpg", }, "virtualeasy_access_zone": "0",true, "recommendedair_low_interest_box_machines_list": [index_level": "GOOD", "KRA175Mphysical_type_mapped": "006", "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_extendedcount": {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 |
|