Query

Object

aiModels

aiWorkflow

aiWorkflowStepVersionDiffSummary

allBuyersGuidesAdmin

allIngestionStats

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.

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.

chartAverageSaleValueRecords

chartEngagementRecords

chartSalesValueRecords

checkoutFlow

Returns a checkout flow entity

checkoutFlows

Returns a paginated array of checkout flows

cloudshelf

Returns a Cloudshelf entity

cloudshelfEnginePayload

cloudshelfList

Returns a paginated array of Cloudshelves

cloudshelfStaffRoles

Returns all Cloudshelf internal staff roles. Requires Cloudshelf staff permissions.

cloudshelfStaffUsers

Returns a paginated list of Cloudshelf staff users. Requires Cloudshelf staff permissions.

cloudshelves

Returns a paginated array of Cloudshelves

createPaymentAttempt

customToken

An internal function for getting a Cloudshelf Authentication Token.

dashboardSalesSummary

device

Returns a Device entity

deviceLocationConstraints

Returns device location constraints and availability. Pass deviceId to show availability for moving a specific device.

devices

Returns a paginated array of Devices.

effectiveTaskConfig

Returns the effective task configuration (defaults + org overrides) for a given task

engineProductsBlock

exchangeRates

Returns the exchange rates for a given currency code in GBP, USD, and EUR

filter

Returns a Filter entity

generateBuyersGuideInsightsForProducts

generateMetabaseQuestion40Embed

getDevices

Returns a paginated array of Devices with advanced filtering and sorting.

getFractionalPaymentEligibility

getHandoffPayload

getLocations

Returns a paginated array of locations

getMobileHandoff

getPaymentRequest

getPaymentToken

getPresignedCustomisationUrl

getPresignedImageUploadUrls

getVersionByType

includeableFilters

Returns all filters that can possibly be included for this organisation

ingestionStats

isInMaintenanceMode

isTrackedURLScanned

location

Returns a location entity

locations

Returns a paginated array of locations

me

Returns the currently authenticated user.

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.

metadataKeys

metadataKeysForOrganisationAdmin

Returns all metadata keys for a specific organisation (admin only).

metadataPreviewSamples

Recent metadata values for a metadata key, for mapper previews in manager.

mySyncErrors

Errors recorded during the most recent sync for the authenticated organisation.

onlineFilterSearchBlockFast

order

Returns an Order entity.

orders

Returns a paginated array of Order entities

organisation

Returns an Organisation entity

organisationApiKeys

organisationInstallComplete

Returns if the install has been completed for an organisation

organisationList

Returns a paginated list of organisations

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.

organisationSyncStatusByDomain

organisationSyncStatusById

organisationUsers

Returns a paginated array of user access rights for the current organisation

organisations

Returns a paginated array of organisations

plugins

Returns a paginated array of plugins

product

Returns a Product entity.

productGroup

Returns a Product Group

productGroups

Returns a paginated array of product groups

productTypesForOrganisationAdmin

Returns distinct product types for a selected organisation for staff admin tools

products

Returns a paginated array of Product entities.

publicDevice

Returns public information about a device

publishedConfig

Returns the last published config for a given entity, or generates a new one with pending changes if requested

role

Returns a role by its ID

roles

Returns a paginated list of roles for the current organisation

salesAssistant

Returns a sales assistant entity

salesAssistants

Returns a paginated array of Sales Assistants

sessions

subscription

Returns a subscription entity

subscriptionCurrentOrg

This is an internal function. This function is not intended to be included in the final release. Only exists due to CS-1273

subscriptionPlans

Returns a list of currently available subscription plans

syncStats

syncStatsToConnector

tagsInBuyersGuide

testAI2

Test AI functionality with optional chat ID and message

testOtelError

Internal test query that throws an error to verify OTel error tracing

theme

Returns a theme entity

themes

Returns a paginated array of Themes

triggerJobs

Returns pending/running Trigger.dev jobs and average runtimes for an organisation

uptimeRecords

usageStatsSessions

user

Returns a User entity

version

Returns the current version and environment type of the API

webhook

Query a webhook by ID

webhooks

Query the list of registered webhooks