- SERVICE DESCRIPTION
This service provides integration with the FleetRock platform through the GHUBEE interface.
It allows the retrieval of Repair Orders (ROs) normalized by Ghubee, enabling filtering by status, events, and date ranges.
Note: The headers api-key-eld and username are mandatory to correctly generate the session token and authenticate against the endpoint.
- INTEGRATION SPECIFICATION
- Service Details
| Service Name | List Repair Orders (FleetRock Integration) |
| Context | /fleetrock/repair-orders |
| Description | Provides an endpoint to list fleet maintenance orders, proxied and managed by Ghubee using ELD credentials. |
| Endpoint |
https://hml.ghubee.com/api/fleetrock/repair-orders |
| Environment Specifications | https://ghubee.com/api |
| Protocol/Transport | HTTPS |
| Method | GET |
| Representation format | JSON |
| Input/Output Interface or Both | Both |
| Data transformation | Yes (Ghubee Wrapper) |
- Assumption
The service requires a valid Ghubee Token plus the ELD specific credentials (API Key and Username) in the headers. Dates must be in YYYY-MM-DD format.
- Data input
Identification of the input data for the Ghubee FleetRock API.
| Field | Description | Format | Size | Required | Remarks |
| Authorization | Authentication token | Header | - | Yes | Bearer <ghubee_token> |
| api-key-eld | ELD API Key | Header | - | Yes | Used for internal auth |
| username | ELD Username | Header | - | Yes | Used for internal auth |
| status | Order Status | Query Param | - | No | Allowed values: notstarted, waiting, inprogress, finished, invoiced, paid, deleted |
| event | Event Type | Query Param | - | No | e.g. "paid", "created" |
| start_date | Filter Start Date | Query Param | 10 | No | YYYY-MM-DD |
| end_date | Filter End Date | Query Param | 10 | No | YYYY-MM-DD |
- Data input example
GET https://hml.ghubee.com/api/fleetrock/repair-orders?status=notstarted&event=created&start_date=2025-03-19&end_date=2025-03-19
Content-Type: application/json
Accept: application/json
Authorization: Bearer token_ghubee
api-key-eld: your_api_key_here
username: your_username_here
- Data output
Return of FleetRock data processed by Ghubee.
| Field | Description | Format | Required | Remarks |
| status | Response status | String | Yes | "Success" / "Error" |
| message | Response message | String | Yes | Operation detail |
| data | Repair Orders List | Array | Yes | List of objects |
| id | FleetRock RO ID | String | Yes | Internal ID |
| unit_number | Asset Number | String | Yes | Vehicle ID |
| vin | Vehicle VIN | String | Yes | Asset VIN |
| vendor_name | Service Vendor | String | Yes | Shop Name |
| status | Current Status | String | Yes | e.g. "Not Started" |
| grand_total | Total Cost | String | Yes | Value |
| date_created | Creation Date | String | Yes | Timestamp |
- Error messages
Identification and description of error message types.
| Situation | Message Code | Message description |
| Success | { "status": "Success", "message": "Success", "data": [...] } | Records retrieved successfully. |
| Authentication Fail | { "status": "Error", "message": "Unauthenticated" } | Invalid Ghubee Token or Missing Headers. |
| Upstream Error | { "status": "Error", "message": "Provider Error" } | Error communicating with FleetRock (check api-key-eld). |