Guía de campos
Esta guía reúne y explica los campos entre el ERP y Logistiko
Documentación relacionada:
Diferencias de nombres entre creación, actualización y webhooks
| Concepto | Creación | Actualización | Webhook | Observaciones |
|---|---|---|---|---|
| Referencia principal del servicio | albaran | servicio para localizarlo; referenciaNueva para cambiarla | serviceRef | En creación se envía la referencia inicial. En actualización se separa la referencia usada para localizar de la referencia nueva. |
| Referencia externa | referenciaExterna | referenciaExterna para localizarla; referenciaExternaNueva para cambiarla | serviceIdOrder | Es una referencia complementaria, puede ser el numero de pedido por ejemplo. |
| Identificador único de Logístiko | No se envía como dato inicial; se obtiene tras crear el servicio | uniqueId | uniqueId | Es el identificador recomendado para actualizaciones e idempotencia. |
| Referencia de ruta | rutaReferencia | rutaReferencia | routeRef | Mismo concepto con naming español en API y naming inglés en webhook. |
| Identificador interno de ruta | — | — | routeId | Solo se comunica en los webhooks. Es el id de la ruta |
| Código del conductor | conductorCodigo | conductorCodigo | driverCode | El webhook también puede incluir driverId, identificador interno de Logístiko. |
| Posición del servicio | posicionServicio en el OpenAPI de creación | — | servicePos | Indica el orden del servicio dentro de la ruta. |
| Tipo de actividad | actividad | — | type | Valores habituales: 1 = recogida; 2 = entrega. |
| Latitud planificada | cliente.latitud | latitude | latitudeService | No debe confundirse con latitudeArrive o latitudeDeparture, que son coordenadas reales del evento. |
| Longitud planificada | cliente.longitud | longitude | longitudeService | No debe confundirse con longitudeArrive o longitudeDeparture. |
| Ciudad o localidad | cliente.ciudad | localidad | — | El nombre cambia entre creación y actualización. |
| Inicio de ventana horaria | horarioDesde | llegadaMin | — | En actualización se utilizan campos de llegada mínima y máxima. |
| Fin de ventana horaria | horarioHasta | llegadaMax | — | En actualización se utilizan campos de llegada mínima y máxima. |
| Duración de parada | paradaDuracion | duracion | — | Formato recomendado: HH:mm. |
| Comentarios generales | comentarios | comentarios | notesArrive, notesDeparture o notesIncidence | Los campos del webhook son observaciones registradas en momentos concretos, no una copia directa de comentarios. |
| Lista de bultos o artículos | bultosLista | bultosLista | parcelList | El nombre de la lista cambia en los webhooks. |
| Código de barras del bulto | bultosLista[].barcode | bultosLista[].barcode | parcelList[].barcode | Mismo dato dentro de listas con nombres diferentes. |
| Nombre del bulto | bultosLista[].nombre | bultosLista[].nombre | parcelList[].name | Naming español en API y naming inglés en webhook. |
| Cantidad del bulto | bultosLista[].cantidad | bultosLista[].cantidad | parcelList[].qty, qtyStart, qtyFinal | El webhook diferencia cantidad planificada, inicial y final. |
| Peso del bulto | bultosLista[].peso | bultosLista[].peso | parcelList[].weight, weightStart, weightFinal | El webhook diferencia peso planificado, inicial y final. |
| Lista de facturas anteriores | facturasPasadas | — | previousInvoiceList | El nombre de la colección cambia y el webhook añade el estado done. |
| Importe de factura anterior | facturasPasadas[].importe | — | previousInvoiceList[].value | El mismo concepto cambia de importe a value. |
| Tipo de pago de factura | facturasPasadas[].tipoPago | — | previousInvoiceList[].paymentType | Naming español en creación y naming inglés en webhook. |
La pestaña Inyección (1) conserva el nombre
ordenIdentificadorpara la referencia externa. El OpenAPI de creación aportado utilizareferenciaExterna. Para nuevas integraciones debe utilizarse el nombre definido en la versión publicada del endpoint.
1. Inyección de servicios
La inyección crea uno o varios servicios dentro de pedidosLista.
Estructura simplificada:
{
"pedidosLista": [
{
"albaran": "ALB-2026-000125",
"actividad": 2,
"cliente": {
"clienteCodigo": "CLI-00025",
"clienteNombre": "Cliente de ejemplo",
"direccion": "Calle Mayor 25",
"codigoPostal": "28013",
"ciudad": "Madrid"
}
}
]
}El objeto cliente es obligatorio en la creación. Dentro de él son obligatorios clienteCodigo, clienteNombre, direccion, codigoPostal y ciudad.
1.1 Campos generales del servicio
| Campo | Tipo | Obligatorio | Descripción y valores |
|---|---|---|---|
albaran | string | Sí | Obligatorio. Referencia principal del servicio. Normalmente corresponde al número de albarán, pedido u otro documento del ERP. |
ordenIdentificador (mapeo) / referenciaExterna (OpenAPI) | string | No | Identificador o referencia externa adicional del pedido o servicio en el ERP. Permite conservar una segunda referencia distinta de albaran. |
comentarios | string | No | Observaciones e instrucciones generales del servicio que pueden mostrarse en planificación y en la APP del conductor. |
etiqueta | string | No | Etiqueta para mostrar, buscar, filtrar o clasificar el servicio. Puede contener varios valores separados por punto y coma. |
sedeCodigo | string | No | Código que identifica la sede en Logístiko. Debe coincidir con una sede configurada previamente. |
conductorCodigo | string | No | Código que identifica al conductor en Logístiko. Puede omitirse cuando la asignación se realizará posteriormente en Logístiko. |
fechaDeseada | string | No | Fecha y hora deseada para realizar el servicio. Formato recomendado: yyyy-MM-dd'T'HH:mm:ssZ, por ejemplo 2025-02-21T09:37:42+0200. |
prioridad | number | No | Prioridad del servicio. Valores: 0 = normal; 1 = prioritario. Valor por defecto: 0. |
actividad | number | Sí | Obligatorio. Tipo de actividad. Valores: 1 = recogida; 2 = entrega. Valor por defecto: 2. |
cantidad | number | No | Cantidad total asociada al servicio. |
peso | number | No | Peso total asociado al servicio. |
volumen | number | No | Volumen total asociado al servicio. |
importeCobrar | number | No | Importe total, en euros, que el conductor debe cobrar al destinatario durante el servicio. |
tipoPago | string | No | Método de pago previsto que se mostrará al conductor, por ejemplo EFECTIVO, TARJETA, CHEQUE, PAGARE, TRANSFERENCIA o CONTADO. |
horarioDesde | string | No | Hora de inicio de la ventana horaria permitida. Formato HH:mm. |
horarioHasta | string | No | Hora de finalización de la ventana horaria permitida. Formato HH:mm. |
horarioCierreInicio | string | No | Hora de inicio de una franja en la que no debe realizarse el servicio. Formato HH:mm. |
horarioCierreFinal | string | No | Hora de finalización de una franja en la que no debe realizarse el servicio. Formato HH:mm. |
paradaDuracion | string | No | Duración estimada de la parada. Formato HH:mm. |
zona | string | No | Zona o clasificación territorial u operativa del servicio. Se utiliza como criterio auxiliar de planificación y filtrado. |
rutaReferencia | string | No | Código o referencia de ruta procedente del ERP. Puede utilizarse desde la APP para autoasignar la ruta o para localizarla posteriormente. |
fechaCreacion | string | No | Fecha de creación del pedido. Formato recomendado: yyyy-MM-dd'T'HH:mm:ssZ. |
fechaPreparacion | string | No | Fecha de preparación del pedido. Formato recomendado: yyyy-MM-dd'T'HH:mm:ssZ. |
1.2 Datos del cliente
| Campo | Tipo | Obligatorio | Descripción y valores |
|---|---|---|---|
cliente.clienteNombre | string | Sí | Obligatorio. Nombre comercial o razón social del cliente o destinatario. |
cliente.direccion | string | Sí | Obligatorio. Calle y número donde se realizará la recogida o entrega. |
cliente.direccionDetalles | string | No | Detalles adicionales de la dirección, como piso, puerta, bloque, muelle o instrucciones de acceso. |
cliente.codigoPostal | string | Sí | Obligatorio. Código postal de la dirección del cliente. |
cliente.ciudad | string | Sí | Obligatorio. Ciudad o localidad donde se realizará el servicio. |
cliente.telefono | string | No | Teléfono de contacto del cliente o destinatario. |
cliente.clienteCodigo | string | Sí | Obligatorio. Código único de la dirección del cliente en el ERP. |
cliente.latitud | number | No | Latitud de la dirección del servicio. Debe enviarse junto con cliente.longitud. |
cliente.longitud | number | No | Longitud de la dirección del servicio. Debe enviarse junto con cliente.latitud. |
cliente.email | string | No | Correo electrónico de contacto del cliente o destinatario. |
cliente.dni | string | No | DNI, NIF u otro documento identificativo del cliente o contacto. |
cliente.clienteNombreFiscal | string | No | Nombre o razón social fiscal del cliente. |
cliente.clienteDireccionFiscal | string | No | Dirección fiscal principal del cliente. |
cliente.clienteDireccionFiscalCP | string | No | Código postal de la dirección fiscal. |
cliente.clienteDireccionFiscalCiudad | string | No | Ciudad o localidad de la dirección fiscal. |
cliente.clienteCIF | string | No | CIF, NIF o identificador fiscal del cliente. |
Ejemplo:
{
"cliente": {
"clienteCodigo": "CLI-00025",
"clienteNombre": "Distribuciones Ejemplo",
"direccion": "Calle Mayor 25",
"direccionDetalles": "Planta 2, puerta B",
"codigoPostal": "28013",
"ciudad": "Madrid",
"latitud": 40.416775,
"longitud": -3.70379,
"telefono": "+34910000000",
"email": "[email protected]"
}
}1.3 Bultos y artículos
bultosLista es opcional. Cuando se incluye, cada elemento representa un bulto, artículo o unidad logística.
| Campo | Tipo | Obligatorio | Descripción y valores |
|---|---|---|---|
bultosLista[].cantidad | number | No | Cantidad asociada al bulto o artículo. |
bultosLista[].barcode | string | Sí, si se envía el bulto | Obligatorio dentro de cada bulto. Código de barras o identificador único del bulto o artículo. |
bultosLista[].nombre | string | No | Nombre del bulto, artículo o unidad logística. |
bultosLista[].peso | number | No | Peso del bulto o artículo. |
bultosLista[].volumen | number | No | Volumen del bulto o artículo. |
bultosLista[].descripcion | string | No | Descripción adicional del bulto o artículo. |
bultosLista[].costeUnitario | number | No | Coste correspondiente a una unidad de la variable seleccionada en variableActualizarCoste. |
bultosLista[].ivaPorcentaje | number | No | Porcentaje de IVA aplicado al bulto o artículo. |
bultosLista[].descuentoPorcentaje | number | No | Porcentaje de descuento aplicado al bulto o artículo. |
bultosLista[].recargoPorcentaje | number | No | Porcentaje de recargo aplicado al bulto o artículo. |
bultosLista[].pickup | number | No | Tipo de movimiento del bulto. Valores: 0 = entrega; 1 = recogida. |
bultosLista[].posAlmacen | string | No | Posición, ubicación o referencia del bulto dentro del almacén. |
bultosLista[].variableActualizarCoste | number | No | Indica qué atributo se usa para calcular o recalcular el importe a partir de costeUnitario. Valores: 0 = sin variable específica; 1 = peso; 2 = cantidad/unidades; 3 = volumen. |
Cálculo de importes mediante variableActualizarCoste
variableActualizarCostevariableActualizarCoste no es un booleano. Indica la magnitud utilizada para calcular o recalcular el importe a partir de costeUnitario.
| Valor | Variable utilizada | Cálculo base |
|---|---|---|
0 | Sin variable específica | No se fuerza una base concreta mediante este campo |
1 | Peso | costeUnitario × peso |
2 | Cantidad o unidades | costeUnitario × cantidad |
3 | Volumen | costeUnitario × volumen |
Los impuestos, descuentos y recargos se informan mediante ivaPorcentaje, descuentoPorcentaje y recargoPorcentaje.
1.4 Facturas anteriores o pendientes
facturasPasadas es opcional. Cuando se incluye, cada objeto debe contener como mínimo referencia e importe.
| Campo | Tipo | Obligatorio | Descripción y valores |
|---|---|---|---|
facturasPasadas[].referencia | string | Sí, si se envía la factura | Obligatorio dentro de cada factura. Referencia de la factura anterior o pendiente. |
facturasPasadas[].importe | number | Sí, si se envía la factura | Obligatorio dentro de cada factura. Importe asociado a la factura. |
facturasPasadas[].descripcion | string | No | Descripción u observaciones de la factura. |
facturasPasadas[].tipoPago | string | No | Método o tipo de pago asociado a la factura. |
facturasPasadas[].fecha | string | No | Fecha de la factura. Formato acordado para la integración, preferentemente yyyy-MM-dd'T'HH:mm:ssZ. |
facturasPasadas[].fechaVencimiento | string | No | Fecha de vencimiento de la factura. Formato acordado para la integración, preferentemente yyyy-MM-dd'T'HH:mm:ssZ. |
2. Actualización de servicios
La actualización modifica un servicio ya existente. Se recomienda identificarlo mediante uniqueId.
Cuando no se utiliza uniqueId, la integración puede localizar el servicio por su referencia principal o externa, según el contrato configurado.
2.1 Identificación y cambio de referencias
| Campo | Tipo | Uso | Descripción y valores |
|---|---|---|---|
uniqueId | string | Recomendado | Identificador único del servicio en Logístiko. Es el identificador recomendado para localizar exactamente el servicio que debe actualizarse. |
servicio | string | Identificador alternativo | Referencia principal actual del servicio. Puede utilizarse para localizarlo cuando no se informa uniqueId. |
referenciaExterna | string | Identificador alternativo | Referencia externa actual del servicio utilizada para localizar o validar el registro que se desea actualizar. |
referenciaNueva | string | Opcional; solo si cambia la referencia | Nueva referencia principal del servicio. Sustituye la referencia anterior; por ejemplo, permite cambiar el número de pedido por el número de albarán. |
referenciaExternaNueva | string | Opcional; solo si cambia la referencia | Nueva referencia externa del servicio. Es opcional y puede utilizarse para conservar el número de pedido después de sustituir la referencia principal por el albarán. |
Paso de pedido a albarán
Para reutilizar el mismo servicio cuando un pedido se convierte en albarán:
{
"uniqueId": "687000000000000000000001",
"referenciaNueva": "ALB-2026-00457",
"referenciaExternaNueva": "PED-2026-00125",
"documentoConcepto": "Albaran"
}referenciaNuevasustituye la referencia principal original.referenciaExternaNuevapermite conservar opcionalmente el número de pedido.documentoConceptocambia dePedidoaAlbaran.- No debe crearse un segundo servicio: debe actualizarse el servicio existente.
- Los artículos de
bultosListatambién pueden actualizarse si han cambiado entre el pedido y el albarán.
2.2 Dirección y contacto
| Campo | Tipo | Uso | Descripción y valores |
|---|---|---|---|
latitude | number | Opcional | Nueva latitud de la dirección del servicio. Debe enviarse junto con longitude. |
longitude | number | Opcional | Nueva longitud de la dirección del servicio. Debe enviarse junto con latitude. |
direccion | string | Opcional | Nueva dirección principal del servicio. |
codigoPostal | string | Opcional | Nuevo código postal de la dirección del servicio. |
localidad | string | Opcional | Nueva ciudad o localidad de la dirección del servicio. |
telefono | string | Opcional | Nuevo teléfono de contacto del destinatario. |
email | string | Opcional | Nuevo correo electrónico de contacto del destinatario. |
contacto | string | Opcional | Nuevo nombre de la persona de contacto. |
dni | string | Opcional | Nuevo DNI, NIF u otro documento identificativo del cliente o contacto. |
2.3 Datos operativos y de planificación
| Campo | Tipo | Uso | Descripción y valores |
|---|---|---|---|
comentarios | string | Opcional | Nuevas observaciones o instrucciones generales del servicio. |
rutaReferencia | string | Opcional | Nueva referencia de ruta asociada al servicio. |
etiqueta | string | Opcional | Nueva etiqueta de clasificación o filtrado. Puede contener varios valores separados por punto y coma. |
cantidad | number | Opcional | Nueva cantidad total asociada al servicio. |
peso | number | Opcional | Nuevo peso total asociado al servicio. |
volumen | number | Opcional | Nuevo volumen total asociado al servicio. |
llegadaMin | string | Opcional | Inicio de la ventana horaria de llegada. Utilizar el formato admitido por la integración, normalmente HH:mm o fecha y hora completa. |
llegadaMax | string | Opcional | Fin de la ventana horaria de llegada. Utilizar el formato admitido por la integración, normalmente HH:mm o fecha y hora completa. |
duracion | string | Opcional | Nueva duración estimada de la parada. Formato recomendado HH:mm. |
conductorCodigo | string | Opcional | Código del nuevo conductor asociado al servicio. Debe coincidir con un conductor configurado en Logístiko. |
prioridad | number | Opcional | Nueva prioridad del servicio. Valores: 0 = normal; 1 = prioritario. |
fechaAuxiliar | string | Opcional | Fecha auxiliar asociada al servicio. Su uso concreto debe acordarse durante el mapeo de la integración. |
fechaPedido | string | Opcional | Fecha del pedido. Formato recomendado: yyyy-MM-dd'T'HH:mm:ssZ. |
fechaPreparacion | string | Opcional | Fecha de preparación del pedido. Formato recomendado: yyyy-MM-dd'T'HH:mm:ssZ. |
asignable | boolean | Opcional | Indica si el servicio puede incluirse en la planificación. Valores: true = asignable; false = no asignable. |
documentoConcepto | string | Opcional | Concepto del documento. Valores habituales: Pedido o Albaran. Permite reflejar el paso de pedido a albarán sin crear un servicio nuevo. |
Campo asignable
asignabletrue: el servicio puede incluirse en la planificación.false: el servicio no debe utilizarse como servicio disponible para asignación.
2.4 Actualización de bultos y artículos
| Campo | Tipo | Uso | Descripción y valores |
|---|---|---|---|
bultosLista[].barcode | string | Opcional | Obligatorio dentro de cada bulto. Código de barras o identificador único del bulto o artículo. |
bultosLista[].nombre | string | Opcional | Nuevo nombre del bulto, artículo o unidad logística. |
bultosLista[].cantidad | number | Opcional | Nueva cantidad asociada al bulto o artículo. |
bultosLista[].peso | number | Opcional | Nuevo peso del bulto o artículo. |
bultosLista[].volumen | number | Opcional | Nuevo volumen del bulto o artículo. |
bultosLista[].costeUnitario | number | Opcional | Nuevo coste correspondiente a una unidad de la variable seleccionada en variableActualizarCoste. |
bultosLista[].descripcion | string | Opcional | Nueva descripción del bulto o artículo. |
bultosLista[].formato | string | Opcional | Formato, presentación o tipo de unidad logística, por ejemplo CAJA, PALET o UNIDAD. |
bultosLista[].variableActualizarCoste | number | Opcional | Indica qué atributo se usa para calcular o recalcular el importe a partir de costeUnitario. Valores: 0 = sin variable específica; 1 = peso; 2 = cantidad/unidades; 3 = volumen. |
bultosLista[].ivaPorcentaje | number | Opcional | Nuevo porcentaje de IVA aplicado al bulto o artículo. |
bultosLista[].descuentoPorcentaje | number | Opcional | Nuevo porcentaje de descuento aplicado al bulto o artículo. |
bultosLista[].recargoPorcentaje | number | Opcional | Nuevo porcentaje de recargo aplicado al bulto o artículo. |
bultosLista[].pickup | number | Opcional | Tipo de movimiento del bulto. Valores: 0 = entrega; 1 = recogida. |
Al actualizar artículos deben enviarse los identificadores necesarios para relacionarlos correctamente. Cuando la integración sustituya la lista completa, el ERP debe enviar todos los artículos definitivos y no solamente los que hayan cambiado.
3. Campos recibidos en los webhooks
Los webhooks son comunicaciones iniciadas por Logístiko:
Logístiko → ERP
La presencia de cada campo depende del evento. Por ejemplo, una llegada puede incluir coordenadas de llegada, mientras que una entrega puede incluir firma, fotografías, cantidades finales y respuestas de formularios.
3.1 Identificación, ruta y conductor
| Campo | Tipo | Disponibilidad | Descripción y valores |
|---|---|---|---|
routeId | string | Según evento | Identificador interno de la ruta en Logístiko. |
routeRef | string | Según evento | Referencia visible o externa de la ruta. |
driverId | string | Según evento | Identificador interno del conductor en Logístiko. |
driverCode | string | Según evento | Código del conductor en Logístiko. |
licensePlate | string | Según evento | Matrícula del vehículo asociado a la ruta, cuando esté disponible. |
uniqueId | string | Según evento | Identificador único del servicio en Logístiko. Debe utilizarse como referencia principal para relacionar el webhook con el servicio del ERP. |
serviceId | string | Según evento | Identificador interno de la asignación o servicio dentro de la ruta. |
serviceRef | string | Según evento | Referencia principal del servicio, normalmente el número de albarán o pedido. |
serviceIdOrder | string | Según evento | Referencia externa u orden del servicio procedente del ERP. |
trackingLink | string | Según evento | Enlace público de seguimiento del servicio, cuando esté habilitado. |
olKey | string | Según evento | Clave externa o identificador de integración asociado al servicio, cuando esté configurado. |
serviceLabel | string | Según evento | Etiqueta o texto descriptivo asociado al servicio. |
servicePos | number | Según evento | Posición u orden del servicio dentro de la ruta. |
type | number | Según evento | Tipo de actividad del servicio. Valores habituales: 1 = recogida; 2 = entrega. |
Diferencias importantes entre identificadores
uniqueIdidentifica de forma estable el servicio en Logístiko.serviceRefcontiene la referencia principal del servicio.serviceIdOrdercontiene la referencia externa o la referencia de pedido del ERP.serviceIdidentifica internamente la asignación o servicio dentro de la ruta.routeIdes el identificador interno de la ruta.routeRefes la referencia visible o externa de la ruta.
3.2 Estados del webhook
| Estado | Significado habitual |
|---|---|
0 | Servicio sin asignar |
1 | Servicio asignado a una ruta |
2 | Ruta iniciada |
3 | Llegada al destino |
4 | Servicio completado |
5 | Servicio con incidencia |
9 | Formulario de inicio de ruta |
10 | Formulario de fin de ruta |
40 | Predespacho o planificación previa |
50 | Evento externo |
99 | Estado forzado |
El significado exacto de algunos campos secundarios depende del evento y de la configuración:
status1ystatus1Labeldescriben el resultado principal de un servicio completado.status2ystatus2Labelidentifican un motivo secundario o un motivo de servicio incompleto.codeIncidenceylabelIncidenceidentifican la incidencia registrada.99representa una modificación o estado forzado.
3.3 Fechas, coordenadas y observaciones
| Campo | Tipo | Disponibilidad | Descripción y valores |
|---|---|---|---|
barcodeReadStartRoute | number | Según evento | Fecha y hora, en epoch milisegundos, en la que se leyó el código de barras al inicio de la ruta. |
barcodeReadCompleteService | number | Según evento | Fecha y hora, en epoch milisegundos, en la que se leyó el código de barras al completar el servicio. |
latitudeService | number | Según evento | Latitud de la dirección planificada del servicio. |
longitudeService | number | Según evento | Longitud de la dirección planificada del servicio. |
dateEstimated | number | Según evento | Fecha y hora estimada de llegada al servicio, en epoch milisegundos. |
dateArrive | number | Según evento | Fecha y hora real de llegada al destino, en epoch milisegundos. |
dateDeparture | number | Según evento | Fecha y hora real de salida o finalización del servicio, en epoch milisegundos. |
notesArrive | string | Según evento | Observaciones registradas durante la llegada al destino. |
notesDeparture | string | Según evento | Observaciones registradas durante la salida o finalización del servicio. |
notesIncidence | string | Según evento | Observaciones registradas para la incidencia. |
latitudeArrive | number | Según evento | Latitud registrada durante la llegada al destino. |
longitudeArrive | number | Según evento | Longitud registrada durante la llegada al destino. |
latitudeDeparture | number | Según evento | Latitud registrada durante la salida o finalización del servicio. |
longitudeDeparture | number | Según evento | Longitud registrada durante la salida o finalización del servicio. |
Las coordenadas tienen significados diferentes:
latitudeServiceylongitudeService: ubicación planificada del servicio.latitudeArriveylongitudeArrive: ubicación registrada durante la llegada.latitudeDepartureylongitudeDeparture: ubicación registrada durante la salida o finalización.
3.4 Resultado, incidencia y evidencias
| Campo | Tipo | Disponibilidad | Descripción y valores |
|---|---|---|---|
status | number | Según evento | Estado comunicado. Valores habituales: 0 = sin asignar; 1 = asignado a ruta; 2 = ruta iniciada; 3 = llegada; 4 = servicio completado; 5 = incidencia; 9 = formulario de inicio; 10 = formulario de fin; 40 = predespacho; 50 = evento externo; 99 = estado forzado. |
status1 | number | Según evento | Resultado principal del servicio completado. Valores habituales: 0 = completado correctamente; 1 = incompleto. Su uso depende del estado y de la configuración. |
status1Label | string | Según evento | Descripción legible correspondiente a status1. |
status2 | number | Según evento | Código del motivo secundario o motivo de servicio incompleto. Los valores dependen de la configuración de Logístiko. |
status2Label | string | Según evento | Descripción legible correspondiente a status2. |
codeIncidence | string | Según evento | Código de la incidencia registrada en Logístiko. |
labelIncidence | string | Según evento | Descripción o etiqueta de la incidencia registrada. |
podSign | string | Según evento | Firma de la entrega codificada en Base64, normalmente como data URI. |
podSignName | string | Según evento | Nombre de la persona que firma la entrega. |
podSignID | string | Según evento | DNI, NIF u otro identificador de la persona que firma. |
podPhoto | string | Según evento | Fotografía principal de la entrega o incidencia codificada en Base64. |
podPhotoList | string[] | Según evento | Lista de fotografías de la entrega o incidencia codificadas en Base64. |
Las firmas y fotografías pueden recibirse codificadas en Base64. El ERP debe evitar registrar el contenido completo en logs y debe disponer de un límite de tamaño suficiente para procesar la petición.
3.5 Bultos recibidos en parcelList
parcelList| Campo | Tipo | Disponibilidad | Descripción y valores |
|---|---|---|---|
parcelList[].uniqueId | string | Según evento | Identificador interno único del bulto o artículo en Logístiko. |
parcelList[].code | string | Según evento | Código interno o referencia del bulto o artículo. |
parcelList[].barcode | string | Según evento | Código de barras del bulto o artículo. |
parcelList[].name | string | Según evento | Nombre del bulto o artículo. |
parcelList[].qty | number | Según evento | Cantidad planificada del bulto o artículo. |
parcelList[].qtyStart | number | Según evento | Cantidad registrada al inicio de la ruta. |
parcelList[].qtyFinal | number | Según evento | Cantidad registrada al completar el servicio. |
parcelList[].readStart | boolean | Según evento | Indica si el bulto fue leído o validado al inicio de la ruta. Valores: true o false. |
parcelList[].readFinal | boolean | Según evento | Indica si el bulto fue leído o validado al completar el servicio. Valores: true o false. |
parcelList[].weight | number | Según evento | Peso planificado del bulto o artículo. |
parcelList[].weightStart | number | Según evento | Peso registrado al inicio de la ruta. |
parcelList[].weightFinal | number | Según evento | Peso registrado al completar el servicio. |
parcelList[].reasonIncidence | string | Según evento | Motivo de incidencia asociado específicamente al bulto o artículo. |
parcelList[].comments | string | Según evento | Comentarios u observaciones asociados al bulto o artículo. |
El webhook puede diferenciar tres momentos:
- Valor planificado:
qtyyweight. - Valor registrado al inicio de la ruta:
qtyStartyweightStart. - Valor registrado al finalizar el servicio:
qtyFinalyweightFinal.
Los campos readStart y readFinal indican si el bulto fue leído o validado en cada momento.
3.6 Respuestas de formularios
| Campo | Tipo | Disponibilidad | Descripción y valores |
|---|---|---|---|
form[].label | string | Cuando el evento incluye formulario | Texto o etiqueta visible de la pregunta del formulario. |
form[].key | string | Cuando el evento incluye formulario | Clave técnica que identifica la pregunta del formulario. |
form[].value | variable | Cuando el evento incluye formulario | Respuesta registrada. El tipo del valor depende de valueType. |
form[].valueType | number | Cuando el evento incluye formulario | Tipo de respuesta. Valores: 0 = texto; 1 = número; 2 = booleano; 3 = identificador de documento. |
form[].valueTypeString | string | Cuando el evento incluye formulario | Nombre legible del tipo de respuesta, por ejemplo text, number, boolean o documentId. |
Valores de valueType:
| Valor | Tipo |
|---|---|
0 | Texto |
1 | Número |
2 | Booleano |
3 | Identificador de documento |
El valor real de form[].value puede ser texto, número o booleano según valueType.
3.7 Facturas anteriores recibidas en previousInvoiceList
previousInvoiceList| Campo | Tipo | Disponibilidad | Descripción y valores |
|---|---|---|---|
previousInvoiceList[].value | number | Según configuración | Importe de la factura anterior o pendiente. |
previousInvoiceList[].reference | string | Según configuración | Referencia de la factura anterior o pendiente. |
previousInvoiceList[].paymentType | string | Según configuración | Método o tipo de pago asociado a la factura. |
previousInvoiceList[].done | boolean | Según configuración | Indica si la factura ya fue gestionada o cobrada. Valores: true o false. |
4. Recomendaciones de mapeo para el ERP
- Almacenar siempre el
uniqueIddevuelto por Logístiko y utilizarlo como identificador principal en las actualizaciones. - Interpretar las fechas de webhook como epoch milisegundos.
- No asumir que todos los campos estarán presentes en todos los webhooks.
- No sustituir un estado reciente por otro anterior únicamente por el orden de recepción. (si tu servidor no estaba disponible temporalmente el reintento nuestro puede ser posterior)
Updated 22 days ago