Présentation de l'API de trace

L'API Transparent Supply Trace permet aux utilisateurs autorisés d'extraire des informations sur les produits, les emplacements, les événements et les transactions de la chaîne d'approvisionnement de leur organisation. La traçabilité des produits de bout en bout signifie que les utilisateurs autorisés peuvent facilement trouver et suivre le chemin des instances de produits de leur organisation tout au long de la chaîne d'approvisionnement.

Noeuds finaux de trace

API de trace fournit deux noeuds finaux: la trace de base et la trace de consommateur. La trace de base est incluse par défaut ; la trace de consommateur est un module complémentaire de valeur qui doit être sélectionné par votre organisation.

Trace de base

Le noeud final de trace de base prend une instance de produit en tant qu'entrée, sous la forme d'un lot de produits unique, d'une palette ou d'un numéro de série. Les résultats de trace de base incluent des informations d'événement et de transaction pour les deux autres instances de produit connectées du produit d'entrée. Ces connexions se produisent, par exemple, lorsque le produit d'entrée est combiné ou emballé avec d'autres produits.

Les identificateurs JSON renvoyés par un appel de trace de base sont les suivants:

  • Identification du produit
  • Instance de produit d'entrée (identificateur)
  • Instances de produit de sortie (identificateurs)
  • Evénements de chaîne d'approvisionnement

La trace de base renvoie uniquement des identificateurs JSON pour ces actifs. Pour obtenir des résultats de trace supplémentaires, l'application doit effectuer des appels supplémentaires pour renvoyer des détails tels que des descriptions de produit ou des détails d'installation d'emplacement.

Le code JSON renvoyé est une structure arborescente enracinée dans les lots / palettes d'entrée, avec d'autres lots / palettes de produits liés aux entrées initiales en tant qu'enfants imbriqués. Chaque noeud de la structure arborescente est connecté à d'autres lots / palettes de produits via des événements connexes, tels que des transformations ou des agrégations.

Lors de la traversée de la structure JSON, la direction de la chaîne d'approvisionnement peut être déduite par la nature des EPC:

  • Le lot / palette de sortie est une relation en aval via des transformations
  • Le lot/palette d'entrée est une relation en amont par le biais de transformations
  • Le lot/palette enfant est une relation en amont dans une agrégation et une relation en aval dans une désagrégation
  • Le lot/palette parent est une relation en aval dans une agrégation et une relation en amont dans une désagrégation

Chaque noeud de la structure arborescente JSON décrit également les événements pour le lot/palette de produit, tels que:

  • La transformation transforme un produit d'entrée en un nouveau produit
  • Agrégation ou désagrégation des packs ou des déconditionnements de produits séparables
  • L'observation enregistre l'emplacement du produit le long de la chaîne d'approvisionnement
  • La Commission est à l'origine de l'instance de produit sur la chaîne d'approvisionnement
  • La mise hors service retire l'instance de produit de la chaîne d'approvisionnement

L'API swagger sortante indique les noeuds finaux de service qui renvoient une sortie allant des données de base (descriptions de produit ou d'installation) aux éléments connectés, tels que ceux contenus dans les résultats de trace.

Trace du consommateur

Le noeud final de trace de consommateur prend également une instance de produit comme entrée-un lot de produits unique, une palette ou un numéro de série. Il renvoie les mêmes identificateurs JSON de trace de base, ainsi que des informations contextuelles supplémentaires pour une meilleure consommabilité.

En plus des identificateurs JSON de trace de base, la trace de consommateur renvoie également:

  • Détails du produit-identificateur et organisation propriétaire
  • Détails de l'installation-identificateur et organisation propriétaire
  • Détails de la pièce jointe-charges liées aux événements, aux produits et aux installations
  • Détails de la transaction commerciale-bon de commande, conseil d'expédition et informations de conseil
Remarque: En raison de sa portée et de ses résultats détaillés, le noeud final de trace du consommateur peut être à la fois gourmande en ressources et renvoyer un volume élevé de données. Veillez à prendre en compte ces variables lors de l'utilisation du noeud final de trace de consommateur, en particulier pour les appels automatisés.

Pour limiter les données renvoyées par la trace de consommateur, définissez un ou plusieurs des paramètres suivants sur false avec l'appel API (les valeurs par défaut sont true):

include_events
include_products
include_lots_and_serials
include_locations
include_trace
include_payloads

Remarque: Les événements et les contenus ont tendance à renvoyer le plus grand volume de données.