Points de terminaison des transactions et des journaux

Votre guide d'intégration V5 !

Introduction

En plus des points de terminaison d'exportation vus jusqu'à présent dans nos guides d'intégration V5, l'API V5 comprend également plusieurs points de terminaison transactionnels qui peuvent être utilisés pour renvoyer des descripteurs/journaux d'événements système à un ERP externe.

Table des Matières

1. Points de terminaison du journal système

Les points de terminaison génériques peuvent être utilisés pour renvoyer un large éventail de descripteurs à travers un certain nombre de modules différents.

Ces points de terminaison renverront des données plus complexes que les points de terminaison transactionnels/génériques et contiendront souvent plusieurs ensembles de données imbriquées relatives aux événements de descripteur. Bien que cela soit utile dans le sens où les données correctes seront renvoyées, ces points de terminaison devront souvent être filtrés pour utiliser au mieux les données renvoyées.

Nous pouvons voir ce que c'est pour l'API V5 ci-dessous :

1.1. Journaux système

Point de terminaison/URI –

http://host:port/V5-API/api/integrate/export/system_logs

Description du point final

Ce point de terminaison renverra un fichier JSON contenant tous les descripteurs d'événements système et les données associées. Si nous l'interrogeons, nous obtiendrons une réponse ressemblant à ceci :

 

Nous pouvons donc voir ici que bien que nous recevions le descripteur « CONSOMMÉ » vers le bas de cette image pour certains fils de safran utilisés pour un lot, nous recevons également de nombreuses données imbriquées supplémentaires, telles qu'un retour de classe complet pour le fournisseur et emplacement que nous pouvons voir ici.

Des filtres peuvent être configurés dans votre ERP pour sélectionner de manière sélective les données que vous souhaitez voir.

Ce fichier d'exemple peut être téléchargé ici.

Utile pour:

1.2. Journal du système

Point de terminaison/URI –

http://host:port/V5-API/api/integrate/export/system_log/{id}

Description du point final

Ce point de terminaison renverra un fichier JSON structuré de manière similaire à l'exportation « Journaux système » ci-dessus, mais il est possible ici de spécifier un numéro d'identification de journal individuel pour obtenir les informations associées. Ceci est utile si l'on souhaite se concentrer sur un événement ou un descripteur spécifique.

Un exemple de ce type de fichier peut être téléchargé ici.

Utile pour:

1.3. Journaux du système de réglage

Point de terminaison/URI –

http://host:port/V5-API/api/integrate/export/adjustment_logs

Description du point final

Ce point de terminaison renverra un fichier JSON contenant la liste des événements du journal système avec le descripteur « ADJUSTMENT » , ce qui permet de restreindre le résultat, par rapport à ce qui a été vu précédemment pour les « Journaux système », aux seules entrées contenant ce descripteur. Cela fournit des données plus pertinentes à l'ERP, adaptées à vos besoins.

Un exemple de ce type de fichier peut être téléchargé ici.

Utile pour:

1.4. Journaux système consommés/produits :

Point de terminaison/URI –

http://host:port/V5-API/api/integrate/export/system_logs_cp 

Description du point final

Ce point de terminaison renverra un fichier JSON contenant la liste des événements du journal système avec le descripteur « CONSUMED » ou « PRODUCED » , ce qui permet de filtrer les résultats par rapport aux « Journaux système » présentés précédemment, en ne retenant que les entrées contenant ces descripteurs. Ces journaux concernent le processus de traitement par lots principal, et plus précisément la réduction et la production des stocks. Cela permet de fournir des données plus pertinentes à l'ERP, en fonction de vos besoins.

Un exemple de ce type de fichier peut être téléchargé ici.

Utile pour:

1.5. Journaux système non consommés/produits :

Point de terminaison/URI –

http://host:port/V5-API/api/integrate/export/system_logs_noncp 

Description du point final

Ce point de terminaison agit en fait comme l'inverse du point de terminaison « Journaux système consommés/produits » ci-dessus, et renverra un fichier JSON qui répertorie les journaux système avec tout sauf les descripteurs « CONSUMED » ou « PRODUCED ».

Utile pour:

1.6. Journaux d'utilisation

Point de terminaison/URI –

http://host:port/V5-API/api/integrate/export/batch_system_logs

Description du point final

Ce point de terminaison renverra un fichier JSON contenant la liste des événements du journal système relatifs au traitement par lots. Il affinera le résultat, en le réduisant des entrées mentionnées précédemment pour les « Journaux système » aux entrées contenant des descripteurs tels que « COLLATED », « BLOT SUSPENDED », etc. (ainsi que « CONSUMED » et « PRODUCED »). Ceci permet de fournir à l'ERP des données plus pertinentes, adaptées à vos besoins.

