Terminais de transação e registro
Seu guia para a integração V5!
Introdução
Além dos endpoints de exportação apresentados até agora em nossos guias de integração da versão 5, a API da versão 5 também oferece diversos endpoints transacionais que podem ser usados para retornar descritores /logs de eventos do sistema para um ERP externo.
Conteúdo
1. Terminais de registro do sistema
Os endpoints genéricos podem ser usados para retornar uma ampla gama de descritores em diversos módulos diferentes.
Esses pontos de extremidade retornarão dados mais complexos do que os pontos de extremidade transacionais/genéricos e geralmente conterão vários conjuntos de dados aninhados relacionados a eventos do descritor. Embora isso seja útil no sentido de que os dados corretos serão retornados, esses pontos de extremidade geralmente precisarão ser filtrados para melhor utilizar os dados retornados.
Podemos ver o que são para a API V5 abaixo:
1.1. Registros do sistema
Ponto final/URI –
http://host:port/V5-API/api/integrate/export/system_logs
Este endpoint retornará um arquivo JSON que incorpora todos os descritores de eventos do sistema e os dados a eles relacionados. Ao acessar este endpoint, receberemos um retorno semelhante a este:
Portanto, podemos ver aqui que, embora recebamos o descritor 'CONSUMED' na parte inferior desta imagem para alguns Saffron Threads usados em um lote, também estamos recebendo muitos dados aninhados adicionais, como um retorno de classe completo para o fornecedor e localização que podemos ver aqui.
Filtros podem ser configurados em seu ERP para escolher seletivamente os dados que você deseja ver.
Este arquivo de exemplo pode ser baixado aqui.
Útil para:
1.2. Registro do sistema
Ponto final/URI –
http://host:port/V5-API/api/integrate/export/system_log/{id}
Este endpoint fornecerá um arquivo JSON de retorno estruturado de forma semelhante à exportação de 'Logs do Sistema' acima, mas aqui podemos especificar um número de ID de log individual para retornar as informações associadas. Isso é útil se quisermos nos concentrar em um evento ou descritor específico.
Um exemplo desse tipo de arquivo pode ser baixado aqui.
Útil para:
1.3. Registros do sistema de ajuste
Ponto final/URI –
http://host:port/V5-API/api/integrate/export/adjustment_logs
Este endpoint retornará um arquivo JSON com uma lista de eventos de log do sistema contendo o descritor 'ADJUSTMENT' , restringindo o retorno, em comparação com o que vimos anteriormente para 'Logs do Sistema', às entradas que contêm apenas esse descritor. Isso ajuda a fornecer dados mais relevantes para o ERP processar, dependendo das suas necessidades.
Um exemplo desse tipo de arquivo pode ser baixado aqui.
Útil para:
1.4. Logs do sistema consumido/produzido:
Ponto final/URI –
http://host:port/V5-API/api/integrate/export/system_logs_cp
Este endpoint retornará um arquivo JSON com uma lista de eventos de log do sistema contendo o descritor 'CONSUMED' ou 'PRODUCED' , restringindo o retorno, em comparação com o que vimos anteriormente para 'Logs do Sistema', às entradas que contêm esses descritores. Esses logs referem-se ao processo principal de loteamento, especificamente à redução e produção de estoque. Isso ajuda a fornecer dados mais relevantes para o ERP processar, dependendo das suas necessidades.
Um exemplo desse tipo de arquivo pode ser baixado aqui.
Útil para:
1.5. Logs do sistema não consumidos/produzidos:
Ponto final/URI –
http://host:port/V5-API/api/integrate/export/system_logs_noncp
Este endpoint funciona efetivamente como o inverso do endpoint 'Logs do sistema consumidos/produzidos' acima e retornará um arquivo JSON que lista os logs do sistema com qualquer descritor que não seja 'CONSUMED' ou 'PRODUCED'.
Útil para:
1.6. Registros de uso
Ponto final/URI –
http://host:port/V5-API/api/integrate/export/batch_system_logs
Este endpoint retornará um arquivo JSON com uma lista de eventos de log do sistema relacionados ao processamento em lote, filtrando o retorno, em comparação com o que vimos acima para 'Logs do Sistema', para entradas que contenham descritores como 'COLLATED', 'BATCH SUSPENDED' etc. (bem como 'CONSUMED' e 'PRODUCED'). Isso ajuda a fornecer dados mais relevantes para o ERP processar, dependendo das suas necessidades.
Um exemplo desse tipo de arquivo pode ser baixado aqui.
Útil para:
1.7. Registros de uso (data do filtro)
Ponto final/URI –
http://host:port/V5-API/api/integrate/export/batch_system_logs/filterFrom/{filterDate}
Este endpoint retorna as mesmas informações que 'Logs de uso' acima, mas permite um filtro de data (carimbo de data e hora da época) para restringir os resultados, se desejado.
Útil para:
1.8. Registros de trabalho
Ponto final/URI –
http://host:port/V5-API/api/integrate/export/job_logs
Este endpoint fornecerá um arquivo de retorno JSON que incorpora descritores de sistema relacionados à produção de tarefas.
Um arquivo de exemplo deste tipo pode ser baixado aqui.
Útil para:
2. Endpoints transacionais/genéricos
Os endpoints transacionais são usados para retornar informações simplificadas sobre eventos descritores que se referem mais especificamente a como vários módulos gerenciam os níveis de estoque. Ao contrário dos endpoints genéricos que vimos acima, que fornecem uma variedade de dados aninhados, esses endpoints fornecem informações simplificadas, sem dados aninhados.
Podemos ver como isso ficaria em nossos exemplos abaixo:
2.1. Transações de ajuste
Ponto final/URI –
http://host:port/V5-API/api/integrate/export/transactions/adjustments
Este terminal pode ser usado para fornecer uma lista de transações de ajuste que ocorreram no sistema. Utilizando este endpoint obteremos uma entrada retornada sempre que a quantidade de um lote for alterada (ou ajustada) através do Control Center ou WMS. Isto pode ser resultado de danos ou produtos vencidos que precisam ser removidos do sistema.
Um exemplo de exportação deste tipo poderia ser assim:
Como podemos ver aqui, esta é uma única entrada para um evento descritor de 'AJUSTE' e não contém nenhum dos dados aninhados potencialmente supérfluos que vimos com o endpoint genérico.
Um arquivo de exemplo deste tipo pode ser baixado aqui.
Útil para:
2.2. Transações de consumo em lote
Ponto final/URI –
http://host:port/V5-API/api/integrate/export/transactions/batching/{completedBatches}
A exportação de transações de consumo em lote fornecerá um arquivo JSON simplificado que contém dados descritores de consumo e produção relevantes para um lote específico e concluído que foi processado pelo sistema.
Usando este endpoint, obteremos um retorno mostrando todas as mercadorias que foram consumidas em lotes e também quanto dos próprios lotes foram produzidos posteriormente.
Um exemplo desse tipo de arquivo pode ser baixado aqui.
Útil para:
2.3. Transações de consumo em lote (data do filtro)
Ponto final/URI –
http://host:port/V5-API/api/integrate/export/transactions/batching/filterfrom/{filterDate}
Este endpoint retorna as mesmas informações que 'Consumo de lote' acima, mas permite um filtro de data (carimbo de data e hora) para restringir os resultados, se desejado.
Útil para:
2.4. Transações de ordem de compra
Exportar endpoint/URI –
http://host:port/V5-API/api/integrate/export/transactions/purchase
A exportação de transações de compra a partir deste endpoint fornecerá um arquivo JSON simplificado que contém dados de recebimento relevantes para pedidos de compra, incluindo descritores do sistema como 'RECEBIDO'.
O endpoint fornece esses dados apenas para pedidos concluídos que não foram marcados como exportados.
Um exemplo desse tipo de arquivo pode ser baixado aqui.
Útil para:
2.5. Transações de pedidos de vendas
Exportar endpoint/URI –
http://host:port/V5-API/api/integrate/export/transactions/sales/{true/false}
A exportação de transações de vendas a partir deste endpoint fornecerá um arquivo JSON simplificado contendo dados de alocação/separação/envio relevantes para os pedidos de venda. Utilizando este endpoint, serão retornados dados referentes a todos os itens vendidos por meio de pedidos de venda, incluindo descritores como 'SEPARADO' e 'ENVIADO'.
O endpoint pode fornecer esses dados para pedidos concluídos (verdadeiro) ou todos os pedidos (falso), desde que esses pedidos ainda não tenham sido marcados como exportados.
Um exemplo desse tipo de arquivo pode ser baixado aqui.
Útil para:
