BScheduler Partner Integration Gateway

List booking requests

GET
https://partner-integration.bscheduler.net
/truckmore/api/v2/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.

List booking requests › query Parameters

from
​string · date-time · required

Start of the date range (UTC, ISO 8601), inclusive. The range from from to to may not exceed 91 days.

to
​string · date-time · required

End of the date range (UTC, ISO 8601). The range from from to to may not exceed 91 days.

fleetId
​integer · int64 · min: 1

Only return results for this fleet (fleetId from /fleets/search). Omit for all fleets in your account.

skip
​integer · min: 0

Paging: number of results to skip. Use with take and the response totalCount.

Default: 0
take
​integer · min: 1 · max: 100

Paging: maximum number of results to return (1-100). Defaults to 10.

Default: 10

List booking requests › Headers

Authorization
​string · required

The 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

totalCount
​integer

Total matches across all pages.


Submit a booking request

POST
https://partner-integration.bscheduler.net
/truckmore/api/v2/requests

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.

Submit a booking request › Headers

Authorization
​string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

timezone
​string · required

IANA 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

rooftopId
​integer · required

Rooftop id from /rooftops.

start
​string · date-time · required

Requested start (UTC, ISO 8601), a startTimeUtc from /timeslots.

phone
​string

Contact phone. Send phone, email, or both; at least one is required.

email
​string · email

Contact email. Send phone, email, or both; at least one is required.

fleetId
​integer

Fleet id from /fleets/search, when the fleet is known.

firstName
​string

Contact first name.

lastName
​string

Contact last name.

notes
​string

Free-text note for the dealer, e.g. unit number and the work needed.

anyOf
At least one variant must match. Multiple variants may match simultaneously.

Decision Table

VariantMatching Criteria
type = object · requires: phone
type = object · requires: email
Properties for Variant 1:
phone
​string · required

Contact phone. Send phone, email, or both; at least one is required.

rooftopId
​integer

Rooftop id from /rooftops.

start
​string · date-time

Requested start (UTC, ISO 8601), a startTimeUtc from /timeslots.

email
​string · email

Contact email. Send phone, email, or both; at least one is required.

fleetId
​integer

Fleet id from /fleets/search, when the fleet is known.

firstName
​string

Contact first name.

lastName
​string

Contact last name.

notes
​string

Free-text note for the dealer, e.g. unit number and the work needed.

Submit a booking request › Responses

Request held for dealer review

Receipt for a submitted booking request. The slot is held for dealer review; nothing is booked yet.
requestId
​integer · int64 · min: 1 · required

Booking request id. Use with GET /requests/{requestId}.

status
​string · enum · required

Always Held on submission.

Enum values:
Held
start
​string · date-time · required

Requested start (UTC).

end
​string · date-time · required

Requested end (UTC), calculated by BScheduler.


Get a booking request

GET
https://partner-integration.bscheduler.net
/truckmore/api/v2/requests/{requestId}

Returns one booking request and, once the dealer has booked it, its appointment. Poll this to learn the outcome of a submitted request.

Get a booking request › path Parameters

requestId
​integer · int64 · min: 1 · required

Booking request id.

Get a booking request › Headers

Authorization
​string · required

The 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

A booking request. `Held` until the dealer books it (`Booked`, with `appointment` set) or it is cancelled (`Cancelled`).
requestId
​integer · int64 · min: 1
status
​string · enum
Enum values:
Held
Booked
Cancelled
start
​string · date-time

Requested start (UTC).

end
​string · date-time

Requested end (UTC).

rooftopId
​integer
fleetId
​integer | null
notes
​string | null
​TruckmoreV2Appointment | null

The booked appointment. Present when status is Booked, otherwise null.


List appointments

GET
https://partner-integration.bscheduler.net
/truckmore/api/v2/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.

List appointments › query Parameters

from
​string · date-time · required

Start of the date range (UTC, ISO 8601), inclusive. The range from from to to may not exceed 91 days.

to
​string · date-time · required

End of the date range (UTC, ISO 8601). The range from from to to may not exceed 91 days.

fleetId
​integer · int64 · min: 1

Only return results for this fleet (fleetId from /fleets/search). Omit for all fleets in your account.

skip
​integer · min: 0

Paging: number of results to skip. Use with take and the response totalCount.

Default: 0
take
​integer · min: 1 · max: 100

Paging: maximum number of results to return (1-100). Defaults to 10.

Default: 10

List appointments › Headers

Authorization
​string · required

The 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

totalCount
​integer

Total matches across all pages.


Get an appointment

GET
https://partner-integration.bscheduler.net
/truckmore/api/v2/appointments/{appointmentId}

Returns one appointment.

Get an appointment › path Parameters

appointmentId
​integer · int64 · min: 1 · required

Appointment id.

Get an appointment › Headers

Authorization
​string · required

The 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

An appointment on the dealer's calendar.
appointmentId
​integer · int64 · min: 1
start
​string · date-time

Start (UTC).

end
​string · date-time

End (UTC).

rooftopId
​integer
rooftopName
​string
fleetId
​integer | null
status
​string

Appointment status name as configured by the dealer.

assignedTo
​string | null

Assigned technician, when one is assigned.

requestId
​integer | null

The booking request this appointment was booked from, if any.


List rooftops

GET
https://partner-integration.bscheduler.net
/truckmore/api/v2/rooftops

Lists the rooftops (dealer locations) that accept online scheduling. Use rooftopId with /timeslots and POST /requests.

List rooftops › Headers

Authorization
​string · required

The 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

​object[]

List available timeslots

GET
https://partner-integration.bscheduler.net
/truckmore/api/v2/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.

List available timeslots › query Parameters

rooftopId
​integer · required

Rooftop id from /rooftops.

selectedDate
​string · date · required

Date to check (YYYY-MM-DD), in the rooftop's local time.

List available timeslots › Headers

Authorization
​string · required

The 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

​object[]

Search fleets

POST
https://partner-integration.bscheduler.net
/truckmore/api/v2/fleets/search

Finds fleets (customers) in the dealer's account by name. Use fleetId on POST /requests and the list routes.

Search fleets › Headers

Authorization
​string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Search fleets › Request Body

fleetName
​string · required

Full or partial fleet name.

Search fleets › Responses

Matching fleets

​object[]

Cancel a booking request

POST
https://partner-integration.bscheduler.net
/truckmore/api/v2/requests/{requestId}/cancel

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.

Cancel a booking request › path Parameters

requestId
​integer · int64 · min: 1 · required

Booking request id.

Cancel a booking request › Headers

Authorization
​string · required

The 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

requestId
​integer · int64 · min: 1 · required
status
​string · enum · required
Enum values:
Cancelled