REST API - Pickup

The Pickup endpoint will supply a list of different pick up points based on a specified location.

Endpoint

/parcel/pickup/{CountryCode}/{ZipCode}

Headers

A valid JWT token in the request is needed along with the version number to authenticate and authorize the request.
Replace ACCESS_TOKEN with a valid access token.

Authorization: Bearer ACCESS_TOKEN
Api-Version: 3.0
Content-Type: application/json

Pickup Request

Based on the provided properties the nearest location will be listed.

Method: GET
Response: 200 OK

Parameter	Type	Comment
CountryCode	string	2 letter ISO Code
ZipCode	string	Zip code of reference location

Pickup Response

The response format is a JSON body with http code 200 OK.
If an error occurred an Error response will be generated.

Parameter	Type	Comment
Carrier	string	Pickup location for specified carrier
Location	string	Name of location
Distance	int	Distance in meters
Latitude	double	Latitude of location
Longitude	double	Longitude of location
LocationCode	string	Code of location
Address	Address	Address of location
OpeningHours	OpeningHours	Opening hours of location

Address

Field	Type	Comment
City	string	City of location
CountryCode	string	2 letter ISO Code
Street	string	Street of location
ZipCode	string	Zip code of location
Number	string	Number of location
NumberSuffix	string	Number suffix of location
Remark	string	Remark for location

OpeningHours

Field	Type	Comment
Monday	string[]	Array of hours
Tuesday	string[]	Array of hours
Wednesday	string[]	Array of hours
Thursday	string[]	Array of hours
Friday	string[]	Array of hours
Saturday	string[]	Array of hours
Sunday	string[]	Array of hours

Response Body

{
    "locations": [
        {
            "carrier": "PostNL",
            "location": "Karwei",
            "distance": 1366,
            "latitude": 51.82920279,
            "longitude": 4.95783257,
            "locationCode": "171947",
            "address": {
                "city": "Gorinchem",
                "countryCode": "NL",
                "street": "Nieuwe Wolpherensedijk",
                "number": "5",
                "numberSuffix": null,
                "zipcode": "4202LP",
                "remark": "Dit is een Pakketpunt. Pakketten die u op werkdagen vóór lichtingstijd afgeeft, bezorgen we binnen Nederland de volgende dag."
            },
            "openingHours": {
                "monday": [
                    "09:00-21:00"
                ],
                "tuesday": [
                    "09:00-21:00"
                ],
                "wednesday": [
                    "09:00-21:00"
                ],
                "thursday": [
                    "09:00-21:00"
                ],
                "friday": [
                    "09:00-21:00"
                ],
                "saturday": [
                    "09:00-18:00"
                ],
                "sunday": [
                    "09:00-18:00"
                ]
            }
        },
        {
            "carrier": "PostNL",
            "location": "Bruna",
            "distance": 1539,
            "latitude": 51.83736141,
            "longitude": 4.9619771,
            "locationCode": "163514",
            "address": {
                "city": "Gorinchem",
                "countryCode": "NL",
                "street": "Piazza Center",
                "number": "10",
                "numberSuffix": null,
                "zipcode": "4204BN",
                "remark": "Dit is een Postkantoor. Post en pakketten die u op werkdagen vóór de lichtingstijd afgeeft, bezorgen we binnen Nederland de volgende dag. Op zaterdag worden alléén pakketten die u afgeeft voor 15:00 uur maandag bezorgd."
            },
            "openingHours": {
                "monday": [
                    "09:00-18:00"
                ],
                "tuesday": [
                    "09:00-18:00"
                ],
                "wednesday": [
                    "09:00-18:00"
                ],
                "thursday": [
                    "09:00-18:00"
                ],
                "friday": [
                    "09:00-18:00"
                ],
                "saturday": [
                    "09:00-17:00"
                ],
                "sunday": [
                    ""
                ]
            }
        }
    ]
}