¶ GetOrderRequest.ResponseOptions

Name	Type	Description	Required
include_product_details	bool	Whether to include the product details in the response	N
include_shopping_phase_context	bool	Whether to include the shopping phase context in the response	N
include_route_legs	bool	Whether to include the route leg details in the response	N
include_tipping_rules	bool	Whether to include the tipping rules in the response	N

¶ GetPaymentSummaryResponse.PaymentProfile

Name	Type	Description	Required
payment_profile_id	string	The payment profile ID.	Y
display_name	PaymentProfileDisplayName	The display name of the payment profile.	Y

¶ GetPaymentSummaryResponse.PaymentProfileDisplayName

Name	Type	Description	Required
name	string	The localized name of the payment profile.	Y
icon	Image	The icon URL of the payment profile.	Y

¶ ResolveWaypointRequest.ResponseOptions

Name	Type	Description	Required
include_nearby_zones	bool	Whether to include the product details in the response	N
include_rider_wayfinding_detailed	bool	Return detailed step-by-step wayfinding instructions with images. Only request when explicitly needed — this is a costly call for RDG.	N

¶ GetUserPromotionsRequest.RequestOptions

Request options are to be set only when detailed information needs to be queried for a specific offer.

Name	Type	Description	Required
promotion_id	string	Specific offer id which is to be queried. UUID validation is enforced in service code (ValidateUUIDGuard), in line with H3PD-5462.	N
promotion_type	string	Type of the offer being queried, i.e. promotion, incentive award, etc. Required whenever request_options is set; enforced in service code along with the rest of the request validation. Refer to this table for allowed values of PromotionType.	Y

¶ PromotionType

Type of the offer associated with a user promotion. Offers surfaced to third parties are modelled under the single umbrella term “promotion”, irrespective of whether they originate from the promotions or the incentives platform.

Name	Number	Description
PROMOTION_TYPE_INVALID	0
PROMOTION_TYPE_STANDARD	1	Standard promotion type that gives the user a fixed discount.
PROMOTION_TYPE_INCENTIVE_AWARD	2	Range based promotion (lower% - upper%) out of which the user can be awarded any value in between, resolved dynamically based on user activity.
PROMOTION_TYPE_INCENTIVE_QUEST	3	Quest based promotion (do x, get y).

¶ GetUserPromotionsRequest.ResponseOptions

Name	Type	Description	Required
include_promotion_restrictions	bool	Whether to include the List details in the response. This will be only applicable if promotion_id is present in the request.	N
include_promotion	bool	Whether to include the Promotion in the response if promotion id is not set.	N

¶ Action

Name	Type	Description	Required
action_id	string	action id which can be performed in trip state Refer to this table for allowed values of ActionId.	Y
action_type	string	Type of action Refer to this table for allowed values of ActionType.	Y
action_display_name	string	Localised action name	Y
action_type_metadata_one_of	ActionTypeMetadataOneOf	metadata related to the actions	N

¶ ActionId

Name	Number	Description
ACTION_ID_INVALID	0
ACTION_ID_CANCEL	1
ACTION_ID_POST_ASSIGN_CONTACT_TRANSPORT_PROVIDER	2
ACTION_ID_UNASSIGN_JOB	3

¶ ActionType

Name	Number	Description
ACTION_TYPE_INVALID	0
ACTION_TYPE_RPC_ACTION	1
ACTION_TYPE_CLIENT_ONLY_ACTION	2

¶ ActionTypeMetadataOneOf

Name	Type	Description	Required
rpc_action_metadata	RpcActionMetadata		N

¶ RpcActionMetadata

Name	Type	Description	Required
rpc_method	string	Name of the rpc method	Y

¶ Adjustment

Name	Type	Description	Required
adjustment_number	int	Adjustment number	Y
adjustment_reason	string	Adjustment reason	Y
pre_adjusted_fare	AdjustedFare	Fare before applying adjustment	Y
post_adjusted_fare	AdjustedFare	Fare after applying adjustment	Y
adjusted_at	string	Adjustment timestamp	Y
adjusted_billing_line_items	array<BillingLineItem>		N

¶ Adjustment.AdjustedFare

Name	Type	Description	Required
fare_amount	string	Fare amount	Y

¶ AppInForegroundPayload

Name	Type	Description	Required
is_cold_launch	bool	A cold launch occurs when the app is started from scratch rather than being resumed from a suspended state (i.e. not in memory)	N

¶ EventPayloadOneOf

Name	Type	Description	Required
app_in_foreground_payload	AppInForegroundPayload		N
location_updated_payload	LocationUpdatedPayload		N
product_impression_payload	ProductImpressionPayload		N

¶ LocationUpdatedPayload

Name	Type	Description	Required
previous_location	LocationSpecification	Previous location which user wants to modify	N
target_location	LocationSpecification	The new location which the user wants to use.	Y

¶ ProductImpressionPayload

Name	Type	Description	Required
product_id	string	Product id of the product that was shown to the user.	Y
fare	Fare	Estimated Fare for the product	Y
eta	ETA	Estimated ETA of the product.	N
etd	int	ETD stands for Expected Time to Destination. Uber returns this value as duration_in_seconds in routeLeg in estimatesForIntent API response.	Y

¶ AnalyticsEvent

Name	Type	Description	Required
event_uuid	string	Unique event uuid.	Y
event_timestamp	string	Timestamp at which the event was originally recorded.	Y
event_type	string	Uber will share a list of event types with their corresponding payload and the scenarios in which the event should be sent. Use the given payload for the list of event types and their corresponding payloads.	Y
event_context	EventContext	Context of the event.	Y
event_payload_one_of	EventPayloadOneOf	One of the objects specifying the event payload. Use the given table for the possible list of event types and their corresponding payloads.	N

¶ App

Name	Type	Description	Required
version	string	App version installed on the mobile. Sample value -> 4.536.10001	N

¶ Device

Name	Type	Description	Required
device_id	string	UUID for uniquely identifying device.	Y
os	string	Os of the device	Y
os_version	string	Os version of the device	Y
type	string	User device type, for example: Mobile	Y
model	string	User device model, for example: motorola defy, nokia 5.4	N
locale	string	User’s device locale, for example: en	N
ip_address	string	User’s device IP address, for example: 172.16.89.38	N
position	Position	Device’s position when this event was fired.	Y

¶ EventContext

Name	Type	Description	Required
device	Device	Device information.	Y
user_id	string	Participant id for whom the analytics event is triggered.	Y
user_state	string	Refer to this table for allowed values of UserState.	N
order	EventOrderContext	Details related to the order. These need to be passed whenever the details are available to 3P.	Y
app	App	App Information. To be passed if 3P uses an app.	N
session	Session	Uber’s Session information	N

¶ UserState

Name	Number	Description
USER_STATE_INVALID	0
USER_STATE_LOOKING	1
USER_STATE_MATCHING	2
USER_STATE_ENROUTE	3
USER_STATE_TRANSPORTING	4

¶ EventOrderContext

Name	Type	Description	Required
order_id	string	Unique order uuid.	N
ride_order_context	RideOrderContext	Details related to the ride order These need to be passed whenever the details are available to 3P.	N

¶ FailedEvent

Name	Type	Description	Required
event_uuid	string	Unique event uuid of the publish-requested event.	Y
error	string	Will return publish failure reason for the event_uuid.	Y
error_message	string	Will be sent when additional details of request failure needs to be passed	N

¶ RideOrderContext

Name	Type	Description	Required
origin	LocationSpecification	Origin location specification.	N
destination	LocationSpecification	Destination location specification.	N
via_locations	array<LocationSpecification>	Intermediate via locations.	N
product_id	string	The product id.	N

¶ Session

Name	Type	Description	Required
session_payload	string	Value returned from ‘x-uber-session’ header stored in mobile client.	Y

¶ BillingLineItem

Name	Type	Description	Required
line_item_id	string	The id of the billing line item Refer to this table for allowed values of BillingLineItemId.	Y
amount	string	Amount value corresponding to the line item	Y

¶ BillingLineItemId

Name	Number	Description
BILLING_LINE_ITEM_ID_INVALID	0
BILLING_LINE_ITEM_ID_CASH_COLLECTED	1
BILLING_LINE_ITEM_ID_UBER_ARREARS	2
BILLING_LINE_ITEM_ID_OUT_OF_BAND_PAYMENT	3

¶ Arrear

Name	Type	Description	Required
order_id	string	The id of the Order	Y
amount	string	E5 Amount of the arrear	Y
currency_code	string	ISO 4217 currency code	Y

¶ CashCollectibleLineItem

Name	Type	Description	Required
line_item_id	string	The id of the line item Refer to this table for allowed values of CashCollectibleLineItemId.	Y
amount	string	The amount of the line item	Y

¶ CashCollectibleLineItemId

Name	Number	Description
CASH_COLLECTIBLE_LINE_ITEM_ID_INVALID	0
CASH_COLLECTIBLE_LINE_ITEM_ID_THIRD_PARTY_SECURED_PAYMENT_AMOUNT	1	Total amount promised to cover digitally by a third party. This should include Wallet Hold and all other third party secured payment amounts like Wusool.
CASH_COLLECTIBLE_LINE_ITEM_ID_THIRD_PARTY_ARREARS	2	Rider arrears accumulated on a third party that the 3P wants Uber to collect on their behalf on the trip.
CASH_COLLECTIBLE_LINE_ITEM_ID_TOTAL_ARREARS	3	Total rider arrears accumulated on third party and Uber inclusive.
CASH_COLLECTIBLE_LINE_ITEM_ID_THIRD_PARTY_SECURED_PAYMENT_WUSOOL_AMOUNT	4	Amount that will be paid by the Wusool program for this trip.

¶ CallbackEvent

Name	Type	Description	Required
message_id	string	Unique id for a comms message that was sent by Uber on /v1/comms/send endpoint whose callback event request this is.	Y
channel	string	The channel of the associated comm message like email, push, sms. Refer to this table for allowed values of Channel.	Y
event_id	string	Unique id of the callback event.	Y
event_type	string	Type of the callback event like blocked, delivered etc. Refer to this table for allowed values of EventType.	Y
event_timestamp	string	Timestamp at which the event occurred in milli seconds.	Y
event_detail	EventDetailOneOf	Details about the callback event. It is a one for each push, email, sms.	N

¶ Channel

Name	Number	Description
CHANNEL_INVALID	0
CHANNEL_SMS	1
CHANNEL_EMAIL	2
CHANNEL_PUSH	3

¶ EventType

