• Getting Started
  • API Reference
Information
Other endpoints
    Get rooftopsgetGet timeslotsgetCreate appointmentpostSearch fleetspostCancel appointmentpost
Schemas
powered by Zuplo
BScheduler Partner Integration Gateway
BScheduler Partner Integration Gateway

Other endpoints

Endpointhttps://partner-integration.bscheduler.net

Get rooftops

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

Returns available rooftops for scheduling. Maps BScheduler branches to Truckmore rooftop terminology.

Get 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.

Get rooftops › Responses

List of rooftops available for scheduling

No data returned
GET/truckmore/api/v1/rooftops
curl --request GET \ --url https://partner-integration.bscheduler.net/truckmore/api/v1/rooftops \ --header 'Authorization: <string>'
shell
Example Responses
No example specified for this content type

Get timeslots

GET
https://partner-integration.bscheduler.net
/truckmore/api/v1/timeslots

Returns available timeslots for a rooftop on a given date. Maps BScheduler branchId to Truckmore rooftopId.

Get timeslots › query Parameters

rooftopId
​number · required

Branch ID from /rooftops

selectedDate
​string · required

Date to check (format: YYYY-MM-DD)

Get 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.

Get timeslots › Responses

List of available timeslots

No data returned
GET/truckmore/api/v1/timeslots
curl --request GET \ --url 'https://partner-integration.bscheduler.net/truckmore/api/v1/timeslots?rooftopId=%3Cnumber%3E&selectedDate=%3Cstring%3E' \ --header 'Authorization: <string>'
shell
Example Responses
No example specified for this content type

Create appointment

POST
https://partner-integration.bscheduler.net
/truckmore/api/v1/appointments

Creates a new appointment. Maps Truckmore fleet/rooftop terminology to BScheduler company/branch.

Create 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.

Create appointment › Request Body

fleetId
​number · required

Fleet ID from /fleets/search

rooftopId
​number · required

Rooftop ID from /rooftops

start
​string · required

Start time (UTC, ISO 8601) matching a startTimeUtc from /timeslots

Create appointment › Responses

Appointment created successfully

​object
success
​boolean
POST/truckmore/api/v1/appointments
curl --request POST \ --url https://partner-integration.bscheduler.net/truckmore/api/v1/appointments \ --header 'Authorization: <string>' \ --header 'Content-Type: application/json' \ --data ' { "fleetId": 0, "rooftopId": 0, "start": "start" } '
shell
Example Request Body
{ "fleetId": 0, "rooftopId": 0, "start": "start" }
json
Example Responses
{ "result": { "id": 0, "start": "start", "end": "end", "rooftopId": 0, "rooftopName": "rooftopName", "fleetId": 0, "appointmentStatusStatus": "appointmentStatusStatus", "assignedTo": "assignedTo" }, "success": true }
json
application/json

Search fleets

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

Searches for fleets by name. Maps BScheduler company terminology to Truckmore fleet.

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

Fleet name to search for

Search fleets › Responses

List of matching fleets

​object[]
success
​boolean
POST/truckmore/api/v1/fleets/search
curl --request POST \ --url https://partner-integration.bscheduler.net/truckmore/api/v1/fleets/search \ --header 'Authorization: <string>' \ --header 'Content-Type: application/json' \ --data ' { "fleetName": "fleetName" } '
shell
Example Request Body
{ "fleetName": "fleetName" }
json
Example Responses
{ "result": [ { "fleetId": 0, "fleetName": "fleetName" } ], "success": true }
json
application/json

Cancel appointment

POST
https://partner-integration.bscheduler.net
/truckmore/api/v1/appointments/cancel

Cancels an existing appointment by ID.

Cancel 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.

Cancel appointment › Request Body

id
​number · required

ID of the appointment to cancel

Cancel appointment › Responses

Appointment cancelled successfully

No data returned
POST/truckmore/api/v1/appointments/cancel
curl --request POST \ --url https://partner-integration.bscheduler.net/truckmore/api/v1/appointments/cancel \ --header 'Authorization: <string>' \ --header 'Content-Type: application/json' \ --data '{ "id": 0 }'
shell
Example Request Body
{ "id": 0 }
json
Example Responses
No example specified for this content type