Añadir servicios

Crea uno o varios servicios en Logístiko.

Cada elemento de pedidosLista representa un servicio de recogida o entrega.

Los campos conductorCodigo, rutaReferencia y zona son opcionales.
Pueden omitirse cuando la planificación se realizará posteriormente
en Logístiko.

Interpretación de la respuesta

Cuando la petición se procesa a nivel de lote, el servidor responde normalmente con HTTP 200. El campo status del cuerpo indica el resultado global del lote:

  • 200: todos los elementos incluidos en respuestaLista se han procesado correctamente.
  • 206: existen elementos en respuestaLista y en errorLista.
  • 205: no hay elementos en respuestaLista y existen elementos en errorLista.

Los valores 205 y 206 son valores del campo JSON status; no son, en la implementación actual, códigos HTTP de la respuesta.

Los códigos incluidos en errorLista[].errorCodigo corresponden al resultado de un elemento individual y tampoco deben interpretarse como el código HTTP de la petición completa.

Actualización del maestro de clientes

Los indicadores update_contact, update_timeWindow, update_stop, update_address, update_dni, update_email, update_phone y update_fiscal son opcionales y se envían dentro de cada servicio, al mismo nivel que cliente.

Por defecto tienen valor false. Cuando un indicador es true, Logístiko compara el dato recibido con el almacenado y actualiza el punto de entrega cuando detecta diferencias. La propagación al cliente base depende del indicador y se explica en la descripción de cada campo.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Listado de servicios que se crearán.

pedidosLista
array of objects
required
length ≥ 1

Lista de servicios que se crearán en Logístiko.

Cada elemento representa una recogida o una entrega.

pedidosLista*
string
required
length ≥ 1

Referencia principal del servicio.

Normalmente corresponde al número de albarán, pedido u otro documento
utilizado por el ERP.

string

Referencia externa adicional del servicio.

Puede utilizarse para conservar el número de pedido, una referencia del
transportista u otro identificador del ERP.

string

Concepto del documento utilizado para crear el servicio.

Por ejemplo, Pedido cuando el servicio se crea antes de generar el
albarán o Albaran cuando el documento ya es definitivo.

string

Código que identifica la sede en Logístiko.

string

Código que identifica al conductor en Logístiko.

string

Fecha deseada para realizar la ruta o el servicio.

Formato de ejemplo: 2025-02-21T09:37:42+0200.

string

Comentarios u observaciones generales del servicio.

string

Etiqueta utilizada para mostrar, buscar, filtrar o clasificar el servicio.

int32
enum
Defaults to 0

Prioridad del servicio.

  • 0: normal.
  • 1: prioritario.
Allowed:
int32
enum
required
Defaults to 2

Tipo de actividad.

  • 1: recogida.
  • 2: entrega.
Allowed:
double

Cantidad total asociada al servicio.

double

Peso total asociado al servicio.

double

Volumen total asociado al servicio.

double

Valor en euros que debe cobrar el repartidor durante el servicio.

string

Método de pago previsto que se mostrará al repartidor.

string
^([01][0-9]|2[0-3]):[0-5][0-9]$

Hora de inicio de la ventana horaria. Formato HH:mm.

string
^([01][0-9]|2[0-3]):[0-5][0-9]$

Hora de inicio de la franja de cierre. Formato HH:mm.

string
^([01][0-9]|2[0-3]):[0-5][0-9]$

Hora de finalización de la franja de cierre. Formato HH:mm.

string
^([01][0-9]|2[0-3]):[0-5][0-9]$

Hora de finalización de la ventana horaria. Formato HH:mm.

string

Duración estimada de la parada. Formato HH:mm.

cliente
object
required

Datos del cliente, destinatario o punto donde se realizará el servicio.

boolean
Defaults to false

Indica si debe actualizarse el contacto almacenado utilizando cliente.contacto.

  • false: no se solicita actualizar el contacto maestro.
  • true: si el valor recibido es diferente, se actualiza el contacto del punto de entrega.

La actualización se replica también al cliente base únicamente cuando el cliente base y el punto de entrega tienen el mismo código.

boolean
Defaults to false

Indica si deben actualizarse la ventana horaria y la franja de cierre almacenadas.

Campos relacionados:

  • horarioDesde y horarioHasta.
  • horarioCierreInicio y horarioCierreFinal.

También se admiten internamente los nombres alternativos timeSlotMin, timeSlotMax, forbiddenStart y forbiddenEnd.

Cuando el valor es true, Logístiko normaliza los horarios y sustituye la ventana habitual. La franja de cierre se guarda como una única pareja de inicio y fin, sustituyendo la primera franja almacenada. La actualización se replica al cliente base únicamente cuando ambos registros tienen el mismo código.

boolean
Defaults to false

Indica si debe actualizarse la duración habitual de parada utilizando paradaDuracion.

