Partner - Booking API

List parking bookings.

Returns parking bookings for a location. Filters by status, arrival, departure, or creation date.

Open Swagger Specification

Endpoint

    GET - https://api.travisroadservices.com/partners/v1/bookings/parkings
    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. Possible values: planned, active, completed, expired, cancelled.
arrival[from] string Filters by arrival date (from). Format: YYYY-MM-DD. Not applicable to cancelled bookings.
arrival[to] string Filters by arrival date (to). Format: YYYY-MM-DD. Not applicable to cancelled bookings.
departure[from] string Filters by departure date (from). Format: YYYY-MM-DD. Not applicable to cancelled bookings.
departure[to] string Filters by departure date (to). Format: YYYY-MM-DD. Not applicable to cancelled bookings.
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 body

Response body

Response 200

BookingParking collection

Fields

Field Type Description
licensePlateTruck string License plate of the truck.
licensePlateTrailer string License plate of the trailer.
driver string Name of the driver assigned to the booking.
arrival string (date-time) Planned arrival date and time of the parking booking.
departure string (date-time) Planned departure date and time of the parking booking.
amount object Total price amount for the parking booking.
price integer Price amount in minor currency units (e.g. cents).
currency string ISO 4217 currency code.
exchangeRate string Applied exchange rate relative to EUR. Only available for bookings with status completed or active.
actualArrivalDateTime string (date-time) Actual arrival date and time recorded by the partner.
actualDepartureDateTime string (date-time) Actual departure date and time recorded by the partner.
id integer Unique identifier of the parking booking.
travisCode string TRAVIS code uniquely identifying the booking.
status string Current status of the booking. Possible values: planned, active, completed, expired, cancelled.
createdAt string (date-time) Date and time the booking was created.

Example

Response 401

No response body - No bearer token set verify if your token is added as bearer token

Response 403

No response body - You don't have access to this API resource

Response 404

Not found, the given resource could not be found

No response body

Response 500

Internal server error, something went wrong at TRAVIS

No response body