Name	Number	Description
EVENT_TYPE_INVALID	0
EVENT_TYPE_BLOCKED	1	When the app receives a push but doesn’t show it to the user due to their push OS status setting.
EVENT_TYPE_BOUNCE	2	When a message bounced.
EVENT_TYPE_BUFFERED	3	When a message is buffered.
EVENT_TYPE_BUFFER_ENDED	4	When the buffering of a message has ended.
EVENT_TYPE_CAUSED_UNSUBSCRIBE	5	When a message causes an unsubscribe.
EVENT_TYPE_CLICK	6	When a link within a message was clicked.
EVENT_TYPE_DELIVERED	7	When a message has been delivered.
EVENT_TYPE_DISMISSED	8	When a message has been dismissed.
EVENT_TYPE_EXPIRED	9	When a message expires.
EVENT_TYPE_FAILED	10	When a message failed to send.
EVENT_TYPE_FAILED_INTERNAL	11	Unknown
EVENT_TYPE_FALLBACK	12	The message was received by Pusher, but for one of several possible reasons, a fallback SMS was sent instead.
EVENT_TYPE_OPEN	13	When a message has been opened.
EVENT_TYPE_PROCESSED	14	When a message has been successfully received by the core delivery service and sent to the delivery provider.
EVENT_TYPE_SENT	15	When a message has been sent to the provider.
EVENT_TYPE_SPAM	16	When a message has been reported as spam.
EVENT_TYPE_SUPPRESSED	17	When an event was suppressed.
EVENT_TYPE_UNDELIVERED	18	When a message has been reported as undelivered.

¶ EmailEventDetail

Name	Type	Description	Required
bounce_type	string	BounceType is set on bounce events and contains a provider specific value i.e. bounce class classification. More on the types of bounces can be found here. Possible values : “10” which means Invalid Recipient.	N
bounce_class	string	BounceClass is a classification of the bounce type. Possible values : “hard_bounce”, “soft_bounce” etc. Refer to this table for allowed values of BounceClass.	N
url	string	URL is set on click events and is the URL that the user clicked on. Each url will have a separate event.	N
is_machine_open	bool	It represents whether or not an open event was processed by a machine instead of an individual user. E.g. if Apple “opens” an email before delivering it to the user.	N
delivery_failure_cause	string	The cause for the email that could not be delivered. For bounce events: the reason that the email bounced. Bounce Example: 550 5.5.0 Requested action not taken: mailbox unavailable. For dropped events: the reason that the email was dropped. Dropped Example: Unsubscribed Address	N
recipient_email	string	RecipientEmail is the email address of the recipient.	Y
is_one_click_unsubscribe_enabled	bool	IsOneClickUnsubscribeEnabled tells whether we are passing one click unsubscribe url in email request or not	N

¶ BounceClass

Name	Number	Description
BOUNCE_CLASS_INVALID	0
BOUNCE_CLASS_HARD_BOUNCE	1	HardBounceClass is a hard bounce which is a permanent failure
BOUNCE_CLASS_SOFT_BOUNCE	2	SoftBounceClass is a soft bounce which is a temporary failure
BOUNCE_CLASS_UNDETERMINED	3	UndeterminedBounceClass is an undetermined bounce which is an indication a new bounce classification has been added

¶ EventDetailOneOf

Name	Type	Description	Required
email_event_detail	EmailEventDetail	Details about the Email callback event	N
push_event_detail	PushEventDetail	Details about the Push callback event	N
sms_event_detail	SmsEventDetail	Details about the Sms callback event	N

¶ PushEventDetail

Name	Type	Description	Required
delivery_failure_cause	string	The cause for the push that could not be delivered. Example : “http error status: 404; reason: app instance has been unregistered; code: registration-token-not-registered; details: Requested entity was not found.”	N

¶ SmsEventDetail

Name	Type	Description	Required
delivery_failure_cause	string	The cause for the sms that could not be delivered.	N

¶ CampaignSpecification

Name	Type	Description	Required
promotion_campaign_specification	PromotionCampaignSpecification	Promotion specification required to build the communication at 3P end for this campaign.	N

¶ CommunicationSpecification

Name	Type	Description	Required
channel	string	Channel of the communication i.e. email, sms, push Refer to this table for allowed values of Channel.	Y
template_id	string	Template identifier for this communication request. This can be an external identifier.	Y
priority	string	Priority of the communication i.e. Transactional/Marketing Refer to this table for allowed values of Priority.	N
expires_at	string	Time at which the comm will expire and should not be sent post that	Y
delivery_time_windows	array<DeliveryTimeWindow>	TimeWindow defines a time slice that the message can only be delivered during. Both ends are inclusive. Maximum range is from 0:00 to 23:59	N
content_identifier	string	Unique id of the content or action	N

¶ Priority

Name	Number	Description
PRIORITY_INVALID	0
PRIORITY_MARKETING	1
PRIORITY_TRANSACTIONAL	2

¶ DeliveryTimeWindow

TimeWindow defines a time slice that the message can only be delivered during. Both ends are inclusive. Maximum range is from 0:00 to 23:59

Name	Type	Description	Required
local_start_hour	int		N
local_start_minute	int		N
local_end_hour	int		N
local_end_minute	int		N

¶ MessageData

Name	Type	Description	Required
push_notification_data	PushNotificationData	Message data for Push notification	N

¶ PlainTextContent

Name	Type	Description	Required
title	string	Title of the message	Y
body	string	Body of the message	Y
deep_link	string	Deep link to be used for the message	N

¶ PromotionCampaignSpecification

Name	Type	Description	Required
promotion	Promotion	Promotion entity associated with the campaign.	Y

¶ PushNotificationData

Name	Type	Description	Required
plain_text	PlainTextContent	Plain text message data for Push notification	N

¶ ThirdPartyRequestContext

Name	Type	Description	Required
trace_id	string	A unique id per request that can be used to trace a 3P request in Uber systems	Y
timestamp	string	The timestamp at which the request was sent to Uber	Y
session_id	string	An id that can be used to link multiple requests within a logical session	N

¶ UberRequestContext

Name	Type	Description	Required
trace_id	string	A unique id per request that can be used to trace an Uber request in 3P systems	Y
timestamp	string	The timestamp at which the request was sent to 3P	Y
session_id	string	An id that can be used to link multiple requests within a logical session	N

¶ CurrencyAmount

Name	Type	Description	Required
value	string	Amount value in E5 format	Y
currency_code	string	ISO 4217 currency code	Y

¶ Distance

Name	Type	Description	Required
number	double	Value of the distance.	N
unit	string	Unit of the distance. Refer to this table for allowed values of DistanceUnit.	N

¶ DistanceUnit

A standard distance, which provides the scale factor for a distance extent, or the granularity or precision for a distance position.

Name	Number	Description
DISTANCE_UNIT_INVALID	0	The default, invalid standard distance unit.
DISTANCE_UNIT_MILES	1	The standard distance unit in miles.
DISTANCE_UNIT_KILOMETERS	2	The standard distance unit in kilometers.
DISTANCE_UNIT_METERS	3	The standard distance unit in meters.

¶ ETA

Name	Type	Description	Required
eta_in_seconds	int	Estimated time of arrival in seconds This is set as wrapper type to make sure the field is always set even when the value is zero ( otherwise 0 value of int gets omitted during json serialization ) This will be set for on-demand trips	N
estimated_at	string	UTC epoch at which this eta was estimated	Y
arrival_at	string	epoch time at which the arrival is expected to happen This will be set in case of reserve trips where we have a fixed arrival time	N
context	ETAContext	Additional context this ETA depends on, e.g. the flight it is computed against for airport pickup (RAPU) trips. Absent when the ETA has no such dependency.	N

¶ ETAContext

Name	Type	Description	Required
flight_context	FlightContext	Set only when this ETA was computed against a specific flight (RAPU/RADO airport pickup trips).	N

¶ FlightContext

Name	Type	Description	Required
flight_id	string	Identifier of the flight this ETA was computed against.	Y

¶ CancellationMetadata

Name	Type	Description	Required
cancellation_time_threshold	CancellationTimeThreshold	Cancellation time threshold	Y
cancellation_fee_range	CurrencyRange	Range of the cancellation fee that may be charged	N

¶ CancellationMetadata.CancellationTimeThreshold

Name	Type	Description	Required
transport_provider_cancel_time_threshold_in_seconds	int	transport_provider cancellation time threshold in seconds	N
rider_free_cancel_time_threshold_in_seconds	int	rider free cancellation time threshold in seconds	Y

¶ CurrencyRange

A range of monetary amounts in a specified currency. The lower and upper bounds are inclusive.

Name	Type	Description	Required
min_amount	string	Lower bound of the amount range	N
max_amount	string	Upper bound of the amount range	N
currency_code	string	ISO 4217 currency code	N

¶ DeductionMetadata

Name	Type	Description	Required
pre_deduction_fare_one_of	FareModelOneOf	Pre deduction fare one of. The type of pre_deduction_fare_one_of will be the same as the top level fare type.	Y
promotion_metadata	PromotionMetadata	Metadata about the promotion applied	N

¶ DeductionMetadata.PromotionMetadata

Name	Type	Description	Required
promotion_id	string	The promotion id responsible for promotion line item	Y
promotion_value	PromotionValueOneOf	Promotion value one of between credit (flat) and percent promotions.	Y

¶ DistanceChargeMetadata

Name	Type	Description	Required
rider_distance_metadata	DistanceMetadata	Per unit distance charges that are charged to riders on trip and the estimated distance	Y
distance_charge_type	string	Type of per unit charge E.g. in city rate might be different from out city rate Refer to this table for allowed values of DistanceChargeType.	N

¶ DistanceChargeType

Represents different kind of charges applied to the trip like inCity and outCity. potentially can happen when a trip is between different region.

Name	Number	Description
DISTANCE_CHARGE_TYPE_INVALID	0
DISTANCE_CHARGE_TYPE_IN_CITY	2
DISTANCE_CHARGE_TYPE_OUT_CITY	3

¶ DistanceMetadata

Name	Type	Description	Required
distance	Distance	Total estimated distance of the trip considered for calculating the distance portion of the fare.	N
rate	DistanceRate	Per unit distance charges.	Y

¶ DistanceRate

Name	Type	Description	Required
unit	string	Unit of distance Refer to this table for allowed values of DistanceUnit.	Y
per_unit_amount	string	Per unit distance charges	Y

¶ Fare

Name	Type	Description	Required
fare_id	string	Unique Id of the fare	Y
expires_at	string	Unix timestamp at which this fare expires	N
currency_code	string	ISO 4217 currency code	Y
contractual	bool	Whether the fare provided is contractual or not	Y
line_items	array<LineItem>	Fare breakdown line items	N
point_fare	string	Fare specified as a single value	N
range_fare	RangeFare	Fares specified as a range	N
no_fare	NoFare	This is returned when the fare cannot be calculated upfront ( at the time fare is being asked ) and is therefore represented as a string describing how the fare will be calculated post-trip.	N
fare_metadata	FareMetadata	Metadata about the fare	N

¶ FareMetadata

