API reference

GraphQL endpoint, queries, mutations, errors and the payment webhook.

Endpoint

POST /api/graphql, authenticated by the session cookie.

Queries

QueryUse
publicCannabisMenuPublic released, in-stock products
publicCannabisStorefrontSettingsPublic store identity
cannabisOperationsWorkspace(section, options)All dashboard page reads
cannabisStorefrontSettingsWorkspaceStore settings page
cannabisCartPreparation, cannabisCartAllocationQuoteCart prep and priced lines

Mutations

Every mutation takes input: JSON! and returns JSON!.

AreaMutations
SetuprunCannabisOnboarding, dismissCannabisOnboarding
AuthorityrenewCannabisAuthority, amendCannabisRulePack, amendCannabisPremisesDetails
StaffprovisionStaffAuthority, setStaffTemporaryPassword, revokeStaffCredential
CatalogconfigureCannabisProduct, amendCannabisProduct, configureCannabisStorefrontSettings
InventoryreceiveCannabisPackage, recordPackageLabResult, releaseCannabisPackage, placePackageHold, releasePackageHold
RecallsopenRecallCase, advanceRecallCase
CustomerscheckInCannabisCustomer
SalescreatePosCannabisCart, addCannabisCartLine, transitionCannabisCartPreparation, cancelCannabisCart, finalizeCannabisSale, refundCannabisSale
CashconfigureRegister, amendRegister, openRegisterShift, closeRegisterShift, approveCashVariance
PaymentslinkTenderPaymentProvider
IncidentsrecordComplianceIncident, transitionComplianceIncident
ReportingretryStateOutboxEvent
Closed by capabilitysubmitCannabisCustomerIntake, recordEligibilityDecision, createCustomerPickupCart, postCannabisInventoryEvent, activateIntegrationInstallation, recordStateInboxEvent, recordReconciliationRun, approveReconciliationRun

Idempotency

Controlled commands need an idempotency key of 8 to 200 characters. Repeating the same key replays the first result.

Errors

Plain rule errors up to 300 characters are returned with code BAD_USER_INPUT. Other errors are masked as Unexpected error.

Webhook

POST /api/payment-webhooks/[providerId]. See Payment providers.

On this page