Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/JorLOrT/rappi2/llms.txt

Use this file to discover all available pages before exploring further.

The Drivers API manages the courier workforce. Each driver (Conductor) is linked to a user account and optionally to a vehicle. Availability is tracked through the disponibilidad field, which is automatically updated when an assignment is created or completed. Deleting a driver soft-deletes the record and sets availability to Inactivo.

​
Availability states

StateDescription
DisponibleDriver is available for new assignments.
OcupadoDriver currently has an active assignment.
InactivoDriver account is deactivated and cannot receive assignments.
The Assignments API automatically transitions a driver from Disponible → Ocupado on assignment creation and back to Disponible when the assignment is finalised.

​
List drivers

​
GET /api/conductores
string
Returns a paginated list of drivers. Each response item includes the associated vehicle object if one is linked. Required permission: conductores:read

​
Query parameters

​
skip
integer
default:"0"
Number of records to skip for pagination.
​
limit
integer
default:"50"
Maximum number of records to return. Hard cap: 200.
​
activo
boolean
default:"true"
Filter by active status.
​
disponibilidad
string
Filter by availability state: Disponible, Ocupado, or Inactivo.

​
Response 200

Array of driver objects.
​
id
integer
required
Unique driver identifier.
​
usuario_id
integer
required
Linked user account ID.
​
nombre
string
required
Driver’s full name.
​
licencia
string
required
Driver’s licence number. Must be unique.
​
disponibilidad
string
required
Current availability: Disponible, Ocupado, or Inactivo.
​
vehiculo_placa
string
Plate of the currently assigned vehicle, or null.
​
activo
boolean
required
Whether the driver account is active.
​
vehiculo
object
Full vehicle object if a vehicle is assigned, otherwise null.
curl "https://api.rappi2.com/api/conductores?disponibilidad=Disponible" \
  -H "Authorization: Bearer <token>"

​
Create a driver

​
POST /api/conductores
string
Creates a new driver profile linked to an existing user account. Optionally assigns a vehicle at creation time. Returns 400 if usuario_id does not exist or if usuario_id / licencia is already in use. Required permission: conductores:write

​
Request body

​
nombre
string
required
Driver’s full name.
​
licencia
string
required
Unique driver’s licence number.
​
usuario_id
integer
required
ID of an existing user account to link.
​
disponibilidad
string
default:"Disponible"
Initial availability state.
​
vehiculo_placa
string
Plate of the vehicle to assign at creation. Must be an existing vehicle.

​
Response 201

The newly created driver object (same shape as list items). 
curl -X POST https://api.rappi2.com/api/conductores \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{
    "nombre": "Carlos Ríos",
    "licencia": "L-00123456",
    "usuario_id": 7,
    "vehiculo_placa": "ABC-123"
  }'

​
Get a driver

​
GET /api/conductores/{conductor_id}
string
Returns a single driver including the linked vehicle. Returns 404 if not found. Required permission: conductores:read

​
Path parameters

​
conductor_id
integer
required
Driver ID.

​
Response 200

Driver object. 
curl https://api.rappi2.com/api/conductores/5 \
  -H "Authorization: Bearer <token>"

​
Update a driver

​
PATCH /api/conductores/{conductor_id}
string
Partially updates driver fields. To change only the vehicle assignment, prefer the dedicated /vehiculo sub-endpoint. Required permission: conductores:write

​
Path parameters

​
conductor_id
integer
required
Driver ID.

​
Request body

All fields are optional.
​
nombre
string
New full name.
​
disponibilidad
string
New availability state: Disponible, Ocupado, or Inactivo.
​
vehiculo_placa
string
New vehicle plate. Must reference an existing vehicle.
​
activo
boolean
Toggle the active flag.

​
Response 200

Updated driver object. 
curl -X PATCH https://api.rappi2.com/api/conductores/5 \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"disponibilidad": "Inactivo"}'

​
Assign a vehicle to a driver

​
PATCH /api/conductores/{conductor_id}/vehiculo
string
Sets or clears the vehicle linked to a driver. When assigning, the vehicle must be active and in Operativo state. Pass vehiculo_placa: null to unlink the current vehicle. Required permission: conductores:write

​
Path parameters

​
conductor_id
integer
required
Driver ID.

​
Request body

​
vehiculo_placa
string
Plate of the vehicle to assign. Pass null to remove the vehicle association.

​
Response 200

Updated driver object, with the new vehicle embedded. 
# Assign vehicle
curl -X PATCH https://api.rappi2.com/api/conductores/5/vehiculo \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"vehiculo_placa": "ABC-123"}'

# Remove vehicle
curl -X PATCH https://api.rappi2.com/api/conductores/5/vehiculo \
  -H "Authorization: Bearer <token>" \
  -H "Content-Type: application/json" \
  -d '{"vehiculo_placa": null}'

​
Deactivate a driver

​
DELETE /api/conductores/{conductor_id}
string
Soft-deletes the driver by setting activo = false and disponibilidad = Inactivo. The record is preserved. Required permission: conductores:delete

​
Path parameters

​
conductor_id
integer
required
Driver ID.

​
Response 204

No body. 
curl -X DELETE https://api.rappi2.com/api/conductores/5 \
  -H "Authorization: Bearer <token>"

Build docs developers (and LLMs) love

Get started for freeTalk to us