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.

Connection details

Setting	Value
Endpoint	https://api.helice.cloud/v2/graphql
Method	POST with a JSON body: query, plus variables and operationName when you use them
API key	apiKey: YOUR_API_KEY header on every request
Signed-in user	Authorization: Bearer ACCESS_TOKEN header next to the API key, for requests made on behalf of a Contact or Customer
Pagination	page and offset on list inputs. offset is the page size and defaults to 12

See Environments and Access for creating an API key and the roles a key needs, Authentication and authorization for the access token and Pagination for reading every page of a result.

Errors

A request with an unknown API key returns HTTP 401:

{ "message": "Invalid API key in request" }

Other failures return HTTP 200 with an errors array next to data. Each error has a message, the path of the field that failed and a code in extensions.code:

{
  "errors": [
    {
      "message": "Product with ID 999999999 not found",
      "path": ["product"],
      "extensions": { "code": "PRODUCT_NOT_FOUND" }
    }
  ],
  "data": null
}

Most operation pages list the codes they can return under "Possible errors". A FORBIDDEN code means the API key lacks the role named on the AUTH line of that operation.

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.
• Deprecations. Deprecated types and fields, with their replacements.

Frequently used

Area	Queries and mutations	Types
Catalog	products, product, category	Product, Cluster, Category, ProductSearchInput
Cart and checkout	cartStart, cartAddItem, cartItemBulk, cartProcess, cart	Cart
Orders	orders, order	Order, Shipment, OrderSearchArguments
Accounts	login, viewer	Company, Contact, Customer

Schema downloads

Download the GraphQL schema (SDL) for code generation, or introspect the endpoint directly with an API key.