Un exemple de ce type de fichier peut être téléchargé ici.

Utile pour:

1.7. Journaux d'utilisation (date de filtre)

Point de terminaison/URI –

http://host:port/V5-API/api/integrate/export/batch_system_logs/filterFrom/{filterDate}

Description du point final

Ce point de terminaison renvoie les mêmes informations que les « Journaux d'utilisation » ci-dessus, mais permet à un filtre à partir de la date (horodatage de l'époque) d'affiner les résultats si vous le souhaitez.

Utile pour:

1.8. Journaux de travaux

Point de terminaison/URI –

http://host:port/V5-API/api/integrate/export/job_logs

Description du point final

Ce point de terminaison fournira un fichier de retour JSON qui intègre les descripteurs système relatifs à la production des tâches.

Un exemple de fichier de ce type peut être téléchargé ici.

Utile pour:

2. Points de terminaison transactionnels/génériques

Les points de terminaison transactionnels servent à renvoyer des informations simplifiées sur les événements descripteurs , plus précisément sur la gestion des niveaux de stock par les différents modules. Contrairement aux points de terminaison génériques présentés précédemment, qui fournissent des données imbriquées variées, ces points de terminaison fournissent des informations simplifiées, sans données imbriquées.

Nous pouvons voir à quoi cela ressemblerait dans nos exemples ci-dessous :

2.1. Opérations d'ajustement

Point de terminaison/URI –

http://host:port/V5-API/api/integrate/export/transactions/adjustments

Description du point final

Ce point de terminaison peut être utilisé pour fournir une liste des transactions d'ajustement survenues dans le système. En utilisant ce point de terminaison, nous obtiendrons une entrée renvoyée chaque fois que la quantité d'un lot est modifiée (ou ajustée) à l'aide de Control Center ou de WMS. Cela pourrait être dû à des dommages ou à des produits périmés qui doivent être retirés du système.

Un exemple d'exportation de ce type pourrait ressembler à ceci :

 

Comme nous pouvons le constater ici, il s'agit d'une entrée unique pour un événement de descripteur « ADJUSTMENT » , et elle ne contient aucune des données imbriquées potentiellement superflues que nous avons vues avec le point de terminaison générique.

Un exemple de fichier de ce type peut être téléchargé ici.

Utile pour:

2.2. Transactions de consommation par lots

Point de terminaison/URI –

http://host:port/V5-API/api/integrate/export/transactions/batching/{completedBatches}

Description du point final

L'exportation des transactions de consommation par lots fournira un fichier JSON simplifié contenant les données descriptives de consommation et de production relatives à un lot spécifique terminé et traité par le système.

En utilisant ce point final, nous obtiendrons un retour indiquant tous les produits qui ont été consommés par lots, ainsi que la quantité de lots eux-mêmes qui ont ensuite été produits.

Un exemple de ce type de fichier peut être téléchargé ici.

Utile pour:

2.3. Transactions de consommation par lots (date de filtre)

Point de terminaison/URI –

http://host:port/V5-API/api/integrate/export/transactions/batching/filterfrom/{filterDate}

Description du point final

Ce point de terminaison renvoie les mêmes informations que « Consommation par lots » ci-dessus, mais permet à un filtre à partir de la date (horodatage de l'époque) d'affiner les résultats si vous le souhaitez.

Utile pour:

2.4. Transactions de bons de commande

Exporter le point de terminaison/URI –

http://host:port/V5-API/api/integrate/export/transactions/purchase

Description du point final 

L'exportation des transactions d'achat à partir de ce point de terminaison fournira un fichier JSON simplifié contenant les données de réception relatives aux commandes d'achat, y compris les descripteurs système tels que « REÇU ».

Le point de terminaison fournit uniquement ces données pour les commandes terminées qui n'ont pas été marquées comme exportées.

Un exemple de ce type de fichier peut être téléchargé ici.

Utile pour:

2.5. Transactions de commande client

Exporter le point de terminaison/URI –

http://host:port/V5-API/api/integrate/export/transactions/sales/{true/false}

Description du point final

L'exportation des transactions de vente depuis ce point de terminaison générera un fichier JSON simplifié contenant les données d'affectation, de prélèvement et d'expédition relatives aux commandes. Ce point de terminaison renverra les données de tous les articles vendus via les commandes, ainsi que des descripteurs tels que « PRÉPARÉ » et « EXPÉDIÉ ».

Le point de terminaison peut fournir ces données pour les commandes terminées (vrai) ou pour toutes les commandes (faux), à condition que ces commandes n'aient pas déjà été marquées comme exportées.

Un exemple de ce type de fichier peut être téléchargé ici.

Utile pour:

Cette page vous a été utile?
OuiNon