BScheduler Partner Integration Gateway

Purpose of the Integration

This Partner Integration Gateway provides partner-facing API endpoints for scheduling operations in BScheduler. The gateway translates between partner-specific terminology and BScheduler internals, allowing partners such as Truckmore to interact with BScheduler using their own field names and conventions.

Getting Started

API Key Requirements

To use this integration, partners must obtain an API key from BlueTread. Each API key is:

  • Unique to the tenant/account - Ensures secure, isolated access per tenant
  • Provided and managed by BlueTread - Contact BlueTread to receive your API key
  • Required for all requests - Must be included in the Authorization header

Authentication

Include your API key in the Authorization header of every request:

Code
Authorization: Bearer YOUR_API_KEY_HERE

Partner Endpoints (Truckmore v2)

All Truckmore endpoints are under /truckmore/api/v2. Request and response schemas, examples and error bodies are in the API Reference. Errors are returned as application/problem+json.

MethodPathPurpose
POST/truckmore/api/v2/requestsSubmit a booking request
GET/truckmore/api/v2/requestsList booking requests
GET/truckmore/api/v2/requests/{requestId}Get a booking request
POST/truckmore/api/v2/requests/{requestId}/cancelCancel a booking request that is still Held
GET/truckmore/api/v2/appointmentsList appointments
GET/truckmore/api/v2/appointments/{appointmentId}Get an appointment
GET/truckmore/api/v2/rooftopsList rooftops
GET/truckmore/api/v2/timeslotsList available timeslots
POST/truckmore/api/v2/fleets/searchSearch fleets

The v1 endpoints (/truckmore/api/v1/*) have been removed and return 404 Not Found.


Error Responses

Status CodeDescription
400Bad Request - Invalid input or missing required fields
401Unauthorized - Invalid or missing API key
403Forbidden - Insufficient permissions
429Too Many Requests - Rate limit exceeded
500Internal Server Error - Processing failed
503Service Unavailable - Backend service temporarily unavailable

Support

For API key requests, technical support, or questions about the integration:

Last modified on