GraphQL API

Query all your data with GraphQL read-only queries

Overview

The Waffo Pancake GraphQL API provides read-only access to all your data. Use REST action endpoints for writes, and GraphQL for queries.

POST /v1/graphql

Authentication: API Key

The GraphQL API supports queries only. All write operations (create, update, delete) use the REST action endpoints.

Making a Request

Request Body

Field	Type	Required	Description
query	string	Yes	GraphQL query string
variables	object	No	Query variables

SDK

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" }]

Status Codes

Status	Description
200	Query succeeded (GraphQL errors in response body errors field)
400	Missing query / query syntax error / invalid environment / missing or invalid role
401	Authentication failed
403	Operation type not allowed (only Query supported) / role not permitted for this endpoint
429	Rate limit exceeded — retry after the interval in the Retry-After header
500	Internal server error

---

Schema Introspection

Recommended: Use standard GraphQL introspection to discover the full schema. This ensures you always work with the latest types and fields.

GraphQL types differ from REST/SDK types. For example, prices is a Record<string, PriceInfo> in REST but [CurrencyPrice!]! (array of {currency, priceInfo}) in GraphQL, and metadata is a parsed object in REST but a JSON string in GraphQL. Do not use SDK TypeScript type definitions to construct GraphQL queries — always use introspection or the examples below.

Discover All Available Queries

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

Discover Type Fields

query {
  __type(name: "Store") {
    name
    fields {
      name
      type { name kind ofType { name } }
    }
  }
}

API Key authentication gives you access to 18 query types including single-entity queries, list queries with filters, count queries, and analytics queries.

---

Filtering

GraphQL queries support filters using typed filter objects:

Type	Operators	Example
StringFilter	eq, ne, in, contains	{ storeId: { eq: "STO_xxx" } }
DateTimeFilter	eq, gt, lt, gte, lte	{ createdAt: { gte: "2026-01-01" } }
IntFilter	eq, gt, lt, gte, lte	{ attemptCount: { gte: 3 } }
AmountFilter	eq, ne, gt, gte, lt, lte	{ amount: { gte: "9.99" }, currency: { eq: "USD" } }
BooleanFilter	eq	{ isActive: { eq: true } }

AmountFilter values are decimal strings in the currency’s major unit (e.g. "9.99"). An amount filter must be accompanied by a sibling currency: { eq: "..." } in the same filter object — a single currency per query. Cross-currency amount comparison is not supported.

query {
  onetimeProducts(
    filter: {
      storeId: { eq: "STO_3bVzrkD0FJjFdZNLk8Ualx" }
      status: { eq: "active" }
    }
  ) {
    id
    name
    prices
  }
}

---

Pagination

Use limit and offset for pagination. Use *Count queries to get total counts.

query {
  onetimeProducts(
    filter: { storeId: { eq: "STO_3bVzrkD0FJjFdZNLk8Ualx" } }
    limit: 10
    offset: 0
  ) {
    id
    name
  }
  onetimeProductsCount(
    filter: { storeId: { eq: "STO_3bVzrkD0FJjFdZNLk8Ualx" } }
  )
}

Parameter	Type	Description
limit	integer	Maximum number of results to return
offset	integer	Number of results to skip

---

Environment-Specific Fields

The API Key environment affects which product data is returned:

• version — Returns the version for the specified environment
• status — Returns the status in the specified environment

A product may be active in test but inactive in production if it hasn’t been published yet.

---

Query Examples

Stores & Products

Query stores, one-time products, subscription products, and product versions

Orders & Payments

Query orders, subscription orders, payments, and refund tickets

Analytics

Revenue statistics, payment analytics, trend analysis, and customer insights