Name	Type	Description	Required
surge_metadata	SurgeMetadata	Metadata about the surge charges	N
cancellation_metadata	CancellationMetadata	Metadata about the cancellation charges	N
deduction_metadata	DeductionMetadata	Metadata for the deduction done in Fare.	N
wait_time_fee_metadata	WaitTimeMetadata	Metadata about the wait time fee	N
via_wait_time_fee_metadata	WaitTimeMetadata	Metadata about the via wait time fee	N
time_charge_metadata	array<TimeChargeMetadata>	Metadata about the per unit time charges	N
distance_charge_metadata	array<DistanceChargeMetadata>	Metadata about the per unit distance charges	N
minimum_fare_metadata	MinimumFareMetadata	Metadata about the minimum fare	N

¶ FareModelOneOf

Name	Type	Description	Required
point_fare	string	Fare specified as a single value	N
range_fare	RangeFare	Fares specified as a range	N
no_fare	NoFare	This is returned when the fare cannot be calculated upfront ( at the time fare is being asked ) and is therefore represented as a string describing how the fare will be calculated post-trip.	N

¶ LineItem

Name	Type	Description	Required
line_item_id	string	The id of the fare breakdown line item	Y
line_item_type	string	Type of this line item	Y
amount	string	The value of this portion of the fare This can be a negative or positive value	Y
metadata	LineItemMetadataOneOf	Metadata about that line item describing how that particular item was calculated	N

¶ LineItemMetadataOneOf

Name	Type	Description	Required
surge_metadata	SurgeMetadata	Metadata about the surge charges	N

¶ MinimumFareMetadata

Name	Type	Description	Required
amount	string	Minimum fare charges that are charged to riders on trip	Y

¶ NoFare

Name	Type	Description	Required
no_fare_type	string	At least one of the type or fare_string will be available. Type of the no fare Refer to this table for allowed values of NoFareType.	N
fare_string	string	Localised string representing the fare value as string.	N

¶ NoFareType

Name	Number	Description
NO_FARE_TYPE_INVALID	0
NO_FARE_TYPE_ACTUALS	1

¶ RangeFare

Name	Type	Description	Required
lower	string	Value of the lower bound of the fare	Y
upper	string	Value of the upper bound of the fare	Y

¶ SurgeMetadata

Name	Type	Description	Required
effective_surge_multiplier	double	Effective surge multiplier based on actual surge fees applied	Y
is_surging	bool	Surge indicative based on the surge fee applied	Y

¶ TimeChargeMetadata

Name	Type	Description	Required
rider_time_metadata	TimeMetadata	Per unit time charges that are charged to riders on trip and the estimated duration	Y
time_charge_type	string	Type of per unit charge E.g. in city rate might be different from out city rate Refer to this table for allowed values of TimeChargeType.	N

¶ TimeChargeType

Represents different kind of charges applied to the trip like inCity and outCity. potentially can happen when a trip is between different region.

Name	Number	Description
TIME_CHARGE_TYPE_INVALID	0
TIME_CHARGE_TYPE_IN_CITY	2
TIME_CHARGE_TYPE_OUT_CITY	3

¶ TimeMetadata

Name	Type	Description	Required
duration	Duration	Total estimated duration of the trip considered for calculating the time portion of the fare.	N
rate	TimeRate	Per unit time charges.	Y

¶ TimeRate

Name	Type	Description	Required
per_unit_amount	string	Per unit time amount	Y
unit	string	unit of time. Refer to this table for allowed values of TemporalUnit.	Y

¶ TemporalUnit

A standard duration, which provides the scale factor for a time extent, or the granularity or precision for a time position

Name	Number	Description
TEMPORAL_UNIT_INVALID	0
TEMPORAL_UNIT_YEAR	1
TEMPORAL_UNIT_MONTH	2
TEMPORAL_UNIT_WEEK	3
TEMPORAL_UNIT_DAY	4
TEMPORAL_UNIT_HOUR	5
TEMPORAL_UNIT_MINUTE	6
TEMPORAL_UNIT_SECOND	7
TEMPORAL_UNIT_MILLISECOND	8
TEMPORAL_UNIT_MICROSECOND	9
TEMPORAL_UNIT_NANOSECOND	10

¶ WaitTimeMetadata

Name	Type	Description	Required
wait_time_rate	TimeRate	Rate at which wait time fee will be charged post the free wait time threshold if any.	Y
wait_time_threshold	Duration	Free rider wait time threshold till when rider is not charged.	Y

¶ FeedbackContext

Name	Type	Description	Required
transport_provider_rating	TransportProviderRating	The rating given by the rider to the transport provider as part of survey type SURVEY_TYPE_TRANSPORT_PROVIDER_RATING	N

¶ TransportProviderRating

Name	Type	Description	Required
rating	int	The rating value submitted by the rider to the transport provider	N
tags	array	The list of tags submitted by the rider to the transport provider	N

¶ FinalizedFare

FinalizedFare capturing the total fare value and the version details

Name	Type	Description	Required
total_fare_amount	string	Total fare amount value capturing all the line items.	Y
currency_code	string	The 3-letter currency code defined in ISO 4217.	Y
line_item_groups	array<LineItemGroup>	List of line item groups	Y
version	int	fare version	Y
metadata	Metadata	Additional fare metadata	N
billing_line_items	array<BillingLineItem>	List of billing line items	N
adjustments	array<Adjustment>	List of adjustments	N

¶ FinalizedFare.LineItemGroup

LineItem groups

Name	Type	Description	Required
line_item_group_id	string	The id of the line item group (primary, surcharge,etc)	Y
amount	string	sum of the amount value corresponding to the line item group	Y
line_items	array<LineItem>	list of line items	N

¶ FinalizedFare.LineItemGroup.LineItem

Name	Type	Description	Required
name	string	localised name of the line item	N
amount	string	Amount value corresponding to the line item	Y
metadata	LineItemMetadataOneOf	Metadata specific for a particular line item only.	N
line_item_id	string	The id of the line item	N

¶ FinalizedFare.LineItemGroup.LineItem.LineItemMetadataOneOf

Name	Type	Description	Required
promotion_metadata	PromotionMetadata	Metadata about the promotions	N

¶ FinalizedFare.Metadata

Name	Type	Description	Required
surge_metadata	SurgeMetadata	Metadata related to surge-pricing	N
ufp_metadata	UFPMetadata	Metadata related to UFP	N
cancellation_metadata	CancellationMetadata	Metadata related to cancellation	N
deduction_metadata	DeductionMetadata	Metadata for the deduction done in Fare	N

¶ FinalizedFare.Metadata.CancellationMetadata

Name	Type	Description	Required
cancellation_time_threshold	CancellationTimeThreshold	Cancellation time threshold	Y

¶ FinalizedFare.Metadata.CancellationMetadata.CancellationTimeThreshold

Name	Type	Description	Required
transport_provider_cancel_time_threshold_in_seconds	int	transport_provider cancellation time threshold in seconds	Y
rider_free_cancel_time_threshold_in_seconds	int	rider free cancellation time threshold in seconds	Y

¶ FinalizedFare.Metadata.DeductionMetadata

Name	Type	Description	Required
promotion_metadata	PromotionMetadata	Metadata about the deductions from promotions	N

¶ FinalizedFare.Metadata.SurgeMetadata

Name	Type	Description	Required
effective_surge_multiplier	double	Effective surge multiplier based on actual surge fees applied	Y
is_surging	bool	Surge indicative based on the surge fee applied	Y

¶ FinalizedFare.Metadata.UFPMetadata

Name	Type	Description	Required
is_rider_ufp_honored	bool	Boolean value to indicate if ufp is honored for rider	Y

¶ PromotionMetadata

Name	Type	Description	Required
promotion_id	string	The promotion id responsible for promotion line item	Y

¶ FormattedAddress

Name	Type	Description	Required
address_line_1	string	Location title for presentation. This is usually the first line of address that is shown to the user E.g. Uber HQ/ 1455 Market Street/ 11th and Market	Y
address_line_2	string	Location subtitle for presentation E.g. 1515 3rd St, San Francisco, CA	Y
city	string	Name of the city E.g. San Francisco	N
postal_code	string	Postal code for the address E.g. 94158	N
state_code	string	ISO 3166-2 subdivision code with the country prefix removed E.g. CA	N
country_code	string	ISO 3166-1 alpha-2 country code E.g. US	N
locale	string	Locale of the address	N
unit_and_floor	string	Unit and/or floor no of the apartment/business premise	N
business_or_building_name	string	Name of the building, apartment or business	N

¶ IntentOneOf

Name	Type	Description	Required
ride_intent_spec	RideIntentSpecification		N

¶ RideIntentSpecification

Name	Type	Description	Required
product_spec	ProductSpecification	Specification regarding the products being asked If not specified then all products matching the intent will be returned	N
origin	LocationSpecification	Origin location specification	Y
destination	LocationSpecification	Destination location specification If not specified, only products where destination is not required, will be returned	N
via_locations	array<LocationSpecification>	Intermediate via locations If specified, only products where multi-destination is enabled will be returned	N
requested_time_spec	RequestedTimeSpecification	[DEPRECATED] Use advance_order_spec instead Specification for the requested start time of the order If not specified then order will be considered on-demand.	N
response_options	ResponseOptions	Option to the caller to ask for additional metadata in the response	N
advance_order_spec	AdvanceOrderSpecification	Specification for advance/airport orders	N

¶ RideIntentSpecification.ProductSpecification

Name	Type	Description	Required
target_product_ids	array	List of product ids If specified, only those products will be returned	N

¶ RideIntentSpecification.ResponseOptions

Name	Type	Description	Required
include_product_details	bool	Whether to include the product details in the response	N
include_route_line_image	bool	Whether to include the route-line image in the response	N
include_availability_predictor	bool	Whether to include the availability predictor in the response	N

¶ JobRules

Name	Type	Description	Required
tipping_rules	TippingRules	Tipping rules	N
transport_provider_rating_rules	TransportProviderRatingRules	Rules to define transport provider rating related details	Y
update_payment_rules	UpdatePaymentRules	Rules to define update payment type related details	N

¶ TippingRules

Name	Type	Description	Required
enabled	bool	Boolean flag to indicate whether the tipping is enabled or not	Y
tipping_threshold	TippingThreshold	Thresholds define the maximum and minimum amount that can be tipped for the given job	Y

¶ TippingThreshold

Name	Type	Description	Required
currency_code	string	ISO 4217 currency code	Y
min_amount	string	E5 value of the minimum tip amount	Y
max_amount	string	E5 value of the maximum tip amount	Y

¶ TransportProviderRatingRules

Name	Type	Description	Required
enabled	bool	Boolean flag to indicate whether transport provider rating is enabled or not	Y

¶ UpdatePaymentRules

Name	Type	Description	Required
allowed_payment_profile_update_types	array	List of allowed payment profile update types Refer to this table for allowed values of PaymentProfileUpdateType.	Y

¶ PaymentProfileUpdateType

Name	Number	Description
PAYMENT_PROFILE_UPDATE_TYPE_INVALID	0
PAYMENT_PROFILE_UPDATE_TYPE_CASH_TO_DIGITAL	1	Update Type Cash to Digital

