Documentos
Emisión, rectificación y acceso a documentos propios recientes.
Crear documento
Envía los datos completos del transporte. La respuesta se entrega después de generar y almacenar el PDF cifrado.
Una referencia no nula es única por organización y entorno. Repetir la referencia con los mismos datos normalizados y metadata devuelve el resultado original dentro de 24 horas (200), sin emitir otro PDF. Una creación nueva devuelve 201. Datos distintos o una referencia de otra credencial producen 409 sin divulgar documentos. Sin referencia no se garantiza deduplicación.
Una referencia cuyo resultado ha vencido devuelve 409 DOCUMENT_WINDOW_EXPIRED. Si el documento está eliminado, no se devuelve su contenido ni se reutiliza su referencia; el reintento devuelve 404. Para rectificar utiliza los endpoints PUT.
Puedes solicitar un token sk_demo_ sin una cuenta ni un alta de organización. Dura 24 horas desde su emisión y solo funciona desde la IP pública que lo solicitó. Cambiar de red o de IP requiere solicitar otro token. La demo añade demo: true, expires_at, qr_url (alias de url) y pdf_url (alias de pdf_download_url). document_locale es el idioma elegido al solicitar el token (es por defecto). Los datos y PDF temporales quedan separados del archivo real y no se cifran como los documentos reales.
Crear documento › Cuerpo de la petición
transport_dateFecha real del transporte en formato YYYY-MM-DD; no es el instante de creación del PDF.
Cargador contractual; puede ser distinto del almacén de origen y del cliente de DeCA.
Transportista que realiza efectivamente el transporte, incluido el subcontratado.
Naturaleza y peso de la mercancía, o magnitud alternativa cuando corresponda. Enviar exactamente una medida.
Vehículo efectivo; si hay remolque o semirremolque, informar sus dos campos juntos.
reference^[A-Za-z0-9-]+(?![\s…Referencia propia opcional, única por organización y entorno e impresa en el PDF. Identifica los reintentos y permite consultar por referencia. No se libera al eliminar el documento.
Autorización especial de circulación cuando sea necesaria. Omitir o enviar null si no procede.
observationsObservaciones que los intervinientes soliciten hacer constar en el documento.
Objeto JSON opcional, conservado y devuelto sin modificación semántica. No se imprime en el PDF. Máximo 16 KiB al serializarlo y 8 niveles de profundidad.
Crear documento › Respuestas
Reintento idempotente; devuelve el resultado original sin generar otro PDF.
Tabla de alternativas
| Alternativa | Criterios de selección |
|---|---|
| type = object · Campos obligatorios: uuid, reference, created_at +7 más | |
| type = object · Campos obligatorios: uuid, reference, created_at +11 más |
uuidUUID del documento emitido.
reference^[A-Za-z0-9-]+(?![\s… · obligatorioReferencia del cliente o null.
created_atInstante original de creación, en UTC.
urlURL HTTPS completa de descarga por QR, incluido su secreto. No registrar ni publicar.
pdf_download_urlURL de descarga autenticada; requiere Bearer de la credencial propietaria dentro de 24 horas.
rectifies_uuidUUID rectificado o null en una emisión inicial.
La misma metadata de la petición; null si no se proporcionó.
document_localeIdioma del PDF elegido al emitirlo según la organización. Se conserva en el resultado; cambiar el idioma de la organización no modifica documentos existentes. No cambia campos JSON ni mensajes de error de la API.
Rectificar documento
Identifica el documento anterior mediante su UUID y envía todos los datos corregidos, sin parches. Solo puede rectificarse la última versión de la misma credencial. Se permite rectificar un documento de más de 24 horas sin devolver su contenido anterior. Un documento eliminado devuelve 404 y no puede rectificarse.
Se genera un documento rectificativo con UUID, PDF y QR nuevos; el original y su QR se conservan. Entrega el nuevo PDF al conductor. El campo reference del cuerpo corresponde a la nueva versión, no al documento de la URL.
Repetir el mismo PUT con los mismos datos normalizados y metadata devuelve la rectificación ya emitida durante las 24 horas siguientes a su creación, sin generar otra versión. Esta comprobación se realiza antes de rechazar un documento ya rectificado y funciona también si el reintento identifica al mismo documento por referencia. Un cambio de datos sobre un documento ya rectificado devuelve 409. Un reintento cuyo resultado ha vencido devuelve 409 DOCUMENT_WINDOW_EXPIRED. Si la rectificación devuelta está eliminada, el reintento devuelve 404. Para otra rectificación, utiliza el UUID o la referencia de la última versión.
Parámetros de ruta
uuidUUID público del documento. Alternativamente, utiliza /api/v1/documents/ref/{reference} con el mismo método. Ejemplo: /api/v1/documents/ref/EXP-2026-004587.
Rectificar documento › Cuerpo de la petición
transport_dateFecha real del transporte en formato YYYY-MM-DD; no es el instante de creación del PDF.
Cargador contractual; puede ser distinto del almacén de origen y del cliente de DeCA.
Transportista que realiza efectivamente el transporte, incluido el subcontratado.
Naturaleza y peso de la mercancía, o magnitud alternativa cuando corresponda. Enviar exactamente una medida.
Vehículo efectivo; si hay remolque o semirremolque, informar sus dos campos juntos.
reference^[A-Za-z0-9-]+(?![\s…Referencia nueva del documento rectificativo, opcional y única por organización y entorno. No reutilizar la referencia del documento identificado en la URL.
Autorización especial de circulación cuando sea necesaria. Omitir o enviar null si no procede.
observationsObservaciones que los intervinientes soliciten hacer constar en el documento.
Objeto JSON opcional, conservado y devuelto sin modificación semántica. No se imprime en el PDF. Máximo 16 KiB al serializarlo y 8 niveles de profundidad.
Rectificar documento › Respuestas
Documento rectificativo emitido, o resultado de un reintento idéntico sin crear otra versión.
Tabla de alternativas
| Alternativa | Criterios de selección |
|---|---|
| type = object · Campos obligatorios: uuid, reference, created_at +7 más | |
| type = object · Campos obligatorios: uuid, reference, created_at +11 más |
uuidUUID del documento emitido.
reference^[A-Za-z0-9-]+(?![\s… · obligatorioReferencia del cliente o null.
created_atInstante original de creación, en UTC.
urlURL HTTPS completa de descarga por QR, incluido su secreto. No registrar ni publicar.
pdf_download_urlURL de descarga autenticada; requiere Bearer de la credencial propietaria dentro de 24 horas.
rectifies_uuidUUID rectificado o null en una emisión inicial.
La misma metadata de la petición; null si no se proporcionó.
document_localeIdioma del PDF elegido al emitirlo según la organización. Se conserva en el resultado; cambiar el idioma de la organización no modifica documentos existentes. No cambia campos JSON ni mensajes de error de la API.
Eliminar documento
Borrado lógico para corregir errores detectados al generar un documento, exclusivamente antes de entregarlo al transportista o al conductor y antes de utilizarlo en un transporte. La integración debe confirmar ambas condiciones; no basta con estar dentro del plazo. Si el documento ya se ha entregado o utilizado, debe rectificarse mediante PUT.
Se permite únicamente mientras la hora del servidor sea anterior a created_at + 2 horas; a las 2 horas exactas ya no se permite. Ni una consulta ni un reintento reinician el plazo. Cada versión utiliza su propia fecha de creación. Solo puede eliminarse la última versión de la credencial autenticada.
Se conservan el PDF, los datos y la trazabilidad, pero el documento deja de aparecer en el listado. Las consultas por UUID o referencia, la descarga autenticada, el QR y los reintentos que devolverían su contenido responden 404. La consulta de estado responde únicamente con status: deleted durante la ventana de consulta de 24 horas. La referencia sigue reservada. No hay endpoint de reactivación; el borrado no destruye el archivo para permitir una recuperación futura.
Repetir el DELETE dentro de las mismas 2 horas devuelve 204 sin cambiar la fecha de eliminación. Pasado ese plazo devuelve 409.
El primer acceso correcto al enlace QR bloquea también el borrado con 409 DOCUMENT_ALREADY_ACCESSED. Ese acceso no prueba por sí solo la realización del transporte.
Parámetros de ruta
uuidUUID público del documento. Alternativamente, utiliza /api/v1/documents/ref/{reference} con el mismo método. Ejemplo: /api/v1/documents/ref/EXP-2026-004587.
Eliminar documento › Cuerpo de la petición
reasonMotivo del error detectado al generar el documento.
confirm_not_deliveredDebe ser true para eliminar: confirma que no se ha entregado al transportista ni al conductor. false devuelve 409 DOCUMENT_ALREADY_DELIVERED.
confirm_not_usedDebe ser true para eliminar: confirma que no se ha utilizado en un transporte. false devuelve 409 DOCUMENT_ALREADY_USED.
Eliminar documento › Respuestas
Documento marcado como eliminado. Sin cuerpo de respuesta.
Listar últimos documentos
Devuelve resúmenes, sin PDF, secreto QR ni metadata. El servidor aplica siempre la ventana de 24 horas y el aislamiento de la credencial. Orden descendente por fecha de creación y UUID como desempate, paginación por página y filtros inclusivos de fecha de transporte. La ventana se evalúa en cada petición; no constituye una instantánea estable entre páginas. No permite consultar el histórico.
Los documentos eliminados no aparecen en el listado.
Parámetros de consulta
pagePágina solicitada, a partir de 1.
limitDocumentos por página, entre 1 y 100.
fromFecha de transporte mínima, inclusive. No amplía la ventana de lectura.
toFecha de transporte máxima, inclusive; igual o posterior a from.
Listar últimos documentos › Respuestas
Página de documentos recientes. Una página sin resultados tiene data vacío.
Consultar documento
Recupera el resultado original dentro de 24 horas, solo para la credencial que emitió el documento. Incluye todos los campos aceptados y normalizados y la metadata sin modificación semántica.
Un UUID o una referencia inexistente, de otra credencial o fuera de la ventana devuelve la misma respuesta 404, sin confirmar existencia ni propietario. Cada referencia identifica su propia versión y no redirige a una rectificación posterior.
Un documento eliminado devuelve 404. Para saber si está eliminado, utiliza la consulta de estado.
Parámetros de ruta
uuidUUID público del documento. Alternativamente, utiliza /api/v1/documents/ref/{reference} con el mismo método. Ejemplo: /api/v1/documents/ref/EXP-2026-004587.
Consultar documento › Respuestas
Resultado original del documento.
Tabla de alternativas
| Alternativa | Criterios de selección |
|---|---|
| type = object · Campos obligatorios: uuid, reference, created_at +7 más | |
| type = object · Campos obligatorios: uuid, reference, created_at +11 más |
uuidUUID del documento emitido.
reference^[A-Za-z0-9-]+(?![\s… · obligatorioReferencia del cliente o null.
created_atInstante original de creación, en UTC.
urlURL HTTPS completa de descarga por QR, incluido su secreto. No registrar ni publicar.
pdf_download_urlURL de descarga autenticada; requiere Bearer de la credencial propietaria dentro de 24 horas.
rectifies_uuidUUID rectificado o null en una emisión inicial.
La misma metadata de la petición; null si no se proporcionó.
document_localeIdioma del PDF elegido al emitirlo según la organización. Se conserva en el resultado; cambiar el idioma de la organización no modifica documentos existentes. No cambia campos JSON ni mensajes de error de la API.
Consultar estado
Devuelve únicamente el estado de un documento de la credencial autenticada, durante las 24 horas siguientes a su creación. Para un documento eliminado responde 200 con {"status":"deleted"}; no devuelve datos del transporte, PDF, enlace QR ni metadata. Un documento activo responde con {"status":"active"}.
Un UUID inexistente, de otra credencial o fuera de las 24 horas devuelve el mismo 404. La eliminación no amplía esa ventana.
Parámetros de ruta
uuidUUID público del documento. Alternativamente, utiliza GET /api/v1/documents/ref/{reference}/status. Ejemplo: /api/v1/documents/ref/EXP-2026-004587/status.
Consultar estado › Respuestas
Estado del documento sin datos de su contenido.
statusEstado del documento. No incluye información del transporte, PDF, QR, metadata ni fechas.
Descargar PDF
Devuelve exactamente los bytes del PDF almacenado, sin regenerarlo. Exige credencial propietaria y una antigüedad inferior a 24 horas. Esta limitación no altera la conservación legal ni la vigencia del QR.
Un documento eliminado devuelve 404 sin entregar el PDF.
Parámetros de ruta
uuidUUID público del documento. Alternativamente, utiliza GET /api/v1/documents/ref/{reference}/pdf. Ejemplo: /api/v1/documents/ref/EXP-2026-004587/pdf.
Descargar PDF › Respuestas
PDF original nativo, de hasta 5 MB. Descarga directa sin regeneración.