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

När du skapar ett arbetsflöde kanske du ofta vill använda data från din butik under villkor och åtgärder. Shopify Flow kommer åt butiksdata genom GraphQL admin-API, vilket innebär att du har åtkomst till nästan alla fält i API:n.

När du bygger ett arbetsflöde kommer du ofta stöta på fältnamn och beskrivningar baserade på API, men du kan behöva veta vilka data som matas ut av API:n. Du kanske till exempel vill veta appnamnet för en order som skapades från ett orderutkast. Du kanske dessutom vill se till att ditt arbetsflöde matar ut de data som du förväntar dig eller i det format som du förväntar dig.

För att granska data har du flera alternativ i Shopify Flow.

Hitta ett fält i Shopify-admin

I de flesta fall kan du hitta data genom att leta i Shopify-admin. Till exempel listas product.title på produktsidan.

Använd fältet i ett livearbetsflöde

Du kan använda fälten i ett arbetsflöde på ett säkert sätt genom att använda åtgärden Loggutmatning . När du kör ett arbetsflöde kommer åtgärden Loggutmatning att skriva ut utdata från alla variabler och text på sidan Kör historik. Du kan även använda aviseringsåtgärder, till exempel Skicka internt e-postmeddelande.

Steg för att använda Logga utdata:

1. Välj en utlösare som kan utlösas manuellt.
2. Lägg till en åtgärd Logga utdata i arbetsflödet och anslut den till utlösaren.
3. I konfigureringen av Logga utdata, klicka på Lägg till en variabel för att lägga till variablerna som du vill se i avsnittet Utdata.
4. När du är klar klickar du på Aktivera arbetsflöde.
5. Utlös arbetsflödet, antingen genom att köra det manuellt eller genom att orsaka att utlösaren utlöses. Om du till exempel använder utlösaren Order skapad, skapa sedan en testorder.
6. När arbetsflödet har körs, kontrollera aktivitetsloggen för variablerna.

Se resurs-JSON-sidan

De flesta resurssidorna i Shopify-admin, till exempel sidorna Order, Produkt och Kund, låter dig se data som betjänar sidan. Denna data är inte med exakt samma namngivning och format som Shopify Flow använder, men värdena matchar vad som finns i GraphQL Admin API. För att granska data, lägg till .json till URL:en.

Navigera till exempel till en order genom att i Shopify-admin gå till sidan Ordrar och klicka på en order. I adressen till sidan i adressfältet i din webbläsare ändrar du adressen från:

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

Gör följande:

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

Observera

.json-formatet följer REST API. För variabelnamnen i REST API används understreck, till exempel line_items. GraphQL och Shopify Flow använder snäckor, till lineItems. Dessutom kan fältnamn ibland skilja sig åt, till properties istället för customAttributes. Verifiera den information som du hittar med denna metod.

Använd GraphiQL eller ett tredjeparts API-verktyg

Du kan direkt skicka en förfrågan till API genom att använda ett tredjeparts API-verktyg såsom Postman eller det kostnadsfria Shopify-tillhandahållna verktyget GraphiQL. Det här alternativet ger de mest exakta resultaten, men det kräver viss kunskap om hur du skapar GraphQL-förfrågningar.

För GraphiQL erbjuder Shopify både en webbaserad GraphiQL-explorer med generiska data och GraphiQL-appen. Med GraphiQL kan du skapa en GraphQL som exakt matchar de fältnamn som du ser i Shopify Flow. Värdena matchar också exakt din butik om du använder appen.

Genom att använda det här verktyget kan du bestämma exakt vilka data Shopify Flow använder, med din verkliga butiksdata. Du skapar till exempel följande fråga:

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

I följande resultat visar variabelnamnet 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 appen 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"
            }
          }
        }
      ]
    }
  }