Three lines

Uber

Developers

Pickup Refinement

Privileged and Confidential This endpoint design has been confidentially shared with you. It is still under development and is subject to change without notice. Please do not share this document or API endpoint details with anyone who is not authorized to have access. For more information read about scopes.

Zones API

The Get Zones endpoint provides information about specialized pickup locations, such as airports, hospitals, and concert arenas. It’s recommended to call this endpoint before creating a trip to ensure smoother pickup and drop-off experiences.

Required Information:

  • Latitude and longitude for the location.
  • Place ID and place provider details (optional).
  • Complete address.
Handling Zones in the UI

The UI should allow input for latitude, longitude, and place ID to identify zones and access points. Based on the API response, coordinators can select the most appropriate pickup or dropoff location.

Zone Types:

  • Hierarchical Zones: Complex locations like airports, where the primary zone (e.g., the airport) contains sub-zones (e.g., terminals), which have dedicated access points (e.g., specific doors).
  • Non-Hierarchical Zones: Simple locations like stadiums, where the primary zone consists of several access points around the perimeter.
  • Access Points Only: If no zones exist, available access points will be returned for nearby locations.

Access Points and Trip Creation

Access Point Info: Use place_id and place_provider to get access points in the API. When creating trips, use the access_point.id and corresponding latitude/longitude from the Zones API response for smooth coordination.

Using Zone API Response

Trip Estimates: For accurate estimates, use the latitude and longitude from the desired zone (or sub-zone for hierarchical pickups).

Trip Creation:

  • Access Point ID: Use access_point.id as start_place.place_id to set the correct pickup or dropoff point.
  • Provider: Set start_place.provider to uber_geofences to indicate a geofenced area.
  • Zone ID for Hierarchical Locations (e.g., airports with terminals): Use sub-zone ID (e.g., terminal ID) from the master zone as start_place.zone_id.
  • Zone ID for Non-Hierarchical Locations (e.g., stadiums): Use the master zone’s ID as start_place.zone_id.
Rider Wayfinding Note

This field helps riders locate their pickup point and is sent via SMS for on-demand, scheduled, and reserved trips.

Uber

Developers
© 2023 Uber Technologies Inc.