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 information about point location that may make it easier to reach it. | location_description_1
| String | Additional description. | location_description_2
| String | Additional description. | distance
| Integer | Distrance from a relative point stated in the search. If the relative point has not been provided, then it takes null value. | opening_hours | String | Point opening hours | address | Object | Address object containing address information about the point such as: street, postal code, city. Sample Address object in the JSON format:
Code Block |
---|
"line1": "Kapelanka 14",
"line2": null |
address_details | Object | 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 | 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_parcel_Structure
Points resource elements have the following attributes:
Attribute | Type | Description | href | String | The URI address to the resource of the particular point | name | String | Point ID. This is its unique name, e.g. KRA007 (for a Parcel Station) | 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. | Is it isnext payments in the . together this that .availableBoolean | Dostępność płatności w danym punkcie. Istnieje możliwość wystąpienia payment_available=true razem z payment_type=0, oznacza to, że płatność jest dostępna. | payment_type | String | virtual | virtual | Integer | Point virtuality
| recommended_low_interest_boxRecommended other Code Block |
{
"href":"http://api-pl-points.easypack24.net/v1/points/KRA011",
"name":"KRA011",
"type":[
"parcel_locker"
],
"status":"OperatingSample Point resource in the JSON format:
"location":{latitude50.09103,"longitude":19.9299},locationtype":null,"location_description":"Stacja paliw Lukoil","location_description_1":"",location_description_2LUKOIL"distance":null,"opening_hours":null,address"line1":"Opolska9",line2"31-274 Kraków"},"address_details":{city"Kraków",
"province":"małopolskie","post_code":"31-274""street":"Opolska", buildingnumber9flatnumber},"phone_number":null,paymentpoint_descrPłatnośćinternetowaPayByLink"functions":[allegrocouriercollect
"allegro_courier_reverse_return_send",allegrocourier_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_id0,
"is_next":false,"payment_available":true,paymenttype0"Brak obsługi płatności"},virtual0"recommended_low_interest_box_machines_list":null
}Authentication
Access to the resource does not require authentication..
List of points
Pobieranie listy punktów.
In the response the server will return a collection with the list of points.
The collection supports paging that is described on page API General.
Sample request
Code Block |
---|
GET https://api-shipx-pl.easypack24.net/v1/points HTTP/1.1
Host: api-shipx-pl.easypack24.net |
Response
HTTP/1.1 200 OK
Content-Type: application/json
{
"href":"https://api-pl-points.easypack24.net/v1/points",
"count":5363,
"page":1,
"per_page":25,
"total_pages":215,
"items":[
{href":"http://api-pl-points.easypack24.net/v1/points/ADA01N""nameADA01N",type[ parcellocker"]"statusOperatinglocationlatitude51.74455,longitude22.25847locationtypenull, "location_description":"PrzysklepieGroszek",location_description_1null"location_description_2":"Groszek", distance:null"opening_hours":"24/7","address":{line1Kleeberga 5Bline221-412 Adamów}, addressdetails{ "city":"Adamów"province"lubelskie", "post_code":"21-412street"Kleeberga",buildingnumber:"5B",flat_number":null}, "phone_number":null,payment_point_descr":"Płatność internetowa PayByLink. Dostępność 24/7",functions":[couriercouriercourier"allegro_letter_reverse_return_send", "allegro_letter_send",allegro_allegro_allegro_parcelparcelcollect"parcel_reverse_return_send"parcelsend "standard_courier_reverse_return_send"standardcourier_send ], partner_id0,"is_next":true,"payment_available":true,payment_type{ "0":"Brak obsługi płatności" },virtual"0"recommendedlow_interest_box_machines_list":null},{"href":"http://api-pl-points.easypack24.net/v1/points/ALK01A",nameALK01Atype[ parcellocker],"status":"Operating", location:{ "latitude":52.8684,"longitude":18.7031 },
"location_type":null,
"location_description"Przy biurze usług ubezpieczeniowych",
location_description_1
"location_description_2"",distance":null,opening_hours24/7
address "line1":"Słowackiego 131",line2"87-700 Aleksandrów Kujawski" }addressdetails{ cityAleksandrów Kujawski province"kujawsko-pomorskiepost_code"87-700 streetSłowackiego, buildingnumber"131", flat_numbernull
][...]}Point details
Collecting point details.
Code Block |
---|
GET /v1/points/:nazwa_punktu |
In the response the server will return point details.
Sample request
Code Block |
---|
GET https://api-shipx-pl.easypack24.net/v1/points/AAB001 HTTP/1.1
Host: api-shipx-pl.easypack24.net |
Response
Code Block |
HTTP/1.1 200 OK
Content-Type: application/json
{href"http://api-pl-points.easypack24.net/v1/points/ADA01N",name":"ADA01N"type[ "parcel_locker"
],
"status":"Operating"location{latitude":51.74455,"longitude":22.25847},locationtype:null"location_description":"PrzysklepieGroszek", locationdescription1:nulllocationdescription2:"Groszek""distance":null"opening_hours":"24/7",address":{line1":"Kleeberga 5B",line2":"21-412 Adamów"},address_details":{city":"Adamów"province":"lubelskie",post_code":"21-412", "street":"Kleeberga",
buildingnumber"5B" flatnumbernull }, phonenumbernullpoint_descr"PłatnośćinternetowaPayByLink.Dostępność24/7",functions["allegro_courier_collect",allegro_courier_reverse_return_send",
"allegro_courier_send",
allegroletterreversereturnsend,"allegro_letter_send", "allegro_parcel_collect"allegro_parcel_reverse_return_sendallegro_parcel_sendparcelparcel_collect",parcel_reverse_return_send",
parcelsend standardcourier_reverse_return_send",standard_courier_send"]partner_id0is_next":truepaymentavailabletruepaymenttype{ "0"Brak obsługi płatności"},"virtual":"0",recommendedlow_interest_box_machines_listPoint the name specified in the searchList of types of points, comma separated, which are to be returned in the response points the stated points all the listed parcel points the stated _id points the stated _id that are NEXTFiltering the list of points on the availability of payments for . points which have the stated postal points which have the stated postal points which have the stated points which have the stated city points which have the stated voivodeship. Searches for points which have the stated voivodeships points with the stated virtuality. points with the stated virtualitiesSearch by date when the point update was made. The parameter should be provided together with updated_to. the parameter specified, back counting from .Search by date when the point update was made. The parameter should be provided together with updated_from.If the updated_from parameter has not been specified, the date cannot be later than 3 days back counting from the updated_from parameter located as close as possible stated geographical coordinates. located as close as possible stated postal .Specifies distance in meters from the point stated in ..Using the parameter forces : Limit of returned points parameters in .Sorting resultsSorting .Sorting from the relative point Sorting Sorting done in both directions, using the sort_order parameter: points points By default, the results are sorted ascending (asc) by point name (name).
Paging
page | Specifies the results page, which should be returned.Specifies number of results displayed on the page. value value displayed Specifies list of to be displayed on page.