GetEstimateForOrderModification
POST/v1/rides/order-modification-estimate¶ Description
Fetches a fare estimate for modifying an existing order. The order must not already be in a terminal state; additional validation of the proposed update depends on the update target requested.
¶ Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| context | ThirdPartyRequestContext | Context of this request | Y |
| order_id | string | The id of the Order | Y |
| requested_by | ParticipantEntity | The participant who is requesting to update this order | Y |
| update_request_one_of | UpdateRequestOneOf | The update request | Y |
¶ Response Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| fare | Fare | The estimated fare for the modified order | Y |
¶ Errors
| HTTP status | Code | Message |
|---|---|---|
| 400 | ERROR_CODE_VALIDATION_FAILED | Request failed validation, e.g. missing requester or invalid update spec |
| 404 | ERROR_CODE_PARTICIPANT_NOT_FOUND | One or more participants not found [value: “ |
| 403 | ERROR_CODE_INVALID_ENTITY_ACCESS | One or more of the participants are not accessible in the current environment |
| 422 | ERROR_CODE_INVALID_LOCATION_SPEC | One or more location specifications are not valid |
| 422 | ERROR_CODE_INVALID_LOCATION_ID | One or more location ids/providers are invalid |
| 404 | ERROR_CODE_ORDER_NOT_FOUND | Given order id does not exist |
| 412 | ERROR_CODE_INVALID_ORDER_ACCESS | Participant is not authorized for read access on this order |
| 412 | ERROR_CODE_INVALID_ORDER_STATE | Order is already in a terminal state |
| 400 | ERROR_CODE_PRODUCT_NOT_FOUND | Invalid product id or product not available for the given origin/destination(s) |
| 400 | ERROR_CODE_PARTICIPANT_BANNED | One of the participants is banned |
| 400 | ERROR_CODE_MAX_JOB_DISTANCE_EXCEEDED | The distance between start and end location exceeds the limit |