Warning! The resource is available only in the following countries: PL, IT |
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:
https://api-shipx-pl.easypack24.net/v1/points
Sandbox environment:
https://sandbox-api-shipx-pl.easypack24.net/v1/points
On this page
Point
resource has the following attributes:
Attribute | Type | Description | Availability | ||
---|---|---|---|---|---|
| String | Unique point name e.g. KRA007 (Parcel Locker) | PL, IT | ||
| Array | Table specifying types of points available at the location. Possible types of points:
| PL, IT | ||
| String | Point status. | PL, IT | ||
| Object |
| PL, IT | ||
| String | Location type. | PL, IT | ||
| String | Additional location description that may make it easier to reach. | PL, IT | ||
| String | Additional description | PL, IT | ||
| String | Additional description | PL, IT | ||
| Integer | Distance from the relative point location. If the relative point has not been specified, takes null value. | PL, IT | ||
| String | Point opening hours | PL, IT | ||
| Object |
| PL, IT | ||
| Object | Detailed point address data
| PL, IT | ||
| String | Point telephone number | PL, IT | ||
| String | Additional information about the point | |||
| Array | Table specifying the functions offered by the point. Possible functions:
| PL, IT | ||
| Integer | Partner ID | PL, IT | ||
| Boolean | Is it a NEXT automatic parcel station | PL, IT | ||
| 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 | PL, IT | ||
| String | Payment type parameter | PL, IT | ||
| Integer | Virtual point | PL, IT | ||
| Array | Other points recommended nearby | PL, IT | ||
| 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). | PL, IT | ||
easy_access_zone | Boolean | Does the parcel locker have an easy access zone? | PL, IT |
Point
resource in JSON format:
{ "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 } |
Access to the resource does not require authentication.
List of Points retrieval, the collection supports pagination, which can be found in API General information.
GET /v1/points |
Example request
curl -X GET https://api-shipx-pl.easypack24.net/v1/points -H 'Content-Type: application/json' |
Response
{ "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 }, {...}, {...}, ] } |
Get point details.
GET /v1/points/:point_name |
Example request
curl -X GET https://api-shipx-pl.easypack24.net/v1/points/KRA012 -H 'Content-Type: application/json' |
Response
{ "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 } |
Parameter | Type | Description | Example | Availability |
---|---|---|---|---|
| String | Searches for shipments with given name. Searches for shipments with given names. |
| PL, IT |
| String | Searches for shipments with given type. Searches for shipments with given types. |
| PL, IT |
| String | Searches for shipments with given function. Searches for shipments with given functions. |
| PL, IT |
| Integer | Searches for shipments with given partner ID. Searches for shipments with given partner IDs. |
| PL, IT |
| Boolean | Searches for NEXT parcel locker points |
| PL, IT |
| Boolean | Searches by payment availability at the point |
| PL, IT |
| String | Searches for shipments with given post code. Searches for shipments with given post codes. |
| PL, IT |
| String | Searches for shipments with given city. Searches for shipments with given cities. |
| PL, IT |
| String | Searches for shipments with given province. Searches for shipments with given provinces. |
| PL, IT |
| Integer | Searches for shipments with given virtual value. Searches for shipments with given virtual values. |
| PL, IT |
| Date | Searches for points updated after the given date If |
| PL, IT |
| Date | Searches for points updated before the given date Requires providing |
| PL, IT |
Search by location
| String | Searches for points closest to the given location |
| PL, IT |
| String | Searches for points closest to the given post code |
| PL, IT |
| 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) |
| PL, IT |
| Integer | Point limiting parameter when using |
| PL, IT |
Result sorting
| Sort by point name |
| PL, IT |
| Sort by relative distance ( |
| PL, IT |
| Sort by status |
| PL, IT |
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 |
| PL, IT |
| Sorts in descending order |
| PL, IT |
Pagination
| Defines the page for which the results should be returnet |
| PL, IT |
| Defines the amount of points returned per page Default: 25 |
| PL, IT |
Filtering of returned fields
| Defines the point attributes that should be returned |
| PL, IT |