Query Object
Fields
#
activeTutorial
Returns the single published tutorial the acting user is eligible for and has not yet seen, or null. This is the source of truth for the in-app tutorial runner.
availableCatalogMetadataCandidates
Returns available metadata fields that are not already in catalog metadata.
availableDashboardCharts
A paginated, text-searchable list of the charts available to add to dashboards. This is the source of truth for the dashboard chart picker (only charts made visible by Cloudshelf staff appear).
availablePDPBlocks
Returns an array of PDP Blocks that are available to add to the PDP
buyersGuide
cachePurgeStats
Returns current stats about the Cloudflare cache purge system (admin only)
canRegisterDevice
Returns a boolean value which indicates if the organisation can register a new device
catalogAttributeStats
Returns organisation-level counts for catalog products, product types, attributes, and attribute values.
catalogMetadataFields
Returns catalog metadata fields with implicit raw and user-defined view/split transforms.
catalogOrganisationCategoryPaths
Returns the distinct list of product classification category paths for the current organisation.
catalogProductTypeOptions
Returns distinct product type names for the current organisation, sorted ascending.
catalogProductTypes
Returns paginated catalog product types for the current organisation with AI key attributes when available.
catalogProducts
Returns paginated catalog products for the current organisation using the current product type assignment.
catalogVendorOptions
Returns distinct vendor names for the current organisation, sorted ascending.
cloudshelfEnginePayload
cloudshelfStaffRoles
Returns all Cloudshelf internal staff roles. Requires Cloudshelf staff permissions.
cloudshelfStaffUsers
Returns a paginated list of Cloudshelf staff users. Requires Cloudshelf staff permissions.
dashboardChartParamKeys
Returns the keys a Metabase parameter can be mapped to: the session_activity columns plus the fixed dashboard dimensions. Requires Cloudshelf staff.
dashboardChartParamOptions
Returns the option values configured on a single Metabase question parameter, or null when Metabase provides no complete list (or is unreachable). Requires Cloudshelf staff.
dashboardChartParams
Returns the params each given chart maps, with resolved defaults. Lets the manager build a chart's per-chart override form before the chart is saved onto a dashboard (unlike the dashboard-level requiredParams , which only reflects saved cells).
dashboardChartsAdmin
Returns a paginated dashboard chart registry synced from Metabase, including param mappings and visibility. Supports text search, filtering, and sorting. Requires Cloudshelf staff.
dashboards
Returns the organisation's dashboards. Creates the default dashboard if the organisation has none.
deviceLocationConstraints
Returns device location constraints and availability. Pass deviceId to show availability for moving a specific device.
eCommercePlatformDisplayNames
Returns the distinct e-commerce platform display names currently in use, excluding built-in platform values (Shopify, SALESFORCE_B2C, Custom).
effectiveTaskConfig
Returns the effective task configuration (defaults + org overrides) for a given task
exchangeRates
Returns the exchange rates for a given currency code in GBP, USD, and EUR
generateMetabaseQuestion40Embed
getDevices
Returns a paginated array of Devices with advanced filtering and sorting.
getMobileHandoff
ibvEnrichmentStats
Returns organisation-level IBV enrichment workflow status, per-phase progress, and counts of classified products, enriched products, and complement recommendations.
includeableFilters
Returns all filters that can possibly be included for this organisation
metabaseEmbedUrl
Returns a signed Metabase iframe URL for the given question, with the caller's organisationId locked into the embed token. The question must be published for embedding in Metabase. Supplied dashboard param values are resolved through the chart's param mappings and signed into the token. URL is short-lived (~10 minutes).
metabaseEmbeddableQuestions
Lists Metabase questions published for static embedding. Sourced live from Metabase.
metadataKeyEntries
Returns all metadata key + namespace pairs available to the organisation.
metadataKeyEntriesForOrganisationAdmin
Returns all metadata key + namespace pairs for a specific organisation (admin only).
metadataKeyStatuses
Returns metadata keys available for selection, plus whether they need another sync.
metadataKeysForOrganisationAdmin
Returns all metadata keys for a specific organisation (admin only).
metadataPreviewSamples
Recent metadata values for a metadata key, for view and split previews in manager.
mySwitchableOrganisationAccessRights
Returns genuine organisation memberships the authenticated user may switch to.
mySyncErrors
Errors recorded during the most recent sync for the authenticated organisation.
onboardingCallAvailability
Upcoming slots and team members for the free onboarding call, from the HubSpot round-robin scheduling page. Returns available=false when the scheduler is not configured or unreachable.
organisationAdminListOptimized
Returns a paginated optimized admin list of organisations with derived table values.
organisationRequiresStockSync
Returns true if any CloudShelf uses device or named location stock relevance
organisationSyncErrorsByDomain
Errors recorded during the most recent sync for the organisation with the given domain name.
organisationSyncErrorsById
Errors recorded during the most recent sync for the organisation with the given id.
organisationUsers
Returns a paginated array of user access rights for the current organisation
productTypesForOrganisationAdmin
Returns distinct product types for a selected organisation for staff admin tools
productVariants
Returns a paginated array of ProductVariant entities.
publishedConfig
Returns the last published config for a given entity, or generates a new one with pending changes if requested
roles
Returns a paginated list of roles for the current organisation
salesAssistants
Returns a paginated array of Sales Assistants
subscriptionCurrentOrg
This is an internal function. This function is not intended to be included in the final release. Only exists due to CS-1273
syncedCatalogMetadataFields
Returns catalog metadata fields that have synced metadata values available for cloudshelf use.
testOtelError
Internal test query that throws an error to verify OTel error tracing
triggerJobs
Returns pending/running Trigger.dev jobs and average runtimes for an organisation
tutorials
Returns every authored tutorial, most-recently-updated first. Requires Cloudshelf staff.
variantOptionNameOptions
Returns paginated distinct product variant option names used by the current organisation.
variantOptionNames
Returns distinct product variant option names used by the current organisation.
QRCheckoutDestination