Partner - Booking API - V2
List bookings.
Returns bookings for a location. Filters by status, service, arrival, departure or creation date.
Endpoint
GET - https://api.travisroadservices.com/partners/v2/bookings
Copy
Header params
| Parameter | Type | Description |
|---|---|---|
location
|
string | Location ID for which to retrieve bookings. |
Query params
| Parameter | Type | Description |
|---|---|---|
status
|
string | Filters by booking status. |
service
|
string | Filters by service. Currently exposed: parking and tank cleaning; passing a service that is not exposed returns an empty result. |
arrival[from]
|
string | Filters by arrival date (from). Format: YYYY-MM-DD. |
arrival[to]
|
string | Filters by arrival date (to). Format: YYYY-MM-DD. |
departure[from]
|
string | Filters by departure date (from). Format: YYYY-MM-DD. Only matches services that have a departure date; others are excluded. |
departure[to]
|
string | Filters by departure date (to). Format: YYYY-MM-DD. Only matches services that have a departure date; others are excluded. |
created[from]
|
string | Filters by creation date (from). Format: YYYY-MM-DD. |
created[to]
|
string | Filters by creation date (to). Format: YYYY-MM-DD. |
page
|
string | The collection page number |
itemsPerPage
|
string | The number of items per page |
Request body
No request bodyResponse body
Response 200
Booking collection
Fields
| Field | Type | Description |
|---|---|---|
truck
|
object | Truck on the booking. Null when the booking has no truck. |
licensePlate
|
string | License plate of the vehicle. |
vehicleType
|
integer | Identifier of the vehicle type. |
trailer
|
object | Trailer on the booking. Null when the booking has no trailer. |
licensePlate
|
string | License plate of the vehicle. |
vehicleType
|
integer | Identifier of the vehicle type. |
driver
|
string | Name or number of the driver assigned to the booking. |
arrivalDate
|
string (date-time) | Planned arrival date at the location (date only). |
serviceInformation
|
object | Service-specific information for the booking. The shape depends on `service`. |
arrival
|
string (date-time) | Parking only. Planned arrival date and time for the service. |
departure
|
string (date-time) | Parking only. Planned departure date and time for the service. |
actualArrivalDateTime
|
string (date-time) | Parking only. Actual arrival date and time recorded by the partner. |
actualDepartureDateTime
|
string (date-time) | Parking only. Actual departure date and time recorded by the partner. |
isEcdRequested
|
boolean | Tankcleaning only. Indicates whether a European Cleaning Document (ECD) is requested. |
previousProducts
|
object | Tankcleaning only. Previously transported products, grouped per trip. |
trip1
|
array | Products transported during the most recent trip prior to this booking. |
trip2
|
array | Products transported during the second most recent trip prior to this booking. |
trip3
|
array | Products transported during the oldest of the three previous trips prior to this booking. |
cargoType
|
string | Tankcleaning only. Type of cargo transported in the tank. Possible values: food, feed, chemical, other. |
price
|
object | Price information for the booking. |
amount
|
number | Price amount in the specified currency. |
currency
|
string | ISO 4217 currency code. |
amountEUR
|
number | Price amount converted to EUR. |
id
|
integer | Unique identifier of the booking. |
travisCode
|
string | TRAVIS code uniquely identifying the booking. |
status
|
string | Current status of the booking. |
service
|
string | Service of the booking. |
createdAt
|
string (date-time) | Date and time the booking was created. |
customerName
|
string | Company name of the customer that owns the booking. |
Example