Collecting the list of points.
Changes since version 1.7.0:
- Entering hard validation for all parameters of Integer, Double, List <Integer> type: in case of incorrect format or incorrect value of API parameter returns error, so far the parameter was ignored.
- Removing Polish translations - in the request for a possible function or possible payment method.
Points resource represents the locations in which logistic operators' services are available. Points can be self-service machines (Paczkomat Automatic Parcel Station, Laundromat) or branches, customer service points. Each of the locations offers specific services - the list of these services is returned in the response under the functions attribute.
Panel | ||||||
---|---|---|---|---|---|---|
| ||||||
|
Production environment:
https://api-shipx-pl.easypack24.net/v1/points
Test encironment:
You can test your implementation on a test environment available at: https://sandbox-api-shipx-pl.easypack24.net/v1/points?
Structure
Point
resource has the following attributes:
Description
Point ID. This is its unique name, e.g. KRA007 (for a Parcel Station)
type
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
Point status.
location
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
Location type.
location_description
Additional location description that may make it easier to reach.
location_description_1
Additional description.
location_description_2
Additional description.
distance
Distance from the relative point location. If the relative point has not been specified takes null value.
opening_hours
Point opening hours
address
Address
object containing the points address information such as street, post-code, city.
Address
object example in JSON format:
Code Block |
---|
"line1": "Kapelanka 14",
"line2": null |
address_details
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
Point telephone number
payment_point_descr
Additional information about the point
functions
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 Recommended other { "href":"http://api-pl-points.easypack24.net/v1/points/KRA011", "name":"KRA011", "type":["parcel_locker"],statusOperating"location":{latitude50.09103,"longitude":19.9299},location_typenull"location_description":"Stacja paliw Lukoil","location_description_1":"",locationdescription_2"LUKOIL", distance:null"opening_hours":null,"address":{line1"Opolska 9","line2":"31-274Kraków""address_details":{city"Kraków",province"małopolskie","post_code":"31-274","street":"Opolska", building_number":"9""flat_number":null},"phone_number":null, "payment_point_descr":"Płatność internetowa PayByLink","functions":[collectcourier"allegro_courier_send","allegro_parcel_send", "parcel", collect"parcel_reverse_return_send",_send"standard_courier_reverse_return_send",standardcourier_send],"partner_id":0,"is_next":false,payment_available":true"payment_type":{0":"Brak obsługi płatności"},"virtual":"0", "recommended_low_interest_box_machines_list":null,easyaccess_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/points |
Example request
Code Block |
---|
curl -X GET https://api-shipx-pl.easypack24.net/v1/points -H 'Content-Type: application/json' |
Response
Point details
Collecting point details.
Code Block |
---|
GET /v1/points/:nazwa_punktu |
Example request
Code Block |
---|
curl -X GET https://api-shipx-pl.easypack24.net/v1/points/AAB001 -H 'Content-Type: application/json' |
Response