Sistema de gestión de paquetería · Manual de referencia y capacitación
Versión del manual 3.1 · Un solo documento con cuatro apartados, uno por cada perfil que usa la plataforma.
En esta versión el manual se divide en cuatro partes, cada una desarrollada a detalle: el apartado del chofer de reparto (la app de campo), el del Portal del cliente, el del administrador (el panel de administración) y el de herramientas para el desarrollador (la integración por API).
Elige tu apartado
La plataforma la usan cuatro perfiles distintos. Cada uno tiene su propio apartado en este manual. Toca el que te corresponde para ir directo a su contenido.
Apartado 1 de 3 · Manual de la plataforma
Guía operativa de campo para el operador de ruta y almacén.
Opera (web) es la aplicación móvil de campo del sistema de paquetería. Está diseñada para usarse desde el teléfono del operador y concentra todo lo que necesitas hacer fuera de la oficina: recoger paquetes en domicilios de clientes, salir a entregar en ruta, registrar la evidencia de cada entrega, gestionar intentos y devoluciones y registrar el ingreso de guías al almacén (CEDIS).
El operador es la persona que mueve físicamente los paquetes y registra en el sistema cada paso. Hay dos perfiles de trabajo que la misma app cubre:
Conduce un vehículo. Recoge paquetes en los domicilios (recolecciones), los entrega a los consignatarios (ruta y entregas) y devuelve lo no entregado. Necesita iniciar una jornada con vehículo y ruta.
Trabaja en el CEDIS. Escanea las guías que llegan para registrar su ingreso al centro de distribución. No necesita vehículo ni ruta.
Cada guía (paquete) recorre una cadena de eventos. Tú, como operador, eres quien confirma los eslabones marcados en azul:
Cuando un paquete no se puede entregar, en lugar de «Entregado» se registra un intento, un rechazo o una devolución, también con su evidencia (ver capítulo 8).
Cada vez que escaneas, el sistema registra un evento con hora y cuando es posible tu ubicación. Ese historial es lo que ve la administración, el cliente en su portal y quien audita la operación. Por eso escanear correctamente no es un trámite: es la fuente de la verdad de dónde está cada paquete.
💡 El término resaltado «cuando es posible» se explica en la sección Preguntas clave (FAQ) y en Solución de problemas: hay situaciones en las que el teléfono no puede aportar la ubicación (GPS apagado, permiso bloqueado o sin señal). En esos casos el evento igual se registra, pero sin coordenadas.
Opera (web) es una aplicación web instalable (PWA): se abre desde el navegador, pero puedes «instalarla» para que quede como un ícono en tu pantalla de inicio y se abra a pantalla completa, como cualquier app.
Tras iniciar sesión llegas al selector (la pantalla de acceso a módulos). Elige según tu trabajo del día:
Recolecciones, ruta, entregas y devoluciones. Requiere elegir vehículo y ruta. Te lleva a iniciar la jornada.
Escanear guías para registrar su ingreso al CEDIS. No requiere vehículo ni ruta, pero sí debes seleccionar el CEDIS donde ingresarán las guías antes de escanear. Solo verás los CEDIS habilitados para tu usuario.
No siempre pasas por el selector. Si ya venías trabajando y vuelves a abrir Opera (web) (porque se apagó la pantalla, la minimizaste o se recargó), la app te devuelve directo a lo que tenías abierto para que no reconfigures nada:
| Situación | A dónde te lleva |
|---|---|
| Tienes una jornada de ruta activa | Al Tablero (no vuelve a pedir vehículo ni ruta) |
| Tienes una sesión de almacén activa | A la pantalla de Ingreso a CEDIS, en el mismo CEDIS |
| No tienes ninguna sesión abierta | Al selector de modo (¿qué vas a hacer hoy?) |
Si tienes las dos cosas activas a la vez, la jornada de ruta manda: abre en el Tablero. El almacén sigue guardado; para ir a él usa la flecha de volver → Almacén.
Es tu pantalla de control. En la parte superior te saluda por tu nombre («Bienvenido, …») y muestra:
| Indicador | Qué significa |
|---|---|
| Entregas | Paquetes que ya entregaste en esta jornada. |
| Por recolectar | Paquetes asignados que aún no recoges. |
| Por entregar | Paquetes que llevas contigo y debes entregar. |
| Recolectados a CEDIS | Paquetes que recolectaste (recolección realizada) y traes contigo; falta ingresarlos al CEDIS. |
| Por devolver a CEDIS | Paquetes que no lograste entregar en ruta (devoluciones) y debes regresar al CEDIS. |
Son cinco indicadores. «Recolectados a CEDIS» y «Por devolver a CEDIS» están separados para que distingas de un vistazo lo que falta ingresar (lo que recogiste) de lo que falta devolver (lo que no entregaste). Mientras el resumen carga, verás un esqueleto del mismo tamaño para que la pantalla no «salte».
También ves un desglose de entregas por cliente.
Si tienes paquetes pendientes, debajo del resumen aparece un aviso amarillo que ya no es un texto fijo: es una lista dinámica que te dice exactamente qué hacer con cada grupo antes de terminar la jornada. Según lo que tengas pendiente, verás uno o varios de estos puntos:
La lista se arma sola: solo muestra los pasos que de verdad te faltan. Cuando todos desaparecen, ya puedes terminar la jornada.
| Botón | Función |
|---|---|
| 🚚 Recolecciones | Recoger paquetes. Muestra una insignia con las recolecciones pendientes y listas. |
| 🗺️ Ruta | Capturar la salida a ruta y ver el orden de entregas. |
| 📦 Entregas Nuevo | Capturar la evidencia de entrega de tus paquetes (cap. 7). Muestra una insignia con los que tienes por entregar. |
| ↩️ Intentos y devoluciones Nuevo | Registrar intentos de entrega, rechazos y devoluciones al remitente (cap. 8). |
| 📥 Mis paquetes Nuevo | Ya habilitado: el inventario de guías de tu jornada, con búsqueda y filtros (cap. 9). Muestra el total de pendientes. |
| 🕑 Mis jornadas | Historial de tus jornadas con horas y ubicaciones. |
| Terminar jornada | Cierra el turno (sujeto a liquidación, cap. 11). |
Dentro de cada módulo (Recolecciones, Ruta, Entregas, Intentos y devoluciones…) verás arriba a la izquierda un botón ☰. Ábrelo para desplegar un menú lateral que te deja saltar directo a otro módulo sin tener que volver al tablero ni al acceso a módulos.
Recolectar = ir a un domicilio del cliente remitente y recoger los paquetes que van a enviarse. Cada tanda de paquetes de un cliente viene agrupada en un manifiesto de recolección (con su folio).
Lista los manifiestos de recolección asignados a tu vehículo. Cada tarjeta muestra folio, cliente, número de guías, peso total, fecha de creación e instrucciones especiales (si las hay). Con tres botones:
| Botón | Para qué sirve |
|---|---|
| 📍 Ubicación | Abre la dirección del cliente remitente en el mapa para que llegues. |
| ▦ Escanear | Abre el escáner para registrar los paquetes que recoges. Al abrirlo, la app envía tu ubicación GPS. |
| ✔ Cerrar | Finaliza la recolección (ver 5.5). |
Si una recolección todavía no está en tu lista, puedes tomarla tú mismo:
El escáner es el corazón del trabajo. Tiene dos modos: entrada (teclear o usar una pistola lectora) y cámara.
Si un paquete de la lista no existe, no está listo o el cliente lo canceló, márcalo como no recolectado. El sistema registra ese estado para que no quede como pendiente eterno.
Cuando hay una anomalía que la administración debe conocer (paquete dañado, mal embalado, dirección incorrecta, etc.):
Cerrar registra el evento «Manifiesto cerrado» y da por finalizada la recolección. Solo es posible cuando todas las guías ya fueron procesadas (recolectadas o marcadas como no recolectadas).
Los paquetes que ya están en el CEDIS se agrupan en manifiestos de ruta para salir a entregar. En este módulo capturas la salida a ruta y sigues el orden de paradas. La entrega en sí (con su evidencia) se registra en el módulo Entregas (cap. 7).
Muestra los manifiestos de ruta con folio, nombre de ruta, CEDIS de origen, número de guías, peso y un indicador de progreso: Todas capturadas o N por capturar.
El botón Ruta abre la hoja con los puntos de entrega únicos (por destino). Ahí puedes:
Al cerrar se registra «Manifiesto cerrado». Pon atención a las guías sin capturar:
Una vez que saliste a ruta, al llegar a cada parada entregas los paquetes al consignatario y registras la entrega en el módulo Entregas (cap. 7), donde capturas quién recibe y la evidencia (firma o foto). Lo que no logres entregar se gestiona en Intentos y devoluciones (cap. 8) y, si aplica, queda como Por devolver a CEDIS para liquidarlo (cap. 11).
Este módulo es donde confirmas en el sistema que entregaste un paquete y capturas la evidencia de esa entrega: quién lo recibió y su firma electrónica o la foto de la guía firmada. Sustituye y amplía lo que antes era solo «marcar entregado».
Al abrir Entregas eliges cómo vas a capturar:
Escaneas (o tecleas) la guía de un paquete, capturas su evidencia y confirmas. Ideal para entregas sueltas.
Capturas el folio de una guía madre y la app trae todas sus guías relacionadas. Las escaneas juntas y las confirmas con una sola evidencia. Ideal para entregas de muchos paquetes al mismo destinatario.
Tanto por guía como por guía madre, la evidencia es la misma. Los campos con * son obligatorios cuando el evento confirma la entrega:
| Campo | Qué capturas |
|---|---|
| Evento a registrar * | El evento de entrega (viene ya seleccionado el que confirma la entrega). Según tu operación puede haber más de una opción. |
| Nombre de quien recibe * | El nombre completo de la persona que recibe el paquete. |
| Comentarios | Notas de la entrega (opcional). |
| Evidencia de confirmación * | Según la configuración de tu empresa: firma electrónica de quien recibe (firmas con el dedo en la pantalla) o foto de la guía firmada (tomas la foto con la cámara). |
| Fotos extra | Hasta 5 fotos adicionales (paquete en el domicilio, etc.). Opcionales. |
| Ubicación de la entrega | Coordenadas del punto de entrega. Obligatoria en guía madre; toca «Capturar ubicación». |
Al confirmar, la guía registra su evento de entrega con: nombre de quien recibe, comentarios, firma o foto, fotos extra y —cuando fue posible— la ubicación. La entrega se refleja de inmediato en tu resumen de jornada (contador de Entregas y entregas por cliente) y el paquete sale del contador «Por entregar».
No todo se entrega a la primera. Cuando el destinatario no está, rechaza el paquete o hay que devolverlo al remitente, este módulo deja constancia de lo ocurrido con su evidencia. Funciona igual que Entregas, pero registra intentos de entrega, rechazos y devoluciones en vez de una entrega confirmada.
Los eventos exactos disponibles los define tu operación; la app te muestra los que aplican al elegir el evento a registrar.
Es el mismo flujo del módulo Entregas, con Por guía y Por guía madre:
Antes decía «Próximamente»; ya está habilitado. «Mis paquetes» es el inventario completo de guías de tu jornada: qué traes, en qué estado está cada una y dónde. Es tu lista de verificación para saber qué te falta liquidar.
| Grupo | Qué agrupa |
|---|---|
| Por entregar | Los que llevas y debes entregar. |
| Por recolectar | Los asignados que aún no recoges. |
| Recolectados a CEDIS | Los que recogiste y falta ingresar al CEDIS. |
| Por devolver a CEDIS | Devoluciones que debes regresar al CEDIS. |
| Entregados | Los que ya entregaste en esta jornada. |
| Otro estado | Cualquier otro estado. |
Para no saturar el teléfono, la lista se muestra por bloques; usa «Ver más» para cargar el resto.
Este modo registra que las guías llegaron físicamente al centro de distribución. Es independiente del vehículo y la ruta: puedes usarlo aunque no tengas jornada de ruta abierta.
El ingreso a CEDIS es la «puerta de entrada» al almacén: sin él, una guía no puede asignarse a un manifiesto de ruta para salir a entregar. Si una guía no se escanea al llegar, quedará atascada en un estado anterior y nadie podrá programar su entrega. Además, es la misma acción con la que liquidas tanto lo recolectado como lo que traes por devolver (cap. 11).
Al pulsar Terminar jornada, la app registra la hora y ubicación de salida y te regresa al selector de modo.
Aparecerá el aviso «No puedes terminar la jornada» con el desglose de lo que falta:
| Pendiente | Cómo se liquida |
|---|---|
| Por recolectar | Ve y recógelo, o márcalo como no recolectado. |
| Por entregar | Entrégalo al consignatario y registra la evidencia en Entregas (cap. 7). Si no se pudo, registra el intento/devolución (cap. 8). |
| Por devolver a CEDIS | Lo que no entregaste (devoluciones): regrésalo al almacén y escanéalo en Almacén → Ingreso a CEDIS. |
Lo que traes recolectado (pendiente de ingresar al CEDIS) también debe liquidarse escaneándolo en Almacén → Ingreso a CEDIS. El aviso enumera solo los pasos que aún te faltan, igual que la guía dinámica del tablero (cap. 4.2).
Una vez que todos los contadores llegan a cero, el botón Terminar jornada funciona y cierras el turno.
En campo la señal falla. Opera (web) está pensada para seguir funcionando sin internet y subir todo cuando vuelva la conexión.
El tablero muestra el estado de tu ubicación. El sistema la usa para registrar dónde inicias/terminas jornada, desde dónde recolectas y dónde entregas. La geolocalización es la del navegador (no depende de ninguna app de mapas externa).
| Indicador | Significado | Qué hacer |
|---|---|---|
| Activada | Permiso concedido y el equipo entrega posición. | Nada, todo correcto. |
| Sin activar | Aún no has concedido el permiso. | Toca «activar» y acepta el diálogo del navegador. |
| Desactivada | Permiso ok, pero el GPS del teléfono está apagado. | Enciende la ubicación del dispositivo. |
| Bloqueada | El permiso fue denegado/bloqueado. | Actívalo en los ajustes de permisos del navegador para este sitio. |
| No disponible | El equipo/navegador no soporta geolocalización. | Usa un dispositivo compatible. |
Estas son las palabras que verás en la app y en el historial de cada guía.
| Término | Qué es |
|---|---|
| Guía | El paquete y su etiqueta con código. La unidad que se rastrea. |
| Guía madre | Una guía que agrupa varias guías relacionadas (por ejemplo, muchos paquetes al mismo destino). Permite escanear y entregar/devolver todo el grupo junto. |
| Código de rastreo | El código (QR o barras) que escaneas del paquete. |
| Folio | El identificador de un manifiesto o de una guía madre. |
| Manifiesto de recolección | Grupo de guías a recoger de un cliente remitente. |
| Manifiesto de ruta | Grupo de guías que salen del CEDIS a entregarse. |
| Evidencia de entrega | Lo que respalda una entrega: nombre de quien recibe, firma electrónica o foto de la guía firmada, fotos extra y ubicación. |
| Firma electrónica | La firma que el destinatario traza con el dedo en la pantalla al recibir. |
| Consignatario | Quien recibe el paquete (destinatario). |
| Remitente | Quien envía el paquete (cliente que recolectas). |
| CEDIS | Centro de distribución (almacén). |
| Jornada | Tu turno de trabajo con un vehículo y una ruta. |
| Liquidar | Resolver todos tus paquetes (entregar o devolver) antes de cerrar la jornada. |
| Evento | Cuándo ocurre |
|---|---|
| Documentado | La guía se creó/confirmó en el sistema. |
| Incluida en manifiesto de recolección | Se agregó a una recolección. |
| Recolectado | La escaneaste al recogerla. (Tú) |
| No recolectado | La marcaste como no recogida. (Tú) |
| Ingresó a CEDIS | Se escaneó al llegar al almacén. (Tú/almacén) |
| Asignado a manifiesto de ruta | Programada para salir a entregar. |
| Salida a ruta | La escaneaste al cargarla para entregar. (Tú) |
| No se capturó la guía para su salida a ruta | Se cerró el manifiesto sin escanearla; debe reingresar a CEDIS. |
| Entregado | El consignatario recibió el paquete; capturaste la evidencia (firma o foto). (Tú) |
| Intento de entrega | Fuiste al domicilio pero no se pudo entregar; quedó constancia con evidencia. (Tú) |
| Rechazo / Devolución | El destinatario rechazó el paquete o se devuelve al remitente. (Tú) |
| Problema / incidencia | Reportaste una anomalía (con nota y fotos). (Tú) |
Los nombres exactos de los eventos de entrega, intento, rechazo y devolución dependen de la configuración de tu empresa; la app te muestra los que aplican al capturar.
| Activo | En curso; puedes escanear, capturar y cerrar. |
| Cerrado | Finalizado. Ya no se modifica. |
| Cancelado | Anulado por administración. Ya no se opera. |
1) Abro Opera → inicio sesión → elijo Operador de ruta.
2) Selecciono mi vehículo y mi ruta → Iniciar jornada. Confirmo que el nombre del operador sea el mío y que «Mi ubicación» diga Activada.
3) Entro a Recolecciones. Para cada cliente: toco Ubicación para llegar, toco Escanear y capturo todos los paquetes, y cierro la recolección.
4) Regreso al CEDIS y (en modo Almacén o según proceso) las guías se registran como Ingresó a CEDIS.
5) Para salir a entregar: entro a Ruta, abro Ruta (N) para ver el orden de paradas, Capturo las guías que cargo y salgo.
6) En cada parada abro Entregas, escaneo la guía, capturo quién recibe + firma/foto y confirmo. Lo que no puedo entregar lo registro en Intentos y devoluciones.
7) Regreso las devoluciones al CEDIS (Ingreso a CEDIS), verifico que el resumen esté en cero pendientes y pulso Terminar jornada.
Entro a Entregas → Por guía madre, capturo el folio de la guía madre y la app trae sus guías relacionadas. Escaneo cada una (veo el avance «8/10»). Toco Confirmar entrega, capturo el nombre de quien recibe, la firma (o foto), la ubicación y confirmo. Las 10 guías quedan entregadas con la misma evidencia.
Abro Intentos y devoluciones → Por guía, escaneo la guía y elijo el evento (intento o rechazo/devolución). Tomo una foto de evidencia (domicilio cerrado, por ejemplo) y Registro evento. Si es devolución, quedará como Por devolver a CEDIS para ingresarlo al almacén.
Abro Mis paquetes, filtro por Por entregar para ver lo que me falta entregar, y busco una guía por su código para confirmar su estado. Si veo la sección «Otros», recuerdo que esos están en otro vehículo y no los puedo operar en esta jornada.
Escaneo los que sí existen. Los que faltan los marco como No recolectar. Si algo es anómalo (paquete listado pero cancelado, o dañado), uso Reportar problema con foto. Luego cierro la recolección: se permite porque todas las guías quedaron procesadas (recolectadas o no recolectadas).
Sigo escaneando las guías relacionadas: el avance se guarda en el teléfono. Cuando vuelve la señal, entro a Entregas → Por guía madre, en «Guías madre en curso» toco la mía para reanudarla y la confirmo con la evidencia (que sí requiere conexión).
El aviso amarillo del tablero me arma una lista con lo que me falta. Reviso cada punto: si dice Por entregar, voy a Entregas; si dice Recolectados a CEDIS, debo ingresar al almacén lo que recogí; si dice Por devolver a CEDIS, debo regresar las devoluciones. Lo recolectado y las devoluciones se registran escaneando en Almacén → Ingreso a CEDIS. Cuando la lista queda vacía, cierro el turno.
Desde el tablero toco la flecha para volver al acceso a módulos (sin cerrar mi jornada). Elijo Almacén — Ingreso a CEDIS, selecciono el CEDIS y escaneo las guías que llegan. Al terminar, vuelvo y mi jornada de ruta sigue activa.
La app me advirtió cuántas guías sin capturar pasarían a «No se capturó… para su salida a ruta». Esas guías deben reingresar a CEDIS para reprogramarse. Lección: escanear todo lo que realmente sale antes de cerrar.
¿Dónde marco un paquete como entregado ahora?
En el módulo Entregas (cap. 7). Escaneas la guía, capturas quién recibe y la firma electrónica o la foto de la guía firmada, y confirmas. Ya no es solo «marcar entregado»: queda la evidencia.
¿Cuál es la diferencia entre «Entregas» e «Intentos y devoluciones»?
Entregas confirma que el paquete llegó a su destinatario. Intentos y devoluciones deja constancia de lo contrario: un intento fallido, un rechazo o una devolución al remitente. Ambos usan el mismo flujo (por guía o por guía madre) y capturan evidencia.
¿Qué es una «guía madre» y cuándo la uso?
Es una guía que agrupa varias guías relacionadas (por ejemplo, muchos paquetes al mismo destino). En Entregas o Devoluciones eliges Por guía madre, capturas su folio, escaneas todas sus guías y las confirmas juntas con una sola evidencia.
¿Firmo en la pantalla o tomo foto?
Depende de la configuración de tu empresa. La app te mostrará el recuadro de firma electrónica (el destinatario firma con el dedo) o el botón para tomar foto de la guía firmada. Sin esa evidencia, no se puede confirmar la entrega.
Me equivoqué al capturar la firma.
Toca Borrar firma y pídele a la persona que firme de nuevo antes de confirmar.
¿Para qué sirve «Mis paquetes»?
Es el inventario de guías de tu jornada. Puedes buscar por código, filtrar por estado (por entregar, por recolectar, etc.) y ver el detalle de cada paquete. Es tu lista para saber qué te falta liquidar.
En «Mis paquetes» veo una sección «Otros», ¿qué es?
Son guías que tienes asignadas en otro vehículo, no en el de tu jornada actual. Solo las puedes consultar; para operarlas debes cambiar de vehículo o pedir al administrador que las reasigne.
¿Cómo salto de un módulo a otro sin volver al inicio?
Usa el botón ☰ (menú de módulos) arriba a la izquierda de cada módulo. Te lleva directo a Recolecciones, Ruta, Entregas, Intentos y devoluciones o al panel, sin cerrar tu jornada.
El nombre que aparece arriba no es el mío.
Significa que estás usando la sesión de otra persona. Toca Salir desde el acceso a módulos e inicia sesión con tu propio usuario antes de escanear nada.
¿Puedo capturar entregas sin internet?
El escaneo de una guía madre sí se guarda sin señal, pero confirmar con evidencia (firma/fotos) requiere conexión, porque las imágenes se suben en ese momento. Para recolecciones e ingreso a CEDIS sí puedes seguir escaneando offline.
¿Puedo trabajar sin internet?
Sí para escanear recolecciones, ruta e ingreso a CEDIS: todo se guarda en el teléfono y se sube al reconectarte. Espera a que los pendientes lleguen a 0 antes de cerrar.
¿Qué escaneo, el QR o el código de barras?
El que tenga configurado tu empresa. La app ya viene ajustada al tipo correcto; solo apunta al código del paquete.
Escaneé un paquete dos veces, ¿pasa algo?
No. La app avisa con doble pitido y vibración y no lo cuenta doble.
¿Por qué no me deja terminar la jornada?
Porque tienes paquetes pendientes (por recolectar, entregar o devolver a CEDIS). Debes liquidarlos primero. Es el candado de liquidación.
¿Puedo cambiar al modo almacén sin perder mi ruta?
Sí. Vuelve al acceso a módulos con la flecha (no con «Salir»); tu jornada sigue activa.
¿Puedo capturar un manifiesto de una ruta distinta a la mía?
No. Solo capturas manifiestos de la ruta con la que iniciaste la jornada. Los de otra ruta solo los puedes ver.
Cerré una recolección/manifiesto por error, ¿cómo lo reabro?
No se puede reabrir: el cierre es definitivo. Contacta a tu administrador para que corrija desde el sistema web.
La app dice «Mi ubicación: Bloqueada».
El permiso está denegado. Actívalo en los ajustes de permisos del navegador para este sitio y enciende el GPS del teléfono.
Entré a Almacén pero no puedo escanear todavía.
Primero debes seleccionar el CEDIS donde ingresarán las guías. El escáner se abre después de elegir el CEDIS. Recuerda que solo aparecen los CEDIS habilitados para tu usuario. Si la lista sale vacía, no tienes ningún CEDIS habilitado: pídeselo a tu administrador.
Soy administrador o supervisor, ¿cómo abro Opera (web)?
Al iniciar sesión con un rol distinto de operador de ruta entras al panel de administración. Desde ahí, en el menú lateral, toca la opción «Opera (web)» para abrir la app de campo. El operador de ruta, en cambio, entra directo a Opera (web) sin pasar por el panel.
No aparece mi vehículo, mi ruta o el CEDIS.
Esos catálogos los administra la oficina. Pide al administrador que los registre o te los asigne. En el caso del CEDIS, además, solo verás los que estén habilitados para tu usuario según tus permisos: si falta uno, el administrador debe habilitártelo.
¿Se ve dónde estuve?
Sí. La jornada guarda ubicación de inicio y fin (con enlace al mapa), las recolecciones envían tu GPS y las entregas pueden guardar la ubicación del punto de entrega. Es respaldo de tu trabajo.
¿Qué significa que la ubicación se registra «cuando es posible»?
El evento (recolección, entrega, ingreso, etc.) siempre se registra con su fecha y hora. La ubicación, en cambio, solo se añade cuando el teléfono puede aportarla. No es posible cuando el GPS está apagado, el permiso está Bloqueado o Sin activar, o no hay señal en ese momento. En esos casos el registro queda sin coordenadas (pero con hora). Para que tus eventos lleven ubicación, mantén el GPS encendido y el permiso en «Activada» (cap. 13).
| Síntoma | Qué hacer |
|---|---|
| La cámara no abre o no lee el código | Verifica el permiso de cámara del navegador, limpia el lente, mejora la luz. Usa el modo de entrada manual tecleando el código. |
| El pitido no suena | Toca una vez la pantalla del escáner (activa el audio) y sube el volumen del teléfono. |
| No me deja confirmar la entrega | Falta un dato obligatorio: el nombre de quien recibe o la evidencia (firma o foto). En guía madre, también la ubicación. Complétalos y vuelve a confirmar. |
| «No se pudo subir la evidencia» | La firma/fotos se suben al confirmar y eso requiere señal. Busca conexión y vuelve a intentar; el escaneo de la guía madre no se pierde. |
| La guía no aparece al escanear en Entregas | Confirma que sea la guía correcta y que ya tuvo salida a ruta. Revísala en Mis paquetes. |
| La lista no se actualiza | Usa el botón Actualizar. Si estás sin señal, verás datos guardados. |
| Escaneos pendientes que no suben | Confirma que tienes señal; toca el banner azul para forzar la sincronización. No cierres la app hasta que llegue a 0. |
| No inicia sesión | Revisa credenciales; pide restablecer contraseña al administrador. |
| La app se ve rara o desactualizada | Ciérrala por completo y vuelve a abrirla con conexión para que cargue la última versión. |
| Mis eventos quedan «sin ubicación» (registro «cuando es posible») | El evento sí quedó guardado con su hora, pero sin coordenadas porque el teléfono no pudo aportar la posición. Revisa el indicador Mi ubicación del tablero: si está Bloqueada o Sin activar/Desactivada, activa el permiso y enciende el GPS (cap. 13). Sin señal también impide la ubicación momentáneamente. |
Apartado 2 de 3 · Manual de la plataforma
Apartado desarrollado por completo en esta versión del manual.
El Portal de clientes es la aplicación web con la que tú —el cliente remitente— operas tus envíos por tu cuenta: generas guías, les das seguimiento, pides recolecciones, das de alta a tus destinatarios y controlas a los usuarios de tu empresa que pueden usar el portal.
El portal es para las cuentas de cliente de la paquetería: la empresa o persona que envía paquetes. Una cuenta puede tener varios usuarios (por ejemplo, distintas personas de tu área de logística), todos trabajando sobre la misma información.
El usuario principal. Además de todo lo del portal, puede crear y administrar a los demás usuarios de la cuenta (ver B10).
Personas que el titular da de alta. Usan el portal con normalidad (guías, recolecciones, consignatarios), pero no gestionan usuarios.
| Sección | Para qué sirve |
|---|---|
| Inicio | Un resumen de tu cuenta y accesos rápidos (B3). |
| Guías | Crear, rastrear, imprimir, duplicar y cancelar tus guías de envío (B5–B8). |
| Recolecciones | Pedir que un chofer pase a recoger tus paquetes (B9). |
| Consignatarios | Tu directorio de destinatarios y sus direcciones (B4). |
| Usuarios | Las personas de tu cuenta con acceso al portal (B10). |
| Mi cuenta | Tus datos y el cambio de contraseña (B11). |
A la izquierda tienes el menú lateral con todas las secciones: Inicio, Guías, Recolecciones, Consignatarios, Usuarios y Mi cuenta. Arriba aparece el nombre de tu empresa. En pantallas chicas el menú se abre con el botón ☰; en la computadora puedes colapsarlo para ganar espacio. Abajo del menú está Cerrar sesión.
Es la primera pantalla al entrar. Te saluda por tu nombre y te da una foto rápida de tu cuenta con tarjetas de resumen y accesos rápidos.
| Tarjeta | Qué te dice |
|---|---|
| Guías totales | Cuántas guías tiene tu cuenta en total. |
| Guías en tránsito | Las que van en camino a su destino. |
| Recolecciones activas | Las solicitudes de recolección aún abiertas. |
| Consignatarios | Cuántos destinatarios tienes registrados. |
Cada tarjeta es un atajo: al tocarla te lleva a la sección correspondiente. Abajo, «Accesos rápidos» repite los enlaces a Guías, Recolecciones, Consignatarios, Usuarios y Mi cuenta.
Un consignatario es un destinatario tuyo (a quién le envías), y cada consignatario tiene una o más direcciones de entrega (destinos). Este directorio es la base de tus envíos: al crear una guía elegirás a qué consignatario y a cuál de sus direcciones va.
La tabla muestra una fila por dirección, con el consignatario, el nombre del destino, la dirección, si es una dirección propia del cliente y su estatus (activo/inactivo). Arriba tienes filtros por búsqueda, consignatario, estatus y dirección propia.
Una guía es la orden de envío de un paquete (o de un grupo de paquetes). En el portal la creas en dos momentos: primero como borrador y luego la activas para que reciba su folio y su código de rastreo.
Entra a Guías y pulsa Nueva guía. El formulario tiene tres bloques: Datos del envío (remitente y destinatario), Logística y Paquetes.
Por defecto el remitente es tu cuenta. Si quieres, en «Envía como» puedes elegir un consignatario como remitente, y luego su dirección de origen.
Elige el consignatario (obligatorio) y luego su destino (obligatorio). Solo aparecen los destinos de ese consignatario.
| Campo | Qué es |
|---|---|
| Lote de guías | De qué lote saldrá el folio al activar. Es opcional: puedes elegirlo después, al activar. |
| Cantidad de guías | Cuántas guías idénticas crear. Si pones 2 o más, se generan agrupadas bajo una Guía Madre automática (B6). |
| Referencia interna | Un identificador tuyo (por ejemplo, tu número de pedido). Opcional. |
| Observaciones | Notas generales del envío. Opcional. |
Agrega uno o varios paquetes. De cada uno capturas:
El portal calcula solo el peso volumétrico (a partir de las medidas) y el peso facturable (el mayor entre el real y el volumétrico). El total de paquetes de una guía no puede pasar de 100.
Al pulsar Guardar, la guía se crea como Borrador: ya existe, pero todavía no tiene folio. Para ponerla en marcha hay que activarla:
Cuando envías varios paquetes al mismo destino, conviene agruparlos bajo una guía madre: un folio «paraguas» que reúne varias guías relacionadas y permite moverlas y entregarlas juntas.
En el formulario de Nueva guía, pon en Cantidad de guías un número 2 o mayor. El portal crea esa cantidad de guías idénticas (mismo destino y paquetes) y las agrupa automáticamente bajo una Guía Madre con su propio código (por ejemplo, GM-0456).
La sección Guías es tu tablero de seguimiento: qué tienes, en qué estado va cada envío y todo su historial.
Cada fila es una guía, con: folio, código de rastreo, guía madre (si aplica), consignatario, destino, ruta, evento actual, fecha de creación y fecha estimada de entrega. Toca una fila para abrir su detalle.
Arriba tienes filtros para encontrar justo lo que buscas:
Al abrir una guía ves toda su ficha:
Desde la lista de guías (columna Acciones) o desde el detalle tienes las operaciones del día a día sobre cada guía.
Si una guía tiene varios paquetes, se genera una etiqueta por paquete.
Duplicar crea una copia como borrador de una guía existente, con los mismos datos. Sirve para repetir un envío parecido sin capturarlo de nuevo; la copia entra como borrador para que la ajustes y actives cuando quieras.
Una recolección es tu solicitud para que la paquetería pase a recoger los paquetes de tus guías. Tú eliges qué guías incluir; la paquetería asigna al chofer y al vehículo.
La lista muestra folio, número de guías, peso total, último evento y fecha. Toca una para abrir su detalle (solo lectura), donde ves:
También puedes imprimir el comprobante de la recolección, y saltar a la sección de guías filtrada por esa recolección con el número de guías.
Tu cuenta puede tener varios usuarios. La sección Usuarios es donde el titular los administra. Los demás usuarios pueden ver la lista, pero no modificarla.
| Acción | Qué hace |
|---|---|
| Editar | Cambia nombre, apellidos o correo del usuario. |
| Contraseña | Le asignas una nueva contraseña (mínimo 6 caracteres). |
| Desactivar / Activar | Quita o devuelve el acceso al portal sin borrar al usuario. |
| Eliminar | Borra al usuario de forma permanente. |
Aquí ves los datos de tu cuenta y de tu perfil, y puedes cambiar tu contraseña.
Estas son las palabras que verás en el portal.
| Término | Qué es |
|---|---|
| Guía | La orden de envío de un paquete (o varios). Es lo que se rastrea. |
| Borrador | Una guía creada pero sin folio. Aún no está en marcha; puedes editarla o cancelarla. |
| Activar | Poner en marcha un borrador: le asigna folio y código de rastreo y queda documentada. |
| Folio | El número que identifica la guía, tomado de un lote. |
| Lote de guías | Un rango de folios que la paquetería habilita para tu cuenta. De ahí sale el folio al activar. |
| Código de rastreo | El código con el que se sigue el paquete físicamente. |
| Guía madre | Un folio que agrupa varias guías al mismo destino, para moverlas y entregarlas juntas. |
| Consignatario | Tu destinatario (a quién le envías). |
| Destino | Una dirección de entrega de un consignatario. |
| Cobertura | Si la paquetería atiende (tiene ruta activa para) el código postal del destino. |
| OCURRE | Modalidad en la que el destinatario recoge en un CEDIS en vez de recibir a domicilio. |
| CEDIS | Centro de distribución (almacén) de la paquetería. |
| Recolección | Tu solicitud para que pasen a recoger las guías. |
| Peso volumétrico | Peso calculado a partir del tamaño del paquete (largo × ancho × alto). |
| Peso facturable | El mayor entre el peso real y el volumétrico. |
| Borrador | Creada, sin folio. Editable y cancelable. |
| Documentada | Activada, con folio. Lista para recolectarse. |
| En tránsito | En camino a su destino. |
| Entregada | Recibida por el destinatario. |
| Cancelada | Anulada. Ya no se opera. |
Creé una guía pero no tiene folio, ¿por qué?
Porque quedó como borrador. El folio se asigna al activarla (B5). Pulsa Activar y, si te lo pide, elige el lote del que saldrá el folio.
No me deja activar: dice que no hay lotes disponibles.
El folio sale de un lote de guías habilitado para tu cuenta. Si no tienes lotes activos con folios libres, pídele a la paquetería que te habilite uno.
Al elegir el destino aparece «Sin cobertura activa».
Significa que la paquetería no tiene una ruta activa para ese código postal, así que no podrás completar el envío a ese destino. Verifica que la dirección y el CP sean correctos o contacta a la paquetería.
¿Cómo envío varios paquetes al mismo destino?
Al crear la guía, pon en Cantidad de guías un número 2 o mayor: se crean varias guías agrupadas en una guía madre (B6).
¿Cuál es la diferencia entre peso real y peso facturable?
El real es lo que pesa el paquete; el volumétrico se calcula por su tamaño; el facturable es el mayor de los dos. El portal los calcula solo.
¿Puedo repetir un envío parecido rápido?
Sí: usa Duplicar en la guía. Crea una copia como borrador que puedes ajustar y activar (B8).
Ya no quiero enviar una guía, ¿la cancelo?
Sí, mientras esté en borrador o documentada. Pulsa Cancelar e indica el motivo. Si ya va en tránsito o entregada, contacta a la paquetería (B8).
Pedí una recolección pero falta una guía en la lista de disponibles.
Solo aparecen las guías documentadas y aún no recolectadas. Actívala primero (B5) y vuelve a intentar.
¿Quién asigna el chofer y el vehículo de mi recolección?
La paquetería. En el detalle de la recolección los ves cuando ya están asignados; desde el portal la consultas, no la editas.
Necesito darle acceso al portal a un compañero.
Si eres el titular, ve a Usuarios → Nuevo usuario (B10). Si no lo eres, pídeselo al titular de tu cuenta.
¿Cómo cambio mi contraseña?
En Mi cuenta → Cambiar mi contraseña (B11). Debe tener al menos 6 caracteres.
¿Puedo enviar a que el cliente recoja en sucursal?
Sí. Al crear el consignatario elige Recolección en CEDIS (OCURRE) y selecciona la sucursal (B4).
| Síntoma | Qué hacer |
|---|---|
| No puedo iniciar sesión | Revisa correo y contraseña (sin espacios). Si no la recuerdas, pídele al titular que la restablezca; si eres titular, a la paquetería. |
| No aparece el consignatario al crear la guía | Revisa que tenga al menos una dirección y esté activo. Créalo o edítalo en Consignatarios (B4). |
| El destino sale «Sin cobertura» | Verifica el CP y la colonia. Si es correcto, ese destino no tiene ruta activa: contacta a la paquetería. |
| No puedo activar la guía | Te falta un lote con folios disponibles. Pídelo a la paquetería (B5). |
| No puedo cancelar una guía | Solo se cancelan borradores o documentadas. Si ya va en tránsito/entregada, contacta a la paquetería. |
| No puedo crear ni editar usuarios | Esa función es solo del titular de la cuenta (B10). |
| La etiqueta no se imprime | Elige el formato en Imprimir y permite las ventanas emergentes del navegador para abrir el visor. |
Apartado 3 de 3 · Manual de la plataforma
Configuración y supervisión de toda la operación de la paquetería.
El panel de administración es la herramienta de escritorio con la que la paquetería gestiona todo el sistema: la geografía y las coberturas, las rutas y los CEDIS, las guías y sus manifiestos, los clientes y sus usuarios, la flota, las plantillas y la configuración general. Mientras el chofer opera en campo (Parte A) y el cliente trabaja en su portal (Parte B), el administrador es quien configura y supervisa la operación completa.
El panel es para el personal interno. Al iniciar sesión, el sistema decide a dónde te lleva según tu rol:
A la izquierda está el menú lateral, organizado en grupos. Puedes colapsarlo para ganar espacio (se recuerda tu preferencia); en móvil se abre con el botón ☰. Abajo está Cerrar sesión.
| Grupo | Módulos |
|---|---|
| Inicio | Dashboard (C2). |
| Geografía | Asentamientos y CPs (C3). |
| Distribución | Rutas, CEDIS, Inventarios, Coberturas y el acceso a Opera (web) (C4–C8). |
| Operación | Guías de Envío, Recolecciones, Manifiestos de Ruta, Jornadas y Liquidaciones (C9–C13). |
| Administración | Clientes, Consignatarios, Lotes de Guías, Plantillas, Vehículos, Usuarios y Configuración (C14–C20). |
Es la pantalla de arranque. Resume el estado del sistema con indicadores (KPIs) y gráficas, y ofrece pestañas para ver distintos tableros.
| Pestaña | Qué muestra |
|---|---|
| Coberturas | El tablero principal: cuántos asentamientos hay y cuántos tienen cobertura. |
| Consignatarios y Destinatarios | Panorama de destinatarios registrados. |
| Rutas | Indicadores de las rutas de distribución. |
| Guías | Indicadores de las guías de envío. |
El catálogo geográfico es la base de todo: asentamientos (colonias), códigos postales, municipios y estados. Guías, destinos y coberturas se apoyan en él.
Las rutas de distribución son las zonas de reparto. A cada ruta se le asignan asentamientos (su cobertura) y una frecuencia por día de la semana. El operador inicia su jornada eligiendo una ruta.
Desde la tabla puedes buscar, editar y activar/desactivar rutas.
Los CEDIS (centros de distribución / almacenes) son los puntos por donde pasan las guías. El ingreso a CEDIS es un evento clave del flujo del paquete.
Aquí se asignan asentamientos a rutas. Un asentamiento «con cobertura» es uno que ya pertenece a alguna ruta; sin esa asignación, no se puede enviar a ese destino.
Puedes descargar la cobertura filtrada. El dashboard (C2) enlaza directo a esta pantalla ya filtrada por el área que elijas.
La bitácora de entradas y salidas de guías en los CEDIS. Es la trazabilidad física de qué guías están dónde.
Desde el menú, la opción Opera (web) abre la app de campo del operador en una pestaña nueva. Sirve para que el personal interno con permiso pueda apoyar en tareas de campo o almacén sin cambiar de cuenta.
El registro y seguimiento de todas las órdenes de paquetería. Es la versión administrativa —y más completa— de lo que el cliente ve en su portal: aquí el administrador crea, documenta, agrupa, imprime, reasigna y cancela guías de cualquier cliente.
El alta es igual a la del portal (remitente, destinatario, logística y paquetes), pero el administrador elige el cliente. La guía nace como Borrador y se pone en marcha al Confirmar (documentar): toma su folio (de un lote, C16) y su código de rastreo.
| Acción | Qué hace |
|---|---|
| Confirmar | Documenta un borrador (le asigna folio y lo pone en marcha). |
| Duplicar | Crea una copia como borrador. |
| Imprimir | Genera la etiqueta en el formato de la plantilla (C17). |
| Asignar evento | Registra manualmente un evento en la guía (correcciones, incidencias). |
| Agrupar en guía madre | Une varias guías bajo una guía madre para moverlas juntas. |
| Cancelar | Anula la guía (con motivo). |
La tabla tiene filtros potentes: por cliente, consignatario, destino, folio, código de rastreo, guía madre, fechas, categoría de evento y evento. Incluye acciones masivas (por ejemplo, cancelar varias).
Los manifiestos de recolección agrupan las guías que se van a recoger de un cliente. Aquí el administrador los crea o revisa los que llegan del portal, y les asigna operador y vehículo.
Los manifiestos de ruta agrupan las guías que salen del CEDIS a entregarse. Definen qué lleva cada operador y en qué orden.
La captura en campo de esa salida y de las entregas la hace el operador en Opera (web) (Parte A, caps. 6 y 7).
El registro de las jornadas de los operadores: inicio, fin y ubicación de cada turno de trabajo.
Muestra los paquetes asignados que siguen pendientes por operador: lo que cada operador aún debe entregar o devolver para «cerrar en cero».
La gestión de clientes: las empresas o personas que envían paquetes. Aquí se dan de alta, se registran sus contactos y su dirección operativa, y se habilita su acceso al portal.
Cada cliente puede tener una aplicación: la vía para que otro sistema del cliente (su tienda en línea, su ERP, etc.) cree guías directamente por API, sin capturarlas a mano. Aquí solo se explica qué es y cómo habilitarla; el funcionamiento técnico (cómo se conecta y qué hace ese otro sistema) está en el apartado Herramientas para el desarrollador.
En la tabla de Clientes, el botón «Aplicación» abre el panel para gestionar sus API keys (las llaves de acceso que autentican a ese sistema externo):
pqx_live_…— con un botón para copiarlo. Cópialo y entrégaselo a quien hará la integración: el sistema solo guarda su huella (hash), nunca el token completo, así que no se puede volver a ver.El directorio de destinatarios por cliente y sus direcciones. Es la versión administrativa del directorio que cada cliente ve en su portal.
Los lotes son rangos numéricos reservados por cliente. De un lote sale el folio de cada guía al documentarla.
Define el diseño de la etiqueta que se imprime para cada guía. Eliges un formato y lo configuras.
El catálogo de unidades de auto transporte: la flota con la que se recolecta y se reparte.
La gestión de accesos y roles del personal interno. Aquí se crean los usuarios del sistema, se les asigna rol y —según el rol— sus permisos por CEDIS.
Desde la tabla puedes editar, filtrar por rol, y restablecer la contraseña («Nueva contraseña»).
Para los roles de almacén (almacenista, auxiliar, supervisor y atención a clientes/administrador), defines a qué CEDIS tiene acceso y con qué nivel:
| Permiso | Qué habilita |
|---|---|
| Ver | Consultar los paquetes de ese CEDIS (excepto en Opera Web). |
| Manipular | Ver y operar (cambiar/agregar eventos, asignar a ruta, etc.) los paquetes de ese CEDIS, incluido Opera Web. |
Personaliza la apariencia e identidad del sistema. Lo que ajustes aquí se refleja en el panel, en el portal del cliente y en Opera (web).
| Ajuste | Qué cambia |
|---|---|
| Nombre de la empresa | El nombre que aparece en el menú y encabezados. |
| Subtítulo | La línea secundaria bajo el nombre. |
| Logo | La imagen de marca del sistema. |
| Favicon | El ícono de la pestaña del navegador. |
| Color de acento | El color principal de botones y resaltados. |
Este apartado muestra, por cada tipo de código (recolección, ruta, guía madre y guía), cómo va el consumo de folios. Cada tipo usa un código con un prefijo y un cuerpo aleatorio; la longitud crece automáticamente cuando los emitidos alcanzan el 60 % de las combinaciones posibles, para no quedarse nunca sin folios disponibles.
| Columna | Qué indica |
|---|---|
| Prefijo | Las letras con las que empieza el código de ese tipo. |
| Longitud | La longitud vigente del cuerpo del código. |
| Emitidos | Cuántos códigos de ese tipo se han generado. |
| Capacidad | Cuántas combinaciones caben en la longitud actual. |
| Avance hacia ampliación (60 %) | Barra de progreso hacia el umbral que dispara el paso a la siguiente longitud. Al llegar, la longitud sube un dígito y se abre una capacidad mucho mayor. |
| Término | Qué es |
|---|---|
| Asentamiento | Una colonia/localidad del catálogo geográfico, con su CP. |
| Cobertura | La asignación de un asentamiento a una ruta. Sin ella no hay envío a ese destino. |
| Ruta | Una zona de reparto con su frecuencia por día. |
| CEDIS | Centro de distribución / almacén. |
| Manifiesto de recolección | Grupo de guías a recoger de un cliente. |
| Manifiesto de ruta | Grupo de guías que salen del CEDIS a entregarse. |
| Lote | Rango de folios reservado a un cliente. |
| Guía madre | Folio que agrupa varias guías relacionadas. |
| Liquidar | Que un operador resuelva (entregue o devuelva) todos sus paquetes. |
| Permiso de CEDIS | El nivel (ver / manipular) que tiene un usuario de almacén sobre un CEDIS. |
| Aplicación del cliente | La habilitación para que un sistema externo del cliente cree guías por API (C14.2). |
| API key | Token secreto (pqx_live_…) ligado a un cliente que autentica las peticiones a la API de guías. Se genera y revoca desde Clientes. |
Apartado 4 de 4 · Manual de la plataforma
Para equipos técnicos que conectan otro sistema (tienda en línea, ERP) con la paquetería.
Este apartado es para quien programa la integración: la persona o el equipo que conecta el sistema del cliente (su tienda en línea, su ERP o cualquier software propio) con la paquetería. Aquí se explica qué es, cómo funciona y cómo se usa, en lenguaje sencillo y también técnico.
Una API es una «ventanilla» automática de la plataforma: en vez de que una persona entre al portal y capture una guía a mano, el sistema del cliente lo hace directamente, de computadora a computadora. Con ella ese sistema puede crear guías y consultar el detalle de una guía (para rastrearla).
El caso típico: una tienda en línea recibe un pedido y, sin intervención humana, genera la guía de envío, obtiene su folio y su código de rastreo, y más tarde consulta ese código para mostrarle al comprador en qué va su envío.
La API es un servicio HTTP tipo REST sobre el mismo endpoint /api/externa/guias, autenticado con una API key (un token secreto por cliente). Tiene dos operaciones:
POST con cuerpo JSON → crea una guía (y opcionalmente la activa, devolviendo folio y código de rastreo). Ver D4.GET con un parámetro de búsqueda → consulta el detalle completo de una guía, incluido su historial de eventos. Ver D5.La API no se activa desde aquí. Se habilita por cliente desde el panel de administración, generando una API key. Sin una key activa, todas las peticiones se rechazan.
Un administrador la habilita en el portal del administrador → módulo Clientes → botón «Aplicación». El paso a paso (generar, copiar y revocar keys) está documentado en C14.2 · La aplicación del cliente.
pqx_live_…), que se muestra una sola vez.403; y consultar una guía de otro cliente responde 404. Si el token se filtra, el administrador debe revocarlo y generar uno nuevo.Cada petición debe llevar la API key en una cabecera HTTP. Se acepta cualquiera de estas dos formas:
Authorization: Bearer pqx_live_xxxxxxxx...
x-api-key: pqx_live_xxxxxxxx...
401.Una sola petición crea la guía. Puedes dejarla como Borrador o activarla en la misma llamada para obtener de inmediato su folio y código de rastreo.
Petición: POST /api/externa/guias · Cabecera: Content-Type: application/json
| Campo | Para qué sirve |
|---|---|
| destino_id (o id_personalizado_destino) | El destino de la guía. El cliente y el consignatario se deducen del destino; no se envían en el cuerpo. |
| lote_id | Lote del que se toma el folio al activar. Obligatorio si activar: true. Debe ser del mismo cliente (C16). |
| activar | true documenta la guía y devuelve folio y código de rastreo. Por defecto (false) queda como borrador. |
| paquetes | Lista de bultos: tipo_embalaje, medidas (largo_cm, ancho_cm, alto_cm), peso_real_kg, valor_declarado y contenido. |
| referencia_interna, observaciones | Opcionales. |
| remitente_consignatario_id, remitente_destino_id | Opcionales. Si se envían, deben pertenecer al cliente de la key. |
| entrega_ocurre + id_cedis | Para entregas en modalidad OCURRE (el destinatario recoge en un CEDIS). |
curl -X POST https://TU-DOMINIO/api/externa/guias \
-H "Authorization: Bearer pqx_live_xxxxxxxx..." \
-H "Content-Type: application/json" \
-d '{
"destino_id": 789,
"lote_id": 42,
"referencia_interna": "PEDIDO-1001",
"activar": true,
"paquetes": [
{ "tipo_embalaje": "CAJA", "peso_real_kg": 2.5, "contenido": "Ropa" }
]
}'
POSTCreada y activada (201):
{ "ok": true, "id": 1234, "estado": "Confirmada",
"folio": "A0001", "ruta_nombre": "RUTA CENTRO",
"codigo_rastreo": "G7F3K9Q2" }
Creada como borrador (201):
{ "ok": true, "id": 1234, "estado": "Borrador",
"folio": null, "codigo_rastreo": null }
Fallo al activar — la guía queda como borrador y se puede reintentar (400):
{ "ok": false, "id": 1234, "estado": "Borrador",
"error": "La guía no tiene un lote seleccionado. Elige un lote antes de activar." }
| Código | Significado |
|---|---|
201 | Guía creada (borrador o activada). |
400 | Datos inválidos, o fallo al activar (falta lote, sin folios o sin cobertura). La guía queda como borrador. |
401 | Falta la API key, o es inválida/revocada. |
403 | El destino o el remitente no pertenece al cliente de la key. |
404 | Destino o CEDIS inexistente. |
500 | Error interno. |
Devuelve el detalle completo de una guía —lo mismo que muestra el módulo de guías al abrirla, incluido su historial de eventos—. Es la base para una página de rastreo propia del cliente.
Petición: GET /api/externa/guias, autenticada con la API key. Se busca por uno de estos parámetros:
| Parámetro | Ejemplo | Uso |
|---|---|---|
| codigo_rastreo | ?codigo_rastreo=G7F3K9Q2 | Ideal para páginas de rastreo. |
| id | ?id=1234 | Id interno devuelto al crear. |
| folio | ?folio=A0001 | Folio de la guía ya activada. |
Ejemplo:
curl "https://TU-DOMINIO/api/externa/guias?codigo_rastreo=G7F3K9Q2" \
-H "Authorization: Bearer pqx_live_xxxxxxxx..."
Respuesta (200) — resumen del objeto guia:
{ "ok": true, "guia": {
"id": 1234, "estado": "Confirmada", "folio": "A0001",
"codigo_rastreo": "G7F3K9Q2", "referencia_interna": "PEDIDO-1001",
"clientes": { … }, "consignatarios": { … }, "destinos": { … },
"rutas": { "nombre_ruta": "RUTA CENTRO" },
"guia_paquetes": [ { "numero_paquete": 1, "peso_real_kg": 2.5, "contenido": "Ropa" } ],
"guia_historial": [
{ "estado_nuevo": "Borrador", "created_at": "…", "catalogo_eventos_guia": { "nombre": "Borrador" } },
{ "estado_nuevo": "Confirmada", "created_at": "…", "catalogo_eventos_guia": { "nombre": "Documentado" } }
] } }
| Código | Significado |
|---|---|
200 | Guía encontrada. |
400 | No se indicó id/codigo_rastreo/folio, o el id es inválido. |
401 | Falta la API key, o es inválida/revocada. |
404 | No existe una guía con ese identificador para este cliente. |
404 igual que una inexistente: así la API no revela si el identificador existe en otra cuenta. El historial incluye el nombre del personal que registró cada evento; si no quieres exponerlo en una página pública, recórtalo en tu propio backend antes de mostrarlo.La API tiene límites de solicitudes para protegerse de abuso. Una integración normal no los alcanza; una que dispara demasiadas peticiones recibe 429 y debe reintentar más tarde.
| Límite | Valor | Al excederlo |
|---|---|---|
| Por API key | 60 solicitudes / minuto | 429 con cabecera Retry-After |
| Por IP | 120 solicitudes / minuto | 429 con cabecera Retry-After |
| Bloqueo automático | +10 rechazos (401/403/429) en 5 min | IP bloqueada 30 min (429) |
Retry-AfterAnte un 429, espera los segundos que indique la cabecera Retry-After antes de reintentar (backoff). No reintentes en bucle: los rechazos se acumulan y pueden bloquear tu IP 30 minutos. Un 400/404 por datos mal formados no bloquea, pero sí cuenta para el límite por IP.docs/api-externa-guias.md del repositorio de la plataforma.400 al activar deja la guía como borrador; puedes corregir el dato (p. ej. el lote) y reintentar la activación sin recrearla.destino_id pertenezca al cliente de la key para no recibir 403.400.429: respeta la cabecera Retry-After y no reintentes en bucle, o tu IP puede quedar bloqueada (D6).codigo_rastreo que devuelve la creación y consúltalo con el GET (D5); no consultes en un bucle constante, hazlo cuando el usuario abra la página de seguimiento.docs/api-externa-guias.md del repositorio de la plataforma, que se mantiene junto al código.401.