¶ JobSpecification

Name	Type	Description	Required
matching_spec	MatchingSpecification	Specification related to matching	N

¶ MatchingModeSpecificationOneOf

Name	Type	Description	Required
pin_matching_spec	PinMatchingSpecification	Specification related to pin matching mode	N

¶ MatchingSpecification

Name	Type	Description	Required
matching_mode	string	Mode of matching Refer to this table for allowed values of MatchingMode.	Y
matching_mode_spec	MatchingModeSpecificationOneOf	Specification for the matching mode	Y

¶ MatchingMode

Name	Number	Description
MATCHING_MODE_INVALID	0
MATCHING_MODE_PIN	1	Pin matching is when a Job is given a pin to match with any available Provider

¶ PinMatchingSpecification

Name	Type	Description	Required
matching_pin	string	PIN to be given to driver to get matched	Y

¶ FulfillmentJob

Name	Type	Description	Required
job_id	string	The id of the fulfillment job	Y
created_at	string	Time at which this job was created	Y
last_updated_at	string	Time at which this job was last updated	Y
job_state	string	Current state of the fulfillment job	Y
state_entered_at	string	The timestamp at which the job entered its current state	Y
transport_provider_context	TransportProviderContext	Context of the transport provider assigned to fulfill this job Only available when a vehicle/transport provider is currently assigned to the job	N
job_context	JobContext	Context of the job	N
waypoints	array<Waypoint>	Waypoints associated with this fulfillment job	N
job_rules	JobRules	Rules associated with this fulfillment job	Y
job_spec	JobSpecification	Specification of the job	N

¶ JobContext

Name	Type	Description	Required
route_context	RouteContext	Route context	N
feedback_context	FeedbackContext	Context of the Feedback. Available after the job is completed.	N
tracking_context	TrackingContext	Context to track real-time flight status, airline, and schedule for airport pickup/dropoff (RAPU/RADO) trips. Updated dynamically as flight information changes.	N

¶ AccessPoint

Name	Type	Description	Required
access_point_id	string	Unique identifier of the access point	Y
point	Point	Coordinates of the resolved location	Y
title	string	Title/label of the access point.	N
subtitle	string	Subtitle/Sub-label of the access point.	N
walking_polyline	string	A base-64 encoded polyline describing the walking route from the resolved location to this access point.	N
rider_wayfinding	string	A verbose note that helps the rider find the pick-up point, i.e. “Meet your driver on the corner of 23rd St & 5th Ave”). Present only for PUDOzonal access points.	N
eligible_product_ids	array	Represents eligible product(IDs) that are supported on this access point. If this field is null, then this access point is eligible for all products. Else if present, can be used for filtering	N
rider_wayfinding_detailed	RiderWayfindingDetailed	[Optional] Detailed stepwise wayfinding instructions for riders	N
access_point_type	string	[Optional] The type of access point. This will be useful in deciding the snapping of PIN on the map. Eg values: pudo, poi-suggestion-snapped, anchor, manual, pudo-alias, poi-suggestion, feature-rich, etc.	N

¶ LocationSpecification

Name	Type	Description	Required
point	Point	Coordinates of the location	N
location_id	string	Id of the location as received from the location_provider	N
location_provider	string	The provider of the location	N
formatted_address	FormattedAddress	Formatted representation of an address Primarily intended for support purposes to understand what address was shown to the rider in the shopping phase	N
zone_id	string	Id of the zone as received from Uber in ResolvedWaypointResponse Set only in case of “uber_geofences”	N
oneline_address	string	Single-line formatted representation of the address	N

¶ Point

Name	Type	Description	Required
latitude	double	The latitude coordinate	Y
longitude	double	The longitude coordinate	Y
altitude	float	Meters above the WGS84 reference ellipsoid	N

¶ ResolvedLocation

Name	Type	Description	Required
point	Point	Coordinates of the resolved location	Y
formatted_address	FormattedAddress	Formatted address representation of the resolved location.	Y
location_id	string	Id of the resolved location corresponding to location_provider	N
location_provider	string	The provider of the resolved location	N

¶ OrderContext

Name	Type	Description	Required
product_context	Product	Product context of this order Available when ‘include_product_details’ option is set in GetOrder request	N
shopping_phase_context	ShoppingPhaseContext	Context from the shopping phase Available when ‘include_shopping_phase_context’ option is set in GetOrder request	N

¶ ShoppingPhaseContext

Name	Type	Description	Required
eta	ETA	ETA that was provided in the GetEstimatesForIntent response if any	N
route	RouteLeg	Route leg that was provided in the GetEstimatesForIntent response if any	N
fare_context	Fare	The fare for this order, that was provided in the GetEstimatesForIntent response if any.	N

¶ CommunicationChannelSpecification

Name	Type	Description	Required
phone_channel_spec	PhoneChannelSpecification	Phone channel specification for communication	N

¶ FareSpecification

Name	Type	Description	Required
fare_id	string	The fare_id for the fare to be applied to the order	Y

¶ OrderSpecification

Name	Type	Description	Required
participant_spec	ParticipantSpecification	Participant specification for the order	Y
payment_spec	PaymentSpecification	Payment related specification	N
fare_spec	FareSpecification	Fare specification	Y
ride_order_spec	RideOrderSpecification	Specification for the ride order	N

¶ OrderTrackingNotificationSpecification

Name	Type	Description	Required
communication_channel_spec	CommunicationChannelSpecification	Communication channel specification for the notification	Y
tracking_events	array	List of tracking events for which notifications should be sent TODO add enum values for tracking events	Y

¶ OrderingOptionsSpecification

Name	Type	Description	Required
pickup_options_spec	PickupOptionsSpecification	Pickup options specification	N
order_tracking_notification_specs	array<OrderTrackingNotificationSpecification>	List of order tracking notification specifications	N

¶ OrderingOptionsSpecification.PickupOptionsSpecification

Name	Type	Description	Required
meeting_options_spec	MeetingOptionsSpecification	Meeting options specification	N
pickup_instructions	string	Pickup instructions requested by the participant	N

¶ OrderingOptionsSpecification.PickupOptionsSpecification.MeetingOptionsSpecification

Name	Type	Description	Required
meet_and_greet_spec	MeetAndGreetSpecification	Meet and greet specification	N
curbside_spec	CurbsideSpecification	Curbside specification	N

¶ OrderingOptionsSpecification.PickupOptionsSpecification.MeetingOptionsSpecification.CurbsideSpecification

Name	Type	Description	Required
requested	bool	Whether curbside pickup is requested	N

¶ OrderingOptionsSpecification.PickupOptionsSpecification.MeetingOptionsSpecification.MeetAndGreetSpecification

Name	Type	Description	Required
requested	bool	Whether meet and greet pickup is requested	N

¶ PaymentSpecification

(This message definition has no fields)

¶ PhoneChannelSpecification

Name	Type	Description	Required
phone_number	string	Phone number for communication	Y
channel_types	array	List of channel types for communication Refer to this table for allowed values of PhoneChannelType.	Y

¶ PhoneChannelType

Name	Number	Description
PHONE_CHANNEL_TYPE_INVALID	0
PHONE_CHANNEL_TYPE_CALL	1
PHONE_CHANNEL_TYPE_SMS	2
PHONE_CHANNEL_TYPE_WHATSAPP	3

¶ PinSpecification

Name	Type	Description	Required
is_pin_required	bool	Flag indicating whether PIN verification is requested for the order Order’s pickup waypoint task will contain PIN verification task if this flag is true	Y

¶ RideOrderSpecification

Name	Type	Description	Required
product_spec	ProductSpecification	Product specification for the order	Y
requested_time_spec	RequestedTimeSpecification	[DEPRECATED] Use advance_order_spec instead Specification for the requested start time of the order If not specified then order will be considered on-demand	N
origin	LocationSpecification	Origin location specification	Y
destination	LocationSpecification	Destination location specification May be required depending upon the product	N
via_locations	array<LocationSpecification>	Intermediate via locations	N
safety_spec	SafetySpecification	Safety specification for the order	N
advance_order_spec	AdvanceOrderSpecification	Specification for advance/airport orders	N
ordering_options_spec	OrderingOptionsSpecification	Ordering options specification for the order	N

¶ RideOrderSpecification.ProductSpecification

Name	Type	Description	Required
product_id	string	The product id	Y

¶ SafetySpecification

Name	Type	Description	Required
pin_spec	PinSpecification	PIN specification for the order	N

¶ Order

Name	Type	Description	Required
order_id	string	The id of the Order	Y
order_spec	OrderSpecification	Specification of the order as provided at the time of creating the order	Y
fare	FinalizedFare	finalized fare of the order Available only after trip completion	N
created_at	string	Time at which this order was created	Y
last_updated_at	string	Time at which this order was last updated	Y
order_state	string	Current state of the order	Y
state_entered_at	string	The timestamp at which the order entered its current state	Y
order_context	OrderContext	Context about the order	N
fulfillment_jobs	array<FulfillmentJob>	One or more jobs associated with this order defining how the order will be fulfilled	N

¶ ChannelDirections

• Direction of the communication channel

Name	Type	Description	Required
can_send	bool	Indicates if the user can send using this channel.	N
can_receive	bool	Indicates if the user can receive using this channel.	N

¶ CommunicationPreferences

Name	Type	Description	Required
communication_channels	array	List of preferred communication channels Refer to this table for allowed values of CommunicationChannel.	N

¶ CommunicationChannel

Name	Number	Description
COMMUNICATION_CHANNEL_INVALID	0
COMMUNICATION_CHANNEL_CALL	1
COMMUNICATION_CHANNEL_SMS	2
COMMUNICATION_CHANNEL_WHATSAPP	3
COMMUNICATION_CHANNEL_EMAIL	4

¶ ConsumerPreferences

Name	Type	Description	Required
temperature_preference	string	Preferred in-vehicle temperature setting Refer to this table for allowed values of ConsumerTemperaturePreference.	N
conversation_preference	string	Preferred conversation setting Refer to this table for allowed values of ConsumerConversationPreference.	N
luggage_preference	string	Preferred luggage handling setting Refer to this table for allowed values of ConsumerLuggagePreference.	N

¶ ConsumerTemperaturePreference

Name	Number	Description
CONSUMER_TEMPERATURE_PREFERENCE_INVALID	0
CONSUMER_TEMPERATURE_PREFERENCE_NOT_SHOWN	1
CONSUMER_TEMPERATURE_PREFERENCE_NO_PREFERENCE	2
CONSUMER_TEMPERATURE_PREFERENCE_WARM	3
CONSUMER_TEMPERATURE_PREFERENCE_HOT	4
CONSUMER_TEMPERATURE_PREFERENCE_COOL	5
CONSUMER_TEMPERATURE_PREFERENCE_COLD	6

¶ ConsumerConversationPreference

