Rides

About the Rides API

The EverTransit Rides API allows you to create and update a ride, as well as retrieve the details of an existing one. To make your requests, you can use the endpoints and their methods listed below.

Endpoints

The Ride object

{
  "id": "597d2186fff125a32fe9e315",
  "createdTime": "2022-08-18T01:06:41.800Z",
  "scheduledTime": "2022-08-18T01:10:16.000Z",
  "pickup": {
    "latitude": 42.483327,
    "longitude": -76.49093299999998,
    "address": "40 Catherwood Road, Ithaca, NY, United States"
  },
  "destination": {
    "latitude": 42.434911,
    "longitude": -76.49840599999999,
    "address": "403 South Cayuga Street, Ithaca, NY, United States"
  },
  "service": {
    "id": "578facccc5b9c32d51d87a46",
    "name": "Sedan Luxury",
    "description": "Luxury sedan cars for all types of rides.",
  },
  "rider": {
    "id": "5218481c3c8d4def7f000028",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "phoneNumber": "+12345678901"
  },
  "driver": {
    "id": "5218481c3c8d4def7f000028",
    "firstName": "Michael",
     "lastName": "Jackson",
     "email": "[email protected]",
     "phoneNumber": "+12345678902"
  },
  "passengers": 1,
  "reservationNumber": "RES-QWERT0",
  "status": "completed",
  "vehicle": {
    "make": "Toyota",
    "model": "Corolla",
    "licensePlate": "808ZEL",
    "color": "Blue",
    "year": 2020
  },
  "externalId": "4251092660",
  "paymentMethod": "credit"
}

Attributes

Name

Type

Description

string

A unique identifier for the ride.

createdTime

string

The date and time the ride was created in ISO format.

scheduledTime

string

The date and time the ride was scheduled in ISO format.

pickup

object

Information about the pickup of the ride. For example, latitude, longitude, and address.

destination

object

Information about the destination of the ride. For example, latitude, longitude, and address.

service

object

Information about the service level of the ride. For example, name and description.

rider

object

Information about the rider of the ride. For example, first name, last name, email, and phone number.

driver

object

Information about the driver of the ride. For example, first name, last name, email, and phone number.

passengers

string

Amount of passengers on the ride.

reservationNumber

string

The reservation number to identify the ride.

status

string

The status of the ride.

vehicle

object

Information about the vehicle of the ride. For example, make, model, license plate, color, and year.

paymentMethod

enum

The payment method used to pay for the ride. It can be one of the followings: credit, cash, external, or invoice.

externalId

string

An external ID to associate the ride with an external system.

Create a ride

Try in the playground

Create a ride.

post

Create a new ride.

Authorizations

Body

passengersinteger · min: 1Required

Amount of passengers on the ride.

Example: 2

externalIdstringOptional

An external ID to associate the ride with an external system.

Example: 4251092660

scheduledTimestring · date-timeRequired

The date and time the ride was scheduled in ISO format.

Example: 2022-08-16T22:06:24.024Z

paymentMethodstring · enumOptional

The payment method used to pay for the ride.

Example: creditPossible values:

Responses

200

The ride was created successfully.

application/json

400

Bad request.

application/json

401

Unauthorized.

application/json

post

POST /v2beta/rides HTTP/1.1
Host: endpoints.evertransit.com
Content-Type: application/json
Accept: */*
Content-Length: 455

{
  "pickup": {
    "latitude": 40.7812199,
    "longitude": -73.9665138,
    "address": "Central Park, New York, NY, USA"
  },
  "destination": {
    "latitude": 40.7812199,
    "longitude": -73.9665138,
    "address": "Empire State Building, New York, NY, USA"
  },
  "passengers": 2,
  "externalId": "4251092660",
  "scheduledTime": "2022-08-16T22:06:24.024Z",
  "service": {
    "id": "5f886c22fe5dd800318f809f"
  },
  "rider": {
    "id": "604fe0b82d0ccc7feaf69669"
  },
  "driver": {
    "id": "604fd3a7955756a6299018c9"
  },
  "paymentMethod": "credit"
}

{
  "id": "5f886c22fe5dd800318f809j",
  "scheduledTime": "2022-08-16T22:06:24.024Z",
  "createdTime": "2022-08-16T22:06:24.024Z",
  "pickup": {
    "latitude": 40.7812199,
    "longitude": -73.9665138,
    "address": "Central Park, New York, NY, USA"
  },
  "destination": {
    "latitude": 40.7812199,
    "longitude": -73.9665138,
    "address": "Empire State Building, New York, NY, USA"
  },
  "service": {
    "id": "5f886c22fe5dd800318f809f",
    "name": "Limo",
    "description": "Up to 12 passengers"
  },
  "rider": {
    "id": "604fe0b82d0ccc7feaf69669",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "phoneNumber": "+1234567890"
  },
  "driver": {
    "id": "604fd3a7955756a6299018c9",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "phoneNumber": "+1234567890"
  },
  "passengers": 2,
  "reservationNumber": "RES-1QW2E3",
  "status": "scheduled",
  "vehicle": {
    "make": "Toyota",
    "model": "Corolla",
    "licensePlate": "ABC-1234",
    "color": "red",
    "year": 2019
  },
  "externalId": "4251092660",
  "paymentMethod": "credit"
}

API playground for creating a ride

Retrieve a ride

Retrieve a ride.

get

Retrieve a ride by its ID.

Authorizations

Path parameters

rideIdstringRequired

A unique identifier for the ride.

Example: 507f191e810c19729de860ea

Responses

200

The ride was retrieved successfully.

application/json

401

Unauthorized.

application/json

404

Not found.

application/json

get

GET /v2beta/rides/{rideId} HTTP/1.1
Host: endpoints.evertransit.com
Accept: */*

