type | Array | Table specifying the kinds of points that are in the given location. Possible types of points: • parcel_locker - Physical automatic parcel machine and shipment handling points where a parcel machine shipment can be sent. • pop - Shipment handling points. • parcel_locker_only - Only physical automatic parcel machine. • parcel_locker_superpop - Shipment handling points which a parcel machine shipment can be sent to. | status | String | Point status. | location | Object | Location object containing information on the geographic location: latitude and longitude.
Sample Location object in the 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 points address information such as street, post-code, city.
Address
object Structure
Point
resource has the following attributes:
Attribute | Type | Description | name | String | Point ID. This is its unique name, e.g. KRA007 (for a Parcel Station) | line1"Kapelanka 14"line2nulladdressdetailsDetailed 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:
parcel=Send and collect standard parcel
parcel_send=Standard parcel send
parcel_collect=Standard parcel collect
parcel_reverse_return_send=Standard parcel reverse return to sender
standard_letter_collect=Standard letter collect
standard_letter_send=Standard letter send
allegro_parcel_collect=Allegro parcel collect
allegro_parcel_send=Allegro parcel send
allegro_parcelObject | AllegroallegroAllegroallegroAllegroallegro_letter_reverse_return_send=Allegro letterreturn to sender
couriercourier couriercourier couriercourier standardcourierCourierparcelstandardcourierCourierparcelstandardcourierCourierparcelaironairportSendand baggage from machine on airport
air_outside_airport=Send and collect baggage from machine outside of airport
cool_parcel_collect=Reservation collect from cooling machine
laundry=Send and collect laundry
avizo=Avizo collectpartner_id | Integer | Partner ID | is_next | Boolean | Is it a NEXT automatic parcel station | payment_available | 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 | payment_type | String | Payment type parameter | virtual | Integer | Virtual point | recommended_low_interest_box_machines_list | Array | Recommended other points nearby | location_247 | Boolean | Is the parcel locker available 24/7 | easy_access_zone | Boolean | Does the parcel locker have an easy access zone? | Point
resource in JSON format:
Code Block |
{
"href":"httpKRA011KRA011"type":[parcel_locker"
],"status":"Operating","location":{latitude":50.09103,"longitude":19.9299}
"location_type":null,"location_description":"StacjapaliwLukoil",location_description_1"location_description_2":"LUKOIL",distancenull,"opening_hours":null,"address":{line1"Opolska 9""line2":"31-274 Kraków"},address_details{"city":"Kraków""provincemałopolskiepostcode"31-274""street":"Opolska", buildingnumber9","flat_number":null},"phone_number":null, paymentpointdescr"Płatność internetowa PayByLink""functions":[allegrocouriercollectallegro_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_nextfalse"payment_available":true,"payment_type":{0"Brak obsługi płatności"},"virtual":"0",recommended_low_interest_box_machines_list":null"easy_access_zone":true}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/pointsExample request
Code Block |
curl-XGEThttps://api-shipx-pl.easypack24.net/v1/points-H'Content-Type:application/json'Response
Code Block |
{href"https://api-pl-points.easypack24.net/v1/points",
"count":5363,
"page":1,perpage25"total_pages":215,items[{"href":"http://api-pl-points.easypack24.net/v1/points/ADA01N" "name":"ADA01N",type[parcellocker ]
"status":"Operating",location{"latitude":51.74455, longitude":22.25847},location_type":null,"location_description":"PrzysklepieGroszek",locationdescription1":null,location_description_2":"Groszek""distance":null,opening_hours":"24/7"address":{line1":"Kleeberga 5B",line2":"21-412 Adamów"},addressdetails:{"city":"Adamów",
province:"lubelskie" "post_code":"21-412", "street":"Kleeberga", building_number":"5B "flat_number":null },phone_number":null"payment_point_descr":"PłatnośćinternetowaPayByLink.Dostępność24/7", "functions":[ "allegro_courier_collect", "allegro_courier_reverse_return "parcel_reverse_return_send",
"parcel_send",
],
"partner_id":0,"is_next":true"payment_available":true,
paymenttype{
"0":"Brak obsługi płatności"
},virtual"0""recommended_low_interest_box_machines_list":null,easyaccess_zone true},{...},
{...},]}Point details
Collecting point details.
Code Block |
GET/v1/points/:nazwa_punktuExample request
Code Block |
curl-XGEThttps://api-shipx-pl.easypack24.net/v1/points/AAB001-H'Content-Type:application/json'Response
Code Block |
HTTP/1.1200OK
Content-Type: application/json
{"href":"http://api-pl-points.easypack24.net/v1/points/ADA01N",nameADA01N"type":[parcel_locker"
],"status":"Operating", "location":{latitude:51.74455"longitude":22.25847},location_type:null"location_description":"Przy sklepie Groszek",location_description_1":null,"location_description_2":"Groszek","distance":null,"opening_hours":"24/7"address":{line1:"Kleeberga5B","line2":"21-412Adamów"}"address_details":{city"Adamów" "province":"lubelskie",postcode"21-412" "street":"Kleeberga",buildingnumber"5B","flat_number":null},phone_number, "payment_point_descr":"PłatnośćinternetowaPayByLink.Dostępność24/7","functions":["allegro_courier_collect",allegro_courier_reverse_return_sendallegro_courier_send",
"allegro_letter_reverse_return_send",allegrolettersend"allegro_parcel_collect", allegroparcel_reverse_return_send"allegro_parcel_send",parcel "parcel_collect",parcelreversereturn_send, "parcel_send",
"standard_courier_reverse_return_send", "standard_courier_send"partner_id0,is_next":true"payment_available":true,payment_type{0"Brak obsługi płatności"
},"virtual":"0",recommended_low_interest_box_machines_list":null,"easy_access_zone": true points the stated points all the listed parcelSorting Sorting using the field points points