Partner - Booking API - V2

Get booking.

Returns the latest information about a specific booking.


Open Swagger Specification

Endpoint

    GET - https://api.travisroadservices.com/partners/v2/bookings/{id}
    Copy
  

Path params

Parameter Type Description
id string Unique identifier of the booking.

Header params

Parameter Type Description
location string Location ID of the requesting location.

Request body

No request body

Response body

Response 200

Booking resource

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

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

Fields

Field Type Description
title string A short, human-readable summary of the problem.
detail string A human-readable explanation specific to this occurrence of the problem.
status number The HTTP status code applicable to this problem.
instance string A URI reference that identifies the specific occurrence of the problem. It may or may not yield further information if dereferenced.
type string A URI reference that identifies the problem type

Example