Skip to main content

概述

Waffo Pancake GraphQL API 提供对所有数据的只读访问。写操作使用 REST action 端点,查询使用 GraphQL。
认证方式: API Key
GraphQL API 仅支持查询(Query)。所有写操作(创建、更新、删除)使用 REST action 端点

发送请求

请求体

状态码


Schema 内省

推荐: 使用标准 GraphQL 内省查询来发现完整 Schema。这确保您始终使用最新的类型和字段。
GraphQL 类型与 REST/SDK 类型不同。 例如,prices 在 REST 中是 Record<string, PriceInfo>(对象 map),但在 GraphQL 中是 [CurrencyPrice!]!{currency, priceInfo} 数组);metadata 在 REST 中是解析后的对象,但在 GraphQL 中是 JSON 字符串。请勿使用 SDK TypeScript 类型定义来构造 GraphQL 查询——始终使用内省或以下示例。

查询所有可用查询

查询类型字段

API Key 认证授予您访问 18 种查询类型,包括单实体查询、带过滤的列表查询、计数查询和分析查询。

过滤

GraphQL 查询支持使用类型化过滤对象进行过滤:
AmountFilter 的值为货币主单位的十进制字符串(如 "9.99")。金额过滤条件必须在同一 filter 对象中搭配 currency: { eq: "..." }(单币种)使用。不支持跨币种金额比较。

分页

使用 limitoffset 进行分页。使用 *Count 查询获取总数。

环境相关字段

API Key 的环境影响返回的商品数据:
  • version — 返回指定环境的版本
  • status — 返回指定环境中的状态
一个商品可能在 test 环境中是 active,但在 production 环境中是 inactive(如果尚未发布)。

查询示例

门店与商品

查询门店、一次性商品、订阅商品和商品版本

订单与支付

查询订单、订阅订单、支付和退款工单

数据分析

收入统计、支付分析、趋势分析和客户洞察