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

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:

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
destinationone 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
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
post/shipments/quotes

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.

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:

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
destinationone 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 · máx: 50 · nullableOpcional

Referencia externa del envío.

Example: ORDER-123456
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-time · nullableOpcional

Fecha prometida de entrega.

Example: 2024-05-25T18:00:00.000Z
Respuestas
201

Envío creado

application/json
successbooleanOpcionalExample: true
post/shipments

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 · nullableOpcionalExample: 2024-05-21T18:00:00.000Z
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
get/shipments/{shipment}

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
get/shipments/{shipment}/tracking

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
post/shipments/tracking/bulk

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

get/shipments/{shipment}/documentation/labels

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

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.

get/shipments/{shipment}/attachments/{attachment}

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
post/shipments/{shipment}/cancel

Última actualización