Uber Developers

Create Sandbox Run

POSThttps://sandbox-api.uber.com/v1/health/sandbox/run

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.

Creates a new run to setup interactive sandbox trips. See Sandbox Guide for details on how to use interactive sandbox trips.

¶ Authorization

OAuth 2.0 Bearer token with the health scope.

¶ ProductID

Driver State	Description
6a8e56b8-914e-4b48-a387-e6ad21d9c00c	parent_product_type_id of Uber X.
17201575-69bd-4498-925e-ffba2af07a9a	parent_product_type_id of Uber Green.
60b76812-c307-4076-b83b-fcb36e75da07	parent_product_type_id of Uber XL.
557ec967-167f-446b-a868-c1457dae0c70	parent_product_type_id of SUV.
f1faedb7-5825-484f-b236-24e2cd95ec23	parent_product_type_id of Uber Black.
4cefa6a0-efb5-41dc-a8bb-870f2c3212ba	parent_product_type_id of Mid Tier.
b1afcc8d-02ff-4bfb-be88-b0afed2a0ef2	parent_product_type_id of Taxi.
d49da4d3-c4fc-4034-b363-c22105fa9c90	parent_product_type_id of Moto.
3af476c7-31aa-4015-8d25-0499e4b2afba	parent_product_type_id of Business Item Delivery.
93ef20c4-5b30-4d80-8a13-e4cad0ce8c13	parent_product_type_id of Rider Item Delivery.
87598847-8405-4a31-809f-a771d3af1df3	parent_product_type_id of Intercity.

¶ Example Request

Try It Replace the token in the below request to use it a terminal to create a run. Note the product_id will need to change.

curl -X POST \
  -H 'authorization: Bearer REPLACETOKEN' \
  -H 'content-type: application/json' \
  -d '{
      "driver_locations": [
        {
          "latitude": 40.75176657279212,
          "longitude": -73.98786252473836
        }
      ],
      "pickup_location": {
        "latitude": 40.7517665,
        "longitude": -73.98786252
      },
      "dropoff_location": {
        "latitude": 40.75279,
        "longitude": -74.00465
      },
      "parent_product_type_id": "6a8e56b8-914e-4b48-a387-e6ad21d9c00c"
  }' \
  'https://sandbox-api.uber.com/v1/health/sandbox/run'

Name	Type	Description
`driver_locations`	`array`	A list of driver locations that should be available for this sandbox run. Each element in the list will create a new driver in the given location. The locations should be close to pickup location. An empty object will randomly place the driver near the pickup location. This list should only contain one location until support for multiple drivers is added soon (required).
`driver_locations[i].latitude`	`float`	The latitude of the driver
`driver_locations[i].longitude`	`float`	The longitude of the driver
`pickup_location`	`object`	The object that contains the latitude and longitude of rider pickup (required)
`pickup_location.latitude`	`float`	Latitude of the pickup location of the trip (required)
`pickup_location.longitude`	`float`	Longitude of the pickup location of the trip (required)
`dropoff_location`	`object`	An object that contains the latitude and longitude of rider drop off (required)
`dropoff_location.latitude`	`float`	Latitude of the drop off location of the trip (required)
`dropoff_location.longitude`	`float`	Longitude of the drop off location of the trip (required)
`parent_product_type_id`	`string`	Unique identifier of a product for drivers in this run. Use from the chart above (required)

¶ Example Response

{
    "run_id": "4c11a40a-950a-4486-baf4-59858300190b"
}

Name	Type	Description
`run_id`	`string`	A unique identifier of a sandbox create run request.