API endpoints > pickuppoints > post
This endpoint delivers information about pickup (or: service) points for the chosen carrier, if the carrier supports this.
The api will try and find the closest 5 points to any given address or coordinate, depending on the search capability of the carrier.
JSON data structure
- CarrierIdInteger numberrequiredMinimum value: 1A valid carrier id (see /carriers/ endpoint)
- LanguageCountryMinimum length: 2, maximum length: 3A valid language as iso2 or iso3 country code for the reply
- AddresssublistrequiredThe address of the recipient
- CityStringrequiredMinimum length: 2, maximum length: 50City of the recipient
- CountryCountryrequiredMinimum length: 2, maximum length: 3Country of the recipient, ISO2 or ISO3 format. Has to be given in capitals.
- HouseNumberInteger numberMinimum value: 1The housenumber of the recipient
- LatReal numberrequiredMaximum value: 10000Latitude of the recipient address
- LongReal numberrequiredMaximum value: 10000Longitude of the recipient address
- NumberExtensionStringMaximum length: 10The number extension of the recipient
- PostalCodeStringrequiredMinimum length: 3, maximum length: 15Postal code of the recipient
- StateStringMinimum length: 2, maximum length: 50State name of the recipient
- Streetname1StringrequiredMinimum length: 4, maximum length: 100The streetname of the recipient
- Streetname2StringMaximum length: 100The secondary streetname of the recipient
JSON reply data
- CountInteger numberAlways returnedMaximum value: 999The amount of points
- FilterTypeSimple ID listA list of possible filters for a UI to be able to filter on point Type as desired. Each ID is a valid Type in points and has a string with the (english) name as the value.
- ErrorsublistAlways returnedAny error will be reported here, see the error list for error codes and their meaning.
- IdInteger numberAlways returnedMaximum value: 999The id of the error
- InfoStringTextual error
- ErrorListArray of objectsList of errors, to clarify the Error if possible
- IdInteger numberAlways returnedMaximum value: 999The error id, see the error list
- TekstStringAlways returnedMaximum length: 255Textual error for detailed information
- PointArray of objectsAn array with pickup points.
- DistanceReal numberAlways returnedThe calculated distance (in meters) to the given address. If not available this is an empty string.
- LatReal numberAlways returnedLatitude of the pickup point
- LongReal numberAlways returnedLongitude of the pickup point
- MapFieldsSelectArray of single valuesExtra pickup information for this point, refers to MapFields id's in /carriers
- PointIdStringAlways returnedMinimum length: 3, maximum length: 25The id of the pickup point
- TypeInteger numberAlways returnedThe typeid of the pickup point. The id depends on the carrier, there is no set list of id's for this. 0 = default
- CarriersublistAlways returnedCarrier information of the pickup point
- IdInteger numberAlways returnedMinimum value: 1The carrier id
- NameStringAlways returnedMinimum length: 1, maximum length: 50The carrier name
- InformationArray of objectsAlways returnedExtra information for the pickup point
- AddressStringAlways returnedMinimum length: 1, maximum length: 255The address (as one line) of the pickup point
- CityStringMinimum length: 1, maximum length: 255The city of the pickup point
- CountryCountryAlways returnedMinimum length: 2, maximum length: 3Country of the pickup point in ISO2 format.
- DistanceInteger numberThe (estimated) distance to the given address, if the carrier API provides it.
- NameStringAlways returnedMinimum length: 1, maximum length: 100The name of the pickup point
- WorkingHoursID list of objects (type 104 min): 1If available for the carrier, the opening hours for the pickup point. The keys are the day id. 0 = Monday, 7 = Sunday. It is possible to have multiple open and close times for a point on one day. Note: not all days have to be defined!
- key_entryArray of objectsAlways returnedMinimum array items: 1Each entry of a day is an array holding 1 or more entries for that day, in the correct order.
- CloseTimeTimeAlways returnedNot before this time: 1The time this point closes
- OpenTimeTimeAlways returnedNot before this time: 1The time this point opens
- key_entryArray of objectsAlways returnedMinimum array items: 1Each entry of a day is an array holding 1 or more entries for that day, in the correct order.
| POST | /pickuppoints/ |