API reference

GraphQL operations, REST routes, and authentication.

GraphQL is served at /api/graphql (Keystone). Session cookie, API key, or OAuth token authenticates; see Roles and permissions. Custom operations live in features/keystone/mutations.

Storefront operations

createActiveCart, activeCart, updateActiveCart, updateActiveCartLineItem, addActiveCartShippingMethod, addDiscountToActiveCart, removeDiscountFromActiveCart, createActiveCartPaymentSessions, setActiveCartPaymentSession, initiatePaymentSession, authorizeCardPaymentSession, evaluateActiveCartCompliance, completeActiveCart, validateShippingAddress, createActiveUserAddress, updateActiveUserAddress, deleteActiveUserAddress, updateActiveUser, updateActiveUserPassword, regenerateCustomerToken, getCustomerOrders, getCustomerOrder, getCustomerAccount, getCustomerAccounts, getUnpaidLineItemsByRegion, createInvoiceFromLineItems, createInvoicePaymentSessions, initiateInvoicePaymentSession, setInvoicePaymentSession, payInvoice, completeInvoicePayment, getInvoicePaymentSessions, getCustomerPaidInvoices, getMyPrivacyData, updatePrivacyPreferences, requestPrivacyAction, registerWebhookEndpoint, sendUserPasswordResetLink, redeemUserPasswordResetToken.

Operator operations

AreaOperations
OrderstransitionOrderStatus, createOrderFulfillment, cancelOrderFulfillment, getRatesForOrder, createProviderShippingLabel, cancelShippingLabel, trackShipment, processReturnRefund, getAnalytics
InventoryadjustInventory
CompliancestopRegulatedCommerce, regulatedCommerceReadiness, generateComplianceReport, recordComplianceReportSubmission, exportComplianceInventory
WebhooksretryWebhookDeliveries
SetupredirectToInit

REST routes

RoutePurpose
/api/graphqlGraphQL
/api/payment-webhooks/[providerId]Payment provider webhooks
/api/oauth/authorize, /callback, /tokenOAuth
/api/mcp-transport/[transport]MCP
/api/completionDashboard AI chat

On this page