Shopify Flow en GraphQL Admin API
Flow gebruikt de Shopify GraphQL Admin API om automatiseringen en integraties te bouwen die het Shopify-beheercentrum uitbreiden en verbeteren. Flow gebruikt versie 2026-01 van de API om voorwaarden en variabelen in workflows te evalueren en acties uit te voeren in je Shopify-winkel. Omdat Flow winkelgegevens opent door de API aan te roepen, heb je vanuit Flow toegang tot bijna alle velden die beschikbaar zijn in de API.
Omdat Shopify elke 3 maanden nieuwe API-versies uitbrengt, moeten sommige workflows mogelijk worden bijgewerkt wanneer velden worden gewijzigd of verouderd zijn.
De GraphQL Admin API in workflows gebruiken
De meeste acties in Flow gebruiken de GraphQL Admin API om wijzigingen aan te brengen in je Shopify-winkel. De actie Bestellingstags toevoegen gebruikt bijvoorbeeld de tagsAdd-mutatie. De actie Admin API-verzoek verzenden kan de meeste mutaties gebruiken, inclusief mutaties die nog niet als acties beschikbaar zijn in Flow.
Wanneer je workflows aanmaakt, kom je vaak veldnamen en beschrijvingen tegen die zijn gebaseerd op de syntaxis van de GraphQL Admin API. Om bijvoorbeeld de totale verkoopbare hoeveelheid van een variant in een workflow te bepalen, gebruik je de variabele variants_item.inventoryQuantity. Een ander voorbeeld: om de locatie te bepalen waar een klant zich heeft geabonneerd op je e-mailnieuwsbrief, gebruik je de variabele emailSubscriptionMethod.
Je hoeft de API niet volledig te beheersen om workflows aan te maken met de Flow-app, maar als je iets weet over de namen en definities van variabelen, kan dit je helpen de specifieke workflowlogica te bouwen die je wilt. Als je bijvoorbeeld het verschil weet tussen de displayName en de firstName van een klant, kan je workflow de juiste gegevens ophalen, afhankelijk van waarvoor je ze wilt gebruiken. Definities zijn opgenomen bij elke variabele terwijl je je workflow bouwt, en je kunt op klikken voor meer informatie over een variabele of definitie.
Winkelgegevens en de GraphQL Admin API
Workflows gebruiken gegevens uit je winkel in voorwaarden en acties. Flow opent winkelgegevens met behulp van de GraphQL Admin API, wat betekent dat je toegang hebt tot bijna alle velden in de API. Als een actie niet over de benodigde gegevens beschikt die door de trigger of een Gegevens ophalen-actie worden geleverd, wordt de workflow niet uitgevoerd en wordt er een foutmelding weergegeven.
Een workflow start bijvoorbeeld met een Klant aangemaakt-trigger en importeert klantgegevens in de workflow. Als die trigger wordt gevolgd door een Bestellingstags toevoegen-actie, waarvoor bestelgegevens en geen klantgegevens nodig zijn, resulteert de workflow in een fout over ontbrekende gegevens.
Mogelijk moet je gegevens vooraf bekijken of de API-documentatie doornemen om te begrijpen welke output de API geeft voor gebruik in Flow en om te controleren of je workflow de verwachte gegevens uitvoert.
Veldargumenten en GraphQL Admin API
Sommige velden in de GraphQL Admin API vereisen argumenten, extra parameters die beperken welke gegevens worden geretourneerd. Het veld product.inCollection heeft bijvoorbeeld een collectie-id-argument nodig om te weten welke collectie gecontroleerd moet worden. Zonder dit argument kan het veld geen resultaat retourneren.
In Flow kun je vanuit deze velden variabelen aanmaken door de vereiste argumentwaarde op te geven. Deze variabelen kun je vervolgens gebruiken in de workflow. Je kunt ook een aangepaste naam aan de variabele toewijzen om er in latere stappen gemakkelijker naar te verwijzen, door product.inCollection(id: "gid://shopify/Collection/123456") bijvoorbeeld de naam product.inSummerBestsellers te geven.
Meer informatie over variabelen aanmaken uit velden met argumenten.
Voor het aanmaken van variabelen uit metavelden is extra informatie in Flow vereist, omdat je de naamruimte en sleutel van elk metaveld zelf definieert. De argumenten zijn dus altijd uniek voor je winkel. Meer informatie over metavelden in Flow.
API-versiebeheer
Shopify brengt elke 3 maanden nieuwe API-versies uit. Flow neemt nieuwe versies zo snel mogelijk over, maar loopt mogelijk achter op de nieuwste versie. Waar mogelijk worden wijzigingen tussen versies automatisch opgelost, maar sommige wijzigingen zijn mogelijk niet eenduidig, zoals in de volgende situaties:
- Wanneer velden worden verwijderd maar er geen vervanging wordt geboden, wat invloed kan hebben op hoe voorwaarden of Liquid worden geëvalueerd.
- Wanneer velden nullable worden, wat invloed kan hebben op hoe voorwaarden of Liquid worden geëvalueerd.
- Wanneer enum-waarden veranderen of nieuwe union- of interface-typen worden toegevoegd, wat invloed kan hebben op Liquid of code.
- Wanneer mutatie-argumenten veranderen, wat invloed kan hebben op de configuratie van 'Admin API-verzoek verzenden'-acties.
Sommige workflows moeten mogelijk handmatig worden bijgewerkt. In deze gevallen geven workflows mogelijk een foutmelding Update vereist of Niet-ondersteunde API weer en word je naar de relevante API-documentatie geleid om de vereiste wijzigingen aan te brengen in de workflow-editor. Wanneer deze updates zijn voltooid en opgeslagen, wordt de workflow automatisch bijgewerkt naar de nieuwste API-versie die beschikbaar is in Flow.
Je kunt ervoor kiezen om problemen tijdelijk te negeren om dringende wijzigingen aan te brengen in een workflow met compatibiliteitsfouten met API-versies. Als deze problemen niet worden opgelost, wordt de workflow mogelijk niet meer uitgevoerd of veroorzaakt deze fouten wanneer de oudere API-versie niet meer wordt ondersteund door Shopify.