Förhandsgranskning av API-data som används i Shopify Flow

De flesta arbetsflöden har åtkomst till data från din butik, så att du kan använda den i villkor och åtgärder. Shopify Flow kommer åt butiksdata genom att anropa GraphQL Admin API, vilket ger dig tillgång till nästan alla fält i API:et.

När du bygger ett arbetsflöde stöter du ofta på fältnamn och beskrivningar som baseras på API:et, men du kan behöva känna till de faktiska datavärdena. Du kanske till exempel vill veta appnamnet för en order som skapats från ett orderutkast. Dessutom kanske du vill se till att ditt arbetsflöde matar ut den data du förväntar dig, eller i det format du förväntar dig.

Det finns flera alternativ i Shopify Flow för att granska datavärdena.

På den här sidan

Hitta ett fält i Shopify admin

I de flesta fall kan du hitta data genom att titta i Shopify admin. Till exempel visas product.title på sidan Produkt.

Hämta exempeldata

När du bygger ett arbetsflöde kan du hämta exempeldata direkt i Flow-redigeraren. Eftersom Flows data kommer från händelser måste du börja med att välja en relevant händelse för att få korrekta exempeldata:

Öppna en åtgärd i Flows redigerare där du vill använda datan och klicka på Lägg till en variabel. Alternativt, i ett villkor, klickar du på Lägg till kriterier.
Klicka på Konfigurera exempeldata.
Flow visar tidigare händelser baserat på arbetsflödets utlösare. Klicka på Uppdatera händelser för att hämta händelser från de senaste körningarna, eller klicka på Börja lyssna efter live-händelser och utlös sedan händelsen manuellt i adminpanelen eller relevant app (för app-baserade utlösare).
När händelsen inträffar visar Flow information om händelsen. Välj den händelse du vill använda för att hämta exempeldata. Klicka på Använd den här utlösarhändelsen.
När du nu bläddrar bland händelser bör exempeldata visas för varje variabel.

Begränsningar:

På grund av utrymmesbegränsningar för data i en lista kommer Flow endast att visa data från den första artikeln i listan.
Flow lagrar upp till 5 händelser åt gången, per arbetsflöde.
Flow kan inte hämta händelser från de senaste körningarna för vissa utlösare, till exempel Schemalagd tid, Metaobjektpost skapad, Kund anslöt sig till segment eller Kund lämnade segment.

Använd fältet i ett aktivt arbetsflöde

Du kan säkert använda fälten i ett arbetsflöde genom att använda åtgärden Loggutdata. När du kör ett arbetsflöde skriver åtgärden Loggutdata ut resultatet av alla variabler och text på sidan Körningshistorik. Du kan även använda aviseringsåtgärder som Skicka internt e-postmeddelande.

Steg för att använda Loggutdata:

Välj en utlösare som kan utlösas manuellt.
Lägg till en Loggutdata-åtgärd i arbetsflödet och anslut den till utlösaren.
Klicka på Lägg till en variabel i konfigurationen för Loggutdata för att lägga till de variabler du vill inspektera i avsnittet Utdata.
Klicka på Aktivera arbetsflöde när du är klar.
Utlös arbetsflödet, antingen genom att köra det manuellt eller genom att få utlösaren att aktiveras. Om du till exempel använder utlösaren Order skapad skapar du en testorder.
När arbetsflödet har körts, kontrollera aktivitetsloggen för variablerna.

Referera till resursens JSON-sida

De flesta resurssidor i Shopify admin, till exempel sidorna Order, Produkt eller Kund, låter dig se den data som sidan använder. Denna data har inte exakt samma namngivning och format som Shopify Flow använder, men värdena matchar det som finns i GraphQL Admin API. För att granska datan lägger du till .json i URL:en.

Navigera till exempel till en order genom att gå till sidan Ordrar i Shopify admin och klicka på en order. I sidans adress i webbläsarens adressfält ändrar du adressen från:

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

Till följande:

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

Använd GraphiQL eller ett API-verktyg från tredjepart

Du kan göra direkta anrop till API:et med hjälp av ett API-verktyg från tredjepart som Postman eller det kostnadsfria Shopify-verktyget GraphiQL. Det här alternativet ger de mest exakta resultaten, men det kräver en viss förtrogenhet med att skapa GraphQL-förfrågningar.

För GraphiQL erbjuder Shopify både en webbaserad GraphiQL-utforskare med generiska data och GraphiQL-appen. Med GraphiQL kan du bygga en GraphQL-förfrågan som exakt matchar fältnamnen i Shopify Flow. Värdena matchar även din butik exakt om du använder appen.

Genom att använda det här verktyget kan du fastställa exakt vilken data Shopify Flow använder, med din verkliga butiksdata. Du kan till exempel skapa följande förfrågan:

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

I följande resultat visar variabeln order / app / name appnamnet för ordern. I det här fallet skapades ordern från appen för orderutkast, så värdet är Draft Orders. Kanalinformation är endast tillgänglig för Point of Sale-appen.

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