メインコンテンツへスキップ

​
概要

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

​
リクエストの作成

​
リクエストボディ

フィールド型必須説明
querystringYesGraphQL クエリ文字列
variablesobjectNoクエリ変数
import { WaffoPancake } from "@waffo/pancake-ts";

const client = new WaffoPancake({
  merchantId: process.env.WAFFO_MERCHANT_ID!,
  privateKey: process.env.WAFFO_PRIVATE_KEY!,
});

interface StoresQuery {
  stores: Array<{ id: string; name: string; status: string }>;
}

const result = await client.graphql.query<StoresQuery>({
  query: `{ stores { id name status } }`,
});
console.log(result.stores);
// => [{ id: "STO_2aUyqjCzEIiEcYMKj7TZtw", name: "My Store", status: "active" }]

​
ステータスコード

ステータス説明
200クエリ成功（GraphQL エラーはレスポンスボディの errors フィールドに含まれます）
400クエリ欠落 / 深度超過 / 無効な環境 / ロールの欠落または無効
401認証失敗
403操作タイプが許可されていません（Query のみサポート）
500内部サーバーエラー

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

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

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

query {
  __schema {
    queryType {
      fields {
        name
        description
        args {
          name
          type { name kind }
        }
      }
    }
  }
}

​
型フィールドを検出

query {
  __type(name: "Store") {
    name
    fields {
      name
      type { name kind ofType { name } }
    }
  }
}
API Key 認証では、単一エンティティクエリ、フィルター付きリストクエリ、カウントクエリ、分析クエリを含む 18 種類のクエリタイプにアクセスできます。

​
フィルタリング

GraphQL クエリは型付きフィルターオブジェクトを使用したフィルタリングをサポートしています。
型演算子例
StringFiltereq, ne, in, contains{ storeId: { eq: "STO_xxx" } }
DateTimeFiltereq, gt, lt, gte, lte{ createdAt: { gte: "2026-01-01" } }
IntFiltereq, gt, lt, gte, lte{ amount: { gte: 1000 } }
BooleanFiltereq{ isActive: { eq: true } }
query {
  onetimeProducts(
    filter: {
      storeId: { eq: "STO_3bVzrkD0FJjFdZNLk8Ualx" }
      status: { eq: "active" }
    }
  ) {
    id
    name
    prices
  }
}

​
ページネーション

ページネーションには limit と offset を使用します。合計件数を取得するには *Count クエリを使用します。 
query {
  onetimeProducts(
    filter: { storeId: { eq: "STO_3bVzrkD0FJjFdZNLk8Ualx" } }
    limit: 10
    offset: 0
  ) {
    id
    name
  }
  onetimeProductsCount(
    filter: { storeId: { eq: "STO_3bVzrkD0FJjFdZNLk8Ualx" } }
  )
}
パラメータ型説明
limitinteger返す結果の最大数
offsetintegerスキップする結果の数

​
環境固有のフィールド

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

​
クエリ例

ストアと商品

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

注文と決済

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

分析

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