Envíos

Obtener cotizaciones de envío

post

Calcula las cotizaciones disponibles para un envío según origen, destino y paquetes.

Autorizaciones

AuthorizationstringRequerido

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

Cuerpo

originone 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).

destinationone 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).

declared_valuenumber · nullableOpcional

Valor declarado (opcional).

Example: 1500

shipper_idstring · nullableOpcional

ID del shipper. Requerido si la org es carrier.

Example: suministros

carrier_idstring · nullableOpcional

ID del carrier. Requerido si la org es shipper.

Example: transporte-rex

Respuestas

200

Cotizaciones obtenidas

application/json

401

No autenticado

403

Sin permisos

422

Error de validación

post/shipments/quotes

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

{
  "origin": {
    "id": "01J9X2K3M4N5P6Q7R8S9T0V1W2"
  },
  "destination": {
    "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"
    }
  ],
  "declared_value": 1500,
  "shipper_id": "suministros",
  "carrier_id": "transporte-rex"
}

{
  "quotes": [
    {
      "service_type_id": 5,
      "service_type_name": "Entrega estándar",
      "price": 1250.5,
      "currency": "ARS",
      "estimated_delivery_days": 3
    }
  ]
}

Crear envío

post

Crea un nuevo envío. Si la organización es carrier, shipper_id es requerido. Si es shipper, carrier_id es requerido.

Ubicación crossdock (facility, opcional). Si el tipo de servicio (según requires_pickup) pasa por un crossdock, el plan de trabajo del envío necesita saber a qué ubicación va:

con facility (código de la ubicación), se usa esa; un código que no es una ubicación crossdock del carrier hace fallar la creación;
sin facility y con una sola ubicación crossdock, se usa esa;
sin facility y con más de una, el envío se crea igual (201) pero sin plan de trabajo, y la respuesta lo avisa en warnings. Antes, ese envío se creaba y su plan de trabajo fallaba sin aviso.

Si el tipo de servicio no pasa por un crossdock, facility se ignora.

Autorizaciones

AuthorizationstringRequerido

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

Cuerpo

originone 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).

destinationone 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).

external_referencestring · máx: 50 · nullableOpcional

Referencia externa del envío.

Example: ORDER-123456

facilitystring · nullableOpcional

Código de la ubicación crossdock a la que va el envío. Opcional; sólo se usa si el tipo de servicio requiere crossdock. Con una sola ubicación se toma sola; con más de una y sin este campo, el envío se crea sin plan de trabajo y se avisa en warnings.

Example: XD-NORTE

tagsstring[] · nullableOpcional

Identificadores externos libres. Admite un prefijo de origen separado por dos puntos. La búsqueda exige el tag completo, prefijo incluido. La cantidad máxima se configura por entorno (20 por defecto).

Example: ["meli_order:46239360147","mercadolibre"]

declared_valuenumber · nullableOpcional

Valor declarado del envío.

Example: 1500

declared_value_currencystring · nullableOpcional

Moneda del valor declarado (debe ser válida para la organización).

Example: ARS

requires_pickupbooleanOpcional

Si el envío requiere pickup previo.

Default: falseExample: false

is_publicbooleanOpcional

Si el tracking del envío es público.

Default: falseExample: false

shipper_idstringOpcional

ID del shipper. Requerido si la org es carrier.

Example: suministros

carrier_idstringOpcional

ID del carrier. Requerido si la org es shipper.

Example: transporte-rex

service_type_idinteger · nullableOpcional

ID del tipo de servicio (opcional).

Example: 5

service_type_codestring · nullableOpcional

Código del tipo de servicio (alternativa a service_type_id).

Example: estandar

promised_delivery_atstring · date · nullableOpcional

Día prometido de entrega (Y-m-d), en la zona horaria del carrier. Si se envía con hora, se toma el día que es ese instante en la zona del carrier y se descarta la hora.

Example: 2024-05-25

Respuestas

201

Envío creado

application/json

successbooleanOpcionalExample: true

warningsstring[]Opcional

