Wyślij żądanie API Admin
Czynność Wyślij żądanie API Admin powoduje wysłanie mutacji do API Shopify GraphQL Admin. W ten sposób możesz wykonać prawie wszystkie czynności, na które zezwala API za pomocą Flow.
Na tej stronie
Pola
Czynność Wyślij żądanie API Admin zawiera następujące pola.
Pole | Opis |
---|---|
Mutacja | Wymagane. Mutacja Shopify GraphQL Admin, którą chcesz wywołać. Mutacja to interfejs API, który wykonuje działanie lub aktualizuje dane. |
Dane wejściowe mutacji | Wymagane. Dane (w JSON), które musisz wysłać w ramach żądania mutacji. Każda mutacja wymaga innego zestawu danych, który jest udokumentowany w linku dostarczonym dla każdej mutacji. Aby utworzyć niezbędne pliki JSON, możesz użyć Liquid lub czynności Wykonaj kod. |
Wyzwalacze
Czynność Wyślij żądanie API Admin może być używana w każdym workflow z dowolnym wyzwalaczem, o ile workflow zapewnia dane niezbędne do utworzenia danych wejściowych mutacji.
Przykłady
Przykład 1: Zaktualizuj szablon używany dla produktu
W tym przykładzie użyjemy czynności Wyślij żądanie API Admin, aby wywołać mutację productUpdate
w celu aktualizacji szablonu używanego dla produktu.
Pole id
jest wymagane i musi być prawidłowym GID produktu. Tutaj ustawiamy je za pomocą zmiennej Liquid {{product.id}}
. Zakłada to, że workflow ma wyzwalacz, który dostarcza obiekt produktu.
templateSuffix
to nazwa szablonu, który chcesz zastosować do produktu. Na przykład, jeśli chcesz zastosować szablon pre-order
, ustaw templateSuffix na pre-order
.
{
"input": {
"templateSuffix": "pre-order",
"id": "{{product.id}}"
}
}
Przykład 2: Zaktualizuj status zwolnienia podatkowego klienta
W tym przykładzie użyjemy czynności Wyślij żądanie API Admin, aby wywołać mutację customerUpdate
w celu aktualizacji statusu zwolnienia podatkowego klienta.
Pole id
jest wymagane i musi być prawidłowym GID klienta. Tutaj ustawiamy je za pomocą zmiennej Liquid {{order.customer.id}}
. Zakłada to, że workflow ma wyzwalacz, który dostarcza obiekt zamówienia.
Pole taxExempt
jest wartością logiczną, która wskazuje, czy klient jest zwolniony z podatku. W tym przykładzie ustawiamy je na true
.
{
"input": {
"id": "{{order.customer.id}}",
"taxExempt": true
}
}
Przykład 3: Zaktualizuj ustawienia regionalne klienta
W tym przykładzie użyjemy czynności Wyślij żądanie API Admin, aby wywołać mutację customerUpdate
w celu aktualizacji ustawień regionalnych klienta.
Pole id
jest wymagane i musi być prawidłowym GID klienta. Tutaj ustawiamy je za pomocą zmiennej Liquid {{customer.id}}
. Zakłada to, że workflow ma wyzwalacz, który dostarcza obiekt klienta.
Pole locale
jest ciągiem znaków reprezentującym ustawienia regionalne klienta. W tym przykładzie ustawiamy je na en
.
{
"input": {
"id": "{{customer.id}}",
"locale": "en"
}
}
Ograniczenia
Czynność Wyślij żądanie API Admin ma następujące ograniczenia:
- Czynność nie zwraca danych do środowiska Flow w wyniku mutacji.
- Czynność nie obsługuje zapytań GraphQL, tylko mutacje.
- Czynność nie obsługuje mutacji asynchronicznych ani mutacji zwracających typ
Job
. - Czynność nie obsługuje mutacji specyficznych dla niektórych aplikacji, które obejmują subskrypcje i mutacje rabatowe.
- Czynność spowoduje wyświetlenie listy
Mutations
iMutation inputs
z jednej wersji API Shopify. Jest to obecnie2024-01
. - Jeśli zaktualizowana wersja API zawiera istotną zmianę, może to spowodować niepowodzenie tej czynności, gdy użyjesz tego pola.