Skip to main content

GraphQL API Reference

Complete reference for the Propeller GraphQL API. Use the interactive explorer to test queries and mutations, or browse the full type system.

The GraphQL API is the primary interface for building customer-facing experiences: webshops, B2B customer portals and self-service ordering interfaces. The Storefront SDK and WordPress Plugin are both built on this API.

In this section

  • Explorer. Interactive GraphQL playground for testing queries and mutations.
  • Queries. All available queries.
  • Mutations. All available mutations.
  • Objects. Object types returned by queries and mutations.
  • Inputs. Input types for query arguments and mutation payloads.
  • Enums. Enumeration types.
  • Scalars. Scalar types.
  • Interfaces. Interface types.
  • Directives. Directives.
  • Deprecated. Deprecated types and fields.

Browse the full type system using the sidebar.