Getting Started
Welcome
Endpoints
Authentication
Ingest Themes
Ingest Locations
Ingest Products
Ingest Product Groups
Reporting Expected Catalog Information
Configure Checkout Flow
Create a Cloudshelf
Sync Content Regularly
Reporting Purchases
Connectors
Shopify
Salesforce
Custom
Plugins
About Plugins
Cloudshelf Basket Transfer
Salesforce B2C Checkout
Barcode Reader
Weglot Translations
Background Information
About GraphQL
API Versioning
Global Ids
Pagination
Upsert Pattern
Error Messages
Rate Limiting
Request Tracking
Upcoming Features
Real-Time Stock Levels
Queries
allIngestionStats
availablePDPBlocks
canRegisterDevice
cloudshelf
cloudshelfEnginePayload
cloudshelves
customToken
device
devices
engineProducts
filter
getMobileHandoff
getPaymentRequest
getPaymentToken
getPresignedCustomisationUrl
getVersionByType
includeableFilters
ingestionStats
isInMaintenanceMode
isNobleEnabled
isTrackedURLScanned
location
locations
me
metadataKeys
nobleQueueByTaskType
nobleQueues
nobleTask
nobleTasksByTypes
order
orders
organisation
organisationInstallComplete
organisationUsers
organisations
pausedNobleQueues
plugins
product
productGroup
productGroups
products
publicDevice
salesAssistant
salesAssistants
sessions
subscription
subscriptionCurrentOrg
subscriptionPlans
syncStats
testFilters
theme
themes
usageStatsSessions
user
webhook
webhooks
Mutations
abortPaymentRequest
addProductsToProductGroup
cancelHandoff
createMobileHandoff
createTrackedURL
createUserAndOrganisationForCustomIntegration
deleteCloudshelves
deleteDevices
deleteLocations
deletePlugin
deleteProductGroups
deleteProducts
deleteSalesAssistants
deleteTask
deleteThemes
duplicateCloudshelves
duplicateThemes
editSubscription
endSession
keepKnownProductGroupsViaFile
keepKnownProductsViaFile
keepKnownVariantsViaFile
leaveOrganisation
markInstallComplete
markShopifyOrganisationUninstallStarted
newSession
promoteTask
registerWebhook
removeProductsFromProductGroup
reportCatalogStats
reportDeviceOnline
requestShopifySubscriptionCheck
restartLongRunningJobs
restartTask
revokeAccessRight
runInternalTool
saveSurveyAnswers
selectCurrentOrganisationAccess
setActingAs
setActiveVersion
setHandoffImageUrl
setPausedNobleQueuesByType
setVariables
startPaymentRequest
subscribe
toggleInMaintenanceMode
toggleNoblePaused
unregisterWebhooks
unsubscribe
updateCustomCSSRules
updateMyUser
updateProductsInProductGroup
updateSalesAssistantRules
updateSession
upsertCloudshelves
upsertDevices
upsertDraftOrders
upsertLocations
upsertOrders
upsertOrganisation
upsertPlugin
upsertProductGroups
upsertProductVariants
upsertProducts
upsertSalesAssistants
upsertShopifyOrganisation
upsertTheme
upsertUser
Types
Alignment
Animation
AttributeValue
AttributeValueInput
AttributeValueOverride
AttributeValueOverrideInput
Banner
BannerBackgroundType
BannerDisplayMode
BannerInput
BannerLinkType
BarcodeDetectionMethod
Boolean
CapitalisationStyle
CatalogStats
CategoryOrder
CheckoutExperience
CheckoutFlow
ClearSalesAssistantRule
Cloudshelf
CloudshelfContent
CloudshelfContentInput
CloudshelfDeletePayload
CloudshelfDuplicatePayload
CloudshelfEdge
CloudshelfEnginePayload
CloudshelfIncludableFilter
CloudshelfIncludableFilterInput
CloudshelfInput
CloudshelfPageInfo
CloudshelfPaginatedPayload
CloudshelfPayloadStatus
CloudshelfPayloadType
CloudshelfUpsertPayload
ComplexSession
ComplexSessionEdge
ComplexSessionPageInfo
ContentConfigurationIssue
ContentType
CountryCode
CurrencyCode
CustomCssInput
CustomIntegrationFullSignupResultPayload
Device
DeviceDeletePayload
DeviceEdge
DeviceInput
DevicePageInfo
DevicePaginatedPayload
DeviceUpsertPayload
DeviceUptimeRecord
DraftOrderInput
ECommercePlatform
EngineImageWithVariantInfo
EngineOrientation
EngineProductWithAdditionalInfo
EngineProductWithAdditionalInfoEdge
EngineProductWithAdditionalInfoPageInfo
EngineProductWithAdditionalInfoPayload
EngineStatus
EngineType
EngineVariant
Filter
FilterExtractionJobData
FilterExtractionStatus
FilterInput
FilterOptions
FilterOptionsInput
FilterOrderType
FilterType
Float
GlobalId
HandoffPayload
HomeScreenLoopPlacement
ImageAnchor
ImageOrientation
ImageQuality
IncludablePDPBlock
IngestionStatsPayload
InstallInformation
Int
KeyValuePair
KeyValuePairInput
KnownPlugin
KnownVersion
LabelRule
LabelRuleCheckType
LabelRuleDisplayType
LabelRuleInput
LabelRuleType
Latitude
Location
LocationDeletePayload
LocationEdge
LocationInput
LocationPageInfo
LocationPaginatedPayload
LocationUpsertPayload
Longitude
MergedInFilter
MergedInFilterInput
Metadata
MetadataInput
Metaimage
MetaimageInput
MobileHandoff
Mutation
NobleTask
NobleTaskDataUnion
NobleTaskEdge
NobleTaskPageInfo
NobleTaskResponse
NobleTaskStatus
NobleTaskType
NonInteractiveCollectionType
Order
OrderEdge
OrderInput
OrderLine
OrderLineInput
OrderPageInfo
OrderPaginatedPayload
OrderStatus
OrderUpsertPayload
Organisation
OrganisationEdge
OrganisationInput
OrganisationPageInfo
OrganisationPaginatedPayload
OrganisationSortOptionsInput
OrganisationUpsertPayload
PDPBlockInput
PDPBlockStyle
PDPBlockType
PDPBlockUnion
PDPDescriptionBlock
PDPLabelsBlock
PDPMetadataBlock
PDPMetadataDisplayType
PDPProductDataBlock
PDPProductDataType
PDPSpacerBlock
PDPVariantsBlock
PaymentGenericPayload
PaymentTokenPayload
Plugin
PluginEdge
PluginInput
PluginPageInfo
PluginPaginatedPayload
PowerTileBackgroundType
Product
ProductDeletePayload
ProductDeletionPayload
ProductEdge
ProductGroup
ProductGroupDeletePayload
ProductGroupDeletionPayload
ProductGroupEdge
ProductGroupInput
ProductGroupPageInfo
ProductGroupPaginatedPayload
ProductGroupUpsertPayload
ProductInput
ProductPageInfo
ProductPaginatedPayload
ProductUpsertPayload
ProductVariant
ProductVariantDeletionPayload
ProductVariantInput
ProductVariantUpsertPayload
PublicDevicePayload
Query
SalesAssistant
SalesAssistantDeletePayload
SalesAssistantEdge
SalesAssistantInput
SalesAssistantNameRule
SalesAssistantPageInfo
SalesAssistantPaginatedPayload
SalesAssistantRulesInput
SalesAssistantUpsertPayload
Session
SessionStatus
ShopifyStoreInput
ShopifyStoreUninstallInput
ShopifySubscriptionCheckData
Size
SortOptionsInput
SortOrder
String
SubscriptionFeaturesInput
SubscriptionInterval
SubscriptionPlan
SubscriptionPlanUsage
SubscriptionRecord
SubscriptionStatus
SubscriptionType
Swatch
SwatchInput
SyncStatsPayload
TaskQueue
Theme
ThemeDeletePayload
ThemeDuplicatePayload
ThemeEdge
ThemeFont
ThemeFontInput
ThemeInput
ThemePageInfo
ThemePaginatedPayload
ThemeRadius
ThemeUpsertPayload
TileSize
TouchIndicator
TrackedURL
TrackedURLPayload
TrackedURLResponse
TrackedUrlStatus
UTCDateTime
UpsertUserInput
UpsertVariantsInput
UsageSessionType
UsageSessionsInput
UsageSessionsResponse
User
UserError
UserErrorCode
UserForOrganisation
UserForOrganisationEdge
UserForOrganisationPageInfo
UserForOrganisationPaginatedPayload
UserInput
UserOrganisationAccess
UserUpsertPayload
VersionType
VerticalAlignment
VisibilityType
Webhook
WebhookEdge
WebhookPageInfo
WebhookPaginatedPayload
WebhookRegisterInput
WebhookRegisterPayload
WebhookSubject
WebhookUnregisterInput
PaymentGenericPayload
Object
Fields
#
cancelled
Boolean
message
String
pending
Boolean
success
Boolean
Usages
#
References
#
Field
abortPaymentRequest
from
Mutation
Field
startPaymentRequest
from
Mutation
Field
getPaymentRequest
from
Query
Previous
PDPVariantsBlock
Next
PaymentTokenPayload
