Forhåndsvis API-data som brukes i Shopify Flow

Når du bygger en arbeidsflyt, kan det ofte hende at du ønsker å bruke data fra butikken din i betingelser og handlinger. Shopify Flow får tilgang til butikkdata ved å kalle opp GraphQL Admin API, som betyr at du har tilgang til nesten alle feltene i API-en.

Når du bygger en arbeidsflyt vil du ofte se feltnavn og beskrivelser basert på API-en, men hende at du ønsker å vite hvilke data som sendes av API-en. Det kan for eksempel hende du ønsker å vite appnavnet til en bestilling som ble opprettet fra et bestillingsutkast. I tillegg vil du kanskje sørge for at arbeidsflyten produserer dataene du forventer, eller i samme form som du forventer.

Det er flere alternativer for gjennomgang av data i Shopify Flow.

Finn et felt i Shopify-administratoren

I de fleste tilfeller er dataene tilgjengelige i Shopify-administrator.

Bruk feltet i en aktiv arbeidsflyt

Du kan bygge en arbeidsflyt med handlinger som hjelper deg med å gjennomgå dataene i stedet for handlingene du planlegger å bruke i den endelige versjonen. La oss for eksempel si at du vil opprette en arbeidsflyt som kansellerer en bestilling. I stedet for å bruke Kanseller bestilling, og potensielt kansellere feil bestilling, kan du begynne med å bruke handlingen Send intern e-post, eller handlingen Send Slack-melding hvis du bruker Slack.

Trinn:

1. Velg en utløser som kan utløses manuelt.
2. Legg til en handling i arbeidsflyten og koble den til utløseren, for eksempel Send intern e-post.
3. Legg til variablene du vil inspisere i seksjonen Melding i handlingen Send intern e-post.
4. Klikk på Slå på arbeidsflyt.
5. Utløs arbeidsflyten, enten ved å kjøre den manuelt eller ved å forårsake at utløseren starter. Hvis du for eksempel bruker utløseren Bestilling opprettet, kan du opprette en testbestilling.
6. Når arbeidsflyten kjører, kan du sjekke e-posten din for å finne variablene.

Se siden med JSON-ressurser

De fleste ressurssider i Shopify-administrator, som sidene Bestilling, Produkt eller Kunde, viser data som er relevante for siden. Disse dataene har ikke helt samme navn og format som Shopify Flow, men verdiene samsvarer med verdiene i GraphQL Admin API. Legg til .json i URL-adressen for å se dataene.

Du kan for eksempel finne en bestilling ved å gå fra Shopify-administrator til siden Bestillinger og klikke på en bestilling. Endre adressen til siden i adresselinjen i nettleseren fra:

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

Til følgende:

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

Merk

.json-formatet følger REST API. Bokstavene i variabelnavnene i REST API bruker understreking, for eksempel line_items. GraphQL og Shopify Flow bruker CamelCase, for eksempel lineItems. I tillegg varierer feltenes navn iblant, for eksempel properties i stedet for customAttributes. Bekreft informasjonen du finner ved hjelp av denne tilnærmingen.

Bruk GraphQL eller et tredjeparts API-verktøy

Du kan sende spørringer direkte til API-en med et tredjeparts-API-verktøy, for eksempel Postman eller det gratis Shopify-leverte verktøyet GraphQL. Dette alternativet gir de mest nøyaktige resultatene, men det krever at du har litt kjennskap til GraphQL-spørringer.

For GraphQL tilbyr Shopify både en nettbasert GraphQL-explorer med generelle data, og GraphQL-appen. Med GraphQL kan du bygge en GraphQL-spørring som stemmer helt med feltnavnene du ser i Shopify Flow. Verdiene stemmer også helt med butikken hvis du bruker appen.

Ved å bruke dette verktøyet kan du fastslå nøyaktig hvilke data Shopify Flow bruker med de faktiske dataene for butikken din. Du oppretter for eksempel følgende spørring:

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

I disse resultatene viser variabelen order / app / name appnavnet for bestillingen. I dette tilfellet ble bestillingen opprettet fra bestillingsutkast-appen, så verdien er Draft Orders. Kanalinformasjonen er bare tilgjengelig for 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"
            }
          }
        }
      ]
    }
  }