[1.23.0] Points

name 

String

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

PL, IT

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. 

PL, IT

status 

String

Point status.

PL, IT

location

Object

Location object including the geographical location latitude and longitude

Location resource example in JSON format:

PL, IT

location_type

String

Location type.

PL, IT

location_description

String

Additional location description that may make it easier to reach.

PL, IT

location_description_1

String

Additional description

PL, IT

location_description_2

String

Additional description

PL, IT

distance

Integer

Distance from the relative point location. If the relative point has not been specified, takes null value.

PL, IT

opening_hours 

String

Point opening hours

PL, IT

address

Object

Address object containing the point's address information such as street, post-code, city.

Address object example in JSON format:

PL, IT

Object

Detailed point address data

PL, IT

phone_number 

String

Point telephone number

PL, IT

payment_point_descr 

String

Additional information about the point

functions

Array

Table specifying the functions offered by the point. Possible functions:

PL, IT

partner_id

Integer

Partner ID

PL, IT

is_next 

Boolean

Is it a NEXT automatic parcel station

PL, IT

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

PL, IT

payment_type 

String

Payment type parameter

PL, IT

virtual 

Integer

Virtual point

PL, IT

recommended_low_interest_box_machines_list 

Array

Other points recommended nearby

PL, IT

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).

PL, IT

easy_access_zone

Boolean

Does the parcel locker have an easy access zone?

PL, IT

name

String
Array

Searches for shipments with given name.

Searches for shipments with given names.

?name=KRA010
?name=Kra010,ADA01N

PL, IT

type

String
Array

Searches for shipments with given type.

Searches for shipments with given types.

?type=parcel_locker
?type=parcel_locker,pop

PL, IT

functions

String
Array

Searches for shipments with given function.

Searches for shipments with given functions.

?functions=parcel
?functions=parcel,parcel_send

PL, IT

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

PL, IT

is_next

Boolean

Searches for NEXT parcel locker points

?is_next=true

PL, IT

payment_available 

Boolean

Searches by payment availability at the point

?payment_available=true

PL, IT

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

PL, IT

city

String
Array

Searches for shipments with given city.

Searches for shipments with given cities.

?city=Kraków

?city=Kraków,Warszawa

PL, IT

province

String
Array

Searches for shipments with given province.

Searches for shipments with given provinces.

?province=Małopolska

?province=Małopolska,Śląsk

PL, IT

virtual

Integer
Array

Searches for shipments with given virtual value.

Searches for shipments with given virtual values.

?virtual=0
?virtual=1,6

PL, IT

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

PL, IT

updated_to

Date

Searches for points updated before the given date

Requires providing updated_from.

?updated_to=2018-04-26

PL, IT

relative_point 

String

Searches for points closest to the given location

?relative_point=52.123,19.321

PL, IT

relative_post_code 

String

Searches for points closest to the given post code

?relative_post_code=11-111

PL, IT

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

PL, IT

limit 

Integer

Point limiting parameter when using relative_point  or relative_post_code 

?limit=10

PL, IT

name 

Sort by point name

?sort_by=name

PL, IT

distance_to_relative_point

Sort by relative distance (relative_point or relative_post_code)

?sort_by=distance_to_relative_point

PL, IT

status

Sort by status

?sort_by=status

PL, IT

asc

Sorts in ascending order

?sort_order=asc&sort_by=status

PL, IT

desc

Sorts in descending order

?sort_order=desc&sort_by=status

PL, IT

page

Defines the page for which the results should be returnet

?page=2

PL, IT

per_page

Defines the amount of points returned per page

Default: 25
Maximum: 500

?per_page=100

PL, IT

fields

Defines the point attributes that should be returned

?fields=name,type

PL, IT