Get Sandbox Run
GEThttps://sandbox-api.uber.com/v1/sandbox/run/{run_id}¶ Use case
Use this endpoint to retrieve the run state created via POST /v1/sandbox-post-terminal-state-trip-run or POST /v1/sandbox-post-terminal-state-eats-run endpoints. Note that this endpoint is only available to be invoked from sandbox environment.
¶ Authorization
OAuth 2.0 Bearer token with the business.receipts scope.
¶ Request
¶ Example request
curl -X GET \
-H "authorization: Bearer <access_token>" \
'https://sandbox-api.uber.com/v1/sandbox/run/<run_id>'
¶ Request URL parameters
| URL parameter | Type | Description |
|---|---|---|
run_id |
string |
A unique identifier of a sandbox run (required). |
¶ Response
¶ Example response
{
"state": "COMPLETED"
}
¶ Response body parameters
| Field | Type | Description |
|---|---|---|
state |
string |
Execution state of sandbox run. Possible values: RUNNING, COMPLETED, FAILED |
run_info |
object |
Optional field that provides additional information about run. |
run_info.order_info |
object |
Optional field that provides additional information about the eats order. |
run_info.order_info.order_id |
string |
Eats order identifier which can be used to retrieve receipt once run is completed. |
message |
string |
Optional message field provides additional information about the run state. |
¶ Errors
| HTTP Status | Code | Description |
|---|---|---|
| 400 | BAD_REQUEST | Suggests that the server was unable to understand or process the request due to its incorrect or malformed structure. |
| 403 | FORBIDDEN | Indicates that the server understood the request but refuses to authorize it. |
| 404 | NOT_FOUND | Suggests that the server was unable to find requested runID |
| 500 | INTERNAL_SERVER_ERROR | Represents an unanticipated error occurred on the server side while processing the request. |