Create a relocation - HQ Rental Software

Moves the vehicle from its current location to location_to_id. The API user needs the permission to update vehicle locations; without it the call returns a business error.

When it applies

A relocation dated today or earlier (in the API user's time zone) is applied at once: the vehicle's current location, and the odometer and fuel level you send, are updated.

A future relocation is saved with vehicle_relocated: false and applied automatically by a daily job on its date. Only the location changes then: the vehicle's odometer and fuel level are not updated.

Date rule. When the vehicle's latest relocation is dated before today, date_date must be on or after the day after that relocation.

Side effects

When amount is not sent, the relocation cost configured in Settings for this pair of locations is used.

When an expense category for relocations is set in Settings, a vehicle expense is created for the relocation amount, even when it is 0.

When availability per location is enabled, the vehicle's open reservations are reassigned when the relocation is applied.

The fleets_vehicle_relocated webhook fires when the relocation is created, also for a future date.

Request

Authorization

Path Params

Header Params

Body Params application/jsonRequired

Example

{
    "location_to_id": 3,
    "date_date": "2026-10-07",
    "date_time": "09:00",
    "amount": 45,
    "odometer": 18275,
    "fuel_level": 7,
    "reason": "Rebalancing for weekend demand"
}

Responses

🟢200OK

application/json

The relocation in data.relocation, with the vehicle (including its model and make), location_from, location_to and the created expense (or null). HTTP 200 is also used for failures: always check success. When it is false, the body is an ErrorBusinessRule (status_code 410) or an ErrorUnauthorized (status_code 401 or 403).

Bodyapplication/json

Example

{
    "success": true,
    "status_code": 200,
    "errors": [],
    "data": {
        "relocation": {
            "id": 731,
            "vehicle_id": 57,
            "location_from_id": 1,
            "location_to_id": 3,
            "date": "2026-10-07T09:00:00.000000Z",
            "amount": "45.00",
            "reason": "Rebalancing for weekend demand",
            "type_id": null,
            "old_odometer": 18240,
            "new_odometer": 18275,
            "old_fuel_level": 8,
            "new_fuel_level": 7,
            "vehicle_relocated": true,
            "created_at": "2026-10-07T09:02:41.000000Z",
            "updated_at": "2026-10-07T09:02:41.000000Z",
            "vehicle": {
                "id": 57,
                "plate": "KLM 4821",
                "current_location_id": 3,
                "status": "available"
            },
            "location_from": {
                "id": 1,
                "name": "Miami Airport"
            },
            "location_to": {
                "id": 3,
                "name": "Fort Lauderdale Downtown"
            },
            "expense": null
        }
    }
}

🟠404Record Not Found

🟠422Parameter Error