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 | ||||||
panelIconId | atlassian-info | panelIcon | :||||
Info | bgColor | #FFEBE6
---|
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 | ||||
---|---|---|---|---|---|---|
| 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 - 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. | ||||
| 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). | ||||
| BooleanString | Does the Type of parcel locker have an | ||||
|
Point
resource in String | Description for type of parcel locker |
Point
resource in JSON format:
Code Block | ||
---|---|---|
| ||
{ "href": "https://api-pl-points.easypack24.net/v1/points/KRA012KRA02APP", "name": "KRA012KRA02APP", "type": [ "parcel_locker" ], "status": "Operating", "location": { "longitude": 2019.0039987325, "latitude": 50.0891300919 }, "location_type": "Outdoor", "location_date": null, "location_description": "Stacja paliw LotosPrywatna posesja wjazd od strony Dobrowolskiego", "location_description_1": null, "location_description_2": "Lotos"null, "distance": null, "opening_hours": "24/7", "address": { "line1": "Os. Kombatantów 20Dobrowolskiego", "line2": "3130-630394 Kraków" }, "address_details": { "city": "Kraków", "province": "małopolskie", "post_code": "3130-630394", "street": "Os. KombatantówDobrowolskiego", "building_number": "20"null, "flat_number": null }, "phone_number": null, "payment_point_descr": "Płatność w Paczkomacie kartą płatniczą lub BLIKIEM oraz internetowo aplikacją InPost Mobile i 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, "payment_type": { "20": "PaymentPayments byare card in the machinenot supported" }, "virtual": "0", "recommended_low_interest_box_machines_list": [ "KRA175MKRA106M", "KRA274MKRA20M", "KRA227MKRA208M", "KRA273MKRA197M", "KRA144MKRA356M" ], "apm_doubled": null, "location_247": true, "operating_hours_extended": { "customer": null }, "agency": "IPM4956660IPM9988771", "image_url": "https://static.easypack24.net/points/pl/images/KRA012KRA02APP.jpg", "easy_access_zone": falsetrue, "air_index_level": null "GOOD", } |
List of Points
List of Points retrieval, the"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": 1937824797, "page": 1, "per_page": 25, "total_pages": 776992, "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ść 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, "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 | ||
---|---|---|
| ||
GET /v1/points/:?name=point_name |
Example request
Code Block | ||
---|---|---|
| ||
curl -X GET https://api.inpost.pl/v1/points/KRA012?name=KRA02APP -H 'Content-Type: application/json' |
Response
Code Block | ||
---|---|---|
| ||
{ "href": "https://api-pl-points.easypack24.net/v1/points/KRA012", "namecount": "KRA012"1, "typepage": [1, "per_page": 25, "parceltotal_lockerpages": ]1, "statusitems": "Operating",[ "location": { { "longitude": 20.00399, "latitudehref": 50.08913"https://api-pl-points.easypack24.net/v1/points/KRA02APP", }, "location_typename": "OutdoorKRA02APP", "location_date": null, "location_descriptiontype": "Stacja paliw Lotos",[ "location_description_1": null, "locationparcel_description_2locker": "Lotos", "distance": null, "opening_hours": "24/7" ], "address": { "line1status": "Os. Kombatantów 20","Operating", "line2location": "31-630 Kraków"{ }, "address_details": { "citylongitude": "Kraków"19.87325, "province": "małopolskie", "post_codelatitude": "31-630",50.00919 "street": "Os. Kombatantów"}, "buildinglocation_numbertype": "20Outdoor", "flatlocation_numberdate": null, }, "phonelocation_numberdescription": null,"Prywatna posesja wjazd od strony "payment_point_descr": "Płatność w Paczkomacie kartą płatniczą lub BLIKIEM oraz internetowo aplikacją InPost Mobile i PayByLink"Dobrowolskiego", "location_description_1": null, "functions": [ "allegrolocation_courierdescription_collect2": null, "allegro_courier_reverse_return_send", "distance": null, "allegro_courier_send", "allegro_letter_send",opening_hours": "24/7", "allegro_parcel_collect",address": { "allegro_parcel_reverse_return_send", "line1": "allegro_parcel_sendDobrowolskiego", "parcel", "line2": "parcel_collect",30-394 Kraków" "parcel_reverse_return_send", }, "parcel_send", "standard_courier_reverse_return_send", address_details": { "standard_courier_send" ], "partner_idcity": 0"Kraków", "is_next": false, "payment_availableprovince": true"małopolskie", "payment_type": { "2post_code": "Payment by card in the machine""30-394", }, "virtualstreet": "0Dobrowolskiego", "recommended_low_interest_box_machines_list": [ "KRA175M"building_number": null, "KRA274M", "KRA227Mflat_number",: null "KRA273M", }, "KRA144M" ], "apmphone_doublednumber": null, "location_247": true, "operatingpayment_hourspoint_extendeddescr": {"Płatność apką InPost oraz PayByLink", "customer": null }, "agencyfunctions": [ "IPM4956660", "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": [ "KRA106M", "KRA20M", "KRA208M", "KRA197M", "KRA356M" ], "apm_doubled": null, "location_247": true, "operating_hours_extended": { "customer": null }, "agency": "IPM9988771", "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" } ], "meta": { "image_urlhref": "https://staticapi-pl-points.easypack24.net/points/pl/images/KRA012.jpg",/v1/points", "count": 1, "page": 1, "easyper_access_zonepage": false25, "airtotal_index_levelpages": null 1 } } |
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 |
|