Sólo presente si el envío se creó con avisos, por ejemplo sin plan de trabajo porque faltó facility.

401

No autenticado

403

Sin permisos

422

Error de validación

post/shipments

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

{
  "origin": {
    "id": "01J9X2K3M4N5P6Q7R8S9T0V1W2"
  },
  "destination": {
    "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": "ORDER-123456",
  "facility": "XD-NORTE",
  "tags": [
    "meli_order:46239360147",
    "mercadolibre"
  ],
  "declared_value": 1500,
  "declared_value_currency": "ARS",
  "requires_pickup": false,
  "is_public": false,
  "shipper_id": "suministros",
  "carrier_id": "transporte-rex",
  "service_type_id": 5,
  "service_type_code": "estandar",
  "merchant": {
    "name": "Tienda Ejemplo",
    "code": "TIENDA-01"
  },
  "promised_delivery_at": "2024-05-25"
}

{
  "success": true,
  "shipment": {
    "id": 10293023,
    "ulid": "01GQBRNWN8ZS4X8K9WN5DFXH3Y",
    "external_reference": "ORDER-123456",
    "control_number": "CTL-789",
    "serviceType": {
      "id": 5,
      "name": "Entrega estándar"
    },
    "shipper": {
      "id": 35343,
      "name": "Suministros de Oficina SA",
      "subdomain": "suministros"
    },
    "carrier": {
      "id": 25343,
      "name": "Transporte Rex",
      "subdomain": "transporte-rex"
    },
    "status": {
      "code": "in_transit",
      "name": "En tránsito",
      "color": "#3B82F6",
      "substatus": {
        "code": "in_transit",
        "name": "En tránsito"
      }
    },
    "origin": {
      "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
    },
    "destination": {
      "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
    },
    "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"
      }
    ],
    "totals": {
      "total_packages": 3,
      "total_grams": 15000,
      "total_cm3": 90000
    },
    "declared_value": 100,
    "is_public": false,
    "requires_pickup": true,
    "related_shipment_id": 10293010,
    "related_type": "return",
    "finished_at": "2024-05-22T14:30:00.000Z",
    "promised_delivery_at": "2024-05-21T03:00:00+00:00",
    "label_printed_at": "2024-05-21T12:00:00.000Z",
    "shipped_at": "2024-05-21T12:00:00.000Z",
    "delivered_at": "2024-05-22T14:30:00.000Z",
    "created_at": "2024-05-21T12:00:00.000Z",
    "updated_at": "2024-05-21T12:00:00.000Z"
  },
  "warnings": [
    "text"
  ]
}

Obtener envío

get

Obtiene los detalles completos de un envío.

Autorizaciones

AuthorizationstringRequerido

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

Parámetros de ruta

shipmentintegerRequerido

ID del envío

Example: 100293023

Respuestas

200

Envío obtenido

application/json

Envío completo con todos sus datos

idinteger · int64Opcional

ID interno del envío.

Example: 10293023

ulidstringOpcional

Identificador secundario del envío.

Example: 01GQBRNWN8ZS4X8K9WN5DFXH3Y

external_referencestring · nullableOpcional

Referencia externa del envío.

Example: ORDER-123456

control_numberstring · nullableOpcional

Número de control del envío.

Example: CTL-789

declared_valuenumberOpcionalExample: 100

is_publicbooleanOpcionalExample: false

requires_pickupbooleanOpcionalExample: true

related_shipment_idinteger · nullableOpcional

ID del envío relacionado (ej. retorno o reenvío).

Example: 10293010

related_typestring · nullableOpcional

Tipo de relación con el envío asociado.

Example: return

finished_atstring · date-time · nullableOpcional

Fecha en que el envío fue finalizado.

Example: 2024-05-22T14:30:00.000Z

promised_delivery_atstring · date-time · nullableOpcional

Inicio del día prometido en la zona horaria del carrier, expresado en UTC.

Example: 2024-05-21T03:00:00+00:00

label_printed_atstring · date-time · nullableOpcionalExample: 2024-05-21T12:00:00.000Z