{
  "id": "5f886c22fe5dd800318f809j",
  "scheduledTime": "2022-08-16T22:06:24.024Z",
  "createdTime": "2022-08-16T22:06:24.024Z",
  "pickup": {
    "latitude": 40.7812199,
    "longitude": -73.9665138,
    "address": "Central Park, New York, NY, USA"
  },
  "destination": {
    "latitude": 40.7812199,
    "longitude": -73.9665138,
    "address": "Empire State Building, New York, NY, USA"
  },
  "service": {
    "id": "5f886c22fe5dd800318f809f",
    "name": "Limo",
    "description": "Up to 12 passengers"
  },
  "rider": {
    "id": "604fe0b82d0ccc7feaf69669",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "phoneNumber": "+1234567890"
  },
  "driver": {
    "id": "604fd3a7955756a6299018c9",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "phoneNumber": "+1234567890"
  },
  "passengers": 2,
  "reservationNumber": "RES-1QW2E3",
  "status": "scheduled",
  "vehicle": {
    "make": "Toyota",
    "model": "Corolla",
    "licensePlate": "ABC-1234",
    "color": "red",
    "year": 2019
  },
  "externalId": "4251092660",
  "paymentMethod": "credit"
}

API playground for retrieving a ride

Update a ride

Update a ride.

patch

Update a ride by its ID.

Authorizations

Path parameters

rideIdstringRequired

A unique identifier for the ride.

Example: 507f191e810c19729de860ea

Body

passengersinteger · min: 1Optional

Amount of passengers on the ride.

Example: 2

externalIdstringOptional

An external ID to associate the ride with an external system.

Example: 4251092660

scheduledTimestring · date-timeOptional

The date and time the ride was scheduled in ISO format.

Example: 2022-08-16T22:06:24.024Z

paymentMethodstring · enumOptional

The payment method used to pay for the ride.

Example: creditPossible values:

statusstringOptional

The status of the ride.

Example: scheduled

Responses

200

The ride was updated successfully.

application/json

400

Bad request.

application/json

401

Unauthorized.

application/json

404

Not found.

application/json

patch

PATCH /v2beta/rides/{rideId} HTTP/1.1
Host: endpoints.evertransit.com
Content-Type: application/json
Accept: */*
Content-Length: 476

{
  "pickup": {
    "latitude": 40.7812199,
    "longitude": -73.9665138,
    "address": "Central Park, New York, NY, USA"
  },
  "destination": {
    "latitude": 40.7812199,
    "longitude": -73.9665138,
    "address": "Empire State Building, New York, NY, USA"
  },
  "passengers": 2,
  "externalId": "4251092660",
  "scheduledTime": "2022-08-16T22:06:24.024Z",
  "service": {
    "id": "5f886c22fe5dd800318f809f"
  },
  "rider": {
    "id": "604fe0b82d0ccc7feaf69669"
  },
  "driver": {
    "id": "604fd3a7955756a6299018c9"
  },
  "paymentMethod": "credit",
  "status": "scheduled"
}

{
  "id": "5f886c22fe5dd800318f809j",
  "scheduledTime": "2022-08-16T22:06:24.024Z",
  "createdTime": "2022-08-16T22:06:24.024Z",
  "pickup": {
    "latitude": 40.7812199,
    "longitude": -73.9665138,
    "address": "Central Park, New York, NY, USA"
  },
  "destination": {
    "latitude": 40.7812199,
    "longitude": -73.9665138,
    "address": "Empire State Building, New York, NY, USA"
  },
  "service": {
    "id": "5f886c22fe5dd800318f809f",
    "name": "Limo",
    "description": "Up to 12 passengers"
  },
  "rider": {
    "id": "604fe0b82d0ccc7feaf69669",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "phoneNumber": "+1234567890"
  },
  "driver": {
    "id": "604fd3a7955756a6299018c9",
    "firstName": "John",
    "lastName": "Doe",
    "email": "[email protected]",
    "phoneNumber": "+1234567890"
  },
  "passengers": 2,
  "reservationNumber": "RES-1QW2E3",
  "status": "scheduled",
  "vehicle": {
    "make": "Toyota",
    "model": "Corolla",
    "licensePlate": "ABC-1234",
    "color": "red",
    "year": 2019
  },
  "externalId": "4251092660",
  "paymentMethod": "credit"
}

API playground for updating a ride

PreviousAPI References NextSearch

Last updated 2 years ago

Was this helpful?