Points (Parcel Locker, ParcelPoint)
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.
New environments with authorization
Production environments:
https://api.inpost.pl/v1/points
Generating access
Go to the Parcel Manager website https://manager.paczkomaty.pl
In the login window, enter your login and click: Login
After logging in go to My Account tab
In the Data tab check if all the company data is correctly filled in
Remember, in order to generate access to API, both your company address and invoice data have to be filled in.After verification go to the new tab API
To generate a new Point Access, expand the ShipX API tab and click Generate
If you already have a token generated make sure to use a token from the list (Lista tokenów do API InPost (API ShipX oraz API Points)) for authentication. If you do not have such a list you need to generate a new token.
Sandbox Environment:
https://sandbox-api-gateway-pl.easypack24.net/v1/points
Generating access
Go to the Parcel Manager website https://sandbox-manager.paczkomaty.pl/
In the login window, enter your login and click: Login
After logging in go to My Account tab
In the Data tab check if all the company data is correctly filled in
Remember, in order to generate access to API, both your company address and invoice data have to be filled in.After verification go to the new tab API
To generate a new Point Access, expand the ShipX API tab and click Generate
If you already have a token generated make sure to use a token from the list (Lista tokenów do API InPost (API ShipX oraz API Points)) for authentication. If you do not have such a list you need to generate a new token.
More information on the available options Display of collection points
Structure
Point
resource has the following attributes:
Attribute | Type | Description |
---|---|---|
| String | Unique point name e.g. KRA007 (Parcel Locker) |
| Array | Table specifying types of points available at the location. Possible types of points:
|
| String | Point status. |
| Object |
"latitude": 50.03988,
"longitude": 19.92485 |
| String | Location type. |
| String | Additional location description that may make it easier to reach. |
| String | Additional description |
| String | Additional description |
| Integer | Distance from the relative point location. If the relative point has not been specified, takes null value. |
| String | Point opening hours |
| Object |
"line1": "Kapelanka 14",
"line2": null |
address_details | Object | Detailed point address data |
| String | Point telephone number |
| String | Additional information about the point |
| Array | Table specifying the functions offered by the point. Possible functions: |
| Integer | ID of partner. "partner_id":0 - Parcel Locker "partner_id": 33 - ParcelPoint with parcel locker parcel pick-up function. "partner_id": 30 - ParcelPoint without parcel locker parcel pick-up function, has only parcel post function. |
| Boolean | Is it a NEXT automatic parcel station |
| 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 |
| String | Payment type parameter |
| Integer | Virtual point |
| Array | Other points recommended nearby |
| 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). |
| String | Type of parcel locker |
| String | Description for type of parcel locker |
Point
resource in JSON format:
List of Points
List of Points retrieval, the collection supports pagination, which can be found in API General information.
Example request
Response
Point details
Get point details.
Example request
Response
Search criteria
Parameter | Type | Description | Example |
---|---|---|---|
| String | Searches for shipments with given name. Searches for shipments with given names. |
|
| String | Searches for shipments with given type. Searches for shipments with given types. |
|
| String | Searches for shipments with given function. Searches for shipments with given functions. |
|
| Integer | Searches for shipments with given partner ID. Searches for shipments with given partner IDs. |
|
| Boolean | Searches for NEXT parcel locker points |
|
| Boolean | Searches by payment availability at the point |
|
| String | Searches for shipments with given post code. Searches for shipments with given post codes. |
|
| String | Searches for shipments with given city. Searches for shipments with given cities. |
|
| String | Searches for shipments with given province. Searches for shipments with given provinces. |
|
| Integer | Searches for shipments with given virtual value. Searches for shipments with given virtual values. |
|
| Date | Searches for points updated after the given date If |
|
| Date | Searches for points updated before the given date Requires providing |
|
Search by location
| String | Searches for points closest to the given location |
|
| String | Searches for points closest to the given post code |
|
| Double | Searches for points in distance up to the given value from Parameter usage requires sorting by distance. Default value: 10000 (10km) Maximum value 50000 (50km) |
|
| Integer | Point limiting parameter when using |
|
Result sorting
| Sort by point name |
|
| Sort by relative distance ( |
|
| Sort by status |
|
Sort ordering can be set using sort_order
attribute. By default the results are sorted in an ascending order using the name
field.
| Sorts in ascending order |
|
| Sorts in descending order |
|
Pagination
| Defines the page for which the results should be returnet |
|
| Defines the amount of points returned per page Default: 25 |
|
Filtering of returned fields
| Defines the point attributes that should be returned |
|