DeliveryVehicle

Un vehículo de reparto con nombre, definido a nivel de Company. Se asigna a grupos de sucursales (BranchGroup) y a repartidores (Provider) mediante tablas pivote; sirve para clasificar qué vehículos operan dónde y quién los conduce.

Estructura de Datos

Atributo Tipo Descripción
id int
name string Nombre del vehículo de reparto
created_at datetime\|null
updated_at datetime\|null
company_id int {@link Company} dueña del vehículo (oculto)
allLogs ApiLog>
branchGroups BranchGroup> Grupos de sucursales que usan este vehículo
company Company {@link Company} dueña del vehículo
logs ApiLog>
providers Provider> Repartidores asignados a este vehículo 
{
    "id": 4,
    "name": "Automóvil",
    "created_at": "2020-09-23 16:25:53",
    "updated_at": "2020-09-26 19:22:10"
}

Endpoints

Insertar DeliveryVehicle

Crear vehículo de reparto

Crea un DeliveryVehicle para la company (name).

Método URI Cabeceras
POST /companies/{companyId}/delivery-vehicles Authorization 
{
    "name": "required|string|max:32"
}

Listar DeliveryVehicle

{info} Soporta: Paginación Filters Carga dinámica

Listar vehículos de reparto

Devuelve los DeliveryVehicle de la company.

Método URI Cabeceras
GET /companies/{companyId}/delivery-vehicles Authorization

Listar DeliveryVehicle de BranchGroup

Listar vehículos de un grupo de sucursales

Devuelve los DeliveryVehicle asignados al BranchGroup indicado.

Método URI Cabeceras
GET /companies/{companyId}/branch-groups/{branchGroupId}/delivery-vehicles Authorization

Listar DeliveryVehicle de Provider

Listar vehículos de un repartidor

Devuelve los DeliveryVehicle asignados al Provider indicado.

Método URI Cabeceras
GET /companies/{companyId}/providers/{providerId}/delivery-vehicles Authorization

Mostrar DeliveryVehicle

{info} Soporta: Carga dinámica

Mostrar vehículo de reparto

Devuelve el DeliveryVehicle por su id.

Método URI Cabeceras
GET /companies/{companyId}/delivery-vehicles/{deliveryVehicleId} Authorization

Actualizar DeliveryVehicle

Actualizar vehículo de reparto

Modifica el name del DeliveryVehicle.

Método URI Cabeceras
PATCH /companies/{companyId}/delivery-vehicles/{deliveryVehicleId} Authorization 
{
    "name": "string|max:32"
}

Vincular DeliveryVehicle

Vincular DeliveryVehicle de BranchGroup

Asignar vehículo a un grupo de sucursales

Vincula el DeliveryVehicle al BranchGroup indicado.

Método URI Cabeceras
PUT /companies/{companyId}/branch-groups/{branchGroupId}/delivery-vehicles/{deliveryVehicleId} Authorization

Vincular DeliveryVehicle de Provider

Asignar vehículo a un repartidor

Vincula el DeliveryVehicle al Provider indicado.

Método URI Cabeceras
PUT /companies/{companyId}/providers/{providerId}/delivery-vehicles/{deliveryVehicleId} Authorization

Desvincular DeliveryVehicle

Desvincular DeliveryVehicle de BranchGroup

Quitar vehículo de un grupo de sucursales

Desvincula el DeliveryVehicle del BranchGroup indicado.

Método URI Cabeceras
DELETE /companies/{companyId}/branch-groups/{branchGroupId}/delivery-vehicles/{deliveryVehicleId} Authorization

Desvincular DeliveryVehicle de Provider

Quitar vehículo de un repartidor

Desvincula el DeliveryVehicle del Provider indicado.

Método URI Cabeceras
DELETE /companies/{companyId}/providers/{providerId}/delivery-vehicles/{deliveryVehicleId} Authorization

Sincronizar DeliveryVehicle

Sincronizar DeliveryVehicle de BranchGroup

Sincronizar vehículos de un grupo de sucursales

Reemplaza el conjunto de DeliveryVehicle asignados al BranchGroup por la lista enviada.

Método URI Cabeceras
PUT /companies/{companyId}/branch-groups/{branchGroupId}/delivery-vehicles Authorization

Sincronizar DeliveryVehicle de Provider

Sincronizar vehículos de un repartidor

Reemplaza el conjunto de DeliveryVehicle asignados al Provider por la lista enviada.

Método URI Cabeceras
PUT /companies/{companyId}/providers/{providerId}/delivery-vehicles Authorization 
[
    "integer"
]

Eliminar DeliveryVehicle

Eliminar vehículo de reparto

Borra el DeliveryVehicle y sus asignaciones a grupos de sucursales y repartidores.

Método URI Cabeceras
DELETE /companies/{companyId}/delivery-vehicles/{deliveryVehicleId} Authorization

Relaciones