Booking API
Update tank cleaning booking.
Updates an existing tank cleaning booking. Provide all required details so the service partner can deliver the best possible service.
Endpoint
PUT - https://api.travisroadservices.com/v1/bookings/tankcleaning/{id}
Copy
Path params
| Parameter | Type | Description |
|---|---|---|
id
|
string | BookingTankCleaningResource identifier |
Request body
Fields
| Field | Type | Required | Description |
|---|---|---|---|
arrival
|
string (date-time) | Yes | Expected arrival date. Format: YYYY-MM-DD. |
isEcdRequested
|
boolean | No | Indicates whether a European Cleaning Document (ECD) is required for this booking. |
previousProducts
|
object | Yes | Previously transported products, provided to help the service partner prepare the most suitable cleaning process. |
trip1
|
array | No | Tank cleaning products transported on earlier occasions to ensure the service partner can provide the best cleaning services. |
trip2
|
array | No | Tank cleaning products transported on earlier occasions to ensure the service partner can provide the best cleaning services. |
trip3
|
array | No | Tank cleaning products transported on earlier occasions to ensure the service partner can provide the best cleaning services. |
cargoType
|
string | Yes | Type of cargo transported in the tank. |
location
|
integer | Yes | Location ID for the location you want to place the booking. |
reference
|
string | No | Customer reference attached to the transaction for easy identification. Maximum 50 characters. |
truck
|
object | No | Truck vehicle for the booking. Provide a known vehicle ID from the vehicle API or supply a licensePlate directly. |
vehicleId
|
integer | No | Vehicle ID known at TRAVIS. When provided, other vehicle parameters are ignored. |
licensePlate
|
string | No | License plate of the vehicle. Required when no vehicle ID is provided; otherwise ignored. |
vehicleType
|
integer | No | Vehicle type identifier. Required when no vehicle ID is provided; otherwise ignored. |
trailer
|
object | No | Trailer vehicle for the booking. Provide a known vehicle ID from the vehicle API or supply a licensePlate directly. |
vehicleId
|
integer | No | Vehicle ID known at TRAVIS. When provided, other vehicle parameters are ignored. |
licensePlate
|
string | No | License plate of the vehicle. Required when no vehicle ID is provided; otherwise ignored. |
vehicleType
|
integer | No | Vehicle type identifier. Required when no vehicle ID is provided; otherwise ignored. |
payment
|
object | No | Payment details for the booking, including invoice customer and optional fuel card. |
recipient
|
object | No | Specifies how the driver receives booking instructions. Possible values: email (sent to the given address), sms (sent to the given phone number), driver_app (pushed to driver app), manual (caller is responsible for delivery). |
type
|
string | Yes | Delivery method for booking instructions: email, sms, manual, or driver_app. |
language
|
string | No | Language code for the instructions delivered to the driver. |
phoneNumber
|
string | No | Phone number for SMS delivery. Required when type is sms. |
email
|
string | No | Email address for email delivery. Required when type is email. |
assignedDriver
|
string (iri-reference) | No | Assigned driver when type is driver_app; must have an active contract with the same customer. |
driverName
|
string | No | Name of the driver associated with the booking. |
Example
Response body
Response 200
BookingTankCleaningResource resource updated
Fields
| Field | Type | Description |
|---|---|---|
arrival
|
string (date-time) | Expected arrival date. Format: YYYY-MM-DD. |
isEcdRequested
|
boolean | Indicates whether a European Cleaning Document (ECD) is required for this booking. |
previousProducts
|
object | Previously transported products, provided to help the service partner prepare the most suitable cleaning process. |
trip1
|
array | Tank cleaning products transported on earlier occasions to ensure the service partner can provide the best cleaning services. |
trip2
|
array | Tank cleaning products transported on earlier occasions to ensure the service partner can provide the best cleaning services. |
trip3
|
array | Tank cleaning products transported on earlier occasions to ensure the service partner can provide the best cleaning services. |
driverInstructions
|
object | Driver instructions for the tank cleaning booking, keyed by language code. |
cargoType
|
string | Type of cargo transported in the tank. |
id
|
integer | Unique identifier of the booking. |
travisCode
|
string | The Travis code uniquely identifying the booking. |
status
|
string | |
location
|
integer | Location ID for the location you want to place the booking. |
reference
|
string | Customer reference attached to the transaction for easy identification. Maximum 50 characters. |
truck
|
object | Truck vehicle for the booking. Provide a known vehicle ID from the vehicle API or supply a licensePlate directly. |
vehicleId
|
integer | Vehicle ID known at TRAVIS. When provided, other vehicle parameters are ignored. |
licensePlate
|
string | License plate of the vehicle. Required when no vehicle ID is provided; otherwise ignored. |
vinNumber
|
string | VIN number of the vehicle. Required when no vehicle ID is provided; otherwise ignored. |
vehicleType
|
integer | Vehicle type identifier. Required when no vehicle ID is provided; otherwise ignored. |
fleetNumber
|
string | Fleet number the vehicle belongs to. |
vehicleDepotName
|
string | Name of the vehicle depot the vehicle belongs to. |
trailer
|
object | Trailer vehicle for the booking. Provide a known vehicle ID from the vehicle API or supply a licensePlate directly. |
vehicleId
|
integer | Vehicle ID known at TRAVIS. When provided, other vehicle parameters are ignored. |
licensePlate
|
string | License plate of the vehicle. Required when no vehicle ID is provided; otherwise ignored. |
vinNumber
|
string | VIN number of the vehicle. Required when no vehicle ID is provided; otherwise ignored. |
vehicleType
|
integer | Vehicle type identifier. Required when no vehicle ID is provided; otherwise ignored. |
fleetNumber
|
string | Fleet number the vehicle belongs to. |
vehicleDepotName
|
string | Name of the vehicle depot the vehicle belongs to. |
payment
|
object | Payment details for the booking, including invoice customer and optional fuel card. |
recipient
|
object | Specifies how the driver receives booking instructions. Possible values: email (sent to the given address), sms (sent to the given phone number), driver_app (pushed to driver app), manual (caller is responsible for delivery). |
type
|
string | Delivery method for booking instructions: email, sms, manual, or driver_app. |
language
|
string | Language code for the instructions delivered to the driver. |
phoneNumber
|
string | Phone number for SMS delivery. Required when type is sms. |
email
|
string | Email address for email delivery. Required when type is email. |
assignedDriver
|
string (iri-reference) | Assigned driver when type is driver_app; must have an active contract with the same customer. |
createdBy
|
string | Identifier of the user or system that created the booking. |
createdAt
|
string (date-time) | Date and time when the booking was created. |
updatedAt
|
string (date-time) | Date and time when the booking was last updated. |
cancelled
|
object | When the booking was cancelled and by which party. Null if it was not. |
at
|
string (date-time) | Date and time of the transition. Null for bookings cancelled before this was recorded; the actor may still be known. |
by
|
object | The party behind the transition, or null when none was recorded. |
type
|
string | Which party acted: customer for the fleet's own user, location for the workshop or parking site, travis for Travis itself. |
name
|
string | Full name of the customer user who acted. Null for location and travis, which are reported as a party rather than as a person. |
declined
|
object | When the booking was declined and by which party. Null if it was not. |
at
|
string (date-time) | Date and time of the transition. Null for bookings cancelled before this was recorded; the actor may still be known. |
by
|
object | The party behind the transition, or null when none was recorded. |
type
|
string | Which party acted: customer for the fleet's own user, location for the workshop or parking site, travis for Travis itself. |
name
|
string | Full name of the customer user who acted. Null for location and travis, which are reported as a party rather than as a person. |
price
|
object | Price of the booking including amount and currency. |
driverName
|
string | Name of the driver associated with the booking. |
isDeletable
|
boolean | Indicates whether the booking can be deleted (cancelled). |
qrUrl
|
string | URL to the QR code for the booking. |
shareUrl
|
string | URL that can be shared with the driver to access booking instructions. |
locationInformation
|
object | Detailed address and coordinate information for the booking location. |
id
|
integer | Unique identifier of the location. |
name
|
string | Name of the location. |
address
|
string | Street address of the location. |
houseNumber
|
string | House number of the location address. |
zipCode
|
string | Postal/zip code of the location. |
city
|
string | City where the location is situated. |
latitude
|
number | Latitude coordinate of the location. |
longitude
|
number | Longitude coordinate of the location. |
Example
Response 400
Invalid input
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
|
integer | 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
Response 401
No response body - No bearer token set verify if your token is added as bearer tokenResponse 403
No response body - You don't have access to this API resourceResponse 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
|
integer | 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
Response 422
An error occurred
Fields
| Field | Type | Description |
|---|---|---|
status
|
integer | The HTTP status code (422). |
violations
|
array | A list of constraint violations that caused the error. |
detail
|
string | A human-readable description of the validation errors. |
type
|
string | A URI reference identifying the validation error type. |
title
|
string | A short summary of the error. |
instance
|
string | A URI reference identifying the specific occurrence of the error. |
Example