Magidoc

Query
Object

Fields

#

allIngestionStats

[ IngestionStatsPayload !]!
Non-null

availablePDPBlocks

[ IncludablePDPBlock !]!
Non-null

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

canRegisterDevice

Boolean !
Non-null

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

checkoutFlow

CheckoutFlowOptions

Returns a checkout flow entity

checkoutFlows

CheckoutFlowPaginatedPayload !
Non-null

Returns a paginated array of checkout flows

cloudshelf

Cloudshelf

Returns a Cloudshelf entity

cloudshelfEnginePayload

CloudshelfEnginePayload !
Non-null

cloudshelves

CloudshelfPaginatedPayload !
Non-null

Returns a paginated array of Cloudshelves

createPaymentAttempt

PaymentGenericPayload !
Non-null

customToken

String

An internal function for getting a Cloudshelf Authentication Token.

device

Device

Returns a Device entity

deviceEngagementRecords

[ DeviceEngagementRecord !]!
Non-null

devices

DevicePaginatedPayload !
Non-null

Returns a paginated array of Devices.

engineProducts

EngineProductWithAdditionalInfoPayload !
Non-null

filter

Filter

Returns a Filter entity

getMobileHandoff

MobileHandoff

getPaymentRequest

PaymentGenericPayload !
Non-null

getPaymentToken

PaymentTokenPayload !
Non-null

getPresignedCustomisationUrl

String !
Non-null

getVersionByType

KnownVersion !
Non-null

includeableFilters

[ CloudshelfIncludableFilter !]!
Non-null

Returns all filters that can possibly be included in the Cloudshelf

ingestionStats

IngestionStatsPayload !
Non-null

isInMaintenanceMode

Boolean !
Non-null

isTrackedURLScanned

Boolean !
Non-null

location

Location

Returns a location entity

locations

LocationPaginatedPayload !
Non-null

Returns a paginated array of locations

me

User !
Non-null

Returns the currently authenticated user.

metadataKeys

[ String !]!
Non-null

onlineFilterSearch

EngineProductWithAdditionalInfoPayload !
Non-null

order

Order

Returns an Order entity.

orders

OrderPaginatedPayload !
Non-null

Returns a paginated array of Order entities

organisation

Organisation

Returns an Organisation entity

organisationInstallComplete

Boolean

Returns if the install has been completed for an organisation

organisationUsers

UserForOrganisationPaginatedPayload !
Non-null

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

organisations

OrganisationPaginatedPayload !
Non-null

Returns a paginated array of organisations

plugins

PluginPaginatedPayload !
Non-null

Returns a paginated array of plugins

product

Product

Returns a Product entity.

productGroup

ProductGroup

Returns a Product Group

productGroups

ProductGroupPaginatedPayload !
Non-null

Returns a paginated array of product groups

products

ProductPaginatedPayload !
Non-null

Returns a paginated array of Product entities.

publicDevice

PublicDevicePayload

Returns public information about a device

salesAssistant

SalesAssistant

Returns a sales assistant entity

salesAssistants

SalesAssistantPaginatedPayload !
Non-null

Returns a paginated array of Sales Assistants

sessions

[ Session !]!
Non-null

subscription

SubscriptionRecord

Returns a subscription entity

subscriptionCurrentOrg

SubscriptionRecord

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

subscriptionPlans

[ SubscriptionPlan !]

Returns a list of currently available subscription plans

syncStats

SyncStatsPayload !
Non-null

theme

Theme

Returns a theme entity

themes

ThemePaginatedPayload !
Non-null

Returns a paginated array of Themes

uptimeRecords

[ DeviceUptimeRecord !]!
Non-null

usageStatsSessions

UsageSessionsResponse !
Non-null

user

User !
Non-null

Returns a User entity

webhook

Webhook

Query a webhook by ID

webhooks

WebhookPaginatedPayload !
Non-null

Query the list of registered webhooks