Voorbeeld van API-gegevens in Shopify Flow bekijken
De meeste workflows hebben toegang tot gegevens uit je winkel, zodat je die kunt gebruiken in voorwaarden en acties. Shopify Flow krijgt toegang tot winkelgegevens door de GraphQL Admin API aan te roepen, waardoor je toegang hebt tot bijna alle velden in de API.
Tijdens het bouwen van een workflow kom je vaak veldnamen en beschrijvingen tegen die zijn gebaseerd op de API, maar soms moet je de waarden van die gegevens weten. Je wilt bijvoorbeeld weten wat de appnaam is voor een bestelling die is aangemaakt vanuit een conceptbestelling. Daarnaast wil je er misschien zeker van zijn dat je workflow de gegevens uitvoert die je verwacht, of in de vorm die je verwacht.
Om de waarden van de gegevens te bekijken, heb je verschillende opties in Shopify Flow.
Op deze pagina
Een veld zoeken in het Shopify-beheercentrum
In de meeste gevallen kun je gegevens vinden door in het Shopify-beheercentrum te kijken. Zo staat product.title bijvoorbeeld vermeld op de pagina Product.
Voorbeeldgegevens ophalen
Wanneer je een workflow bouwt, kun je voorbeeldgegevens rechtstreeks in de Flow-editor ophalen. Omdat de gegevens van Flow afkomstig zijn van events, moet je, om nauwkeurige voorbeeldgegevens te krijgen, beginnen met het kiezen van een relevant event:
- Open in de editor van Flow een actie waar je de gegevens wilt gebruiken en klik op Een variabele toevoegen. In een voorwaarde kun je ook klikken op Criteria toevoegen.
- Klik op Voorbeeldgegevens configureren.
- Flow geeft eerdere events weer op basis van de trigger van de workflow. Klik op Events vernieuwen om events van recente runs op te halen, of klik op Naar live events luisteren en trigger het event vervolgens handmatig in het beheerpaneel of de betreffende app (voor triggers op basis van apps).
- Nadat het event heeft plaatsgevonden, geeft Flow gegevens over het event weer. Kies het event dat je wilt gebruiken om voorbeeldgegevens op te halen. Klik op Deze triggerevent gebruiken.
- Als je nu door events bladert, zouden er voor elke variabele voorbeeldgegevens moeten worden weergegeven.
Beperkingen:
- Vanwege ruimtegebrek geeft Flow voor gegevens in een lijst alleen gegevens van het eerste artikel in de lijst weer.
- Flow slaat maximaal 5 events per workflow tegelijk op.
- Flow kan voor sommige triggers, zoals 'Geplande tijd', 'Metaobject-item aangemaakt', 'Klant is lid geworden van segment' of 'Klant heeft segment verlaten', geen events van recente runs ophalen.
Het veld gebruiken in een live workflow
Je kunt de velden veilig in een workflow gebruiken door de actie Uitvoer loggen te gebruiken. Wanneer je een workflow uitvoert, drukt de actie Uitvoer loggen de uitvoer van variabelen en tekst af op de pagina Run-geschiedenis. Je kunt ook meldingsacties gebruiken, zoals Interne e-mail verzenden.
Stappen om 'Uitvoer loggen' te gebruiken:
- Kies een trigger die handmatig kan worden geactiveerd.
- Voeg de actie Uitvoer loggen toe aan de workflow en verbind deze met de trigger.
- Klik in de configuratie van Uitvoer loggen op Een variabele toevoegen om de variabelen die je wilt inspecteren toe te voegen aan de sectie Uitvoer.
- Klik op Workflow inschakelen als je klaar bent.
- Activeer de workflow, hetzij door deze handmatig uit te voeren, hetzij door de trigger te laten afgaan. Als je bijvoorbeeld de trigger Bestelling aangemaakt gebruikt, maak je een testbestelling aan.
- Nadat de workflow is uitgevoerd, controleer je het activiteitenlogboek voor de variabelen.
De JSON-pagina van de resource raadplegen
Op de meeste resourcepagina's in het Shopify-beheercentrum, zoals de pagina's Bestelling, Product of Klant, kun je de gegevens bekijken die voor de pagina worden gebruikt. Deze gegevens hebben niet precies dezelfde naam en indeling als die van Shopify Flow, maar de waarden komen overeen met die in de GraphQL Admin API. Voeg .json toe aan de URL om de gegevens te bekijken.
Navigeer bijvoorbeeld naar een bestelling door in het Shopify-beheercentrum naar de pagina Bestellingen te gaan en op een bestelling te klikken. Wijzig in de adresbalk van je browser het adres van de pagina van:
https://https://admin.shopify.com/store/<shopname>/orders/3804849891234
Naar het volgende:
https://https://admin.shopify.com/store/<shopname>/orders/3804849891234.json
GraphiQL of een externe API-tool gebruiken
Je kunt de API rechtstreeks bevragen met een externe API-tool zoals Postman of de gratis door Shopify geleverde tool, GraphiQL. Deze optie geeft de meest nauwkeurige resultaten, maar vereist wel enige bekendheid met het aanmaken van GraphQL-query's.
Voor GraphiQL biedt Shopify zowel een webgebaseerde GraphiQL-verkenner met algemene gegevens als de GraphiQL-app. Met GraphiQL kun je een GraphQL-query bouwen die exact overeenkomt met de veldnamen in Shopify Flow. De waarden komen ook exact overeen met die van je winkel als je de app gebruikt.
Door deze tool te gebruiken, kun je precies bepalen welke gegevens Shopify Flow gebruikt, met de echte gegevens van je winkel. 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 appnaam voor de bestelling weer. In dit geval is de bestelling aangemaakt vanuit de app Conceptbestellingen, 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"
}
}
}
]
}
}