Aide
Se connecter

Aperçu des données d’API utilisées dans Shopify Flow

La plupart des flux de travail accèdent aux données de votre boutique, afin que vous puissiez les utiliser dans des conditions et des actions. Shopify Flow accède aux données de la boutique en appelant la GraphQL Admin API, ce qui vous donne accès à la quasi-totalité des champs de l’API.

Lorsque vous créez un flux de travail, vous rencontrez souvent des noms de champs et des descriptions basés sur l’API, mais vous pouvez avoir besoin de connaître les valeurs de ces données. Par exemple, vous pouvez vouloir connaître le nom de l’appli pour une commande créée à partir d’une commande provisoire. De plus, vous pouvez vouloir vous assurer que votre flux de travail génère les données que vous attendez, ou dans le format que vous attendez.

Pour examiner les valeurs des données, plusieurs options s’offrent à vous dans Shopify Flow.

Sur cette page

Trouver un champ dans l’interface administrateur Shopify

Dans la plupart des cas, vous pouvez trouver des données en consultant l’interface administrateur Shopify. Par exemple, product.title est indiqué sur la page Produit.

Obtenir des données d’exemple

Lorsque vous créez un flux de travail, vous pouvez obtenir des données d’exemple directement dans l’éditeur de Flow. Étant donné que les données de Flow proviennent d’événements, vous devez commencer par choisir un événement pertinent afin d’obtenir des données d’exemple précises :

  1. Dans l’éditeur de Flow, ouvrez une action où vous souhaitez utiliser les données, puis cliquez sur Ajouter une variable. Sinon, dans une condition, cliquez sur Ajouter des critères.
  2. Cliquez sur Configurer les données d’exemple.
  3. Flow affiche les événements précédents en fonction du déclencheur du flux de travail. Cliquez sur Actualiser les événements pour récupérer les événements des exécutions récentes, ou cliquez sur Commencer à écouter les événements en direct, puis déclenchez manuellement l’événement dans l’interface administrateur ou l’appli pertinente (pour les déclencheurs basés sur une appli).
  4. Une fois l’événement survenu, Flow affiche les détails le concernant. Choisissez l’événement que vous souhaitez utiliser pour obtenir des données d’exemple. Cliquez sur Utiliser cet événement déclencheur.
  5. Désormais, lorsque vous parcourez les événements, des données d’exemple devraient s’afficher pour chaque variable.

Limites :

  • En raison de contraintes d’espace, pour les données d’une liste, Flow n’affiche que les données du premier élément de la liste.
  • Flow stocke jusqu’à 5 événements à la fois, par flux de travail.
  • Flow ne peut pas récupérer les événements des exécutions récentes pour certains déclencheurs, tels que Heure programmée, Entrée de métaobjet créée, Le client a rejoint le segment ou Le client a quitté le segment.

Utiliser le champ dans un flux de travail actif

Vous pouvez utiliser les champs dans un flux de travail en toute sécurité en utilisant l’action Consigner le résultat. Lorsque vous exécutez un flux de travail, l’action Consigner le résultat imprime le résultat de toutes les variables et de tout texte sur la page Historique d’exécution. Vous pouvez également utiliser des actions de notification telles que Envoyer un e-mail interne.

Étapes pour utiliser l’action Consigner le résultat :

  1. Choisissez un déclencheur qui peut être activé manuellement.
  2. Ajoutez une action Consigner le résultat au flux de travail et connectez-la au déclencheur.
  3. Dans la configuration de l’action Consigner le résultat, cliquez sur Ajouter une variable pour ajouter les variables que vous souhaitez inspecter à la section Résultat.
  4. Lorsque vous avez terminé, cliquez sur Activer le flux de travail.
  5. Déclenchez le flux de travail, soit en l’exécutant manuellement, soit en provoquant le déclenchement du déclencheur. Par exemple, si vous utilisez le déclencheur Commande créée, créez une commande de test.
  6. Une fois le flux de travail exécuté, vérifiez l’historique d’activité pour voir les variables.

Consulter la page JSON de la ressource

La plupart des pages de ressources de l’interface administrateur Shopify, telles que les pages Commande, Produit ou Client, vous permettent d’afficher les données qui alimentent la page. Le nom et le format de ces données ne sont pas exactement les mêmes que ceux utilisés par Shopify Flow, mais les valeurs correspondent à celles de la GraphQL Admin API. Pour examiner les données, ajoutez .json à l’URL.

Par exemple, accédez à une commande en allant à la page Commandes dans votre interface administrateur Shopify, puis en cliquant sur une commande. Dans la barre d’adresse de votre navigateur, modifiez l’adresse de la page pour la faire passer de :

https://https://admin.shopify.com/store/<shopname>/orders/3804849891234

À ce qui suit :

https://https://admin.shopify.com/store/<shopname>/orders/3804849891234.json

Utiliser GraphiQL ou un outil d’API tiers

Vous pouvez interroger directement l’API à l’aide d’un outil d’API tiers tel que Postman ou l’outil gratuit fourni par Shopify, GraphiQL. Cette option fournit les résultats les plus précis, mais elle nécessite une certaine familiarité avec la création de requêtes GraphQL.

Pour GraphiQL, Shopify propose à la fois un explorateur GraphiQL en ligne avec des données génériques et l’appli GraphiQL. Avec GraphiQL, vous pouvez créer une requête GraphQL qui correspond exactement aux noms des champs dans Shopify Flow. Les valeurs correspondent également exactement à votre boutique si vous utilisez l’appli.

En utilisant cet outil, vous pouvez déterminer exactement quelles données Shopify Flow utilise, avec les données réelles de votre boutique. Par exemple, vous créez la requête suivante :

{
  orders(first:5, reverse:true) {
    nodes {
      createdAt
      app {
        name
      }
      channelInformation {
        app {
          title
        }
      }
    }
  }
}

Dans les résultats suivants, la variable order / app / name affiche le nom de l’appli pour la commande. Dans ce cas, la commande a été créée à partir de l’appli des commandes provisoires, la valeur est donc Draft Orders. Les informations sur le canal sont uniquement disponibles pour l’appli Point of Sale.

{
  "data": {
    "orders": {
      "nodes": [
        {
          "createdAt": "2023-04-10T12:32:41Z",
          "app": {
            "name": "Draft Orders"
          },
          "channelInformation": null
        },
        {
          "createdAt": "2023-04-10T12:29:12Z",
          "app": {
            "name": "Draft Orders"
          },
          "channelInformation": null
        },
        {
          "createdAt": "2023-03-17T20:23:10Z",
          "app": {
            "name": "Draft Orders"
          },
          "channelInformation": null
        },
        {
          "createdAt": "2023-03-17T20:20:53Z",
          "app": {
            "name": "Draft Orders"
          },
          "channelInformation": null
        },
        {
          "createdAt": "2023-03-17T15:45:15Z",
          "app": {
            "name": "Point of Sale"
          },
          "channelInformation": {
            "app": {
              "title": "Point of Sale"
            }
          }
        }
      ]
    }
  }