This endpoint allows a user to retrieve an array of place IDs that represent addresses that may be used as the pickup location or delivery for a quote.
{
"data": [
{
"id": "23e3Kf0k23tnXe32",
"city": "Los Angeles",
"state": "CA",
"street": "4532 Sepulveda Blvd",
"zip": "90034"
},
{
"id": "13x7Kf0k11RnMn03",
"city": "Sherman Oaks",
"state": "CA",
"street": "4532 Sepulveda Blvd",
"zip": "91403"
}
]
}
The only query parameter this endpoint requires is a zip code. However, you may receive multiple place results if the provided address is ambiguous. To reduce the likelihood of using an inaccurate place ID when requesting a quote, provide the most specific address information that you can when making this call.
You can use any place ID returned by this endpoint to generate a quote. If the place ID corresponds to an address that is missing a street address (if you only provide a zip code, for instance), the place ID may not be usable for purchasing a shipment. See Booking a Shipment for more details.
As place IDs are periodically refreshed, they should not be cached and reused. Doing so may result in place IDs becoming invalid over time.
Limitations in the Sandbox Environment
In the sandbox environment, we offer only four valid places to quote and create shipments for. Providing an address input with the street, city, state, or zip code values from the address column below will return a Places object that contains the corresponding place ID.
Address | Corresponding Place ID |
---|---|
Los Angeles County Museum of Art 5905 Wilshire Boulevard Los Angeles, CA 90036 | ChIJsXqcyjy5woARNz6sOh0ZmwA |
Griffith Observatory 2800 East Observatory Road Los Angeles, CA 90027 | ChIJywjU6WG_woAR3NrWwrEH_3M |
Space Needle 400 Broad Street Seattle, WA 98109 | ChIJ-bfVTh8VkFQRDZLQnmioK9s |
Yankee Stadium 1 East 161st Street Concourse, NY 10451 | ChIJcWnnWiz0wokRCB6aVdnDQEk |