Find Pick-Up/Drop-Off (PUDO) Locations
This tutorial explains how to find Pick-Up and Drop-Off (PUDO) locations, or what we will refer to as Service Points. You will learn how to make a POST call to search for Service Points near a chosen address for your selected carriers and services.
Display these Service Points at checkout so your customers may choose the most convenient location from where they can collect or ship their parcel.
Similar to the Quickstart: Create a Label guide, we need to know some basic information to get Service Points.
REQUIREMENTS
To get Service Points, you must include the following:
- The
carrier_id
for any carriers you wish to retrieve Service Points for. Find yourcarrier_id
using List Your Carriers. - One (but not more than one) of the following location identifier groups:
lat
andlong
... or ...addressline_1
,city_locality
,state_province
,postal_code
, andcountry_code
... or ...address_query
Request Body
The following table lists the parameters required for this endpoint. For samples of a full request, see the Example Requests section below.
Property Name | Required | Type | Description |
---|---|---|---|
carrier_id | ✔ | String | Need at least one, can be multiple carriers. |
service_point | Optional | Object | See Example Request 4. |
service_code | Optional | String | For a single service code. For multiple service codes, separate each with a comma. |
radius | Optional | Number | Search radius in kilometers |
max_results | Optional | Number | The maximum number of service points to return. Default is 100 |
lat | Integer | The latitude of the point. Represented as signed degrees. Required if long is provided. Latitude & Longitude Formats | |
long | Integer | The longitude of the point. Represented as signed degrees. Required if lat is provided. Latitude & Longitude Formats | |
address_query | String | Unstructured text to search for service points by. (i.e., 123 Any St, Austin, TX) | |
address | String. | Always provide the country_code and at least one other field (i.e., city and country_code ). The more fields you enter, the more accurate your results will be. | |
country_code | String | 2 characters. Example: CA. A two-letter ISO 3166-1 country code |
Below are four examples of different ways to POST calls in JSON. Each example includes the response you should see returned, plus how to understand and use their results. These examples to help you locate Service Points include:
- Search by Lat, Long
- Search by Address
- Search by Address string
- Search by Service Point ID (if you know the PUDO location's
service_point_ID
and want information such as hours of operation, etc.)
Example Request 1: Search Service Points with Latitude & Longitude
Click to see Example Request 1: Details
This example shows how to get a list of Service Points by providing longitude and latitude (lat
& long
), and filtering by a specific carrier and service. You can then use a Service_Point_ID
to Print a Label for that shipping location.
sends lat
and long
details along with carrier_id
and service_code
properties in the POST call.
Example Request 2: Search Service Points by Address
Click to see Example Request 2**: Search Service Points by Address
Example Request 3: Search Service Points by Address String
Click to see Example Request 3: Details
Example Request 4: Search Service Points by Service Point ID
Click to see Example Request 4: Details
This POST call will return address
(object), hours_of_operation
(object), and features
(String or Array of strings) as they relate to the Service Point.