Name	Number	Description
CONSUMER_CONVERSATION_PREFERENCE_INVALID	0
CONSUMER_CONVERSATION_PREFERENCE_NOT_SHOWN	1
CONSUMER_CONVERSATION_PREFERENCE_NO_PREFERENCE	2
CONSUMER_CONVERSATION_PREFERENCE_QUIET	3
CONSUMER_CONVERSATION_PREFERENCE_CHAT	4

¶ ConsumerLuggagePreference

Name	Number	Description
CONSUMER_LUGGAGE_PREFERENCE_INVALID	0
CONSUMER_LUGGAGE_PREFERENCE_NOT_SHOWN	1
CONSUMER_LUGGAGE_PREFERENCE_YES	2
CONSUMER_LUGGAGE_PREFERENCE_NO	3

¶ ConsumerSpecification

Name	Type	Description	Required
consumer_preferences	ConsumerPreferences	Preferences specified by the rider for their trip	N
communication_preferences	CommunicationPreferences	Communication preferences for the consumer	N

¶ EntitySpecificationOneOf

Name	Type	Description	Required
payer_specification	PayerSpecification	Payer specification for the participant	N
requester_specification	RequesterSpecification	Requester specification for the participant	N
consumer_specification	ConsumerSpecification	Consumer specification for the participant	N

¶ ExternalUserInfo

Name	Type	Description	Required
reference_id	string	3P reference id of the external user (e.g., DARB user ID)	Y

¶ GuestInfo

Name	Type	Description	Required
user_info	UserInfo	[ OPTIONAL] Information of the user identity.	N

¶ InAppMessage

• Information about in-app messaging

Name	Type	Description	Required
has_in_app_messaging	bool	Indicates if this participant has in-app messaging capability.	N
audio	ChannelDirections	Information about the audio capabilities	N
text	ChannelDirections	Information about the text capabilities	N
photo	ChannelDirections	Information about the photo capabilities	N

¶ ParticipantCapabilities

Name	Type	Description	Required
in_app_message	InAppMessage	Information about the in-app messaging capability.	N

¶ ParticipantEntity

Name	Type	Description	Required
user_id	string		N
org_id	string		N
guest_info	GuestInfo		N
external_user_info	ExternalUserInfo		N
entity_specification_one_of	EntitySpecificationOneOf	The participant entity’s specification	N
user_profile	UserProfile	User profile this participant entity is operating under	N

¶ ParticipantEntity.UserProfile

[OPTIONAL] User profile with respect to the participant entity

Name	Type	Description	Required
profile_id	string	The user profile ID. May be absent for callers that only assert a profile type.	N
user_profile_type	string	The type of user profile.	Y
organization_id	string	Organization UUID of the U4B org	N

¶ ParticipantSpecification

Name	Type	Description	Required
requester	ParticipantEntity	A requester is a user or an org that is requesting a ride from Uber There will always be one requester of an order	Y
consumers	array<ParticipantEntity>	A consumer is a user or an org that is consuming the services provided by Uber using these APIs There can be multiple consumers of an order	N
payers	array<ParticipantEntity>	A payer is a user or an org that is paying for the services provided by Uber using these APIs There can be multiple payers for an order	N
stakeholders	array<ParticipantEntity>	Stakeholders are additional optional entities that may have some level of interest in the fulfillment of the order	N

¶ RequesterSpecification

Name	Type	Description	Required
third_party_source_type	string	The user profile of the requester Only Alexa is using this as of now	N
capabilities	ParticipantCapabilities	The capabilities of the participant	N

¶ UserInfo

Name	Type	Description	Required
first_name	string	first name of the consumer	Y
last_name	string	last name of the consumer	N
phone_number	string	A valid unique phone number, formatted according to the E.164 recommendation	Y
email_id	string	Unique Email identifier of user. Must be sent if Careem has the email of the user ( verified or unverified ).	N
country_code	string	ISO 3166-1 alpha-2 country code.	N

¶ BusinessPolicy

Name	Type	Description	Required
policy_id	string	Identifier of the business policy (a.k.a. policyUUID / program_uuid)	Y
policy_version	string	Version of the business policy	N

¶ CardInfo

Card details of the payment profile.

Name	Type	Description	Required
payment_profile_card_type	string	This field stores payment profile card type Refer to this table for allowed values of PaymentProfileCardType.	Y
bin	string	First 6 digits of the card number	Y
payment_profile_card_category	string	This field stores payment profile card category Refer to this table for allowed values of PaymentProfileCardCategory.	N

¶ PaymentProfileCardType

Card type of the payment profile.

Name	Number	Description
PAYMENT_PROFILE_CARD_TYPE_INVALID	0
PAYMENT_PROFILE_CARD_TYPE_AMEX	1
PAYMENT_PROFILE_CARD_TYPE_MASTERCARD	2
PAYMENT_PROFILE_CARD_TYPE_VISA	3
PAYMENT_PROFILE_CARD_TYPE_DISCOVER	4

¶ PaymentProfileCardCategory

Card category of the payment profile.

Name	Number	Description
PAYMENT_PROFILE_CARD_CATEGORY_INVALID	0
PAYMENT_PROFILE_CARD_CATEGORY_CREDIT	1
PAYMENT_PROFILE_CARD_CATEGORY_DEBIT	2
PAYMENT_PROFILE_CARD_CATEGORY_PREPAID	3

¶ ExpenseInfo

Name	Type	Description	Required
code	string	Expense code for the trip	N
memo	string	Free-text memo for expense reporting. Appears in trip receipt	N

¶ Instrument

Instrument represents the payment profile instrument data. This is to be set only for non cash payment profile types.

Name	Type	Description	Required
card_info	CardInfo	stores card details.	N

¶ PayerSpecification

Name	Type	Description	Required
payment_profile	PaymentProfile	The payment profile to use for the payer.	N
user_profile	UserProfile	[DEPRECATED] The user profile to use for the payer. Use ParticipantEntity.UserProfile instead.	N
use_credits	bool	Boolean flag to indicate whether uber-credits should be used or not.	N
promotion_eligibility_rules	array<PromotionEligibilityRule>	the promotion eligibility rules for the trip/user	N
business_policy	BusinessPolicy	Business policy (a.k.a. spending cap policy / program_uuid) used by the participant in this order	N
expense_info	ExpenseInfo	Additional information for business expensing	N

¶ PayerSpecification.UserProfile

[DEPRECATED] Use ParticipantEntity.UserProfile instead.

Name	Type	Description	Required
profile_id	string	[DEPRECATED] The user profile ID. Use ParticipantEntity.UserProfile.profile_id instead.	Y
user_profile_type	string	[DEPRECATED] The type of user profile. Use ParticipantEntity.UserProfile.user_profile_type instead.	Y
organization_id	string	[DEPRECATED] Organization UUID of the U4B org	N

¶ PaymentProfile

Name	Type	Description	Required
payment_profile_type	string	The type of payment profile.	N
payment_profile_id	string	The payment profile ID.	N
instrument	Instrument	The Instrument of Payment profile.	N

¶ PromotionEligibilityRule

Name	Type	Description	Required
rule_type	string	the eligibility rule type for promotion	Y

¶ OrderPaymentSelectionCriteriaOneOf

Criteria to return payment details for an order

Name	Type	Description	Required
ride_payment_selection_criteria	RidePaymentSelectionCriteria		N

¶ RidePaymentSelectionCriteria

Criteria specific to rides

Name	Type	Description	Required
origin	LocationSpecification	Origin location specification	Y
destination	LocationSpecification	Destination location specification	N
product_spec	ProductSpecification	Product specification	N

¶ Position

Name	Type	Description	Required
point	Point	Coordinates of the location	N
horizontal_accuracy	float	An industry-standard quantity which relates the latitude and longitude estimate with an ideal circular probability distribution, asserting one-sigma (68%) confidence that the real horizontal position lies within so many meters of the estimate	N
vertical_accuracy	float	An industry-standard quantity which relates the altitude estimate with an ideal probability distribution, asserting one-sigma (68%) confidence that the real altitude lies within so many meters of the estimate	N
course	float	Direction of travel in degrees clockwise from true north	N
speed	float	The momentary speed of the vehicle in metersPerSec	N
course_accuracy	float	A quantity which relates the direction of travel with a probability distribution, asserting 68% confidence that the true direction lies within so many degrees above or below the estimate	N
speed_accuracy	float	A quantity which relates the speed of the sensing device with a probability distribution, asserting 68% confidence that the true speed lies within so many meters per second above or below the estimate	N
measured_at	string	The timestamp at which the location was measured	N

¶ ProductVehicles

Name	Type	Description	Required
product_id	string	The product id	Y
vehicles	array<Vehicle>	An array of nearby vehicles containing their positions	Y
product_type_id	string	The product type id	Y

¶ ProductVehicles.Vehicle

Name	Type	Description	Required
vehicle_id	string	The vehicle id	Y
positions	array<Position>	An array of vehicle positions in increasing order of measured_at - max 30 seconds in past	Y

¶ Product

Name	Type	Description	Required
product_id	string	Unique identifier for the product	Y
display_name	string	Localized display name of the product	Y
short_description	string	Localized short description of the product	Y
long_description	string	Localized long description of the product	N
capacity	int	Capacity of the product	N
images	array<Image>	[DEPRECATED] List of images of this product. Use image_assets instead.	N
product_classification	ProductClassification	Product classification info	N
destination_required	bool	Whether a destination is required to request this product	N
multi_destination	MultiDestination	Multi destination info	N
change_destination	bool	Whether changing the destination is supported on-trip (after pickup)	N
pool_enabled	bool	Whether the product allows pooling	N
scheduling_info	SchedulingInfo	[DEPRECATED] Info about product’s scheduling capabilities	N
reserve_info	ReserveInfo	Info about product’s reservation capabilities	N
product_type_id	string	Unique identifier for the product type	Y
image_assets	ImageAssets	Image assets for this product	N
disclaimer	string	Disclaimer to be shown to the client alongside product display metadata	N

¶ Product.ImageAssets

Name	Type	Description	Required
product_images	array<Image>	Product images	N
background_images	array<Image>	Background images for product card display	N

¶ Product.MultiDestination

Name	Type	Description	Required
enabled	bool	Whether the product allows multi-destination	N
max_destinations	int	Maximum number of destinations allowed (via locations + the final destination)	N

¶ Product.ProductClassification

Name	Type	Description	Required
product_type	string	The product type across all cities where Uber operates	N
product_tier	string	Represents the class of the product, determined by price and comfort level	N
product_features	array	Represents what features are available for a product	N

¶ Product.ReserveInfo

Name	Type	Description	Required
enabled	bool	Whether reservation is enabled for this product	Y
max_threshold_in_minutes	int	Defines the maximum time period in advance for booking a trip.	N
min_threshold_in_minutes	int	Defines the minimum time period before a trip can be booked.	N
wait_time_threshold_in_seconds	int	Defines the wait time that a driver must wait at the rider’s request location (after scheduled pickup time) to begin charging the rider for wait time for Reservation trips.	N
free_cancellation_threshold_in_minutes	int	Free cancellation window in minutes before the pick up time. Reservation trips cancelled under this threshold will be charged per cancellation fee policy.	N

