BScheduler Partner Integration Gateway

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.
type
​string
title
​string
status
​integer
detail
​string
instance
​string
requestId
​string
timestamp
​string · date-time
path
​string
​object

Gateway trace, on errors raised by the gateway.

traceId
​string

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

TruckmoreV2Appointment

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.

TruckmoreV2Request

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.

TruckmoreV2RequestList

totalCount
​integer

Total matches across all pages.

TruckmoreV2AppointmentList

totalCount
​integer

Total matches across all pages.

TruckmoreV2TimeslotList

​object[]

TruckmoreV2RooftopList

​object[]

TruckmoreV2FleetList

​object[]

TruckmoreV2CancelResult

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