Admin APIリクエストを送信する
[Admin APIリクエストを送信する] アクションにより、Shopify GraphQL Admin APIにミューテーションを送信します。そうすることで、APIがFlowの使用を許可する、ほとんどすべてのアクションを実行できます。
フィールド
[Admin APIリクエストを送信する] アクションには、以下のフィールドが含まれます。
| フィールド | 説明 |
|---|---|
| ミューテーション | 必須。呼び出すShopify GraphQL Adminミューテーションです。ミューテーションとは、アクションを実行する、またはデータをアップデートするAPIです。 |
| ミューテーション入力 | 必須。ミューテーションリクエストの一部として送信する必要のあるデータ (JSON) です。各ミューテーションには異なるデータセット (各ミューテーションに提供されるリンクからドキュメントにアクセス可能) が必要です。必要なJSONを構築するには、Liquidまたはコードを実行するアクションを使用できます。 |
トリガー
[Admin APIリクエストを送信する] アクションは、ミューテーション入力の構築に必要なデータを提供するワークフローであれば、どのワークフローでも使用でき、どのトリガーでも開始されます。
例
例1：商品に使用するテンプレートを更新する
この例では、[Admin APIリクエストを送信する] アクションを使用して、productUpdateミューテーションを呼び出して商品に使用するテンプレートを更新します。
idフィールドは必須であり、有効な商品GIDでなければなりません。ここでは、{{product.id}}Liquid変数を使用して設定しています。これは、ワークフローに商品オブジェクトを提供するトリガーがあることを前提としています。
templateSuffixは、商品に適用するテンプレートの名前です。たとえば、pre-orderテンプレートを適用する場合は、pre-orderにtemplateSuffixを設定します。
{
"input": {
"templateSuffix": "pre-order",
"id": "{{product.id}}"
}
}例2：お客様の免税ステータスを更新する
この例では、[Admin APIリクエストを送信する] アクションを使用して、customerUpdateミューテーションを呼び出してお客様の免税ステータスを更新します。
idフィールドは必須であり、有効なお客様GIDでなければなりません。ここでは、{{order.customer.id}}Liquid変数を使用して設定しています。これは、ワークフローに注文オブジェクトを提供するトリガーがあることを前提としています。
taxExemptフィールドは、お客様が免税対象かどうかを示すブーリアンです。この例では、trueに設定しています。
{
"input": {
"id": "{{order.customer.id}}",
"taxExempt": true
}
}例3：お客様のロケールを更新する
この例では、[Admin APIリクエストを送信する] アクションを使用して、customerUpdateミューテーションを呼び出してお客様のロケールを更新します。
idフィールドは必須であり、有効なお客様GIDでなければなりません。ここでは、{{customer.id}}Liquid変数を使用して設定しています。これは、ワークフローにお客様オブジェクトを提供するトリガーがあることを前提としています。
localeフィールドは、お客様のロケールを表す文字列です。この例では、enに設定しています。
{
"input": {
"id": "{{customer.id}}",
"locale": "en"
}
}制限
[Admin APIリクエストを送信する] アクションには、以下の制限があります。
- このアクションは、ミューテーションの結果として、データをFlow環境に返すことはありません。
- このアクションは、GraphQLクエリには対応していません。ミューテーションのみに対応しています。
- このアクションは、非同期ミューテーションや
Jobタイプを返すミューテーションには対応していません。 - このアクションは、サブスクリプションやディスカウントのミューテーションなど、特定のアプリに特化したミューテーションには対応していません。
- このアクションにより、
2024-01現在の、単一Shopify APIバージョンのMutationsとMutation inputsの一覧が表示されます。 - APIのバージョンがアップグレードされ、大規模な変更が行われた場合、対象のフィールドに依存していると、このアクションが失敗する可能性があります。