¶ Product.SchedulingInfo

Name	Type	Description	Required
enabled	bool	Whether the product allows scheduling	N

¶ CountryOverride

Name	Type	Description	Required
country_code	string	ISO 3166-1 alpha-2 country code E.g. US	Y
promotion_value_override	PromotionValueOneOf	The value overriding the base promotion value in the country.	Y

¶ CreditPromotion

Name	Type	Description	Required
credit_amount	string	Value of the promotion for flat promotions in E5.	Y
currency_code	string	The 3-letter currency code defined in ISO 4217.	Y
display_text	string	Display information about the promotion.	N

¶ DurationRange

If lower_bound_secs is not provided, default will be set to 0. If upper_bound_secs is not provided, default will be set to 0 and assumed as infinity.

Name	Type	Description	Required
lower_bound_secs	int	Minimum trip duration required for the promotion to be applicable. If upper_bound_secs is not provided, default will be set to 0 and assumed as infinity.	Y
upper_bound_secs	int	Maximum trip duration required for the promotion to be applicable.	Y

¶ GeofenceRestriction

Name	Type	Description	Required
geofence_restriction_type	string	The geofence coverage of the promotion like city level, country level etc. Example value “ “CITY”. Refer to this table for allowed values of GeofenceRestrictionType.	Y
country_codes	array	List of country_codes : ISO 3166-1 alpha-2 country code E.g. [US]. In case of multi-country promotion this is set for all country codes.	N
city_names	array	Localized Name of the city that the promotion only applies to. Safari names E.g. san francisco This will only be set for promotions with geofence_type as CITY i.e. restricted to a single city. For multi-city promotions we will only have the list of products right now & not the cities.	N

¶ GeofenceRestrictionType

Name	Number	Description
GEOFENCE_RESTRICTION_TYPE_INVALID	0
GEOFENCE_RESTRICTION_TYPE_COUNTRY	1	Promotion is restricted to a country geofence.
GEOFENCE_RESTRICTION_TYPE_ORIGIN_DESTINATION	2	Promotion is restricted to a trip origin/dropoff geofence.
GEOFENCE_RESTRICTION_TYPE_CITY	3	Promotion is restricted to a city geofence.
GEOFENCE_RESTRICTION_TYPE_MULTICOUNTRY	4	Promotion spawns over multiple countries.

¶ PercentPromotion

Name	Type	Description	Required
percent_value	double	Value of the promotion as percentage (0-1).	Y
max_allowed_amount	string	A cap on the amount that can be discounted for Trip Percent discounts in E5.	N
currency_code	string	The 3-letter currency code defined in ISO 4217.	N
display_text	string	Display information about the promotion.	N

¶ ProductRestriction

Name	Type	Description	Required
eligible_products	array<EligibleProduct>	Products that this promotion is restricted to.	N

¶ ProductRestriction.EligibleProduct

Name	Type	Description	Required
display_name	string	localized products names to which the promotion is restricted to.	Y
product_id	string	Unique identifier for the product	Y

¶ Promotion

Name	Type	Description	Required
promotion_id	string	Unique id of the promotion entity.	Y
starts_at	string	Start time or the promotion activation time.	N
ends_at	string	End time of the promotion. If no end time specified, we will assume infinity. The promotion may run for a long time. This field will denote the promotion life. During this time, promotion can be applied/removed to different users at different time.	N
expires_in_seconds	int	Time in seconds until expiry after the promotion is applied to a user’s account. Thus, the same promotion may expire at different times for a given user based on when it was applied.	N
country_code	string	ISO 3166-1 alpha-2 country code E.g. US	N
max_trips_allowed	int	Number of trips that this promotion can be applied to for each user (single vs multi-trip)	N
promotion_value	PromotionValueOneOf	Promotion value one of between credit (flat) and percent promotions.	Y
promotion_value_overrides	array<PromotionValueOverride>	Overrides promotion values if any.	N
promotion_restrictions	array<PromotionRestriction>	Restriction object capturing the restrictions on the promotion.	N

¶ PromotionCode

Name	Type	Description	Required
id	string	Unique identifier for the promotion code	Y
code	string	The actual promotion code string	Y

¶ PromotionRestriction

Name	Type	Description	Required
created_at	string	Time at which this restriction was created.	N
updated_at	string	Time of promotion restriction updation if updated (latest)	N
restriction_type_one_of	RestrictionTypeOneOf	RestrictionTypeOneOf representing different type of restrictions.	Y

¶ PromotionTimeRestriction

Name	Type	Description	Required
schedule	Schedule	What times should the promotion be restricted to? This more of constraints during promo validity period. For example, promotion can be used during 7AM-10PM or valid during weekends.	N
duration_range	DurationRange	This means that the promotion will only be valid for trips that fall within the specified duration range. The format typically includes a start and end duration, which could be used to set boundaries like a minimum and maximum trip duration required for the promotion to be applicable.	N

¶ PromotionValueCountryOverride

Name	Type	Description	Required
country_overrides	array<CountryOverride>	List of Country wise overrides of the base promotion value.	Y

¶ PromotionValueOneOf

Name	Type	Description	Required
credit_promotion	CreditPromotion	Flat discount/ credit promotion type. Example : $10 off.	N
percent_promotion	PercentPromotion	Percent discount promotion type. Example : 10% off.	N
range_percent_promotion	RangePercentPromotion	Range based percent discount promotion type. Example : 10-30% off.	N

¶ PromotionValueOverride

Name	Type	Description	Required
promotion_value_country_override	PromotionValueCountryOverride	Country wise overrides of the base promotion value.	N

¶ RangePercentPromotion

Range based percent discount promotion. The effective discount is resolved dynamically within [lower_percent_value, upper_percent_value] at the time of estimate/finalization. Example : 10-30% off.

Name	Type	Description	Required
lower_percent_value	double	Lower bound value of the promotion as percentage (0-1).	Y
upper_percent_value	double	Upper bound value of the promotion as percentage (0-1).	Y
max_allowed_amount	string	A cap on the amount that can be discounted for Trip Percent discounts in E5.	N
currency_code	string	The 3-letter currency code defined in ISO 4217.	N
display_text	string	Display information about the promotion.	N

¶ RecurringTimeSpan

Name	Type	Description	Required
start	string	String rep for the start time. It could be mentioning a particular day in a week. String rep for the start time. It could be mentioning a particular day in a week. Start is a cron expression and duration is valid time window begins at start. ------ Example ------ Start: String(“0 4 * * mon,fri”), Run at 4:00 AM every Monday and Friday 0: The minute the task will start (0 minutes past the hour). 4: The hour the task will start (4 AM). *: Any day of the month. *: Any month. mon,fri: Specifies the days of the week (Monday and Friday).	Y
duration	int	Duration for this span in Minutes. Duration: Int32(60),	Y

¶ RestrictionTypeOneOf

Name	Type	Description	Required
geofence_restriction	GeofenceRestriction	Restriction on the geofence in which the promotion is available.	N
product_restriction	ProductRestriction	Restriction on the products to which the promotion is restricted to.	N
user_attributes_restriction	UserAttributesRestriction	Restrictions on user attributes for promotion eligibility.	N
promotion_time_restriction	PromotionTimeRestriction	Restriction on the time/duration for which the promotion can be used.	N

¶ Schedule

Name	Type	Description	Required
recurring_time_spans	array<RecurringTimeSpan>	List of RecurringTimeSpan to which promotion will be restricted to.	N

¶ UserAttributesRestriction

Name	Type	Description	Required
is_new_users_promotion	bool	Is this for new users only?	N

¶ UserPromotion

Name	Type	Description	Required
promotion	Promotion	Promotion entity associated. Promotion entity will only contain promotion_id if include_promotion = false else it will have other fields present.	N
redemption_count	int	Number of times the promotion has been redeemed by the user so far.	N
is_redeemed	bool	If the promotion has been completely redeemed by the user.	N
expires_at	string	Expiry time for the user promotion. This is different from Promotion.expires_in or Promotion.ends_at. UserPromotion.expires_at : This indicates the time promotion will expire for this given user. Promotion.ends_at : The promotion may run for a long time. This field will denote the promotion life. During this time, promotion can be applied/removed to different users at different time. Promotion.expires_in : This indicates the duration for which the promotion is active after it is applied to a user. Thus, the same promotion may expire at different times for a given user based on when it was applied.	N
created_at	string	Creation time for the user promotion. This is different from the time promotion createdAt time. This actually indicates the time promotion was made available to the user.	N
updated_at	string	Updation time for the user promotion	N
promotion_type	string	Type of the offer associated with this user promotion. Refer to this table for allowed values of PromotionType.	N

¶ AdvanceOrderSpecification

Name	Type	Description	Required
requested_time_spec	RequestedTimeSpecification	Schedule by either pickup or dropoff time. Only one can be set	N
airport_pickup_spec	AirportPickupSpecification	Airport pickup specification, if the pickup is at an airport	N
airport_dropoff_spec	AirportDropoffSpecification	Airport dropoff specification, if the dropoff is at an airport	N

¶ AirportDropoffSpecification

Name	Type	Description	Required
requested_time_spec	RequestedTimeSpecification	Requested time specification for the airport dropoff	N
flight_spec	FlightSpecification	Flight specification for the airport dropoff	Y

¶ AirportPickupSpecification

Name	Type	Description	Required
flight_spec	FlightSpecification	Flight specification for the airport pickup	Y

¶ FlightSpecification

Name	Type	Description	Required
flight_designator	string	IATA flight designator (e.g. EK101)	Y
airport_code	string	IATA airport code of the airport (e.g. DXB)	Y
flight_time_spec	FlightTimeSpecification	Time specification for the flight	Y

¶ FlightTimeSpecification

Name	Type	Description	Required
date	string	Date of the flight in airport timezone in ISO 8601 format	N
flight_time_window	Interval	Time window for the flight	N

¶ RequestedTimeSpecification

Name	Type	Description	Required
starts_at	string	[DEPRECATED] Requested start time of the order If not specified, default will be the time of request	N
time_window_one_of	TimeWindowOneOf	[DEPRECATED]Defines the time range for the requested trip	Y
pickup_time_window	Interval		N
dropoff_time_window	Interval		N

¶ TimeWindowOneOf

Name	Type	Description	Required
pickup_time_window	Interval		N
dropoff_time_window	Interval		N

¶ AvailabilityIndicators

Name	Type	Description	Required
request_blocker	RequestBlocker	Reason blocking this product from being requested, if any	N
availability_predictor	AvailabilityPredictor	Prediction of future supply availability for this product	N

¶ AvailabilityIndicators.AvailabilityPredictor

Name	Type	Description	Required
predictor_result	string	Predicted supply availability. Refer to this table for allowed values of PredictorResult.	N

