Page Comparison

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

bgColor	#f0f0f0
titleBGColor	#f0f0f0
title	On this page

Table of Contents

minLevel	2

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:

AttributeType

Description

nameString

Point ID. This is its unique name, e.g. KRA007 (for a Parcel Station)

typeArray

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.

locationObject

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_descriptionString

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

addressObject

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

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

functionsArray

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

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

Info
More information on the available options Display of collection points

On this page

Table of Contents

Structure

Point resource has the following attributes:

Attribute

Type

Description

name

String

Unique point name e.g. KRA007 (Parcel Locker)

type

Array

Table specifying types of points available at the location.

Possible types of points:

parcel_locker - Physical parcel locker and parcel points to which you can send your parcel.
pop - All parcel points.
parcel_locker_only - Only physical parcel locker.
parcel_locker_superpop - Parcel points which you can send your parcel.

status

String

Point status.

location

Object

Location object including the geographical location latitude and longitude

Location resource example in 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 point's address information such as street, post-code, city.

Address object example in JSON format:

Code Block
"line1": "Kapelanka 14", "line2": null

Code Block
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:

Code Block

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

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

Other points recommended nearby
`location_247`	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).
easy_access_zone	Boolean	Does the parcel locker have an easy access zone?

Point resource in JSON format:

Code Block

{ "href":"http://api-pl-points.easypack24.net/v1/points/KRA011", "name":"KRA011", "type":[

language	json

{
            "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
        }

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

Code Block

language	json

{
    "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",

"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

Code Block{ "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" "name":"ADA01N",type[parcellocker],status":"Operating","location":{"latitude":51.74455,longitude22.25847 },location_type"location_description"Przy sklepie Groszek", "location_description_1":null,description_2"Groszek""distance":null, opening"24/7","address":{line1"Kleeberga 5B","line2":"21-412Adamów"},address_details{city"Adamów "province":"lubelskie", postcode"21-412" "street":"Kleeberga", buildingnumber"5B", "flat_number":null "phone_number":null, "payment_point_descr":"Płatność internetowa PayByLink. Dostępność 24/7", "functions":[ "allegro_courier_collect", "allegro_courier_reverse_return_send", "parcel_reverse_return_send", "parcel_send", "standard_courier_reverse_return_send", "standard_courier_send" ]

Point details

Get point details.

Code Block

language	json

GET /v1/points/:point_name

Example request

Code Block

language	json

curl -X GET https://api-shipx-pl.easypack24.net/v1/points/KRA012 -H 'Content-Type: application/json'

Response

Code Block

language	json

{
    "href": "https://api-pl-points.easypack24.net/v1/points/KRA012",

partner_id:0 is_nexttrue,paymentavailable:true,"payment_type":{ 0Brak obsługi płatności" } virtual"0","recommended_low_interest_box_machines_list":null"easy_access_zonetrue {...}{...}]}

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

Code BlockHTTP/1.1 200 OK Content-Type: application/json { hrefhttp://api-pl-points.easypack24.net/v1/points/ADA01N",name"ADA01Ntype[parcellocker],statusOperatinglocation{latitude":51.74455,longitude22.25847},locationtypenull,locationdescription"Przy sklepie Groszek"locationdescription_1locationdescription2Groszek", "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"flat_number":null},phonenumber:null"payment_point_descr":"Płatność internetowa PayByLink. Dostępność 24/7",functions":[allegrocollectallegroreverse_return_allegrocourier_send" allegro_letter_reverse_return_send" allegroletter_send",allegro_parcel_collect", "allegro_parcel_reverse_return_send", "allegro_parcel_send" parcel "parcel_collect",parcel_reverse_return_sendparcel_send"standard_courier_reverse_return_sendstandard_courier_send"],partner_id":0isnexttruepaymentavailablepaymenttype0"Brakobsługipłatności""virtual":"0"recommendedlow_interest_box_machines_listnulleasyaccesszonetrue

Search criteria

Parameter

Type

Description

Example

name

String
Array

Searches for shipments with given name.

Searches for shipments with given names.

?name=KRA010
?name=Kra010,ADA01N

type

String
Array

Searches for shipments with given type.

Searches for shipments with given types.

?type=parcel_locker
?type=parcel_locker,pop

functions

String
Array

Searches for

points the stated points all the listed parcel

`parcel,parcel_send`
`partner_id`	Integer Array	Searches for shipments with given partner ID. Searches for shipments with given partner IDs.	`?partner_id=1` `?partner_id=1,2`
`is_next`	Boolean	Searches for NEXT parcel locker points	`?is_next=true`
`payment_available`	Boolean	Searches by payment availability at the point	`?payment_available=true`
`post_code`	String Array	Searches for shipments with given post code. Searches for shipments with given post codes.	`?post_code=11-111` `?post_code=11-111,22-222`
`city`	String Array	Searches for shipments with given city. Searches for shipments with given cities.	`?city=Kraków` `?city=Kraków,Warszawa`
`province`	String Array	Searches for shipments with given province. Searches for shipments with given provinces.	`?province=Małopolska` `?province=Małopolska,Śląsk`
`virtual`	Integer Array	Searches for shipments with given virtual value. Searches for shipments with given virtual values.	`?virtual=0` `?virtual=1,6`
`updated_from`	Date	Searches for points updated after the given date If `updated_to` has not been given the date cannot be earlier than 3 days before the current date	`?updated_from=2018-04-24`
`updated_to`	Date	Searches for points updated before the given date Requires providing `updated_from`.	`?updated_to=2018-04-26`

Search by location

`relative_point`	String	Searches for points closest to the given location	`?relative_point=52.123,19.321`
`relative_post_code`	String	Searches for points closest to the given post code	`?relative_post_code=11-111`
`max_distance`	Double	Searches for points in distance up to the given value from `relative_point` or `relative_post_code` Parameter usage requires sorting by distance. Default value: 10000 (10km) Maximum value 50000 (50km)	`?relative_point=52.123,19.321&max_distance=10000`
`limit`	Integer	Point limiting parameter when using `relative_point` or `relative_post_code`	`?limit=10`

Result sorting

name

Sorting Sorting using the field points points

Sort by point name	`?sort_by=name`
`distance_to_relative_point`	Sort by relative distance (`relative_point` or `relative_post_code`)	`?sort_by=distance_to_relative_point`
`status`

in ascending order	`?sort_order=asc&sort_by=status`
`desc`	Sorts

Versions Compared

Old Version 6

New Version 7

Key

Structure

Structure

Authentication

List of Points

Authentication

List of points

Point details

Point details

Search criteria