Customers
About the Customer API
The EverTransit Customer API allows you to create a new customer, list customers from a given email, and retrieve the details of a particular customer by its ID. To make your requests, you can use the endpoints and their methods listed below.
Endpoints
The Customer object
{
"id": "5f886c22fe5dd800318f8092",
"firstName": "John",
"lastName": "Doe",
"email": "[email protected]",
"phoneNumber": "+19545556666",
"createdTime": "2022-08-18T01:10:16.000Z",
}
Attributes
firstName
string
The first name of the customer.
lastName
string
The last name of the customer.
string
The email of the customer.
id
string
A unique identifier for the customer.
phoneNumber
string
The phone number of the customer.
createdTime
string
The date and time the customer was created in ISO format.
hits
array
Information about the ride that matches the search criteria. For example, the ID, passengers, status, destination, service level, rider, driver, etc.
totalHits
number
The number of matching criteria from the search result.
Create a customer
Create a customer.
The first name of the customer.
John
The last name of the customer.
Doe
The phone number of the customer.
+123456789
POST /v2beta/customers HTTP/1.1
Host: endpoints.evertransit.com
Content-Type: application/json
Accept: */*
Content-Length: 88
{
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"phoneNumber": "+123456789"
}
{
"id": "5f886c22fe5dd800318f809j",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"phoneNumber": "+123456789",
"createdTime": "2022-08-16T22:06:24.024Z"
}
API playground for creating a customer
List customers
Retrieves a list of customers that matches the criteria.
Only customers with this email will be returned.
[email protected]
The limit of items per page in the response.
20
Example: 10
Specify the page to retrieve. You will need to use it if you want to retrieve specific pages.
1
Example: 1
GET /v2beta/customers HTTP/1.1
Host: endpoints.evertransit.com
Accept: */*
{
"hits": [
{
"id": "5f886c22fe5dd800318f809j",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"phoneNumber": "+123456789",
"createdTime": "2022-08-16T22:06:24.024Z"
}
],
"totalHits": 1
}
API playground for listing customers
Retrieve a customer
Retrieve a customer by its ID.
A unique identifier for the customer.
507f191e810c19729de860jk
GET /v2beta/customers/{customerId} HTTP/1.1
Host: endpoints.evertransit.com
Accept: */*
{
"id": "5f886c22fe5dd800318f809j",
"email": "[email protected]",
"firstName": "John",
"lastName": "Doe",
"phoneNumber": "+123456789",
"createdTime": "2022-08-16T22:06:24.024Z"
}
Last updated
Was this helpful?