¶ PredictorResult

Name	Number	Description
PREDICTOR_RESULT_INVALID	0
PREDICTOR_RESULT_GREEN	1
PREDICTOR_RESULT_YELLOW	2
PREDICTOR_RESULT_RED	3

¶ AvailabilityIndicators.RequestBlocker

Name	Type	Description	Required
block_type	string	Whether this product can be booked. Refer to this table for allowed values of BlockType.	N

¶ BlockType

Name	Number	Description
BLOCK_TYPE_INVALID	0
BLOCK_TYPE_NONE	1
BLOCK_TYPE_WARN	2
BLOCK_TYPE_BLOCK	3

¶ OrderingOptions

Name	Type	Description	Required
pickup_options	PickupOptions	Pickup options available for this product estimate	N
consumer_options	ConsumerOptions	Consumer preference options supported by this product	N

¶ OrderingOptions.ConsumerOptions

Name	Type	Description	Required
temperature_preference_enabled	bool	Whether in-vehicle temperature preference is supported for this product	N
conversation_preference_enabled	bool	Whether conversation preference is supported for this product	N
luggage_preference_enabled	bool	Whether luggage preference is supported for this product	N

¶ OrderingOptions.PickupOptions

Name	Type	Description	Required
meeting_options	MeetingOptions	Meeting options for this product	N
pickup_instructions	PickupInstructions	Pickup instructions options for this product	N

¶ OrderingOptions.PickupOptions.MeetingOptions

Name	Type	Description	Required
meet_and_greet	MeetAndGreet	Meet and greet option for this product	N
curbside	Curbside	Curbside option for this product	N

¶ OrderingOptions.PickupOptions.MeetingOptions.Curbside

Name	Type	Description	Required
enabled	bool	Whether curbside pickup is enabled for this product	N

¶ OrderingOptions.PickupOptions.MeetingOptions.MeetAndGreet

Name	Type	Description	Required
enabled	bool	Whether meet and greet pickup is enabled for this product	N

¶ OrderingOptions.PickupOptions.PickupInstructions

Name	Type	Description	Required
enabled	bool	Whether custom pickup instructions are enabled for this product	N

¶ RideEstimate

Name	Type	Description	Required
product_estimates	array<ProductEstimates>	Estimates for products matching the intent	N

¶ RideEstimate.ProductEstimates

Name	Type	Description	Required
product	Product	Containing only the product id All product details are included if response_options.include_product_details is set to true	Y
eta	ETA	ETA of the product	N
fare	Fare	Fares for this order intent	N
route	RouteLeg	Route leg from origin to destination ( includes via locations if any )	N
availability_indicators	AvailabilityIndicators	Availability indicators for this product estimate	N
ordering_options	OrderingOptions	Ordering options available for this product estimate	N

¶ RiderWayfindingDetailed

Name	Type	Description	Required
title	string	[Required] Title text for this instruction.	N
subtitle	string	[Optional] Subtitle text for this instruction.	N
image	Image	Image associated with this instruction.	N
wayfinding_steps	array<WayfindingStep>		N

¶ WayfindingStep

Name	Type	Description	Required
title	string	[Required] Title text for this step.	N
subtitle	string	[Optional] Subtitle text for this step.	N
image	Image	Image associated with this step.	N

¶ RouteContext

Name	Type	Description	Required
route_leg	RouteLeg	Route leg from origin to destination ( includes via locations if any )	Y
positions	array<Position>	list of positions	Y

¶ RouteLeg

Name	Type	Description	Required
origin	Point	The start location of this route leg	N
destination	Point	The end location of this route leg	N
encoded_polyline	string	Polyline is the string encoded route	N
distance_in_meters	int	Distance of this leg of route	N
duration_in_seconds	int	Duration of this leg of route	N
route_line_image	Image	The image of the route-line on a static map	N
haversine_distance_in_meters	int	Haversine (straight-line) distance of this leg of route	N

¶ Image

Name	Type	Description	Required
url	string	Image of an object or entity and its associated metadata	N

¶ AnswerOneOf

Name	Type	Description	Required
single_select_answer	SingleSelectAnswer	Only one answer is allowed	N
multi_select_answer	MultiSelectAnswer	Multiple answers are allowed	N

¶ MultiSelectAnswer

Name	Type	Description	Required
selected_option_ids	array	The list of option ids selected for the question	Y

¶ MultiSelectQuestion

Name	Type	Description	Required
min_selection_threshold	int	The minimum number of options that can be selected	Y
max_selection_threshold	int	The maximum number of options that can be selected	Y
options	array<Option>	The list of options for multi select question	Y

¶ Option

Name	Type	Description	Required
option_id	string	The option id. This will be used as answer in the request of the SubmitSurvey api.	Y
option_display_name	string	Localized display name of the option	Y
option_category	string	Localized category name to which option belongs	N
image	Image	Image associated with the option	N
sub_questions	array<Question>	List of sub questions associated with the option	N

¶ Question

Name	Type	Description	Required
question_id	string	The question id. This will be used as question in the request of the SubmitSurvey api.	Y
title	string	Localized title describing the question	Y
is_required	bool	Indicates if the question is mandatory for SubmitSurvey api request or not	Y
question_one_of	QuestionOneOf	Describes the type of the question	Y

¶ QuestionOneOf

Name	Type	Description	Required
single_select_question	SingleSelectQuestion	Only one option can be selected	N
multi_select_question	MultiSelectQuestion	Multiple options can be selected	N

¶ QuestionResponse

Name	Type	Description	Required
question_id	string	The question id. This will be the value of question_id from GetSurvey response.	Y
answer_one_of	AnswerOneOf	The answer for the question. This will be the value of option_id/s corresponding to question_id from GetSurvey response.	Y
sub_responses	array<QuestionResponse>	The list of sub question responses for a question	N

¶ SingleSelectAnswer

Name	Type	Description	Required
selected_option_id	string	The option id selected for the question	Y

¶ SingleSelectQuestion

Name	Type	Description	Required
options	array<Option>	The list of options for single select question	Y

¶ SurveyResponse

Name	Type	Description	Required
survey_id	string	The survey id received from GetSurveyResponse	Y
survey_type	string	The type of survey Possible values: ‘TRANSPORT_PROVIDER_RATING’, ‘CANCELLATION’ Refer to this table for allowed values of SurveyType.	Y
question_responses	array<QuestionResponse>	The question responses selected from GetSurveyResponse	Y

¶ SurveyType

Name	Number	Description
SURVEY_TYPE_INVALID	0
SURVEY_TYPE_TRANSPORT_PROVIDER_RATING	1	Survey type for rider rating the driver
SURVEY_TYPE_CANCELLATION	2	Survey type for ride cancellation reasons

¶ Duration

Name	Type	Description	Required
number	int	The value of the duration	N
unit	string	The temporal unit which provides the precision Refer to this table for allowed values of TemporalUnit.	N

¶ Interval

Name	Type	Description	Required
starts_at	string	start time of the interval in unix millis	N
ends_at	string	end time of the interval in unix millis	N

¶ FlightInfo

Name	Type	Description	Required
airline	Airline	Airline operating this flight	N
flight_designator	string	IATA flight designator (e.g. AI301)	N
status	string	Current status of the flight. Refer to this table for allowed values of FlightStatus.	N
departure	FlightSchedule	Departure schedule of the flight	N
arrival	FlightSchedule	Arrival schedule of the flight	N

¶ FlightStatus

Name	Number	Description
FLIGHT_STATUS_INVALID	0
FLIGHT_STATUS_SCHEDULED	1
FLIGHT_STATUS_PROPOSED	2
FLIGHT_STATUS_IN_AIR	3
FLIGHT_STATUS_LANDED	4
FLIGHT_STATUS_CANCELLED	5
FLIGHT_STATUS_NO_TAKEOFF_INFO	6
FLIGHT_STATUS_DELAYED	7
FLIGHT_STATUS_OUTGATE	8
FLIGHT_STATUS_INGATE	9
FLIGHT_STATUS_EXPECTED	10
FLIGHT_STATUS_PAST_FLIGHT	11

¶ FlightSchedule

Name	Type	Description	Required
airport_code	string	IATA airport code (e.g. DXB)	N
estimated_time	string	Estimated time for this schedule point (unix millis)	N

¶ TrackingContext

Name	Type	Description	Required
flight_info	FlightInfo	Context of the flight. Available only for RAPU/RADO trips. This is a dynamic field which is updated based on actual flight status.	N

¶ AnonymousContactInfo

Name	Type	Description	Required
known_caller_info	KnownCallerInfo	Contact info for a known caller. rider ↔ driver are already identified and matched by the platform.	N
unknown_caller_info	UnknownCallerInfo	Contact info for an unknown caller. Platform can’t pre-verify who’s dialing in. The caller must dial the number and enter the PIN before being connected to the real callee.	N

¶ ContactInfo

Name	Type	Description	Required
anonymous_voice_number	string	A valid phone number, formatted according to the E.164 recommendation	N
anonymous_sms_number	string	A valid phone number, formatted according to the E.164 recommendation Note that it could be different from the voice number	N
conversation_id	string	ConversationID of chat session	N
private_voice_number	string	A valid private phone number, formatted according to the E.164 recommendation Only available when anonymous number is not supported in country of the trip	N
private_sms_number	string	A valid private phone number, formatted according to the E.164 recommendation Only available when anonymous number is not supported in country of the trip	N
participant_entity	ParticipantEntity	Participant entity associated with this contact info	N

¶ ContactInfoV2

Name	Type	Description	Required
anonymous_contact_info	AnonymousContactInfo	Anonymous contact information for the transport provider	N
conversation_id	string	ConversationID of chat session	N
private_voice_number	string	A valid private phone number, formatted according to the E.164 recommendation	N
private_sms_number	string	A valid private phone number for sms, formatted according to the E.164 recommendation	N
participant_entity	ParticipantEntity	The participant entity associated with this contact info	N

¶ KnownCallerInfo

Name	Type	Description	Required
voice_number	string	Voice number for the known caller	N
sms_number	string	SMS number for the known caller	N

¶ TransportProvider

Name	Type	Description	Required
first_name	string	First name of the transport provider	N
last_name	string	Last name of the transport provider	N
rating	float	Rating of the transport provider	N
picture	Image	Picture of the transport provider	N
transport_provider_id	string	The transport provider’s unique identifier	N

¶ TransportProviderContext

Name	Type	Description	Required
transport_provider	TransportProvider	Information about the transport provider (driver)	N
vehicle	Vehicle	Information about the vehicle	N
last_known_position	Position	Last known position of the transport provider	N
contact_info	ContactInfo	Information about how to contact this transport provider on the job. Note: This field would be deprecated in future and replaced by contact_infos.	N
contact_infos	array<ContactInfo>	List of contact infos which contains information about how to contact this transport provider on the job. This would be used in case of guest trips where there could be multiple contact infos for a single transport provider.	N
contact_infos_v2	array<ContactInfoV2>	List of contact infos which contains information about how to contact this transport provider on the job. TODO: add feature scopes restriction	N

