ParcelShopFinder Service
-
Introduction
The ParcelShopFinder Service is used to retrieve a list of nearby parcel shops and lockers ordered by proximity to a specified location. This location can be provided either as geo data (latitude and longitude) or as a postal code.
Finding parcel shops and lockers by geo data is preferred and provide better results.The parcel shop information (“parcelShopId”) is required when creating a 2Shop shipment. Each shipment must be linked to a specific parcel shop, which can be retrieved from the list returned by this service.
The results include essential details such as the parcelShopID, address, and opening hours and can be used to show the parcel shops and lockers in a webshop checkout. When you want to embed the data in Google Maps, you will need a Google API key. Obtaining a Google API key is your own responsibility.
You can also use one of our plugins, where we arange this for you (if available in the plugin).This service is intended to be called daily to ensure that there is always an up-to-date list of nearby parcel shops and lockers to choose from.
-
REST URL
Geo Data – findParcelShopsByGeoData
- Live:
POST https://wsshipper.dpd.nl/rest/services/ParcelShopFinderService/V5_0/findParcelShopsByGeoData
- Stage:
POST https://wsshippertest.dpd.nl/rest/services/ParcelShopFinderService/V5_0/findParcelShopsByGeoData
Postal Code – findParcelShops
- Live:
-
Request - Geo Data
{ "authentication": { "delisId": "*****", "authToken": "*****", "messageLanguage": "nl_NL" }, "findParcelShopsByGeoData": { "longitude": "5.3866225", "latitude": "51.4766742", "limit": "10" } } -
Request - Postal Code
{ "authentication": { "delisId": "*****", "authToken": "*****", "messageLanguage": "nl_NL" }, "findParcelShops": { "country": "NL", "zipCode": "5688HB", "city": "Oirschot", "limit": "10" } } -
Response
{ "findParcelShopsByGeoDataResponse": { "parcelShop": [ { "parcelShopId": 78765051544949, "pudoId": "NL23611", "company": "DPD Nederland B.V.", "street": "Pakket Onderweg", "houseNo": "1", "country": "NL", "countryNum": 528, "state": null, "zipCode": "5688 HB", "city": "Oirschot", "town": "Oirschot", "phone": "", "fax": "", "email": "", "homepage": "", "latitude": 51.4766742, "longitude": 5.3866225, "coordinateX": 0.0, "coordinateY": 0.0, "coordinateZ": 0.0, "distance": 2.523, "expressPickupTime": "", "extraInfo": "", "openingHours": [ { "weekDay": "maandag", "openMorning": "00:00", "closeMorning": "00:00", "closeAfternoon": "18:00", "openAfternoon": "13:00" }, { "weekDay": "dinsdag", "openMorning": "09:00", "closeMorning": "18:00", "closeAfternoon": "00:00", "openAfternoon": "00:00" }, { "weekDay": "woensdag", "openMorning": "09:00", "closeMorning": "18:00", "closeAfternoon": "00:00", "openAfternoon": "00:00" }, { "weekDay": "donderdag", "openMorning": "09:00", "closeMorning": "18:00", "closeAfternoon": "00:00", "openAfternoon": "00:00" }, { "weekDay": "vrijdag", "openMorning": "08:00", "closeMorning": "18:00", "closeAfternoon": "00:00", "openAfternoon": "00:00" }, { "weekDay": "zaterdag", "openMorning": "09:00", "closeMorning": "17:00", "closeAfternoon": "00:00", "openAfternoon": "00:00" }, { "weekDay": "zondag", "openMorning": "00:00", "closeMorning": "00:00", "closeAfternoon": "00:00", "openAfternoon": "00:00" } ], "holiday": [], "services": [ { "code": "100", "available": true, "description": "Afhalen door ontvanger", "serviceDetail": [] }, { "code": "200", "available": true, "description": "Online betaalde pakketten worden geaccepteerd", "serviceDetail": [] }, { "code": "991", "available": true, "description": "Retourzendingen worden geaccepteerd", "serviceDetail": [] } ] } ] }, "status": { "type": "OK", "code": "200", "message": "valid" } } -
Parameters
Request – General
Field Data Type Mandatory Range Description delisId xs:string Yes The delis user id for authentication. authToken xs:string Yes The token for authentication. Field authToken of Login, as a result of Method “getAuth” of LoginService. messageLanguage xs:string Yes length:5 The language for messages.
“nl_NL” for Dutch messages.
“en_US” for English messages.
Request – Geo DataField Data Type Mandatory Range Description longitude xs:double Yes The longitude of the search location. latitude xs:double Yes The latitude of the search location. limit xs:int Yes minInclusive: 1
maxInclusive: 100Number of parcel shop retrieved in the response.
Request – Postal CodeField Data Type Mandatory Range Description country xs:string Yes length:2 Country of the search location in ISO 3166-1 alpha-2 format. zipCode xs:string Yes maxLength:9 Zip code of the search location. city xs:string Yes maxLength:35 City/town of the search location. limit xs:int Yes minInclusive: 1
maxInclusive: 100Number of parcel shop retrieved in the response.
ResponseField Data Type Description parcelShopId xs:integer The ID of the parcel shop. pudoId xs:string The Pudo ID of the parcel shop. company xs:string The company name of the parcel shop. street xs:string The street of the parcel shop. houseNo xs:string The house number of the parcel shop. country xs:string The country of the parcel shop. countryNum xs:string Country of the parcel shop in ISO 3166-1 numeric-3 format. state xs:string The state of the parcel shop. zipCode xs:string The zip code of the parcel shop. city xs:string The city of the parcel shop. town xs:string The town of the parcel shop. phone xs:string The phone number of the parcel shop. fax xs:string The fax number of the parcel shop. email xs:string The email address of the parcel shop. homepage xs:string The website of the parcel shop. latitude xs:string The latitude of the parcel shop. longitude xs:string The longitude of the parcel shop. coordinateX xs:string The X geo coordinate of the parcel shop. coordinateY xs:string The Y geo coordinate of the parcel shop. coordinateZ xs:string The Z geo coordinate of the parcel shop. distance xs:string The distance from the search location to the parcel shop in kilometers. expressPickupTime xs:string The time when express deliveries are picked up. extraInfo xs:string Additional information to find the parcel shop (e.g. if the shop is in a mall). weekday xs:string The name of the weekday in the “messageLanguage”. openMorning xs:string Time of opening of the parcel shop in the morning. closeMorning xs:string Time of closing of the parcel shop in the morning. closeAfternoon xs:string Time of closing of the parcel shop in the afternoon. openAfternoon xs:string Time of opening of the parcel shop in the afternoon. holidayStart xs:string The start date of holiday in date format “yyyy-MM-dd HH:mm:ss”. holidayEnd xs:string The end date of holiday in date format “yyyy-MM-dd HH:mm:ss”. code xs:string The code of service. available xs:boolean This field specifies whether it is allowed to search for the parcel shops or not. description xs:string The description of service code.