Documentación

El módulo de Documentación permite consultar los archivos y documentos asociados a despachos de comercio exterior gestionados por EURUS PRO®: facturas comerciales, packing lists, Bill of Lading, certificados de origen, certificados sanitarios y cualquier otro documento adjunto a un despacho.

Este módulo aplica tanto a importaciones como a exportaciones — la API no distingue el tipo de operación en sus endpoints de consulta de archivos.

Endpoints disponibles

Hay dos endpoints principales, ambos en la etiqueta Documentación de la Referencia de la API:

1. GET /dispatch/{numeroDespacho}/files Devuelve todos los documentos (o filtrados por fileTypeName) de un despacho específico del cliente.

2. GET /files Devuelve los documentos de un tipo específico (fileTypeName) emitidos en un rango de fechas para un cliente.

Y un tercero, en la etiqueta Maestros, que alimenta a los dos anteriores:

3. GET /master/file-types Devuelve los tipos documentales activos de la agencia: los valores que acepta fileTypeName. No requiere rut.

Parámetros comunes

Estos dos los exige toda llamada a la API:

Parámetro	Ubicación	Descripción
idAgencia	Path (variable de servidor)	Identificador de tu agencia EURUS PRO®. Se asigna al provisionar el acceso.
key	Query	API Key provista por EURUS PRO®. Ver Autenticación.

Y este, en los endpoints bajo /dispatch/* y en GET /files:

Parámetro	Ubicación	Descripción
rut	Query	RUT del cliente final (ver formato de RUT). Acota lo que ves: solo devuelve despachos de esa cuenta y sus documentos.

GET /master/file-types no recibe rut: el maestro es de la agencia, no de un cliente final.

Conceptos clave

Despacho

Un despacho es la unidad operativa que agrupa todos los documentos de una operación de comercio exterior. Cada despacho tiene un número (numeroDespacho) asignado por EURUS PRO® al momento de su creación.

fileTypeName

Identifica el tipo de documento dentro de un despacho. Valores actualmente habilitados en la API:

fileTypeName	Descripción
FACTURA AGENCIA	Factura emitida por la agencia EURUS PRO®.
FACTURA TERCEROS	Factura emitida por terceros (navieras, transportistas, almacenes, etc.).
NOTA DE COBRO	Nota de cobro asociada al despacho.
CERTIFICADO DE ORIGEN	Certificado de origen de la mercancía.
CONOCIMIENTO DE EMBARQUE (B/L)	Bill of Lading / conocimiento de embarque marítimo.

La lista de arriba es una referencia, no la fuente

Los valores habilitados los define cada agencia. Consúltalos con GET /master/file-types —una llamada al inicio de tu proceso— en vez de fijarlos en tu código: así los tipos que se habiliten después aparecen sin que tengas que desplegar nada.

Los cambios de cobertura se anuncian igualmente en el Changelog.

URL encoding obligatorio

Los valores de fileTypeName contienen espacios y, en algunos casos, paréntesis y barras. Por eso deben enviarse URL-encoded en la query string:

Valor	URL-encoded
FACTURA AGENCIA	FACTURA%20AGENCIA
FACTURA TERCEROS	FACTURA%20TERCEROS
NOTA DE COBRO	NOTA%20DE%20COBRO
CERTIFICADO DE ORIGEN	CERTIFICADO%20DE%20ORIGEN
CONOCIMIENTO DE EMBARQUE (B/L)	CONOCIMIENTO%20DE%20EMBARQUE%20%28B%2FL%29

Si construyes la URL con helpers como URLSearchParams (JS), params={} (httpx / requests en Python) o -d --data-urlencode (cURL), el encoding se hace automáticamente y no tienes que preocuparte. El problema aparece solo si concatenas strings crudos.

Casos de uso comunes

1. Descargar todos los documentos de un despacho conocido

Si tu ERP registra un despacho y quiere adjuntar todos sus documentos:

curl "https://api-comex.eurus.pro/z_cl_demo/v1/dispatch/123457/files?key=$API_KEY&rut=999999999"

2. Extraer todas las facturas de agencia de un mes para conciliación contable

Para un proceso batch mensual — nota el %20 en lugar del espacio:

curl "https://api-comex.eurus.pro/z_cl_demo/v1/files?key=$API_KEY&rut=999999999&startDate=2026-01-01&endDate=2026-01-31&fileTypeName=FACTURA%20AGENCIA"

O, de forma equivalente y más legible, con --data-urlencode de cURL:

curl -G "https://api-comex.eurus.pro/z_cl_demo/v1/files" \
  --data-urlencode "key=$API_KEY" \
  --data-urlencode "rut=999999999" \
  --data-urlencode "startDate=2026-01-01" \
  --data-urlencode "endDate=2026-01-31" \
  --data-urlencode "fileTypeName=FACTURA AGENCIA"

Consulta la Referencia de la API para ver todos los parámetros, esquemas de respuesta y ejemplos interactivos.