Embarques
Operación de transporte que coordina paradas, flete y resultados de entrega sin ser responsable del inventario.
Campos
El nombre API es el que usan la API, MCP y la CLI.
| Nombre | Nombre API | Tipo | Obligatorio | Descripción |
|---|---|---|---|---|
| ID | id | ID de registro | Sí | |
| Nombre | label | Texto | ||
| Folio | uid | Texto | El folio es un identificador único y legible para el registro. | |
| Día | date | Fecha | Sí | Programado para este embarque. |
| Transportista | carrierId | Referencia | ||
| Usuario | userId | Usuario | ||
| Vehículo | vehicleId | Referencia | ||
| Conductor | logisticsdriverId | Referencia | ||
| Modo | mode | Constante | Sí | Opción fija del conjunto permitido para este campo. |
| Número de rastreo | trackingNumber | Texto | ||
| Nivel de servicio | serviceLevel | Constante | Opción fija del conjunto permitido para este campo. | |
| Salida planificada | dateDeparturePlanned | Fecha | Fecha de calendario sin hora. | |
| Salida real | dateDepartureActual | Fecha | Fecha de calendario sin hora. | |
| Llegada planificada | dateArrivalPlanned | Fecha | Fecha de calendario sin hora. | |
| Llegada real | dateArrivalActual | Fecha | Fecha de calendario sin hora. | |
| Peso total | weight | Decimal | Sí | Valor numérico con decimales. |
| Unidad de peso | weightunit | Constante | Sí | Unidad en la que se expresa el peso total del embarque. |
| Volumen total | volume | Decimal | Sí | Valor numérico con decimales. |
| Tarimas totales | palletCountTotal | Número Entero | Sí | Número entero sin parte fraccionaria. |
| Estatus | status | Constante | Sí | Estado del ciclo o del proceso según los valores permitidos para este registro. |
| Tags | tagIds | Tags | ||
| Descripción | description | Campo de Texto | ||
| Creado por | createdBy | Usuario | ||
| Creado el | createdAt | Fecha y Hora | Sí | |
| Actualizado por | updatedBy | Usuario | ||
| Actualizado el | updatedAt | Fecha y Hora | Sí | |
| Iniciado por | startedBy | Usuario | ||
| Iniciado el | startedAt | Fecha y Hora | ||
| Finalizado por | endedBy | Usuario | ||
| Finalizado el | endedAt | Fecha y Hora | ||
| Confirmado por | confirmedBy | Usuario | ||
| Confirmado el | confirmedAt | Fecha y Hora | ||
| Cancelado por | canceledBy | Usuario | ||
| Cancelado el | canceledAt | Fecha y Hora | ||
| Bloqueado por | blockedBy | Usuario | ||
| Bloqueado el | blockedAt | Fecha y Hora | ||
| Archivado por | archivedBy | Usuario | ||
| Archivado el | archivedAt | Fecha y Hora |
Relaciones
Los registros poseídos (línea sólida) se eliminan con su dueño. Los registros agrupados (línea punteada) pueden existir solos.
| Campo | Apunta a | Tipo |
|---|---|---|
Transportista carrierId | Transportistas | referencia |
Usuario userId | Usuarios | referencia |
Vehículo vehicleId | Vehículos | referencia |
Conductor logisticsdriverId | Conductores | referencia |
Tags tagIds | Tags | referencia |
Acciones
Lo que puedes hacer con un registro. Cada acción también envía el evento de webhook logisticsshipments.<acción>. Las lecturas (find, get, count) funcionan en toda tabla.
| Nombre | Nombre API | Descripción | Dónde |
|---|---|---|---|
| Crear | create | Crea un embarque. | App · WebMCP · API · MCP · CLI |
| Editar | update | Guarda los cambios del embarque. | App · WebMCP · API · MCP · CLI |
| Despachar | start | Envía el embarque a entrega. | App · WebMCP · API · MCP · CLI |
| Finalizar | end | Termina el fin. El trabajo se detiene. No se puede deshacer. | App · WebMCP · API · MCP · CLI |
| Cancelar | cancel | Revierte el efecto registrado de la acción. | App · WebMCP · API · MCP · CLI |
| Planear | confirm | Marca el plan del embarque como listo. | App · API · MCP · CLI |
| Bloquear | block | Impide editar y eliminar el embarque. Sigue visible y puede seguir en documentos existentes. Desbloquéalo para volver a cambiarlo. | App · WebMCP · API · MCP · CLI |
| Desbloquear | unblock | Permite de nuevo editar y eliminar el embarque. | App · WebMCP · API · MCP · CLI |
| Archivar | archive | Retira el embarque del uso diario. Sale de las listas y los selectores activos, y la mayoría de las acciones se detienen. Desarchívalo para restaurarlo. | App · WebMCP · API · MCP · CLI |
| Restaurar | unarchive | Devuelve el embarque a las listas y las acciones activas. | App · WebMCP · API · MCP · CLI |
| Eliminar | delete | Elimina el embarque y los datos que le pertenecen. No se puede deshacer. | App · WebMCP · API · MCP · CLI |
Estados
Cómo pasa un registro de un estado a otro. Archivar y bloquear pueden ocurrir en cualquier estado.
| Acción | Nombre API |
|---|---|
| Cancelar | cancel |
| Planear | confirm |
| Despachar | start |
| Finalizar | end |