También se admite internamente el nombre alternativo serviceDuration.

  • false: no se solicita actualizar la duración habitual.
  • true: si el valor es diferente, se actualiza la duración del punto de entrega.

La actualización se replica al cliente base únicamente cuando ambos registros tienen el mismo código. Un valor convertido a 0 puede sobrescribir la duración almacenada, por lo que no debe activarse sin enviar una duración válida.

boolean
Defaults to false

Indica si deben actualizarse los datos maestros de dirección con los valores recibidos en cliente.

Campos utilizados:

  • direccion
  • direccionDetalles
  • codigoPostal
  • ciudad
  • pais
  • latitud
  • longitud

La actualización se ejecuta cuando existe una dirección no vacía o unas coordenadas válidas, y cuando cambia la dirección, el código postal, la ciudad o las coordenadas originales. Si no se reciben coordenadas válidas, Logístiko puede geocodificar la dirección.

La actualización se replica al cliente base únicamente cuando ambos registros tienen el mismo código.

Nota de implementación: unas coordenadas válidas diferentes pueden actualizar la ubicación almacenada aunque update_address sea false.

boolean
Defaults to false

Indica si debe actualizarse el DNI, NIF o identificador almacenado utilizando cliente.dni.

Si el valor recibido es diferente, se actualiza el punto de entrega. La actualización se replica al cliente base únicamente cuando ambos registros tienen el mismo código.

boolean
Defaults to false

Indica si debe actualizarse el correo electrónico almacenado utilizando cliente.email.

Si el valor recibido es diferente, se actualiza el punto de entrega. La actualización se replica al cliente base únicamente cuando ambos registros tienen el mismo código.

boolean
Defaults to false

Indica si debe actualizarse el teléfono almacenado utilizando cliente.telefono.

Si el valor recibido es diferente, se actualiza el punto de entrega. La implementación actual replica también el teléfono al cliente base cuando existe, sin comprobar que ambos registros tengan el mismo código.

boolean
Defaults to false

Indica si deben actualizarse los datos fiscales almacenados con la información incluida en cliente.

Campos relacionados:

  • cliente.clienteDireccionFiscal
  • cliente.clienteDireccionFiscalDetalles
  • cliente.clienteDireccionFiscalCP
  • cliente.clienteDireccionFiscalCiudad
  • cliente.clienteNombreFiscal
  • cliente.clienteCIF

Si cualquiera de estos valores es diferente, se actualiza el conjunto completo de datos fiscales del punto de entrega. La implementación actual replica también todos los datos fiscales al cliente base cuando existe, sin comprobar que ambos registros tengan el mismo código.

bultosLista
array of objects

Lista de bultos o artículos asociados al servicio.

bultosLista
facturasPasadas
array of objects

Lista de facturas anteriores o importes pendientes asociados al servicio.

facturasPasadas
int32
≥ 0

Posición del servicio dentro de la ruta cuando el orden viene predefinido por el ERP.

string

Zona o clasificación operativa del servicio.

string

Código de ruta utilizado posteriormente desde la aplicación para que el
conductor pueda autoasignarse la misma.

string

Fecha de creación del pedido.

Formato de ejemplo: 2025-02-20T18:37:42+0200.

string

Fecha de preparación del pedido.

Formato de ejemplo: 2025-02-21T09:37:42+0200.

formularioEspecificoLista
array of objects

Lista de preguntas o campos específicos asociados al servicio.

formularioEspecificoLista
string

Campo personalizado. Debe ser configurado previamente por Logístiko.

string

Campo personalizado. Debe ser configurado previamente por Logístiko.

string

Campo personalizado. Debe ser configurado previamente por Logístiko.

boolean

Campo personalizado. Debe ser configurado previamente por Logístiko.

string

Campo personalizado. Debe ser configurado previamente por Logístiko.

string

Campo personalizado. Debe ser configurado previamente por Logístiko.

string

Campo personalizado de fecha. Debe ser configurado previamente por
Logístiko. Formato de ejemplo: 2025-02-21T09:37:42+0200.

string

Campo personalizado de fecha. Debe ser configurado previamente por
Logístiko. Formato de ejemplo: 2025-02-21T09:37:42+0200.

string

Campo personalizado de fecha. Debe ser configurado previamente por
Logístiko. Formato de ejemplo: 2025-02-21T09:37:42+0200.

double

Campo numérico personalizado. Debe ser configurado previamente por Logístiko.

double

Campo numérico personalizado. Debe ser configurado previamente por Logístiko.

double

Campo numérico personalizado. Debe ser configurado previamente por Logístiko.

Headers
string
required

Clave de acceso a la API facilitada por Logístiko.

string
required

Identificador del usuario autorizado para utilizar la API.

Responses

204

No se encontró una lista reconocida con elementos para procesar o la lista estaba vacía. La respuesta no contiene cuerpo útil.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json