shipped_atstring · date-time · nullableOpcionalExample: 2024-05-21T12:00:00.000Z

delivered_atstring · date-time · nullableOpcionalExample: 2024-05-22T14:30:00.000Z

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

Envío no encontrado

get/shipments/{shipment}

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

{
  "id": 10293023,
  "ulid": "01GQBRNWN8ZS4X8K9WN5DFXH3Y",
  "external_reference": "ORDER-123456",
  "control_number": "CTL-789",
  "serviceType": {
    "id": 5,
    "name": "Entrega estándar"
  },
  "shipper": {
    "id": 35343,
    "name": "Suministros de Oficina SA",
    "subdomain": "suministros"
  },
  "carrier": {
    "id": 25343,
    "name": "Transporte Rex",
    "subdomain": "transporte-rex"
  },
  "status": {
    "code": "in_transit",
    "name": "En tránsito",
    "color": "#3B82F6",
    "substatus": {
      "code": "in_transit",
      "name": "En tránsito"
    }
  },
  "origin": {
    "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
  },
  "destination": {
    "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
  },
  "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"
    }
  ],
  "totals": {
    "total_packages": 3,
    "total_grams": 15000,
    "total_cm3": 90000
  },
  "declared_value": 100,
  "is_public": false,
  "requires_pickup": true,
  "related_shipment_id": 10293010,
  "related_type": "return",
  "finished_at": "2024-05-22T14:30:00.000Z",
  "promised_delivery_at": "2024-05-21T03:00:00+00:00",
  "label_printed_at": "2024-05-21T12:00:00.000Z",
  "shipped_at": "2024-05-21T12:00:00.000Z",
  "delivered_at": "2024-05-22T14:30:00.000Z",
  "created_at": "2024-05-21T12:00:00.000Z",
  "updated_at": "2024-05-21T12:00:00.000Z"
}

Seguimiento de envío

get

Retorna el historial de estados del envío ordenado cronológicamente.

Autorizaciones

AuthorizationstringRequerido

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

Parámetros de ruta

shipmentintegerRequerido

ID del envío

Example: 100293023

Respuestas

200

Historial de seguimiento

application/json

401

No autenticado

403

Sin permisos

404

Envío no encontrado

get/shipments/{shipment}/tracking

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

{
  "tracking": [
    {
      "status": {
        "code": "in_transit",
        "name": "En tránsito"
      },
      "substatus": {
        "code": "in_transit",
        "name": "En tránsito"
      },
      "occurred_at": "2024-05-21T12:00:00Z",
      "comments": "El envío ha sido despachado",
      "metadata": {}
    }
  ]
}

Seguimiento masivo de envíos

post

Retorna el historial de seguimiento para múltiples envíos en una sola llamada.

Autorizaciones

AuthorizationstringRequerido

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

Cuerpo

shipmentsinteger[]Requerido

IDs de los envíos a consultar.

Example: [100293023,100293024,100293025]

Respuestas

200

Seguimiento masivo

application/json

401

No autenticado

422

Error de validación

post/shipments/tracking/bulk

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

{
  "shipments": [
    100293023,
    100293024,
    100293025
  ]
}

{
  "tracking": [
    {
      "shipment_id": 100293023,
      "tracking": [
        {
          "status": {
            "code": "in_transit",
            "name": "En tránsito"
          },
          "substatus": {
            "code": "in_transit",
            "name": "En tránsito"
          },
          "occurred_at": "2024-05-21T12:00:00Z",
          "comments": "El envío ha sido despachado",
          "metadata": {}
        }
      ]
    }
  ]
}

Obtener etiquetas del envío

get

Genera y retorna las etiquetas del envío en formato PDF, PNG o ZPL.

Autorizaciones

AuthorizationstringRequerido

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

Parámetros de ruta

shipmentintegerRequerido

ID del envío

Example: 100293023

Parámetros de consulta

formatstring · enumRequerido

Formato de salida de la etiqueta

Valores posibles:

outputstring · enumOpcional

