Skip to main content

概要

Waffo Pancake GraphQL API は、すべてのデータへの読み取り専用アクセスを提供します。書き込みには REST アクションエンドポイントを使用し、クエリには GraphQL を使用します。
認証: API Key
GraphQL API はクエリのみをサポートしています。すべての書き込み操作(作成、更新、削除)は REST アクションエンドポイントを使用します。

リクエストの作成

リクエストボディ

ステータスコード


スキーマイントロスペクション

推奨: 標準の GraphQL イントロスペクションを使用して完全なスキーマを検出してください。これにより、常に最新の型とフィールドで作業できます。
GraphQL の型は REST/SDK の型と異なります。 例えば、prices は REST では Record<string, PriceInfo>(オブジェクトマップ)ですが、GraphQL では [CurrencyPrice!]!{currency, priceInfo} の配列)です。また metadata は REST では解析済みオブジェクトですが、GraphQL では JSON 文字列です。SDK の TypeScript 型定義を使って GraphQL クエリを構築しないでください。常にイントロスペクションまたは以下の例を使用してください。

利用可能なすべてのクエリを検出

型フィールドを検出

API Key 認証では、単一エンティティクエリ、フィルター付きリストクエリ、カウントクエリ、分析クエリを含む 18 種類のクエリタイプにアクセスできます。

フィルタリング

GraphQL クエリは型付きフィルターオブジェクトを使用したフィルタリングをサポートしています。
AmountFilter の値は通貨の主単位の10進文字列です(例: "9.99")。金額フィルターは、同じ filter オブジェクト内に currency: { eq: "..." }(単一通貨)を必ず併記する必要があります。通貨をまたいだ金額比較はサポートされていません。

ページネーション

ページネーションには limitoffset を使用します。合計件数を取得するには *Count クエリを使用します。

環境固有のフィールド

API Key の環境は、どの商品データが返されるかに影響します。
  • version — 指定された環境のバージョンを返します
  • status — 指定された環境でのステータスを返します
商品がまだ公開されていない場合、test では active で production では inactive になることがあります。

クエリ例

ストアと商品

ストア、単発商品、サブスクリプション商品、商品バージョンのクエリ

注文と決済

注文、サブスクリプション注文、決済、返金チケットのクエリ

分析

収益統計、決済分析、トレンド分析、顧客インサイト