TruckMore v2
List booking requests
Lists booking requests whose requested start falls in a date range (at most 91 days), optionally for one fleet. Paged with skip / take; totalCount is the number of matches across all pages.
query Parameters
fromStart of the date range (UTC, ISO 8601), inclusive. The range from from to to may not exceed 91 days.
toEnd of the date range (UTC, ISO 8601). The range from from to to may not exceed 91 days.
fleetIdOnly return results for this fleet (fleetId from /fleets/search). Omit for all fleets in your account.
skipPaging: number of results to skip. Use with take and the response totalCount.
takePaging: maximum number of results to return (1-100). Defaults to 10.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List booking requests › Responses
A page of booking requests
totalCountTotal matches across all pages.
Submit a booking request
Requests a service slot at a rooftop. The slot is held for the dealer to review and book; nothing is on the calendar until the request's status becomes Booked. start must be a startTimeUtc returned by GET /truckmore/api/v2/timeslots. Requires the timezone header and at least one of phone or email (BScheduler returns 400 when both are missing). Returns 201 with a receipt.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
timezoneIANA timezone of the caller, e.g. America/New_York. BScheduler uses it to decide the caller's current day when validating start. Requests without it are rejected with 400.
Submit a booking request › Request Body
rooftopIdRooftop id from /rooftops.
startRequested start (UTC, ISO 8601), a startTimeUtc from /timeslots.
phoneContact phone. Send phone, email, or both; at least one is required.
emailContact email. Send phone, email, or both; at least one is required.
fleetIdFleet id from /fleets/search, when the fleet is known.
firstNameContact first name.
lastNameContact last name.
notesFree-text note for the dealer, e.g. unit number and the work needed.
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: phone | |
| type = object · requires: email |
phoneContact phone. Send phone, email, or both; at least one is required.
rooftopIdRooftop id from /rooftops.
startRequested start (UTC, ISO 8601), a startTimeUtc from /timeslots.
emailContact email. Send phone, email, or both; at least one is required.
fleetIdFleet id from /fleets/search, when the fleet is known.
firstNameContact first name.
lastNameContact last name.
notesFree-text note for the dealer, e.g. unit number and the work needed.
Submit a booking request › Responses
Request held for dealer review
requestIdBooking request id. Use with GET /requests/{requestId}.
statusAlways Held on submission.
startRequested start (UTC).
endRequested end (UTC), calculated by BScheduler.
Get a booking request
Returns one booking request and, once the dealer has booked it, its appointment. Poll this to learn the outcome of a submitted request.
path Parameters
requestIdBooking request id.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get a booking request › Responses
The booking request
requestIdstatusstartRequested start (UTC).
endRequested end (UTC).
rooftopIdfleetIdnotesThe booked appointment. Present when status is Booked, otherwise null.
List appointments
Lists appointments starting in a date range (at most 91 days), optionally for one fleet. Paged with skip / take; totalCount is the number of matches across all pages.
query Parameters
fromStart of the date range (UTC, ISO 8601), inclusive. The range from from to to may not exceed 91 days.
toEnd of the date range (UTC, ISO 8601). The range from from to to may not exceed 91 days.
fleetIdOnly return results for this fleet (fleetId from /fleets/search). Omit for all fleets in your account.
skipPaging: number of results to skip. Use with take and the response totalCount.
takePaging: maximum number of results to return (1-100). Defaults to 10.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List appointments › Responses
A page of appointments
totalCountTotal matches across all pages.
Get an appointment
Returns one appointment.
path Parameters
appointmentIdAppointment id.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Get an appointment › Responses
The appointment
appointmentIdstartStart (UTC).
endEnd (UTC).
rooftopIdrooftopNamefleetIdstatusAppointment status name as configured by the dealer.
assignedToAssigned technician, when one is assigned.
requestIdThe booking request this appointment was booked from, if any.
List rooftops
Lists the rooftops (dealer locations) that accept online scheduling. Use rooftopId with /timeslots and POST /requests.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List rooftops › Responses
Rooftops open for scheduling
List available timeslots
Lists open timeslots at a rooftop on a date. A slot stays listed after someone requests it; the dealer chooses between requests. Days the dealer marks as closed holidays return no slots. Send a slot's startTimeUtc as start on POST /requests.
query Parameters
rooftopIdRooftop id from /rooftops.
selectedDateDate to check (YYYY-MM-DD), in the rooftop's local time.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
List available timeslots › Responses
Open timeslots
Search fleets
Finds fleets (customers) in the dealer's account by name. Use fleetId on POST /requests and the list routes.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Search fleets › Responses
Matching fleets
Cancel a booking request
Cancels a booking request that is still Held. A request the dealer has already booked, or one already cancelled, cannot be cancelled here (409): the driver should contact the dealer. Appointments cannot be cancelled through this API.
path Parameters
requestIdBooking request id.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Cancel a booking request › Responses
Request cancelled
requestIdstatus