Versioning
The Pickware ERP API uses date-based version slugs. The version is part of the endpoint path, so the current schema is reached at POST /api/graphql/2026-06-unstable. The -unstable suffix marks it as an early preview that may still receive breaking changes before the first stable schema is released.
Each schema version has its own generated reference. New versions are published as separate references so integrations already in production can keep using the version they were built against.
Compatibility expectations
Schemas with the -unstable suffix may change in incompatible ways between releases: fields can be renamed or removed, input shapes can change, and mutations may be redesigned. Track release notes before upgrading.
Once a schema is published without the -unstable suffix, integrations can rely on documented fields, inputs, and mutations within that version. Additive changes such as new fields or enum values may still appear in stable versions, so design clients to tolerate them: ignore unknown fields and handle unrecognized enum values gracefully rather than treating them as errors.
When a future change needs a different contract, it is introduced in a new schema version and documented as a separate reference.
Using the reference
Use the generated 2026-06-unstable API reference as the source of truth for:
- Query and mutation names.
- Field names and nullability.
- Input fields and default values.
- Required scopes for reading and writing.
- Available filter inputs.