Partner - Drive In API
Start a parking session
Registers the arrival of a truck on your location. The truck license plate must either belong to a Parking Booking on your location in the recent timeframe (-24 to +2 hours), or be registered to a Customer that supports TravisPay drive-in. When a Booking is found, the session is linked to it (the earliest arrival is used). Arrival may be at most 1 hour in the past and at most 1 hour in the future. Only one open parking session per truck on your location is allowed.
Endpoint
POST - https://api.travisroadservices.com/partners/v1/drive-in/check-in
Copy
Header params
| Parameter | Type | Description |
|---|---|---|
location
|
string | Location ID of the requesting location. |
Request body
Fields
| Field | Type | Required | Description |
|---|---|---|---|
arrival
|
string (date-time) | Yes | Arrival in local time. At most 1 hour in the past and at most 1 hour in the future. |
truckLicensePlate
|
string | Yes | License plate of the truck. |
Example
Response body
Response 201
CheckInResource resource created
Fields
| Field | Type | Description |
|---|---|---|
id
|
string | Unique identifier of the parking session. |
arrival
|
string (date-time) | Arrival in local time. At most 1 hour in the past and at most 1 hour in the future. |
truckLicensePlate
|
string | License plate of the truck. |
customerName
|
string | Name of the Customer connected to the given truck. |
booking
|
object | Parking Booking the session is automatically linked to. |
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 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 422
Unprocessable entity, the request is invalid or no parking session can be started: invalid input, arrival out of range, an open parking session already exists for this truck, or neither a Booking nor TravisPay is available for this license plate. Each violation carries a code: 019b3a01-3333-7000-8000-000000000001 (invalid arrival), …0002 (invalid license plate), …0003 (neither Booking nor TravisPay), …0004 (open parking session already exists)
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
Response 500
Internal server error, something went wrong at TRAVIS
No response body