For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tareas

Endpoints

Crear tarea

post

Crea una nueva tarea independiente (no asociada a un workflow).

Autorizaciones
AuthorizationstringRequerido

Token Bearer generado en la sección de integraciones de tu organización en Zipnova Rutas.

Cuerpo
addressone ofRequerido

Dirección de origen o destino. Se puede enviar de tres formas mutuamente excluyentes:

ModoQué enviarComportamiento
1. Dirección existentesolo idReutiliza una dirección ya creada, tal cual está.
2. Lugar guardadosolo place_idCopia automáticamente todos los datos desde el lugar.
3. Dirección nuevaobjeto completoCrea una dirección nueva.

Reglas de exclusión:

  • id y place_id son excluyentes entre sí.
  • En el modo 3, la ubicación se indica por IDs internos (city_id) o por nombres (city + state + country).
o
o
external_referencestring · nullableOpcional

Referencia externa de la tarea.

Example: TASK-001
recipient_namestring · nullableOpcional

Nombre del destinatario.

Example: Juan Pérez
notesstring · nullableOpcional

Notas adicionales para el conductor.

Example: Llamar antes de llegar
Respuestas
201

Tarea creada

application/json
successbooleanOpcionalExample: true
post/tasks

Listar tareas

get

Retorna un listado paginado de tareas de la organización, con soporte para filtros y búsqueda.

Autorizaciones
AuthorizationstringRequerido

Token Bearer generado en la sección de integraciones de tu organización en Zipnova Rutas.

Parámetros de consulta
shift_datestring · dateOpcional

Filtrar por fecha (formato YYYY-MM-DD).

Example: 2024-05-21
filter[global]string · mín: 3Opcional

Búsqueda global en texto libre (mínimo 3 caracteres).

filter[status]integerOpcional

Filtrar por ID de estado.

filter[pickup]booleanOpcional

Filtrar solo tareas de pickup.

filter[assigned]booleanOpcional

Filtrar tareas asignadas al usuario autenticado.

filter[blueprint]stringOpcional

Filtrar por ID o código del blueprint.

filter[shipment]stringOpcional

Filtrar por ID del envío.

filter[workflow]stringOpcional

Filtrar por ID del workflow.

Respuestas
200

Lista paginada de tareas

application/json
get/tasks

Obtener tarea

get

Obtiene los detalles completos de una tarea.

Autorizaciones
AuthorizationstringRequerido

Token Bearer generado en la sección de integraciones de tu organización en Zipnova Rutas.

Parámetros de ruta
taskstringRequerido

ID de la tarea

Example: 01GQBRNWN8ZS4X8K9WN5DFXH3Y
Respuestas
200

Tarea obtenida

application/json

Tarea de entrega o pickup

idstringOpcional

Identificador de la tarea.

Example: 01GQBRNWN8ZS4X8K9WN5DFXH3Y
internal_idintegerOpcional

ID interno de la tarea.

grouping_hashstringOpcional

Hash que agrupa tareas relacionadas del mismo workflow.

Example: 4343dsknnd9sdskd29d
client_codestring · nullableOpcional

Código de cliente asociado a la tarea.

Example: CLI-001
is_pickupbooleanOpcional

Si la tarea es de pickup (retiro).

Example: false
recipient_namestring · nullableOpcional

Nombre del destinatario.

Example: Juan Pérez
notesstring · nullableOpcional

Notas de la tarea.

Example: Llamar antes de llegar
is_self_assignablebooleanOpcional

Si la tarea puede ser autoasignada.

Example: false
should_complete_afterstring · date-time · nullableOpcional

Fecha y hora mínima de completado.

Example: 2024-05-21T09:00:00.000Z
should_complete_beforestring · date-time · nullableOpcional

Fecha y hora máxima de completado.

Example: 2024-05-21T13:00:00.000Z
depends_on_task_idsstring[]Opcional

IDs de las tareas de las que depende esta tarea.

Example: ["01GQBRNWN8ZS4X8K9WN5DFXH3Y","01HXYZ123456789ABCDEFGHIJK"]
costnumber · nullableOpcional

Costo asociado a la tarea.

Example: 0
service_time_secondsintegerOpcional

Tiempo de servicio en segundos.

Example: 300
merchantone of · nullableOpcional
merchant_idinteger · nullableOpcional

ID del comercio asociado.

groupable_by_merchantbooleanOpcional

Si la tarea puede agruparse por comercio.

created_atstring · date-timeOpcionalExample: 2024-05-21T12:00:00.000Z
updated_atstring · date-timeOpcionalExample: 2024-05-21T12:00:00.000Z
get/tasks/{task}

Obtener adjunto de tarea

get

Retorna el contenido de un adjunto específico de la tarea, codificado en base64.

Autorizaciones
AuthorizationstringRequerido

Token Bearer generado en la sección de integraciones de tu organización en Zipnova Rutas.

Parámetros de ruta
taskstringRequerido

ID de la tarea

Example: 01GQBRNWN8ZS4X8K9WN5DFXH3Y
attachmentstring · uuidRequerido

UUID del adjunto

Example: 123e4567-e89b-12d3-a456-426614174000
Respuestas
200

Adjunto obtenido

application/json

Adjunto con contenido en base64

idstring · uuidOpcionalExample: 123e4567-e89b-12d3-a456-426614174000
groupstringOpcionalExample: invoice
namestringOpcionalExample: Factura.pdf
mime_typestringOpcionalExample: application/pdf
sizeintegerOpcional

Tamaño en bytes.

Example: 102400
created_atstring · date-timeOpcionalExample: 2024-05-21T12:00:00.000Z
contentstring · byteOpcional

Contenido del archivo codificado en base64.

get/tasks/{task}/attachments/{attachment}

Cancelar tarea

post

Cancela una tarea.

Autorizaciones
AuthorizationstringRequerido

Token Bearer generado en la sección de integraciones de tu organización en Zipnova Rutas.

Parámetros de ruta
taskstringRequerido

ID de la tarea

Example: 01GQBRNWN8ZS4X8K9WN5DFXH3Y
Cuerpo
metadataobject · nullableOpcional

Metadata opcional para el evento de cancelación.

Respuestas
200

Tarea cancelada

application/json
successbooleanOpcionalExample: true
post/tasks/{task}/cancel

Esquemas

Última actualización