Booking API
List bookings.
List bookings.
Endpoint
GET - https://api.travisroadservices.com/v1/bookings
Copy
Query params
| Parameter | Type | Description |
|---|---|---|
arrivalDateTime
|
string | Filters bookings with an arrival on or after the given date and time. |
departureDateTime
|
string | Filters bookings with a departure on or before the given date and time. Only parking bookings carry a departure, so no booking of another service matches. Use dateFrom and dateTo to select a period across every service. |
dateFrom
|
string | Filters bookings that overlap the given period: the booking ends on or after this date. Bookings without a departure, such as truckwash, end when they arrive. Format: Y-m-d, covering the whole day from 00:00:00. |
dateTo
|
string | Filters bookings that overlap the given period: the booking arrives on or before this date. Format: Y-m-d, covering the whole day up to 23:59:59. |
service
|
string | Filters by service type. Possible values: truckwash, parking, tankcleaning, repair. |
requiredActionReasons
|
string | Filters repair bookings by why they require action from the customer. Accepts one or more of: "workshopNeedsReply" (the workshop is waiting on a response) and "bookingNeedsToBeShared" (the booking is planned but its instructions have not been shared with a driver yet). Only repair bookings are returned when it is set, so combined with another service the result is empty. |
language
|
string | Specifies the language of the response. |
status
|
string | Filters by booking status. Possible values: planned, active, completed, expired, cancelled. |
licensePlate
|
string | Filters bookings by vehicle license plate. |
isSelfService
|
string | Filters bookings by whether they are self-service. |
updatedAt[from]
|
string | Filters bookings changed on or after the given date and time. Inclusive, so a booking changed in the same second may be returned again — de-duplicate on id. |
updatedAt[to]
|
string | Filters bookings changed on or before the given date and time. Inclusive. |
page
|
string | The collection page number |
itemsPerPage
|
string | The number of items per page |
Request body
No request bodyResponse body
Response 200
Booking collection