GetNearbyVehicles
POST/v1/rides/get-nearby-vehicles¶ Description
Returns nearby vehicles given the rider and location.
¶ Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| context | ThirdPartyRequestContext | Context of this request | Y |
| requested_by | ParticipantEntity | The participant who is in the shopping phase | Y |
| origin | LocationSpecification | The coordinates of the origin for which we want to find the nearby vehicles | Y |
| target_product_ids | array |
Product ids of the product for which nearby vehicles are needed. The product ids in the response would be filtered and only products with these product ids would be returned. | N |
¶ Response Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| product_vehicles | array<ProductVehicles> | An array of products containing product id and nearby vehicles of this product | N |
¶ Errors
| HTTP status | Code | Message |
|---|---|---|
| 422 | ERROR_CODE_INVALID_LOCATION_SPEC | Location spec is not valid |
| 422 | ERROR_CODE_INVALID_LOCATION_ID | Location id/provider is invalid |
| 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_OUTSIDE_SERVICE_AREA | Pickup location is outside the service area |
| 422 | ERROR_CODE_REGION_NOT_ACCESSIBLE | Requested region is not accessible |
| 422 | ERROR_CODE_PARTICIPANT_BANNED | Requesting participant is banned |