¶ UnknownCallerInfo

Name	Type	Description	Required
voice_number	string	Voice number for the unknown caller	N
pin	string	PIN for anonymous caller identification	N

¶ UpdateOrderSpecRequest

Request to update an order spec

Name	Type	Description	Required
update_target	string	One of the following specifying what we are trying to update Refer to this table for allowed values of UpdateTarget.	Y
order_spec	UpdateOrderSpecification	Updated order spec according to the update target.	Y

¶ UpdateTarget

Type of update specifications

Name	Number	Description
UPDATE_TARGET_INVALID	0
UPDATE_TARGET_STANDARD_RIDE_DESTINATION_WAYPOINTS	2	Use this to update destination Waypoints in RideOrderSpecification.
UPDATE_TARGET_STANDARD_RIDE_ORIGIN_WAYPOINT	3	Use this to update origin Waypoints in RideOrderSpecification.
UPDATE_TARGET_PAYMENT_PROFILE	4	Use this option to update the payment profile of the order
UPDATE_TARGET_EXPENSE_MEMO	5	Use this option to update the expense memo of the order
UPDATE_TARGET_REQUESTED_TIME_SPEC	6	Use this option to update the requested time for a reserve/scheduled trip
UPDATE_TARGET_FLIGHT_SPEC	7	Use this option to update the flight spec for a reserve trip with airport pickup
UPDATE_TARGET_PICKUP_OPTIONS_SPEC	8	Use this option to update the pickup options for a reserve trip
UPDATE_TARGET_PRODUCT_SPECIFICATION	9	Use this option to update the product specification

¶ UpdateOrderSpecification

Name	Type	Description	Required
participant_spec	ParticipantSpecification	Participant specification	N
fare_spec	FareSpecification	Fare specification	N
ride_order_spec	UpdateRideOrderSpecification	Specification for the ride order	N

¶ UpdateRequestOneOf

Request options to update an order

Name	Type	Description	Required
update_order_spec_request	UpdateOrderSpecRequest		N

¶ UpdateRideOrderSpecification

Name	Type	Description	Required
origin	LocationSpecification	Origin location specification	Y
destination	LocationSpecification	Destination location specification	N
via_locations	array<LocationSpecification>	Intermediate via locations	N
ordering_options_spec	OrderingOptionsSpecification	Ordering options specification (pickup meeting option / instructions).	N
advance_order_spec	AdvanceOrderSpecification	Advance/airport order specification, used for UPDATE_TARGET_REQUESTED_TIME_SPEC and UPDATE_TARGET_FLIGHT_SPEC.	N

¶ UserProfile

Name	Type	Description	Required
user_profile_type	string	Type of user-profile	Y
user_profile_attributes	UserProfileAttributes	User profile attributes	N
preferred_payment_profile_id	string	Preferred payment profile id for the user-profile	Y

¶ UserProfileAttributes

Name	Type	Description	Required
user_profile_id	string	UUID of the user-profile	Y
user_profile_name	string	Name of the user-profile	Y

¶ ColorInfo

Name	Type	Description	Required
name	string	Name of the color	N
hex_code	string	Hex code of the color	N

¶ Vehicle

Name	Type	Description	Required
make	string	Make of the vehicle. E.g. Maruti Suzuki	N
model	string	Model name of the vehicle. E.g. Dzire	N
picture	Image	Picture of the vehicle if available	N
license_plate	string	License plate number of the vehicle	N
color_info	ColorInfo	Color of the vehicle	N

¶ WaypointContext

Name	Type	Description	Required
waypoint_type	string	Type of the waypoint this requested location is being resolved for. Possible values: “WAYPOINT_TYPE_PICKUP”, “WAYPOINT_TYPE_DROPOFF”. Refer to this table for allowed values of WaypointType.	Y
requested_time_spec	RequestedTimeSpecification	[DEPRECATED] Use advance_order_spec instead Specification for the requested start time of the order If not specified then order will be considered on-demand	N
advance_order_spec	AdvanceOrderSpecification	Specification for the requested start/end time of the order. If not specified then order will be considered on-demand.	N

¶ WaypointType

Name	Number	Description
WAYPOINT_TYPE_INVALID	0
WAYPOINT_TYPE_PICKUP	1
WAYPOINT_TYPE_VIA	2
WAYPOINT_TYPE_DROPOFF	3

¶ UpdateLocationRules

Name	Type	Description	Required
enabled	bool	Whether updating the location of an entity (where this rule is defined) is allowed at the moment this property is returned. This is a dynamic field, i.e. it represents the current state of the rule. For example - for pickup waypoint, during matching state it will be returned as false, and during assigned state it will be returned as true	Y
max_radius_in_metres	int	Maximum haversine distance (from current location) to which location can be edited.	Y

¶ UpdateWaypointRules

Name	Type	Description	Required
update_location_rules	UpdateLocationRules	Defines actions and actions’ properties that govern updating location of a waypoint.	N

¶ WaypointRules

Name	Type	Description	Required
update_waypoint_rules	UpdateWaypointRules	Defines actions and actions’ properties that govern updating a waypoint’s attributes.	N

¶ PinConfirmationTaskSpecification

Name	Type	Description	Required
pin	string	PIN to be shared to driver	Y

¶ Waypoint

Name	Type	Description	Required
waypoint_type	string	Type of the waypoint Refer to this table for allowed values of WaypointType.	Y
waypoint_state	string	Current state of the waypoint	Y
state_entered_at	string	The timestamp in millis at which waypoint entered its current state	Y
state_entered_at_position	Position	Position at which waypoint entered its current state Available only when the state is : waiting and completed	N
eta	ETA	ETA to this waypoint Only available when the waypoint is in non terminal state and the transport provider is associated with the trip.	N
route_legs	array<RouteLeg>	The route legs up to this waypoint. Available when ‘include_route_legs’ option is set in GetOrder request. Only available for waypoints in non-terminal state when a transport provider is on the job. If this is the next waypoint, the legs span from the transport provider’s current position to this waypoint. Otherwise, the legs span from the last waypoint to this waypoint. Multiple legs may exist for pool rides or forward-dispatch scenarios.	N
waypoint_id	string	The id of the waypoint	Y
rules	WaypointRules	Waypoint rules. These are the rules that define waypoint specific actions and their properties. For example: UpdateWaypointRules define the actions and actions’ properties that govern updating a waypoint. (example - waypoint location update rules)	N
access_point	AccessPoint	The access point (with details) corresponding to this waypoint, if any, set for this order - that was provided in the ResolveWaypointResp.	N
waypoint_tasks	array<WaypointTask>	Tasks associated with this waypoint	N
created_at	string	The timestamp in millis at which the waypoint was created	N

¶ WaypointTask

Name	Type	Description	Required
task_id	string	The id of the task	Y
task_type	string	Type of the task. Possible values: WAYPOINT_TASK_TYPE_PIN_CONFIRMATION Refer to this table for allowed values of WaypointTaskType.	Y
task_state	string	State of the task 3Ps need to show the data accordingly on the app. For PIN, show PIN only when the state is non-terminal. Refer to this table for allowed values of WaypointTaskState.	Y
task_spec	WaypointTaskSpecificationOneOf	The spec associated with this task	Y

¶ WaypointTaskType

Name	Number	Description
WAYPOINT_TASK_TYPE_INVALID	0
WAYPOINT_TASK_TYPE_PIN_CONFIRMATION	1	PIN confirmation task type

¶ WaypointTaskState

Name	Number	Description
WAYPOINT_TASK_STATE_INVALID	0
WAYPOINT_TASK_STATE_PENDING	1	If the task has not started yet
WAYPOINT_TASK_STATE_COMPLETED	2	If the task is completed
WAYPOINT_TASK_STATE_FAILED	3	If the participant is unable to perform this task

¶ WaypointTaskSpecificationOneOf

Name	Type	Description	Required
pin_confirmation_task_spec	PinConfirmationTaskSpecification	Specification associated with PIN task	N

¶ Airline

Name	Type	Description	Required
iata_code	string	Official IATA code of the Airline i.e. AA, 6E, DL	Y
name	string	Official Name of the Airline i.e. Alaska Airlines, Indigo, Delta	Y
access_point_ids	array	[DEPRECATED] Access point (IDs) associated with this Airline.	N
access_points	array<AccessPoint>	List of Access points associated with this Airline.	N
popularity	double	* popularity rank of the airline, ranging between 1.0 - 100.0, where 1 indicates the most popular airline *	N

¶ AirportDropoffZone

Name	Type	Description	Required
id	string	If this is the parent zone, then this would be the IATA airport code Else if this is the child airport zone, then this would be the terminal name	Y
name	string	Airport Name in case of parent zone, else Terminal Name	Y
full_name	string	Full Airport Name in case of parent zone, else Full Terminal Name	Y
access_points	array<AccessPoint>	[DEPRECATED] AccessPoints present within this zone. Will be null for hierarchical parent zones.	N
airlines	array<Airline>	Ordered list of Airlines supported at this zone in order of priority Will be null for hierarchical parent zones.	N
sub_zones	array<AirportDropoffZone>	Ordered list of Airlines supported at this zone in order of priority Will be null for hierarchical parent zones.	N

¶ BoundedZones

Name	Type	Description	Required
bounding_rectangle	BoundingRectangle	A rectangle bounding box consisting of two {latitude, longitude} pairs that encapsulates the zones returned.	Y
zones	array<ZoneOneOf>	Priority-wise ordered list of all nearby parent PUDO zones.	N

¶ BoundingRectangle

Name	Type	Description	Required
north_east	Point	Represents coordinate of the North-East point of this region	Y
south_west	Point	Represents coordinate of the South-West point of this region	Y

¶ ZoneInfoOneOf

Name	Type	Description	Required
bounded_zones	BoundedZones	Data pertaining to all nearby regular PUDO(PickUpDropOff) Zones.	N
airport_dropoff_zone	AirportDropoffZone	Data pertaining to the Airport Drop-off Zone. Present if the requested location is a drop-off at an airport and Uber suggests to trigger Airport Destination Refinement for this airport.	N

¶ ZoneOneOf

Name	Type	Description	Required
pudo_zone	PUDOZone	A nearby PUDO Zone.	N

¶ ZoneOneOf.PUDOZone

Name	Type	Description	Required
id	string	Unique identifier of the zone	Y
access_points	array<AccessPoint>	AccessPoints associated with the zone. Will be null for hierarchical parent zones.	N
sub_zones	array<PUDOZone>	Priority-wise ordered list of zones that are children of this zone. Will be null for terminal zones.	N
name	string	Name/label of the zone	Y
polygon	string	A string representing a list of coordinates that enclose the zone, encoded in Encoded Polyline Algorithm Format.	Y
categories	array	Categories associated with the zone	N