GraphQL API Reference

Every query, mutation and type you can call — generated from the API's schema each time this site is built. Operations that only Growmax platform staff can run are not listed.

Before you start

• Authenticate with an ARC user JWT: Authorization: Bearer <accessToken> — see Authentication. Tenant API keys (gm_live_…) are for the service REST API (reference: REST API reference), not for GraphQL.
• Endpoint: POST https://<api-host>/graphql.
• Tenant scope: your credential decides the organization; you never pass one.
• Never compute prices client-side — resolve prices through the API's pricing queries and let document creation apply the canonical pipeline.

New here? The developer guides explain when to use each operation. Use this reference when you need the exact current arguments, fields, enums, and deprecations. Check the API changelog for breaking changes and deprecations.

Most-used operations by domain

The schema is large. These are the operations most integrations need — each link opens its exact reference page.

Catalog and pricing

Operation	Kind	Purpose
products	query	Page the tenant catalog (cursor, limit, filter).
productVariants	query	Variant detail for one product, including UOM and stock.
calculateVariantPrice	query	Quantity price preview for a variant.
categories	query	Category tree.
brands	query	Brands.
getUOMs	query	Units of measure for line inputs.

Customers and suppliers

Operation	Kind	Purpose
customers	query	Find customers by search string.
customersPage	query	Cursor-paginated customer sync.
partners	query	Customers and suppliers by role filter.
globalSearch	query	Cross-entity search.
createCustomer	mutation	Create a customer.

Sales: quote to order

Operation	Kind	Purpose
quotes	query	List quotes.
createQuote	mutation	Create a quote (line unitPrice required).
convertQuoteToSalesOrder	mutation	Convert an accepted quote.
salesOrders	query	List sales orders (skip/take).
createSalesOrder	mutation	Create an order (line unitPrice optional — server prices it).
confirmSalesOrder	mutation	Confirm a draft order (optimistic concurrency).

Invoicing and payments

Operation	Kind	Purpose
invoices	query	List invoices.
convertQuoteToInvoice	mutation	Invoice directly from a quote.
createInvoice	mutation	Create an invoice.
payments	query	List payments.
createPayment	mutation	Record a payment.
allocatePayment	mutation	Allocate a payment to invoices.

Purchasing and inventory

Operation	Kind	Purpose
purchaseOrders	query	List purchase orders.
createPurchaseOrder	mutation	Create a purchase order.
grns	query	List goods receipts.
createGRN	mutation	Receive goods at a warehouse.
stockMovements	query	Inventory change feed for reconciliation.
warehouses	query	Warehouses.
inventorySummary	query	Stock health for a product/warehouse.
adjustInventory	mutation	Stock adjustment movement.
transferInventory	mutation	Warehouse-to-warehouse transfer.

Browse the full schema

When the curated index above is not enough, use the sidebar. It is grouped by business domain (quotes and sales orders, invoices and payments, catalog and pricing, and so on). Each domain lists its queries and mutations, and the types they use under Types. Types shared across several domains, and the GraphQL directives, are under Shared types; subscriptions have their own group.

The full schema also contains surface-specific operations (buyer portal, mobile, admin console, copilot) that exist for ARC's own clients. The developer guides are the supported path for integrations.

Breaking changes are recorded in the API changelog.