BScheduler Partner Integration Gateway
stringstringintegerstringstringstringstring · date-timestringstring integer · int64 · min: 1 · requiredstring · enum · requiredstring · date-time · requiredstring · date-time · required integer · int64 · min: 1string · date-timestring · date-timeintegerstringinteger | nullstringstring | nullinteger | null integer · int64 · min: 1string · enumstring · date-timestring · date-timeintegerinteger | nullstring | null
TruckmoreV2Problem
Error body: RFC 9457 (formerly RFC 7807) problem details. Errors raised by the gateway (missing input, API key, rate limit) use an `https://httpproblems.com/http-status/{status}` type with `instance` and a `trace` object; a BScheduler outage (503) or an unexpected error (500) uses `type: about:blank`; errors from BScheduler are passed through with an RFC 9110 `type` URI, a `title` and a `traceId`, and any other BScheduler error body is reshaped into an `about:blank` problem with the reason phrase as `title`. BScheduler validation errors list their reasons per field in `errors` and may omit `detail`. Every error also carries `requestId`, `timestamp` and `path` (or `instance`) for support requests.
typetitlestatusdetailinstancerequestIdtimestamppathobject
Gateway trace, on errors raised by the gateway.
traceIdBScheduler trace id (W3C traceparent), on errors from BScheduler.
object
BScheduler validation errors: reasons keyed by BScheduler field name.
TruckmoreV2RequestReceipt
Receipt for a submitted booking request. The slot is held for dealer review; nothing is booked yet.
requestIdBooking request id. Use with GET /requests/{requestId}.
statusAlways Held on submission.
Enum values:
Held
startRequested start (UTC).
endRequested end (UTC), calculated by BScheduler.
TruckmoreV2Appointment
An appointment on the dealer's calendar.
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.
TruckmoreV2Request
A booking request. `Held` until the dealer books it (`Booked`, with `appointment` set) or it is cancelled (`Cancelled`).
requestIdstatusEnum values:
Held
Booked
Cancelled
startRequested start (UTC).
endRequested end (UTC).
rooftopIdfleetIdnotesTruckmoreV2Appointment | null
The booked appointment. Present when status is Booked, otherwise null.