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

Lorsque vous créez un flux de travail, il est souvent possible que vous vouliez utiliser les données de votre boutique dans certaines conditions et actions. Shopify Flow accède aux données de la boutique en appelant l’API GraphQL Admin, ce qui signifie que vous avez accès à presque tous les champs de l’API.

Au cours de la mise en place d’un flux de travail, vous rencontrerez souvent des noms de champs et des descriptions en fonction de l’API, mais vous devrez peut-être savoir quelles sont les données sorties par l’API. Par exemple, vous voudrez peut-être connaître le nom de l’application pour une commande créée à partir d’une commande provisoire. De plus, vous voudrez peut-être vous assurer que votre flux de travail extraie les données que vous attendez, ou dans le formulaire que vous attendez.

Pour étudier ces données, vous avez plusieurs options dans Shopify Flow.

Trouver un champ dans l’interface administrateur Shopify

Dans la plupart des cas, les données sont disponibles dans l’interface administrateur Shopify. Par exemple, product.title est répertorié à la page de produit.

Utiliser le champ dans un flux de travail en direct

Vous pouvez utiliser les champs d’un flux de travail en toute sécurité en utilisant l’action Sortie de journal. Lorsque vous exécutez un flux de travail, l’action Sortie de journal imprime la sortie de toutes les variables et du texte sur la page Historique des exécutions. Vous pouvez également utiliser les actions de notification telles que Envoyer un e-mail interne.

Étapes pour utiliser la sortie de journal :

1. Choisissez un déclencheur qui peut être utilisé manuellement.
2. Ajoutez une action Sortie de journal au flux de travail et connectez-la au déclencheur.
3. Dans la configuration Sortie de journal, cliquez sur Ajouter une variable pour ajouter les variables que vous souhaitez voir apparaître dans la section Sortie.
4. Une fois terminé, cliquez sur Activer le flux de travail.
5. Déclenchez le flux de travail, soit en l’exécutant manuellement, soit en exécutant le déclencheur. Par exemple, si vous utilisez le déclencheur Commande créée, créez une commande de test.
6. Une fois que le flux de travail s’exécute, cochez l’historique d’activité pour les variables.

Voir la page JSON de ressource

La plupart des pages ressources de l’interface administrateur Shopify, telles que les pages Commande, Produit ou Client, vous permettent de voir les données qui servent la page. Ces données n’ont pas exactement le même nom et le même format que ceux que Shopify Flow utilise, mais les valeurs correspondent à ce qui se trouve dans l’API Admin GraphQL. Pour examiner les données, ajoutez l’extension .json à l’URL.

Par exemple, accédez à une commande en vous rendant sur la page Commandes de l’interface administrateur Shopify et en cliquant sur une commande. Dans l’adresse de la page de la barre d’adresse de votre navigateur, changez l’adresse de :

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

Effectuez les opérations suivantes :

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

Remarque

Le format .json suit l’API REST. La casse des noms de variables dans l’API REST utilise les traits de soulignement, tels que line_items. GraphQL et Shopify Flow utilisent le « camelCasing », tel que « lineItems ». En outre, il arrive parfois que les noms de champs diffèrent, comme properties au lieu de customAttributes. Vérifiez les informations que vous trouvez en utilisant cette approche.

Utiliser GraphQL ou un outil API tiers

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

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

En utilisant cet outil, vous pouvez déterminer exactement quelles données Shopify Flow utilise, avec vos données réelles de 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’application pour la commande. Dans ce cas, la commande a été créée à partir de l’application de commandes provisoires, de sorte que la valeur est Draft Orders. Les informations du canal ne sont disponibles que pour l’application 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"
            }
          }
        }
      ]
    }
  }