Puntos finales de transacciones y registros
¡Su guía para la integración de V5!
Introducción
Además de los puntos finales de exportación que hemos visto hasta ahora en nuestras guías de integración de V5, la API de V5 también incluye varios puntos finales transaccionales que se pueden usar para devolver descriptores de eventos del sistema /registros a un ERP externo.
Índice
1. Puntos finales del registro del sistema
Se pueden utilizar puntos finales genéricos para devolver una amplia gama de descriptores en varios módulos diferentes.
Estos puntos finales devolverán datos más complejos que los puntos finales transaccionales/genéricos y, a menudo, contendrán múltiples conjuntos de datos anidados relacionados con eventos de descriptores. Si bien esto es útil en el sentido de que se devolverán los datos correctos, a menudo será necesario filtrar estos puntos finales para aprovechar mejor los datos devueltos.
Podemos ver cuáles son para la API V5 a continuación:
1.1. Registros del sistema
Punto final/URI –
http://host:port/V5-API/api/integrate/export/system_logs
Este punto final proporcionará un archivo de respuesta JSON que incorpora todos los descriptores de eventos del sistema y los datos relacionados con ellos. Si accedemos a este punto final, obtendremos una respuesta similar a esta:
Entonces podemos ver aquí que, aunque recibimos el descriptor 'CONSUMIDO' hacia la parte inferior de esta imagen para algunos hilos de azafrán que se usan para un lote, también recibimos muchos datos anidados adicionales, como un retorno de clase completo para el proveedor y ubicación que podemos ver aquí.
Se pueden configurar filtros dentro de su ERP para seleccionar selectivamente los datos que desea ver.
Este archivo de ejemplo se puede descargar aquí.
Útil para:
1.2. Registro del sistema
Punto final/URI –
http://host:port/V5-API/api/integrate/export/system_log/{id}
Este punto final proporcionará un archivo de retorno JSON con una estructura similar a la exportación de "Registros del sistema" descrita anteriormente, pero aquí podemos especificar un número de identificación de registro individual para obtener la información asociada. Esto resulta útil si queremos centrarnos en un evento o descriptor específico.
Aquí puede descargar un ejemplo de este tipo de archivo.
Útil para:
1.3. Registros del sistema de ajuste
Punto final/URI –
http://host:port/V5-API/api/integrate/export/adjustment_logs
Este endpoint devolverá un archivo JSON con una lista de eventos del registro del sistema que contengan el descriptor 'ADJUSTMENT' , lo que permite filtrar la información obtenida de los registros del sistema para mostrar únicamente las entradas que contienen este descriptor. Esto facilita que el sistema ERP procese datos más relevantes según sus necesidades.
Aquí puede descargar un ejemplo de este tipo de archivo.
Útil para:
1.4. Registros del sistema consumidos/producidos:
Punto final/URI –
http://host:port/V5-API/api/integrate/export/system_logs_cp
Este endpoint devolverá un archivo JSON con una lista de eventos del registro del sistema que contengan el descriptor "CONSUMED" o "PRODUCED" , lo que permite filtrar la información devuelta, a diferencia de lo que vimos anteriormente para los "Registros del sistema", para mostrar solo las entradas que contienen estos descriptores. Estos registros corresponden al proceso principal de procesamiento por lotes, específicamente a la reducción y producción de inventario. Esto ayuda a proporcionar datos más relevantes para que el ERP los procese según sus necesidades.
Aquí puede descargar un ejemplo de este tipo de archivo.
Útil para:
1.5. Registros del sistema no consumidos/producidos:
Punto final/URI –
http://host:port/V5-API/api/integrate/export/system_logs_noncp
Este punto final actúa efectivamente como el inverso del punto final 'Registros del sistema consumidos/producidos' mencionado anteriormente, y devolverá un archivo JSON que enumera los registros del sistema con cualquier descriptor que no sea 'CONSUMED' o 'PRODUCED'.
Útil para:
1.6. Registros de uso
Punto final/URI –
http://host:port/V5-API/api/integrate/export/batch_system_logs
Este endpoint devolverá un archivo JSON con una lista de eventos del registro del sistema relacionados con el procesamiento por lotes, filtrando la información obtenida de los registros del sistema para mostrar únicamente entradas con descriptores como «COLLATED», «BATCH SUSPENDED», etc. (además de «CONSUMED» y «PRODUCED»). Esto permite que el sistema ERP procese datos más relevantes según sus necesidades.
Aquí puede descargar un ejemplo de este tipo de archivo.
Útil para:
1.7. Registros de uso (filtrar fecha)
Punto final/URI –
http://host:port/V5-API/api/integrate/export/batch_system_logs/filterFrom/{filterDate}
Este punto final devuelve la misma información que los 'Registros de uso' anteriores, pero permite un filtro desde la fecha (marca de tiempo de época) para limitar los resultados si se desea.
Útil para:
1.8. Registros de trabajo
Punto final/URI –
http://host:port/V5-API/api/integrate/export/job_logs
Este punto final proporcionará un archivo de respuesta JSON que incorpora descriptores del sistema relacionados con la producción de trabajos.
Un archivo de ejemplo de este tipo se puede descargar aquí.
Útil para:
2. Puntos finales transaccionales/genéricos
Los puntos finales transaccionales se utilizan para devolver información simplificada sobre eventos descriptores que se refieren más específicamente a cómo los distintos módulos gestionan los niveles de inventario. A diferencia de los puntos finales genéricos que hemos visto anteriormente, que proporcionan una variedad de datos anidados, estos puntos finales proporcionan información simplificada sin datos anidados.
Podemos ver cómo se vería esto en nuestros ejemplos a continuación:
2.1. Transacciones de ajuste
Punto final/URI –
http://host:port/V5-API/api/integrate/export/transactions/adjustments
Este punto final se puede utilizar para proporcionar una lista de transacciones de ajuste que han ocurrido en el sistema. Al utilizar este punto final, obtendremos una entrada cada vez que se cambie (o ajuste) la cantidad de un lote mediante el Centro de control o WMS. Esto podría deberse a daños o productos vencidos que deben retirarse del sistema.
Un ejemplo de exportación de este tipo podría verse así:
Como podemos ver aquí, se trata de una única entrada para un evento descriptor 'AJUSTE' , y no contiene ninguno de los datos anidados potencialmente superfluos que vimos con el punto final genérico.
Aquí puede descargar un archivo de ejemplo de este tipo.
Útil para:
2.2. Transacciones de consumo por lotes
Punto final/URI –
http://host:port/V5-API/api/integrate/export/transactions/batching/{completedBatches}
La exportación de transacciones de consumo por lotes proporcionará un archivo JSON simplificado que incluye datos descriptivos de consumo y producción relevantes para un lote específico y completado que ha sido procesado por el sistema.
Usando este punto final, obtendremos un retorno que muestra todos los productos básicos que se han consumido en el procesamiento por lotes, y también cuántos lotes se produjeron posteriormente.
Aquí puede descargar un ejemplo de este tipo de archivo.
Útil para:
2.3. Transacciones de consumo por lotes (fecha de filtrado)
Punto final/URI –
http://host:port/V5-API/api/integrate/export/transactions/batching/filterfrom/{filterDate}
Este punto final devuelve la misma información que el 'Consumo por lotes' anterior, pero permite un filtro desde la fecha (marca de tiempo de época) para limitar los resultados si se desea.
Útil para:
2.4. Transacciones de órdenes de compra
Exportar punto final/URI –
http://host:port/V5-API/api/integrate/export/transactions/purchase
La exportación de transacciones de compra desde este punto final proporcionará un archivo JSON simplificado que incluye datos de recepción relevantes para las órdenes de compra, incluidos descriptores del sistema como 'RECIBIDO'.
El punto final solo proporciona estos datos para los pedidos completados que no se han marcado como exportados.
Aquí puede descargar un ejemplo de este tipo de archivo.
Útil para:
2.5. Transacciones de órdenes de venta
Exportar punto final/URI –
http://host:port/V5-API/api/integrate/export/transactions/sales/{true/false}
La exportación de transacciones de venta desde este punto final proporcionará un archivo JSON simplificado con datos de asignación, selección y envío relevantes para los pedidos de venta. Al usar este punto final, se obtendrán datos de todos los artículos vendidos mediante pedidos de venta, así como descriptores como "PECADO" y "ENVIADO".
El punto final puede proporcionar estos datos para los pedidos completados (verdadero) o todos los pedidos (falso), siempre que estos pedidos aún no se hayan marcado como exportados.
Aquí puede descargar un ejemplo de este tipo de archivo.
Útil para:
