Search pickup dropoff locations by address or geographical coordinates.
get/pickup_dropoff_locations
Request
- Base URL: https://api.shipcloud.io/v1
- URL: https://api.shipcloud.io/v1/pickup_dropoff_locations
- Auth: HTTP basic
Query parameters
carriersstring required
Example:dhl, hermes
Must be set with the carrier names (see /carriers endpoint). Multiple carriers can be given as a comma separated list.
streetstring
The street with house number and addition if applicable of the address.
zip_codestring
The zipcode of the address.
citystring
The city of the address.
statestring
The state, county or province of the address.
countrystring
Example:DE
The country of the address.
latitudenumber
Example:53.5446081
The geographical coordinate that specifies the north-south position.
longitudenumber
Example:9.996158
The geographical coordinate that specifies the east-west position.
radiusinteger
The search radius in meters.
limitinteger
The maximum number of locations to include in the search result.
Response
A successful response with a list of pickup dropoff locations.
Changes
No recorded changes to this operation across all 1 revision of this API.