GetAvailableProducts
POST/v1/rides/products¶ Description
Fetches all available products at a given origin/destination location. Destination is optional; when omitted, products are still returned for the origin location alone.
¶ Request Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| context | ThirdPartyRequestContext | Context of this request | Y |
| participant_spec | ParticipantSpecification | Info of the entities that are participating in an order | Y |
| origin | LocationSpecification | Origin location specification. Used to filter products available at this location. | Y |
| destination | LocationSpecification | Destination location specification. Used to filter products based on destination. | N |
¶ Response Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| products | array<Product> | A list of available products at a given location | N |
¶ Errors
| HTTP status | Code | Message |
|---|---|---|
| 400 | ERROR_CODE_VALIDATION_FAILED | Requester field is required but was not found in the request payload |
| 422 | ERROR_CODE_INVALID_LOCATION_SPEC | Location spec is not valid, e.g. origin/destination has neither a place id nor a point |
| 422 | ERROR_CODE_INVALID_LOCATION_ID | Location id/provider is invalid |
| 422 | ERROR_CODE_OUTSIDE_SERVICE_AREA | Pickup or destination is outside the service area |
| 422 | ERROR_CODE_REGION_NOT_ACCESSIBLE | Requested region is not accessible |
| 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 |