Workflows
Endpoints
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: los packages se toman siempre del envío, y origin/destination también salvo que vengan en el request. Una dirección enviada (origin, destination o crossdock) reemplaza a la del envío; así se arman los flujos inversos, como la devolución al seller, donde el destino de la tarea es el origen del envío.
Si el blueprint requiere crossdock, se indica con facility (código de la ubicación) o con crossdock (dirección o place_id), nunca con los dos. Sin ninguno de los dos: si la organización tiene una sola ubicación crossdock se usa esa; si tiene más de una, facility es obligatorio.
Autorizaciones
AuthorizationstringRequerido
Token Bearer generado en la sección de integraciones de tu organización en Zipnova Rutas.
Cuerpo
blueprint_codestringOpcionalExample:
Código del blueprint. Requerido si no se envía blueprint_id.
entrega-estandarblueprint_idintegerOpcionalExample:
ID del blueprint. Requerido si no se envía blueprint_code.
15external_referencestring · nullableOpcionalExample:
Referencia externa del workflow.
WF-2024-001shipment_idinteger · nullableOpcionalExample:
ID del envío existente. Si se envía, los packages se toman del envío, y origin/destination también salvo que vengan en el request.
100293023originone ofOpcional
Dirección de origen o destino. Se puede enviar de tres formas mutuamente excluyentes:
| Modo | Qué enviar | Comportamiento |
|---|---|---|
| 1. Dirección existente | solo id | Reutiliza una dirección ya creada, tal cual está. |
| 2. Lugar guardado | place_id | Copia automáticamente todos los datos desde el lugar. Cualquier otro campo enviado junto se ignora. |
| 3. Dirección nueva | objeto completo | Crea una dirección nueva. |
Reglas de exclusión:
idyplace_idson 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
destinationone ofOpcional
Dirección de origen o destino. Se puede enviar de tres formas mutuamente excluyentes:
| Modo | Qué enviar | Comportamiento |
|---|---|---|
| 1. Dirección existente | solo id | Reutiliza una dirección ya creada, tal cual está. |
| 2. Lugar guardado | place_id | Copia automáticamente todos los datos desde el lugar. Cualquier otro campo enviado junto se ignora. |
| 3. Dirección nueva | objeto completo | Crea una dirección nueva. |
Reglas de exclusión:
idyplace_idson 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
facilitystring · nullableOpcionalExample:
Código de la ubicación crossdock. Reemplaza a crossdock; obligatorio si el blueprint requiere crossdock y la organización tiene más de una ubicación.
XD-NORTEcrossdockone ofOpcional
Dirección de origen o destino. Se puede enviar de tres formas mutuamente excluyentes:
| Modo | Qué enviar | Comportamiento |
|---|---|---|
| 1. Dirección existente | solo id | Reutiliza una dirección ya creada, tal cual está. |
| 2. Lugar guardado | place_id | Copia automáticamente todos los datos desde el lugar. Cualquier otro campo enviado junto se ignora. |
| 3. Dirección nueva | objeto completo | Crea una dirección nueva. |
Reglas de exclusión:
idyplace_idson 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:
true401
No autenticado
403
Sin permisos
422
Error de validación
post/workflows
POST /api/v1/workflows HTTP/1.1
Host: mi-organizacion.routes.zipnova.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1285
{
"blueprint_code": "entrega-estandar",
"blueprint_id": 15,
"external_reference": "WF-2024-001",
"shipment_id": 100293023,
"origin": {
"id": "01J9X2K3M4N5P6Q7R8S9T0V1W2"
},
"destination": {
"id": "01J9X2K3M4N5P6Q7R8S9T0V1W2"
},
"facility": "XD-NORTE",
"crossdock": {
"id": "01J9X2K3M4N5P6Q7R8S9T0V1W2"
},
"settings": [
{
"step_code": "delivery",
"requirements_start": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"requirements_complete": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"requirements_fail": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
]
}
],
"packages": [
{
"id": 1,
"external_reference": "PKG-001",
"description": "Producto refrigerado",
"label_code": "LBL123",
"length": 50,
"width": 30,
"height": 20,
"original_length": 50,
"length_unit": "cm",
"original_width": 30,
"width_unit": "cm",
"original_height": 20,
"height_unit": "cm",
"grams": 5000,
"original_weight": 5,
"weight_unit": "kg",
"declared_value_amount": 150,
"declared_value_currency": "ARS",
"un_code": "1234",
"classification": "FOOD",
"is_flammable": false,
"is_corrosive": false,
"is_fragile": true,
"temperature_min": 2,
"temperature_max": 8,
"original_temperature_min": 2,
"temperature_min_unit": "celsius",
"original_temperature_max": 8,
"temperature_max_unit": "celsius"
}
]
}{
"success": true,
"workflow": {
"id": 28491,
"external_reference": "WF-001",
"current_status": "in_progress",
"blueprint": {
"id": 15,
"code": "entrega-estandar",
"steps": [
{
"id": 3,
"name": "Entrega"
}
]
},
"data": {},
"tasks": [
{
"id": "01GQBRNWN8ZS4X8K9WN5DFXH3Y",
"internal_id": 1,
"grouping_hash": "4343dsknnd9sdskd29d",
"client_code": "CLI-001",
"carrier": {
"id": 5,
"subdomain": "mi-empresa",
"name": "Mi Empresa S.A."
},
"step": {
"name": "delivery",
"display_name": "Entrega",
"complete_actions": [
{}
],
"fail_actions": [
{}
],
"cancel_actions": [
{}
]
},
"is_pickup": false,
"status": {
"id": 1,
"code": "pending",
"name": "Pendiente",
"color": "#FF5733",
"metadata": {},
"changed_at": "2024-05-21T12:00:00+00:00"
},
"address": {
"id": "01J9X2K3M4N5P6Q7R8S9T0V1W2",
"name": "Juan Pérez",
"street": "Calle del Bajo",
"street_number": "123",
"floor": "2",
"apartment": "B",
"reference": "Portón negro, timbre 2",
"zipcode": "8400",
"phone": "+5492944412345",
"email": "jperez@ejemplo.com",
"city": {
"id": 1875,
"name": "Bariloche"
},
"state": {
"id": 25,
"name": "Rio Negro"
},
"country": {
"id": 1,
"name": "Argentina",
"iso": "AR"
},
"geo_latitude": -41.133472,
"geo_longitude": -71.310936
},
"recipient_name": "Juan Pérez",
"notes": "Llamar antes de llegar",
"is_self_assignable": false,
"assigned_to_user": {
"id": 10,
"firstname": "Carlos",
"lastname": "López"
},
"should_complete_after": "2024-05-21T09:00:00.000Z",
"should_complete_before": "2024-05-21T13:00:00.000Z",
"depends_on_task_ids": [
"01GQBRNWN8ZS4X8K9WN5DFXH3Y",
"01HXYZ123456789ABCDEFGHIJK"
],
"cost": 0,
"service_time_seconds": 300,
"requirements_start": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"requirements_complete": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"requirements_fail": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"time_windows": {
"monday": [
"08:00-14:00",
"15:00-20:00"
],
"tuesday": [
"08:00-14:00",
"15:00-20:00"
],
"wednesday": [
"08:00-14:00",
"15:00-20:00"
],
"thursday": [
"08:00-14:00",
"15:00-20:00"
],
"friday": [
"08:00-14:00",
"15:00-20:00"
],
"saturday": [
"08:00-13:00"
],
"sunday": []
},
"packages": [
{
"id": 10323223,
"label_code": "LBL123",
"external_reference": "PKG-001",
"weight": {
"value": 5000,
"original_value": 5,
"unit": "kg"
},
"grams": 5000,
"length": {
"value": 50,
"original_value": 50,
"unit": "cm"
},
"width": {
"value": 30,
"original_value": 30,
"unit": "cm"
},
"height": {
"value": 20,
"original_value": 20,
"unit": "cm"
},
"temperature_min": {
"value": 2,
"original_value": 2,
"unit": "celsius"
},
"temperature_max": {
"value": 8,
"original_value": 8,
"unit": "celsius"
},
"is_flammable": false,
"is_corrosive": false,
"is_fragile": true,
"classification": "FOOD",
"un_code": "1234",
"declared_value_amount": 150,
"declared_value_currency": "ARS"
}
],
"shipment": {
"id": 100293023,
"ulid": "01GQBRNWN8ZS4X8K9WN5DFXH3Y",
"reference": "ORDER-123456",
"client_code": "SHP-CLI-001",
"external_reference": "EXT-ORDER-789",
"declared_value": 100,
"control_number": "CN-001"
},
"workflow": {
"id": 28491,
"external_reference": "WF-001",
"step_in_workflow": "Entrega",
"blueprint": {
"type": "delivery"
}
},
"merchant": {
"id": 42,
"name": "Tienda Ejemplo",
"code": "TIENDA-01"
},
"merchant_id": 1,
"groupable_by_merchant": true,
"created_at": "2024-05-21T12:00:00.000Z",
"updated_at": "2024-05-21T12:00:00.000Z"
}
]
}
}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
workflowintegerRequeridoExample:
ID del workflow
42Parámetros de consulta
include_tasksinteger · enumOpcionalExample:
Si se envía con valor 1, incluye las tareas del workflow en la respuesta.
1Valores posibles: Respuestas
200
Workflow obtenido
application/json
Workflow que agrupa las tareas de un envío o proceso logístico
idintegerOpcionalExample:
Identificador del workflow.
28491external_referencestring · nullableOpcionalExample:
Referencia externa del workflow.
WF-001current_statusstringOpcionalExample:
Estado actual del workflow.
in_progressdataobject · 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
401
No autenticado
403
Sin permisos
404
Workflow no encontrado
get/workflows/{workflow}
GET /api/v1/workflows/{workflow} HTTP/1.1
Host: mi-organizacion.routes.zipnova.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"id": 28491,
"external_reference": "WF-001",
"current_status": "in_progress",
"blueprint": {
"id": 15,
"code": "entrega-estandar",
"steps": [
{
"id": 3,
"name": "Entrega"
}
]
},
"data": {},
"tasks": [
{
"id": "01GQBRNWN8ZS4X8K9WN5DFXH3Y",
"internal_id": 1,
"grouping_hash": "4343dsknnd9sdskd29d",
"client_code": "CLI-001",
"carrier": {
"id": 5,
"subdomain": "mi-empresa",
"name": "Mi Empresa S.A."
},
"step": {
"name": "delivery",
"display_name": "Entrega",
"complete_actions": [
{}
],
"fail_actions": [
{}
],
"cancel_actions": [
{}
]
},
"is_pickup": false,
"status": {
"id": 1,
"code": "pending",
"name": "Pendiente",
"color": "#FF5733",
"metadata": {},
"changed_at": "2024-05-21T12:00:00+00:00"
},
"address": {
"id": "01J9X2K3M4N5P6Q7R8S9T0V1W2",
"name": "Juan Pérez",
"street": "Calle del Bajo",
"street_number": "123",
"floor": "2",
"apartment": "B",
"reference": "Portón negro, timbre 2",
"zipcode": "8400",
"phone": "+5492944412345",
"email": "jperez@ejemplo.com",
"city": {
"id": 1875,
"name": "Bariloche"
},
"state": {
"id": 25,
"name": "Rio Negro"
},
"country": {
"id": 1,
"name": "Argentina",
"iso": "AR"
},
"geo_latitude": -41.133472,
"geo_longitude": -71.310936
},
"recipient_name": "Juan Pérez",
"notes": "Llamar antes de llegar",
"is_self_assignable": false,
"assigned_to_user": {
"id": 10,
"firstname": "Carlos",
"lastname": "López"
},
"should_complete_after": "2024-05-21T09:00:00.000Z",
"should_complete_before": "2024-05-21T13:00:00.000Z",
"depends_on_task_ids": [
"01GQBRNWN8ZS4X8K9WN5DFXH3Y",
"01HXYZ123456789ABCDEFGHIJK"
],
"cost": 0,
"service_time_seconds": 300,
"requirements_start": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"requirements_complete": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"requirements_fail": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"time_windows": {
"monday": [
"08:00-14:00",
"15:00-20:00"
],
"tuesday": [
"08:00-14:00",
"15:00-20:00"
],
"wednesday": [
"08:00-14:00",
"15:00-20:00"
],
"thursday": [
"08:00-14:00",
"15:00-20:00"
],
"friday": [
"08:00-14:00",
"15:00-20:00"
],
"saturday": [
"08:00-13:00"
],
"sunday": []
},
"packages": [
{
"id": 10323223,
"label_code": "LBL123",
"external_reference": "PKG-001",
"weight": {
"value": 5000,
"original_value": 5,
"unit": "kg"
},
"grams": 5000,
"length": {
"value": 50,
"original_value": 50,
"unit": "cm"
},
"width": {
"value": 30,
"original_value": 30,
"unit": "cm"
},
"height": {
"value": 20,
"original_value": 20,
"unit": "cm"
},
"temperature_min": {
"value": 2,
"original_value": 2,
"unit": "celsius"
},
"temperature_max": {
"value": 8,
"original_value": 8,
"unit": "celsius"
},
"is_flammable": false,
"is_corrosive": false,
"is_fragile": true,
"classification": "FOOD",
"un_code": "1234",
"declared_value_amount": 150,
"declared_value_currency": "ARS"
}
],
"shipment": {
"id": 100293023,
"ulid": "01GQBRNWN8ZS4X8K9WN5DFXH3Y",
"reference": "ORDER-123456",
"client_code": "SHP-CLI-001",
"external_reference": "EXT-ORDER-789",
"declared_value": 100,
"control_number": "CN-001"
},
"workflow": {
"id": 28491,
"external_reference": "WF-001",
"step_in_workflow": "Entrega",
"blueprint": {
"type": "delivery"
}
},
"merchant": {
"id": 42,
"name": "Tienda Ejemplo",
"code": "TIENDA-01"
},
"merchant_id": 1,
"groupable_by_merchant": true,
"created_at": "2024-05-21T12:00:00.000Z",
"updated_at": "2024-05-21T12:00:00.000Z"
}
]
}Actualiza la configuración de un workflow existente: settings y direcciones (origin, destination, crossdock). Cada dirección enviada se aplica sólo a las tareas pendientes cuyo step la usa.
Autorizaciones
AuthorizationstringRequerido
Token Bearer generado en la sección de integraciones de tu organización en Zipnova Rutas.
Parámetros de ruta
workflowintegerRequeridoExample:
ID del workflow
42Cuerpo
originone ofOpcional
Dirección de origen o destino. Se puede enviar de tres formas mutuamente excluyentes:
| Modo | Qué enviar | Comportamiento |
|---|---|---|
| 1. Dirección existente | solo id | Reutiliza una dirección ya creada, tal cual está. |
| 2. Lugar guardado | place_id | Copia automáticamente todos los datos desde el lugar. Cualquier otro campo enviado junto se ignora. |
| 3. Dirección nueva | objeto completo | Crea una dirección nueva. |
Reglas de exclusión:
idyplace_idson 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
destinationone ofOpcional
Dirección de origen o destino. Se puede enviar de tres formas mutuamente excluyentes:
| Modo | Qué enviar | Comportamiento |
|---|---|---|
| 1. Dirección existente | solo id | Reutiliza una dirección ya creada, tal cual está. |
| 2. Lugar guardado | place_id | Copia automáticamente todos los datos desde el lugar. Cualquier otro campo enviado junto se ignora. |
| 3. Dirección nueva | objeto completo | Crea una dirección nueva. |
Reglas de exclusión:
idyplace_idson 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
crossdockone ofOpcional
Dirección de origen o destino. Se puede enviar de tres formas mutuamente excluyentes:
| Modo | Qué enviar | Comportamiento |
|---|---|---|
| 1. Dirección existente | solo id | Reutiliza una dirección ya creada, tal cual está. |
| 2. Lugar guardado | place_id | Copia automáticamente todos los datos desde el lugar. Cualquier otro campo enviado junto se ignora. |
| 3. Dirección nueva | objeto completo | Crea una dirección nueva. |
Reglas de exclusión:
idyplace_idson 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:
true401
No autenticado
403
Sin permisos
404
Workflow no encontrado
422
Error de validación
put/workflows/{workflow}
PUT /api/v1/workflows/{workflow} HTTP/1.1
Host: mi-organizacion.routes.zipnova.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 508
{
"origin": {
"id": "01J9X2K3M4N5P6Q7R8S9T0V1W2"
},
"destination": {
"id": "01J9X2K3M4N5P6Q7R8S9T0V1W2"
},
"crossdock": {
"id": "01J9X2K3M4N5P6Q7R8S9T0V1W2"
},
"settings": [
{
"step_code": "delivery",
"requirements_start": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"requirements_complete": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"requirements_fail": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
]
}
]
}{
"success": true,
"workflow": {
"id": 28491,
"external_reference": "WF-001",
"current_status": "in_progress",
"blueprint": {
"id": 15,
"code": "entrega-estandar",
"steps": [
{
"id": 3,
"name": "Entrega"
}
]
},
"data": {},
"tasks": [
{
"id": "01GQBRNWN8ZS4X8K9WN5DFXH3Y",
"internal_id": 1,
"grouping_hash": "4343dsknnd9sdskd29d",
"client_code": "CLI-001",
"carrier": {
"id": 5,
"subdomain": "mi-empresa",
"name": "Mi Empresa S.A."
},
"step": {
"name": "delivery",
"display_name": "Entrega",
"complete_actions": [
{}
],
"fail_actions": [
{}
],
"cancel_actions": [
{}
]
},
"is_pickup": false,
"status": {
"id": 1,
"code": "pending",
"name": "Pendiente",
"color": "#FF5733",
"metadata": {},
"changed_at": "2024-05-21T12:00:00+00:00"
},
"address": {
"id": "01J9X2K3M4N5P6Q7R8S9T0V1W2",
"name": "Juan Pérez",
"street": "Calle del Bajo",
"street_number": "123",
"floor": "2",
"apartment": "B",
"reference": "Portón negro, timbre 2",
"zipcode": "8400",
"phone": "+5492944412345",
"email": "jperez@ejemplo.com",
"city": {
"id": 1875,
"name": "Bariloche"
},
"state": {
"id": 25,
"name": "Rio Negro"
},
"country": {
"id": 1,
"name": "Argentina",
"iso": "AR"
},
"geo_latitude": -41.133472,
"geo_longitude": -71.310936
},
"recipient_name": "Juan Pérez",
"notes": "Llamar antes de llegar",
"is_self_assignable": false,
"assigned_to_user": {
"id": 10,
"firstname": "Carlos",
"lastname": "López"
},
"should_complete_after": "2024-05-21T09:00:00.000Z",
"should_complete_before": "2024-05-21T13:00:00.000Z",
"depends_on_task_ids": [
"01GQBRNWN8ZS4X8K9WN5DFXH3Y",
"01HXYZ123456789ABCDEFGHIJK"
],
"cost": 0,
"service_time_seconds": 300,
"requirements_start": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"requirements_complete": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"requirements_fail": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"time_windows": {
"monday": [
"08:00-14:00",
"15:00-20:00"
],
"tuesday": [
"08:00-14:00",
"15:00-20:00"
],
"wednesday": [
"08:00-14:00",
"15:00-20:00"
],
"thursday": [
"08:00-14:00",
"15:00-20:00"
],
"friday": [
"08:00-14:00",
"15:00-20:00"
],
"saturday": [
"08:00-13:00"
],
"sunday": []
},
"packages": [
{
"id": 10323223,
"label_code": "LBL123",
"external_reference": "PKG-001",
"weight": {
"value": 5000,
"original_value": 5,
"unit": "kg"
},
"grams": 5000,
"length": {
"value": 50,
"original_value": 50,
"unit": "cm"
},
"width": {
"value": 30,
"original_value": 30,
"unit": "cm"
},
"height": {
"value": 20,
"original_value": 20,
"unit": "cm"
},
"temperature_min": {
"value": 2,
"original_value": 2,
"unit": "celsius"
},
"temperature_max": {
"value": 8,
"original_value": 8,
"unit": "celsius"
},
"is_flammable": false,
"is_corrosive": false,
"is_fragile": true,
"classification": "FOOD",
"un_code": "1234",
"declared_value_amount": 150,
"declared_value_currency": "ARS"
}
],
"shipment": {
"id": 100293023,
"ulid": "01GQBRNWN8ZS4X8K9WN5DFXH3Y",
"reference": "ORDER-123456",
"client_code": "SHP-CLI-001",
"external_reference": "EXT-ORDER-789",
"declared_value": 100,
"control_number": "CN-001"
},
"workflow": {
"id": 28491,
"external_reference": "WF-001",
"step_in_workflow": "Entrega",
"blueprint": {
"type": "delivery"
}
},
"merchant": {
"id": 42,
"name": "Tienda Ejemplo",
"code": "TIENDA-01"
},
"merchant_id": 1,
"groupable_by_merchant": true,
"created_at": "2024-05-21T12:00:00.000Z",
"updated_at": "2024-05-21T12:00:00.000Z"
}
]
}
}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
workflowintegerRequeridoExample:
ID del workflow
42Respuestas
200
Workflow cancelado
application/json
401
No autenticado
403
Sin permisos
404
Workflow no encontrado
post/workflows/{workflow}/cancel
POST /api/v1/workflows/{workflow}/cancel HTTP/1.1
Host: mi-organizacion.routes.zipnova.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*
{
"data": {
"workflow": {
"id": 28491,
"external_reference": "WF-001",
"current_status": "in_progress",
"blueprint": {
"id": 15,
"code": "entrega-estandar",
"steps": [
{
"id": 3,
"name": "Entrega"
}
]
},
"data": {},
"tasks": [
{
"id": "01GQBRNWN8ZS4X8K9WN5DFXH3Y",
"internal_id": 1,
"grouping_hash": "4343dsknnd9sdskd29d",
"client_code": "CLI-001",
"carrier": {
"id": 5,
"subdomain": "mi-empresa",
"name": "Mi Empresa S.A."
},
"step": {
"name": "delivery",
"display_name": "Entrega",
"complete_actions": [
{}
],
"fail_actions": [
{}
],
"cancel_actions": [
{}
]
},
"is_pickup": false,
"status": {
"id": 1,
"code": "pending",
"name": "Pendiente",
"color": "#FF5733",
"metadata": {},
"changed_at": "2024-05-21T12:00:00+00:00"
},
"address": {
"id": "01J9X2K3M4N5P6Q7R8S9T0V1W2",
"name": "Juan Pérez",
"street": "Calle del Bajo",
"street_number": "123",
"floor": "2",
"apartment": "B",
"reference": "Portón negro, timbre 2",
"zipcode": "8400",
"phone": "+5492944412345",
"email": "jperez@ejemplo.com",
"city": {
"id": 1875,
"name": "Bariloche"
},
"state": {
"id": 25,
"name": "Rio Negro"
},
"country": {
"id": 1,
"name": "Argentina",
"iso": "AR"
},
"geo_latitude": -41.133472,
"geo_longitude": -71.310936
},
"recipient_name": "Juan Pérez",
"notes": "Llamar antes de llegar",
"is_self_assignable": false,
"assigned_to_user": {
"id": 10,
"firstname": "Carlos",
"lastname": "López"
},
"should_complete_after": "2024-05-21T09:00:00.000Z",
"should_complete_before": "2024-05-21T13:00:00.000Z",
"depends_on_task_ids": [
"01GQBRNWN8ZS4X8K9WN5DFXH3Y",
"01HXYZ123456789ABCDEFGHIJK"
],
"cost": 0,
"service_time_seconds": 300,
"requirements_start": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"requirements_complete": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"requirements_fail": [
{
"type": "signature",
"label": "Firma del destinatario",
"required": true,
"value": "text"
}
],
"time_windows": {
"monday": [
"08:00-14:00",
"15:00-20:00"
],
"tuesday": [
"08:00-14:00",
"15:00-20:00"
],
"wednesday": [
"08:00-14:00",
"15:00-20:00"
],
"thursday": [
"08:00-14:00",
"15:00-20:00"
],
"friday": [
"08:00-14:00",
"15:00-20:00"
],
"saturday": [
"08:00-13:00"
],
"sunday": []
},
"packages": [
{
"id": 10323223,
"label_code": "LBL123",
"external_reference": "PKG-001",
"weight": {
"value": 5000,
"original_value": 5,
"unit": "kg"
},
"grams": 5000,
"length": {
"value": 50,
"original_value": 50,
"unit": "cm"
},
"width": {
"value": 30,
"original_value": 30,
"unit": "cm"
},
"height": {
"value": 20,
"original_value": 20,
"unit": "cm"
},
"temperature_min": {
"value": 2,
"original_value": 2,
"unit": "celsius"
},
"temperature_max": {
"value": 8,
"original_value": 8,
"unit": "celsius"
},
"is_flammable": false,
"is_corrosive": false,
"is_fragile": true,
"classification": "FOOD",
"un_code": "1234",
"declared_value_amount": 150,
"declared_value_currency": "ARS"
}
],
"shipment": {
"id": 100293023,
"ulid": "01GQBRNWN8ZS4X8K9WN5DFXH3Y",
"reference": "ORDER-123456",
"client_code": "SHP-CLI-001",
"external_reference": "EXT-ORDER-789",
"declared_value": 100,
"control_number": "CN-001"
},
"workflow": {
"id": 28491,
"external_reference": "WF-001",
"step_in_workflow": "Entrega",
"blueprint": {
"type": "delivery"
}
},
"merchant": {
"id": 42,
"name": "Tienda Ejemplo",
"code": "TIENDA-01"
},
"merchant_id": 1,
"groupable_by_merchant": true,
"created_at": "2024-05-21T12:00:00.000Z",
"updated_at": "2024-05-21T12:00:00.000Z"
}
]
}
}
}Esquemas
Última actualización