Wyświetl podgląd danych API używanych w Shopify Flow

Podczas tworzenia workflow możesz często używać danych ze swojego sklepu w warunkach i czynnościach. Shopify Flow uzyskuje dostęp do danych sklepu, wywołując interfejs API GraphQL Admin, co oznacza, że masz dostęp do prawie wszystkich pól w API.

Podczas tworzenia workflow możesz często napotykać nazwy pól i opisy oparte na API. Być może będziesz potrzebować także wiedzy na temat danych wyprowadzanych przez API. Na przykład możesz chcieć poznać nazwę aplikacji dla zamówienia, które zostało utworzone na podstawie wersji roboczej zamówienia. Ponadto możesz mieć potrzebę upewnienia się, że Twój workflow wyprowadza dane, których oczekujesz, lub w wymaganym przez Ciebie formularzu.

Aby sprawdzić dane, możesz skorzystać z kilku opcji dostępnych w Shopify Flow.

Znajdź pole w panelu administracyjnym Shopify

W większości przypadków dane są dostępne w panelu administracyjnym Shopify.

Użyj pola w aktywnym workflow

Możesz utworzyć workflow za pomocą czynności, które pomogą Ci sprawdzić dane, a nie czynności, których zamierzasz użyć w wersji finalnej. Załóżmy na przykład, że chcesz utworzyć workflow, który anuluje zamówienie. Zamiast używać czynności Anuluj zamówienie i potencjalnie anulować niewłaściwe zamówienie, możesz zacząć od czynności Wyślij wewnętrzną wiadomość e-mail lub Wyślij wiadomość Slack, jeśli korzystasz ze Slacka.

Kroki:

1. Wybierz wyzwalacz, który może być uruchamiany ręcznie.
2. Dodaj czynność do workflow i połącz ją z wyzwalaczem, np. Wyślij wewnętrzną wiadomość e-mail.
3. Dodaj zmienne, które chcesz sprawdzić, do sekcji Wiadomość w czynności Wyślij wewnętrzną wiadomość e-mail.
4. Kliknij opcję Włącz workflow.
5. Wyzwól workflow, uruchamiając go ręcznie lub powodując uruchomienie wyzwalacza. Na przykład, jeśli używasz wyzwalacza Utworzono zamówienie, utwórz zamówienie testowe.
6. Po uruchomieniu workflow sprawdź wiadomość e-mail pod kątem zmiennych.

Zapoznaj się ze stroną JSON zasobu

Większość stron zasobów w panelu administracyjnym Shopify, takich jak strony Zamówienie, Produkt lub Klient, umożliwia wyświetlanie danych wykorzystywanych na danej stronie. Dane te nie mają dokładnie tego samego nazewnictwa i formatu, jakich używa Shopify Flow, ale wartości są zgodne z tym, co znajduje się w interfejsie API GraphQL Admin. Aby przejrzeć dane, dodaj .json do adresu URL.

Możesz na przykład przejść do zamówienia, wyświetlając w panelu administracyjnym Shopify stronę Zamówienia i klikając zamówienie. W adresie strony na pasku adresu przeglądarki zmień adres z:

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

na poniższy:

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

Uwaga

Format .json jest zgodny z interfejsem API REST. W formatowaniu nazw zmiennych w API REST używane są podkreślenia, takie jak line_items. GraphQL i Shopify Flow używają camelCasing, np. lineItems. Ponadto czasami nazwy pól mogą się różnić, np. properties zamiast customAttributes. Zweryfikuj informacje, które znajdziesz za pomocą tej metody.

Użyj narzędzia GraphiQL lub API firmy zewnętrznej

Możesz bezpośrednio wysłać zapytanie do interfejsu API, korzystając z narzędzia API firmy zewnętrznej, takiego jak Postman lub GraphiQL – bezpłatnego narzędzia oferowanego przez Shopify. Ta opcja zapewnia najbardziej dokładne wyniki, ale wymaga pewnej znajomości tworzenia zapytań GraphQL.

Dla GraphiQL Shopify oferuje zarówno internetowy GraphiQL Explorer z danymi ogólnymi, jak i aplikację GraphiQL. GraphiQL można wykorzystać do utworzenia zapytania GraphQL, które dokładnie odpowiada nazwom pól widocznym w aplikacji Shopify Flow. Wartości dokładnie odpowiadają również Twojemu sklepowi, jeśli korzystasz z aplikacji.

Za pomocą tego narzędzia możesz dokładnie określić, jakich danych używa aplikacja Shopify Flow, korzystając z rzeczywistych danych sklepu. Możesz na przykład utworzyć poniższe zapytanie:

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

W poniższych wynikach zmienna order / app / name wyświetla nazwę aplikacji dla zamówienia. W tym przypadku zamówienie zostało utworzone przy użyciu aplikacji dla wersji roboczych zamówień, więc wartość to Draft Orders. Informacje o kanale są dostępne tylko dla aplikacji 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"
            }
          }
        }
      ]
    }
  }