ServiceType

Catálogo global de tipos de servicio de la plataforma. Cada tipo tiene un code estable que usan el resto de modelos (Service, ServiceCharge, ServiceProfile, FleetAssociation). Valores: 1 delivery, 2 shopping, 3 shipping, 4 trip.

Notas y gotchas

  • Es un catálogo compartido: solo la plataforma lo edita (PATCH service-types/{id} cambia name / is_enabled).
  • Se relaciona 1:N con services, serviceCharges, serviceProfiles y fleets.

Estructura de Datos

Atributo Tipo Descripción
id int
name string Nombre visible del tipo de servicio
code int Código estable del tipo (1 delivery, 2 shopping, 3 shipping, 4 trip)
is_enabled bool Si el tipo está disponible en la plataforma
created_at datetime\|null
updated_at datetime\|null
allLogs ApiLog>
fleetAssociations FleetAssociation> Asociaciones de flota de este tipo de servicio
fleets Fleet> Flotas que operan este tipo de servicio
logs ApiLog>
serviceCharges ServiceCharge> Cargos de servicio de este tipo
serviceProfiles ServiceProfile> Perfiles de repartidor de este tipo
services Service> Servicios concretos de este tipo 
{
    "id": 1,
    "name": "Delivery",
    "code": 1,
    "is_enabled": true,
    "created_at": "2023-07-07 13:36:34",
    "updated_at": "2023-07-07 13:36:34"
}

Endpoints

Listar ServiceType

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

Listar tipos de servicio

Listado paginado del catálogo global de ServiceType.

Método URI Cabeceras
GET /service-types N/A

Mostrar ServiceType

{info} Soporta: Carga dinámica

Mostrar tipo de servicio

Devuelve el ServiceType por su id.

Método URI Cabeceras
GET /service-types/{serviceTypeId} N/A

Actualizar ServiceType

Actualizar tipo de servicio

Modifica name / is_enabled de un ServiceType. Es un catálogo global; solo lo edita la plataforma.

Método URI Cabeceras
PATCH /service-types/{serviceTypeId} Authorization 
{
    "name": "string|max:255",
    "is_enabled": "boolean"
}

Relaciones