Modo de salida: base64 retorna el archivo codificado en base64 (por defecto), stream lo retorna como stream, download como descarga.

Default: base64Valores posibles:

Respuestas

200

Etiquetas generadas. Para output=base64 (por defecto), retorna JSON con las etiquetas codificadas. Para output=stream o download, retorna el archivo binario directamente (no JSON).

Respuesta JSON cuando output=base64 (por defecto).

401

No autenticado

403

Sin permisos

404

Envío no encontrado

422

Formato inválido

get/shipments/{shipment}/documentation/labels

GET /api/v1/shipments/{shipment}/documentation/labels?format=pdf HTTP/1.1
Host: mi-organizacion.routes.zipnova.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "data": {
    "file": "Ynl0ZXM=",
    "files": [
      "Ynl0ZXM="
    ]
  }
}

Listar adjuntos del envío

get

Retorna la lista de archivos adjuntos de todas las tareas del envío.

Autorizaciones

AuthorizationstringRequerido

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

Parámetros de ruta

shipmentintegerRequerido

ID del envío

Example: 100293023

Respuestas

200

Lista de adjuntos

application/json

401

No autenticado

403

Sin permisos

404

Envío no encontrado

get/shipments/{shipment}/attachments

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

{
  "attachments": [
    {
      "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"
    }
  ]
}

Obtener adjunto del envío

get

Retorna el contenido de un adjunto específico del envío, 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

shipmentintegerRequerido

ID del envío

Example: 100293023

attachmentstring · uuidRequerido

UUID del adjunto

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

Respuestas

200

Adjunto obtenido con contenido en base64

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/shipments/{shipment}/attachments/{attachment}

GET /api/v1/shipments/{shipment}/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 envío

post

Cancela un envío. Cancela automáticamente todas las tareas y workflows pendientes asociados.

Autorizaciones

AuthorizationstringRequerido

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

Parámetros de ruta

shipmentintegerRequerido

ID del envío

Example: 100293023

Respuestas

200

Envío cancelado

application/json

successbooleanOpcionalExample: true

401

No autenticado

403

Sin permisos

404

Envío no encontrado

422

El envío no puede cancelarse en su estado actual

post/shipments/{shipment}/cancel

POST /api/v1/shipments/{shipment}/cancel HTTP/1.1
Host: mi-organizacion.routes.zipnova.app
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "success": true,
  "shipment": {
    "id": 10293023,
    "ulid": "01GQBRNWN8ZS4X8K9WN5DFXH3Y",
    "external_reference": "ORDER-123456",
    "control_number": "CTL-789",
    "serviceType": {
      "id": 5,
      "name": "Entrega estándar"
    },
    "shipper": {
      "id": 35343,
      "name": "Suministros de Oficina SA",
      "subdomain": "suministros"
    },
    "carrier": {
      "id": 25343,
      "name": "Transporte Rex",
      "subdomain": "transporte-rex"
    },
    "status": {
      "code": "in_transit",
      "name": "En tránsito",
      "color": "#3B82F6",
      "substatus": {
        "code": "in_transit",
        "name": "En tránsito"
      }
    },
    "origin": {
      "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
    },
    "destination": {
      "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
    },
    "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"
      }
    ],
    "totals": {
      "total_packages": 3,
      "total_grams": 15000,
      "total_cm3": 90000
    },
    "declared_value": 100,
    "is_public": false,
    "requires_pickup": true,
    "related_shipment_id": 10293010,
    "related_type": "return",
    "finished_at": "2024-05-22T14:30:00.000Z",
    "promised_delivery_at": "2024-05-21T03:00:00+00:00",
    "label_printed_at": "2024-05-21T12:00:00.000Z",
    "shipped_at": "2024-05-21T12:00:00.000Z",
    "delivered_at": "2024-05-22T14:30:00.000Z",
    "created_at": "2024-05-21T12:00:00.000Z",
    "updated_at": "2024-05-21T12:00:00.000Z"
  }
}

AnteriorOrganizaciones

SiguienteWorkflows

Última actualización hace 3 meses