Query

Object

allIngestionStats

availablePDPBlocks

Returns an array of PDP Blocks that are available to add to the PDP

buyersGuide

canRegisterDevice

Returns a boolean value which indicates if the organisation can register a new device

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

cloudshelves

Returns a paginated array of Cloudshelves

createPaymentAttempt

customToken

An internal function for getting a Cloudshelf Authentication Token.

device

Returns a Device entity

devices

Returns a paginated array of Devices.

engineProductsBlock

exchangeRates

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

filter

Returns a Filter entity

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

getVersionByType

includeableFilters

Returns all filters that can possibly be included in the Cloudshelf

ingestionStats

isInMaintenanceMode

isTrackedURLScanned

location

Returns a location entity

locations

Returns a paginated array of locations

me

Returns the currently authenticated user.

metadataKeys

onlineFilterSearchBlockFast

order

Returns an Order entity.

orders

Returns a paginated array of Order entities

organisation

Returns an Organisation entity

organisationInstallComplete

Returns if the install has been completed for an organisation

organisationList

Returns a paginated list of organisations

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

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

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

theme

Returns a theme entity

themes

Returns a paginated array of Themes

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