Voorbeeld van API-gegevens die in Shopify Flow worden gebruikt

Wanneer je een workflow bouwt, zal het vaak voorkomen dat je gegevens uit je winkel gebruikt in voorwaarden en acties. Shopify Flow heeft toegang tot winkelgegevens door de GraphQL Admin API aan te roepen. Dit betekent dat je toegang hebt tot bijna alle velden in de API.

Tijdens het bouwen van een workflow kom je vaak veldnamen en -beschrijvingen tegen op basis van de API, maar het kan handig zijn als je weet welke gegevens door de API worden uitgevoerd. Je wilt bijvoorbeeld de naam van de app weten voor een bestelling die is aangemaakt op basis van een conceptbestelling. Daarnaast wil je er waarschijnlijk voor zorgen dat je workflow de gegevens uitvoert die je verwacht, of in de vorm die je verwacht.

Als je de gegevens wilt bekijken, zijn er verschillende opties in Shopify Flow.

Een veld zoeken in het Shopify-beheercentrum

In de meeste gevallen zijn de gegevens beschikbaar in het Shopify-beheercentrum.

Het veld in een live workflow gebruiken

Je kunt een workflow bouwen met acties waarmee je gegevens kunt controleren en niet meteen de acties die je in de definitieve versie wilt gebruiken. Stel dat je een workflow wilt aanmaken die een bestelling annuleert. In plaats van de actie Bestelling annuleren te gebruiken en mogelijk de verkeerde bestelling te annuleren, kun je eerst de actie Interne e-mail verzenden of de actie Slack-bericht verzenden als je Slack gebruikt.

Stappen:

1. Kies een trigger die handmatig kan worden geactiveerd.
2. Voeg een actie aan de workflow toe en koppel deze aan de trigger, bijvoorbeeld Interne e-mail verzenden.
3. Voeg de variabelen die je wilt inspecteren toe aan de sectie Bericht van de actie Interne e-mail verzenden.
4. Klik op Workflow inschakelen.
5. Trigger de workflow door deze handmatig uit te voeren of door ervoor te zorgen dat de trigger wordt geactiveerd. Als je bijvoorbeeld de trigger Bestelling aangemaakt gebruikt, maak je een testbestelling aan.
6. Voer de workflow uit en controleer je de variabelen in je e-mail.

De JSON-bronpagina bekijken

Met de meeste bronpagina's in het Shopify-beheercentrum, zoals de pagina's Bestelling, Product of Klant, kun je de onderliggende gegevens van de pagina bekijken. Deze gegevens hebben niet precies dezelfde naam en indeling die Shopify Flow gebruikt, maar de waarden komen overeen met de inhoud van de GraphQL Admin API. Als je de gegevens wilt bekijken, voeg je .json aan de URL toe.

Navigeer bijvoorbeeld naar een bestelling door in het Shopify-beheercentrum naar de pagina Bestellingen te gaan en op een bestelling te klikken. Wijzig het adres van de pagina in de adresbalk van je browser:

https://<your_domain>.myshopify.com/admin/orders/3804849891234

Als volgt:

https://<your_domain>.myshopify.com/admin/orders/3804849891234.json

Opmerking

De .json-indeling volgt de REST API. In de variabelenamen in REST API worden onderstrepingstekens gebruikt, bijvoorbeeld line_items. GraphQL en Shopify Flow maken gebruik van camelCasing, bijvoorbeeld lineItems. Bovendien verschillen veldnamen soms, bijvoorbeeld properties in plaats van customAttributes. Controleer de informatie die je op deze manier vindt.

GraphiQL of een API-tool van derden gebruiken

Je kunt rechtstreeks een query uitvoeren op de API met behulp van een externe API-tool zoals Postman of de gratis Shopify-tool GraphiQL. Deze optie biedt de meest nauwkeurige resultaten, maar vereist enige bekendheid met het maken GraphQL-query's.

Voor GraphiQL biedt Shopify zowel een webgebaseerde GraphiQL-explorer met generieke gegevens als de GraphiQL-app. Met GraphiQL kun je een GraphQL maken die exact overeenkomt met de veldnamen die je in Shopify Flow ziet. De waarden komen ook exact overeen met je winkel als je de app gebruikt.

Door deze tool te gebruiken, kun je precies bepalen welke gegevens Shopify Flow gebruikt, met je echte winkelgegevens. Je maakt bijvoorbeeld de volgende query aan:

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

In de volgende resultaten geeft de variabele order / app / name de app-naam voor de bestelling weer. In dit geval is de bestelling aangemaakt vanuit de conceptbestellingen-app, dus de waarde is Draft Orders. Kanaalgegevens zijn alleen beschikbaar voor de Point of Sale-app.

{
  "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"
            }
          }
        }
      ]
    }
  }