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:

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:

• 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

time_windowsone of · nullableOpcional

Horario semanal de la tarea.

should_complete_afterstring · date-time · nullableOpcional

Desde cuándo se puede completar la tarea. ISO 8601 con offset (Z o ±hh:mm); sin offset se toma como UTC.

Example: 2026-09-22T09:00:00-03:00

should_complete_beforestring · date-time · nullableOpcional

Hasta cuándo se puede completar la tarea. ISO 8601 con offset (Z o ±hh:mm); sin offset se toma como UTC.

Example: 2026-09-22T18:00:00-03:00

Respuestas

201

Tarea creada

application/json

successbooleanOpcionalExample: true

401

No autenticado

403

Sin permisos

422

Error de validación

post/tasks

POST /api/v1/tasks HTTP/1.1
Host: mi-organizacion.routes.zipnova.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 1473

{
  "address": {
    "id": "01J9X2K3M4N5P6Q7R8S9T0V1W2"
  },
  "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"
    }
  ],
  "external_reference": "TASK-001",
  "recipient_name": "Juan Pérez",
  "notes": "Llamar antes de llegar",
  "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": []
  },
  "should_complete_after": "2026-09-22T09:00:00-03:00",
  "should_complete_before": "2026-09-22T18:00:00-03:00"
}

{
  "success": true,
  "task": {
    "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": "[phone]",
      "email": "[e-mail]",
      "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"
  }
}

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

401

No autenticado

403

Sin permisos

get/tasks

GET /api/v1/tasks HTTP/1.1
Host: mi-organizacion.routes.zipnova.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "data": [
      {
        "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": "[phone]",
          "email": "[e-mail]",
          "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"
      }
    ],
    "links": {
      "first": "https://example.com",
      "last": "https://example.com",
      "prev": "https://example.com",
      "next": "https://example.com"
    },
    "meta": {
      "total": 150,
      "per_page": 20,
      "current_page": 1,
      "last_page": 8,
      "from": 1,
      "to": 20
    }
  }
}

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

time_windowsone of · nullableOpcional

Horario semanal de la tarea.

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

401

No autenticado

403

Sin permisos

404

Tarea no encontrada

get/tasks/{task}

GET /api/v1/tasks/{task} HTTP/1.1
Host: mi-organizacion.routes.zipnova.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "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": "[phone]",
    "email": "[e-mail]",
    "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"
}

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.

401

No autenticado

403

Sin permisos

404

Adjunto no encontrado

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

GET /api/v1/tasks/{task}/attachments/{attachment} HTTP/1.1
Host: mi-organizacion.routes.zipnova.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "group": "invoice",
  "name": "Factura.pdf",
  "mime_type": "application/pdf",
  "size": 102400,
  "created_at": "2024-05-21T12:00:00.000Z",
  "content": "Ynl0ZXM="
}

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

401

No autenticado

403

Sin permisos

404

Tarea no encontrada

post/tasks/{task}/cancel

POST /api/v1/tasks/{task}/cancel HTTP/1.1
Host: mi-organizacion.routes.zipnova.app
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 15

{
  "metadata": {}
}

{
  "success": true,
  "task": {
    "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": "[phone]",
      "email": "[e-mail]",
      "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