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

Workflows

Endpoints

Crear workflow

post

Crea un nuevo workflow. Requiere blueprint_code o blueprint_id.

Si se envía shipment_id, el workflow se crea a partir de un envío existente y origin/destination/packages se toman del envío (salvo que el blueprint requiera crossdock).

Autorizaciones
AuthorizationstringRequerido

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

Cuerpo
blueprint_codestringOpcional

Código del blueprint. Requerido si no se envía blueprint_id.

Example: entrega-estandar
blueprint_idintegerOpcional

ID del blueprint. Requerido si no se envía blueprint_code.

Example: 15
external_referencestring · nullableOpcional

Referencia externa del workflow.

Example: WF-2024-001
shipment_idinteger · nullableOpcional

ID del envío existente. Si se envía, origin/destination/packages se toman del envío.

Example: 100293023
crossdockone ofOpcional

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
Respuestas
201

Workflow creado

application/json
successbooleanOpcionalExample: true
post/workflows

Obtener workflow

get

Obtiene los detalles de un workflow. Por defecto retorna el resumen; para incluir las tareas enviá include_tasks=1.

Autorizaciones
AuthorizationstringRequerido

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

Parámetros de ruta
workflowintegerRequerido

ID del workflow

Example: 42
Parámetros de consulta
include_tasksinteger · enumOpcional

Si se envía con valor 1, incluye las tareas del workflow en la respuesta.

Example: 1Valores posibles:
Respuestas
200

Workflow obtenido

application/json

Workflow que agrupa las tareas de un envío o proceso logístico

idintegerOpcional

Identificador del workflow.

Example: 28491
external_referencestring · nullableOpcional

Referencia externa del workflow.

Example: WF-001
current_statusstringOpcional

Estado actual del workflow.

Example: in_progress
dataobject · nullableOpcional

Datos adicionales asociados al workflow (estructura variable según el blueprint).

tasksone ofOpcional

Tareas del workflow. Con include_tasks=1 retorna objetos Task completos; sin ese parámetro retorna resúmenes TaskSummary (subset reducido).

o
get/workflows/{workflow}

Actualizar workflow

put

Actualiza la configuración de un workflow existente (settings y crossdock).

Autorizaciones
AuthorizationstringRequerido

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

Parámetros de ruta
workflowintegerRequerido

ID del workflow

Example: 42
Cuerpo
crossdockone ofOpcional

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
Respuestas
200

Workflow actualizado

application/json
successbooleanOpcionalExample: true
put/workflows/{workflow}

Cancelar workflow

post

Cancela un workflow y todas sus tareas pendientes.

Autorizaciones
AuthorizationstringRequerido

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

Parámetros de ruta
workflowintegerRequerido

ID del workflow

Example: 42
Respuestas
200

Workflow cancelado

application/json
post/workflows/{workflow}/cancel

Esquemas

Última actualización