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
allegro_parcel_reverse_return_send=Allegro parcel return to sender
allegro_letter_collect=Allegro letter collect
allegro_letter_send=Allegro letter send
allegro_letter_reverse_return_send=Allegro letter return to sender
allegro_courier_collect=Allegro courier parcel collect
allegro_courier_send=Allegro courier parcel send
allegro_courier_reverse_return_send=Allegro courier parcel return to sender
standard_courier_collect=Courier parcel collect
standard_courier_send=Courier parcel send
standard_courier_reverse_return_send=Courier parcel return to sender
air_on_airport=Send and collect 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 collect
partner_id
Partner ID
is_next
Is it a NEXT automatic parcel station
payment_available
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
virtual
location_247
Point
resource in JSON format:
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