undefined
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
Real-Time Stock Levels
Custom Card Payment
PDP Metadata Javascript Mapper
Comparison Splitter
Connectors
Shopify
Salesforce
Custom
CMS Intergration
Managed Login
Managed Users
Managed Devices
Plugins
About Plugins
Salesforce B2C Checkout
Barcode Reader
Weglot Translations
Payment Providers
Background Information
About GraphQL
API Versioning
Global Ids
Pagination
Upsert Pattern
Error Messages
Rate Limiting
Request Tracking
Upcoming Features
Webhooks
Webhook Topic OrderCreated
Queries
aiModels
aiWorkflow
aiWorkflowStepVersionDiffSummary
allBuyersGuidesAdmin
allIngestionStats
availablePDPBlocks
buyersGuide
cachePurgeStats
canRegisterDevice
catalogAttributeStats
catalogProductTypes
catalogProducts
chartAverageSaleValueRecords
chartEngagementRecords
chartSalesValueRecords
checkoutFlow
checkoutFlows
cloudshelf
cloudshelfEnginePayload
cloudshelfList
cloudshelfStaffRoles
cloudshelfStaffUsers
cloudshelves
createPaymentAttempt
customToken
dashboardSalesSummary
device
deviceLocationConstraints
devices
effectiveTaskConfig
engineProductsBlock
exchangeRates
filter
generateBuyersGuideInsightsForProducts
generateMetabaseQuestion40Embed
getDevices
getFractionalPaymentEligibility
getHandoffPayload
getLocations
getMobileHandoff
getPaymentRequest
getPaymentToken
getPresignedCustomisationUrl
getPresignedImageUploadUrls
getVersionByType
includeableFilters
ingestionStats
isInMaintenanceMode
isTrackedURLScanned
location
locations
me
metadataKeyEntries
metadataKeyEntriesForOrganisationAdmin
metadataKeyStatuses
metadataKeys
metadataKeysForOrganisationAdmin
metadataPreviewSamples
mySyncErrors
onlineFilterSearchBlockFast
order
orders
organisation
organisationApiKeys
organisationInstallComplete
organisationList
organisationRequiresStockSync
organisationSyncErrorsByDomain
organisationSyncErrorsById
organisationSyncStatusByDomain
organisationSyncStatusById
organisationUsers
organisations
plugins
product
productGroup
productGroups
productTypesForOrganisationAdmin
products
publicDevice
publishedConfig
role
roles
salesAssistant
salesAssistants
sessions
subscription
subscriptionCurrentOrg
subscriptionPlans
syncStats
syncStatsToConnector
tagsInBuyersGuide
testAI2
testOtelError
theme
themes
triggerJobs
uptimeRecords
usageStatsSessions
user
version
webhook
webhooks
Mutations
abortPaymentRequest
addProductsToProductGroup
aiGenerateBuyersGuide
aiGenerateBuyersGuideContext
aiGenerateBuyersGuideQuestions
aiGenerateBuyersGuideTagProducts
cancelHandoff
completeDraftOrder
createAiModel
createAiWorkflowStepDraft
createDraftOrder
createMobileHandoff
createOrganisationApiKey
createPaidOrder
createTrackedURL
createUserAndLinkOrganisation
deleteAiModel
deleteAiWorkflowStepDraft
deleteCheckoutFlows
deleteCheckoutFlowsUsingFilter
deleteCloudshelves
deleteCloudshelvesUsingFilter
deleteDevices
deleteDevicesUsingFilter
deleteLocations
deleteLocationsUsingFilter
deletePlugin
deleteProductGroups
deleteProducts
deleteRoles
deleteSalesAssistants
deleteSalesAssistantsUsingFilter
deleteThemes
deleteThemesUsingFilter
duplicateCheckoutFlows
duplicateCheckoutFlowsUsingFilter
duplicateCloudshelves
duplicateCloudshelvesUsingFilter
duplicateThemes
duplicateThemesUsingFilter
editSubscription
endRemoteSession
endSession
evictUserByEmail
forcePublishOrganisation
generateCode
generateRemoteControlNonce
heartbeatRemoteSession
importCatalogProductTypesCsv
importCatalogProductsCsv
keepKnownProductGroupsViaFile
keepKnownProductsViaFile
keepKnownVariantsViaFile
leaveOrganisation
linkUserToOrganisationAtSignup
markInstallComplete
markShopifyOrganisationUninstallStarted
newSession
notice
publishAiWorkflowStepDraft
queueCatalogAttributeCoverageBackfill
refreshAllBuyersGuideImageSearchPhrases
registerWebhook
removeProductsFromProductGroup
reportCatalogStats
reportDeviceOnline
reportTriggerJobCompleted
reportTriggerJobFailed
reportTriggerJobPending
reportTriggerJobStarted
requestShopifySubscriptionCheck
revokeAccessRight
revokeOrganisationApiKey
runInternalTool
saveOrgHubspotData
saveSurveyAnswers
selectCurrentOrganisationAccess
sendBasketToStore
sendBuyersGuideSummary
sendEmailVerification
sendRemoteControlEvent
sendWishlist
setActingAs
setActiveAiWorkflowStepVersion
setActiveVersion
setAiModelEnabled
setCatalogProductAttributeValueLocked
setCatalogProductTypeAttributeLocked
setHandoffImageUrl
setOrganisationSyncStatus
setProductTagLock
setVariables
setVariantEditableByPlatformIds
startPaymentRequest
startRemoteSession
startSync
startSyncWithDomainName
subscribe
testAiModel
testAiWorkflowStep
toggleInMaintenanceMode
transferToShopifyPOS
triggerCatalogAttributeUpdate
triggerFilterExtraction
triggerOrganisationIbvEnrichmentWorkflow
triggerOrganisationIbvWorkflows
unregisterWebhooks
unsubscribe
updateAiModel
updateAiWorkflowStepDraft
updateCatalogProductAttributeValue
updateCatalogProductTypeAttribute
updateCloudshelfStaffRole
updateCustomCSSRules
updateMyUser
updateOrganisationRunIbvWorkflows
updateOrganisationSyncStatus
updateProductTags
updateProductsInProductGroup
updateProductsInProductGroupInBatch
updateSalesAssistantRules
updateSession
updateTriggerTaskConfig
updateUserLastAccess
upsertCMSDevice
upsertCheckoutFlows
upsertCloudshelves
upsertDevices
upsertDraftOrders
upsertLocations
upsertOrders
upsertOrganisation
upsertOrganisationFilters
upsertPaymentProviders
upsertPlugin
upsertProductGroups
upsertProductVariants
upsertProducts
upsertRole
upsertSalesAssistants
upsertShopifyOrganisation
upsertStockLevels
upsertTheme
upsertUser
upsertUserByEmail
Subscriptions
buyersGuideAiGenerationStatusUpdated
buyersGuideContextStatusUpdated
buyersGuideProductTaggingStatusUpdated
buyersGuideQuestionsStatusUpdated
organisationSyncStatusUpdated
Types
AcquisitionOptionAvailability
AcquisitionOptionPriceType
AcquisitionType
AiGenerationStatus
AiModel
AiModelApiStyle
AiModelCreateInput
AiModelDeleteInput
AiModelSetEnabledInput
AiModelTestInput
AiModelTestPayload
AiModelUpdateInput
AiProvider
AiStartedPayload
AiWorkflow
AiWorkflowSchemaNode
AiWorkflowStep
AiWorkflowStepDraftCreateInput
AiWorkflowStepDraftUpdateInput
AiWorkflowStepPublishInput
AiWorkflowStepSetActiveInput
AiWorkflowStepTestInput
AiWorkflowStepTestPayload
AiWorkflowStepVersion
AiWorkflowStepVersionDiffSummaryInput
AiWorkflowStepVersionDiffSummaryPayload
Alignment
AttractLoopProductSelectionMethod
AttributeValue
AttributeValueInput
AttributeValueOverride
AttributeValueOverrideInput
BackgroundAnimationType
BackgroundCustomImage
BackgroundCustomImageInput
Banner
BannerAction
BannerBackgroundType
BannerInput
BannerLinkType
BannerScript
BannerScriptInput
BarcodeDetectionMethod
Boolean
BuyersGuide
BuyersGuideAdminListItem
BuyersGuideAiGenerationStatusPayload
BuyersGuideAiInsights
BuyersGuideAiProductTaggingStatusPayload
BuyersGuideAiQuestionGenerationStatusPayload
BuyersGuideAnswer
BuyersGuideAnswerInput
BuyersGuideAnswerType
BuyersGuideCostBadge
BuyersGuideFilterStrictLevel
BuyersGuideInput
BuyersGuideInsightsMultiInput
BuyersGuideInsightsMultiPayload
BuyersGuideInsightsProductInput
BuyersGuidePersona
BuyersGuidePersonaInput
BuyersGuideProductInsights
BuyersGuideQuestion
BuyersGuideQuestionGenerationStep
BuyersGuideQuestionInput
BuyersGuideResultLabel
BuyersGuideResultLabelInput
BuyersGuideResultType
CachePurgeStats
CapitalisationStyle
CardCheckoutDestination
CatalogAttributeStatsPayload
CatalogAttributeUpdateMode
CatalogAttributeWorkflowProgressPayload
CatalogAttributeWorkflowStatus
CatalogCsvImportPayload
CatalogProductAttributeValueItemPayload
CatalogProductPaginatedPayload
CatalogProductRowPayload
CatalogProductRowPayloadEdge
CatalogProductRowPayloadPageInfo
CatalogProductSortField
CatalogProductSortInput
CatalogProductTypeAttributeItemPayload
CatalogProductTypeComplementItemPayload
CatalogProductTypePaginatedPayload
CatalogProductTypeRowPayload
CatalogProductTypeRowPayloadEdge
CatalogProductTypeRowPayloadPageInfo
CatalogProductTypeSortField
CatalogProductTypeSortInput
CatalogStats
ChartEngagementRecord
ChartStacking
ChartTotalAndCountRecord
ChartValueRecord
CheckoutExperience
CheckoutFlowAcquisitionOption
CheckoutFlowAcquisitionOptionInput
CheckoutFlowDeletePayload
CheckoutFlowDuplicatePayload
CheckoutFlowEdge
CheckoutFlowFilterInput
CheckoutFlowInput
CheckoutFlowOptions
CheckoutFlowPageInfo
CheckoutFlowPaginatedPayload
CheckoutFlowUpsertPayload
ClearSalesAssistantRule
Cloudshelf
CloudshelfAllocationStatus
CloudshelfBackground
CloudshelfBackgroundInput
CloudshelfContent
CloudshelfContentInput
CloudshelfDeletePayload
CloudshelfDetailsPrinterBlock
CloudshelfDuplicatePayload
CloudshelfEdge
CloudshelfEnginePayload
CloudshelfExperienceType
CloudshelfFilterInput
CloudshelfGridIcon
CloudshelfIncludableFilter
CloudshelfIncludableFilterInput
CloudshelfInput
CloudshelfLabels
CloudshelfLabelsInput
CloudshelfPageInfo
CloudshelfPaginatedPayload
CloudshelfPayloadStatus
CloudshelfPayloadType
CloudshelfSortField
CloudshelfSortInput
CloudshelfStaffRoleInput
CloudshelfStaffUser
CloudshelfStaffUserEdge
CloudshelfStaffUserPageInfo
CloudshelfStaffUserPaginatedPayload
CloudshelfUpsertPayload
CodeGenerationInput
CodeGenerationPayload
ComparisonField
ComparisonFieldInput
ComparisonFieldType
CompleteDraftOrderInput
ComplexSession
ComplexSessionEdge
ComplexSessionPageInfo
ConfigType
ContentConfigurationIssue
ContentType
CountryCode
CreateDraftOrderAttributeInput
CreateDraftOrderInput
CreatePaidOrderInput
CreatePaidOrderPayload
CreateUserAndLinkOrganisationPayloadResult
CurrencyCode
CustomCssInput
DashboardSalesSummaryPayload
DeliveryAddressInput
Device
DeviceDeletePayload
DeviceDetailsPrinterBlock
DeviceEdge
DeviceFilterInput
DeviceInput
DeviceLocationConstraints
DevicePageInfo
DevicePaginatedPayload
DeviceSortField
DeviceSortInput
DeviceUpsertPayload
DeviceUptimeRecord
DraftOrderInput
DraftOrderPayload
ECommercePlatform
EffectiveTaskConfig
EmailVerifcationResultPayload
EngineImageWithVariantInfoBlock
EngineOrientation
EngineProductAiAttributeBlock
EngineProductBlock
EngineProductBlockEdge
EngineProductBlockPageInfo
EngineProductBlockPayload
EngineProductGroupWithPositionBlock
EngineProductIbvBlock
EngineProductIbvComplementItemBlock
EngineProductIbvComplementRecommendationBlock
EngineProductIbvEnrichmentBlock
EngineProductMetadataBlock
EngineProductVariantBlock
EngineStatus
EngineStockBlock
EngineStockLevelBlockWithVariantId
EngineType
ExchangeRateBase
Filter
FilterExtractionStatus
FilterInput
FilterOptions
FilterOptionsInput
FilterOrderType
FilterType
Float
FractionalCheckoutDestination
FulfilmentDetailsPrinterBlock
GlobalId
HandoffEnginePayload
HandoffPayload
ID
ImageAnchor
ImageBackgroundStyle
ImageOrientation
ImageQuality
ImageSource
ImportCatalogProductTypesCsvInput
ImportCatalogProductsCsvInput
IncludablePDPBlock
IngestionStatsPayload
InstallInformation
Int
JSON
KeyValuePair
KeyValuePairInput
KnownPlugin
KnownVersion
LabelRule
LabelRuleCheckType
LabelRuleDisplayType
LabelRuleInput
LabelRuleType
Latitude
Location
LocationDeletePayload
LocationDetailsPrinterBlock
LocationDeviceAvailability
LocationEdge
LocationFilterInput
LocationInput
LocationPageInfo
LocationPaginatedPayload
LocationSortField
LocationSortInput
LocationUpsertPayload
Longitude
MergedInFilter
MergedInFilterInput
MetabaseQuestionEmbedPayload
Metadata
MetadataInput
MetadataKeyEntry
MetadataKeyStatusPayload
Metaimage
MetaimageInput
MobileHandoff
Mutation
Order
OrderDetailsPrinterBlock
OrderEdge
OrderInput
OrderLine
OrderLineInput
OrderPageInfo
OrderPaginatedPayload
OrderReferencePrinterBlock
OrderStatus
OrderUpsertPayload
OrgSortInput
Organisation
OrganisationApiKey
OrganisationApiKeyCreateInput
OrganisationApiKeyCreatePayload
OrganisationApiKeyEdge
OrganisationApiKeyFilterInput
OrganisationApiKeyPageInfo
OrganisationApiKeyPaginatedPayload
OrganisationApiKeyRevokePayload
OrganisationApiKeySortField
OrganisationApiKeySortInput
OrganisationApiKeyStatus
OrganisationEdge
OrganisationFilterInput
OrganisationInput
OrganisationPageInfo
OrganisationPaginatedPayload
OrganisationPaymentProviderInput
OrganisationProductTypeOptionPayload
OrganisationSortField
OrganisationSortOptionsInput
OrganisationStatus
OrganisationSyncRecoveryReason
OrganisationSyncStatusPayload
OrganisationSyncUpdateInput
OrganisationSyncUpdateReason
OrganisationUpsertPayload
PDPAIProductAttributesBlock
PDPBlockAvailability
PDPBlockInput
PDPBlockName
PDPBlockPrice
PDPBlockStyle
PDPBlockType
PDPBlockUnion
PDPDescriptionBlock
PDPLabelsBlock
PDPMetadataBlock
PDPMetadataDisplayType
PDPProductDataBlock
PDPProductDataType
PDPSpacerBlock
PDPVariantsBlock
PaymentDetailsPrinterBlock
PaymentGenericPayload
PaymentInStore
PaymentTokenPayload
PermissionAction
Plugin
PluginEdge
PluginInput
PluginPageInfo
PluginPaginatedPayload
PowerTileBackgroundType
PrecutPrinterBlock
PresignedUploadUrl
PreviousOrganisationDataPayload
PrinterBlockInput
PrinterBlocksUnion
Product
ProductDeletePayload
ProductDeletionPayload
ProductEdge
ProductGroup
ProductGroupDeletePayload
ProductGroupDeletionPayload
ProductGroupEdge
ProductGroupInput
ProductGroupPageInfo
ProductGroupPaginatedPayload
ProductGroupSearchQueryInput
ProductGroupUpdateBatch
ProductGroupUpdateBatchItem
ProductGroupUpdateBatchPayload
ProductGroupUpsertPayload
ProductInput
ProductLanguage
ProductPageInfo
ProductPaginatedPayload
ProductTagChangeInput
ProductUpsertPayload
ProductVariant
ProductVariantDeletionPayload
ProductVariantInput
ProductVariantUpsertPayload
ProtectedEntity
PublicDevicePayload
QRCheckoutDestination
Query
RemoteControlEventInput
RemoteControlEventType
RemoteControlProductInfoPayload
Role
RoleDeleteInput
RoleDeletePayload
RoleEdge
RoleInput
RolePageInfo
RolePaginatedPayload
RolePermission
RolePermissionInput
RoleTemplateType
RoleUpsertPayload
SalesAssistant
SalesAssistantDeletePayload
SalesAssistantDetailsPrinterBlock
SalesAssistantEdge
SalesAssistantFilterInput
SalesAssistantInput
SalesAssistantNameRule
SalesAssistantPageInfo
SalesAssistantPaginatedPayload
SalesAssistantRulesInput
SalesAssistantUpsertPayload
SendBasketToStoreAttributeInput
SendBasketToStoreInput
SendBasketToStoreLineInput
SendBasketToStorePayload
SendBuyersGuideSummaryInput
SendBuyersGuideSummaryLineInput
SendBuyersGuideSummaryPayload
SendBuyersGuideSummaryQuestionInput
SendWishlistAttributeInput
SendWishlistInput
SendWishlistLineInput
SendWishlistPayload
Session
SessionStatus
SessionType
SetCatalogProductAttributeValueLockedInput
SetCatalogProductTypeAttributeLockedInput
ShoeSizeUnit
ShopifyStoreInput
ShopifyStoreUninstallInput
Size
SortOptionsInput
SortOrder
SpacerPrinterBlock
StockLevel
StockLevelInput
StockLevelOptions
StockLevelUpsertPayload
String
Subscription
SubscriptionFeature
SubscriptionFeatureSetting
SubscriptionFeaturesInput
SubscriptionInterval
SubscriptionPlan
SubscriptionPlanUsage
SubscriptionRecord
SubscriptionStatus
SubscriptionType
Swatch
SwatchInput
SyncErrorInput
SyncErrorType
SyncStage
SyncStatsPayload
TextPrinterBlock
Theme
ThemeDeletePayload
ThemeDuplicatePayload
ThemeEdge
ThemeFilterInput
ThemeFont
ThemeFontInput
ThemeHomeFrame
ThemeHomeFrameInput
ThemeInput
ThemePageInfo
ThemePaginatedPayload
ThemeRadius
ThemeUpsertPayload
ThirdPartyOrder
ThirdPartyTaxLine
TileSize
TimestampPrinterBlock
TrackedURL
TrackedURLPayload
TrackedURLResponse
TrackedUrlStatus
TransferToPOSInput
TransferToPOSInputAttributeInput
TransferedOrderPayload
TriggerJobAverage
TriggerJobInfo
TriggerJobsPayload
TriggerTaskConfigEntryInput
TriggerTaskConfigItem
UTCDateTime
UpdateCatalogProductAttributeValueInput
UpdateCatalogProductTypeAttributeInput
UpsertCMSDeviceInput
UpsertUserByEmailInput
UpsertUserInput
UpsertVariantsInput
UsageSessionType
UsageSessionsInput
UsageSessionsResponse
User
UserError
UserErrorCode
UserForOrganisation
UserForOrganisationEdge
UserForOrganisationPageInfo
UserForOrganisationPaginatedPayload
UserInput
UserOrganisationAccess
UserOrganisationAccessSortField
UserOrganisationAccessSortInput
UserUpsertPayload
VersionType
VerticalAlignment
VirtualKeyboardEventType
VirtualKeyboardLanguage
VisibilityType
Webhook
WebhookEdge
WebhookPageInfo
WebhookPaginatedPayload
WebhookRegisterInput
WebhookRegisterPayload
WebhookSubject
WebhookUnregisterInput
BackgroundCustomImageInput
Input Object
Fields
#
id
String
!
Non-null
image
String
!
Non-null
position
Int
!
Non-null
Previous
BackgroundCustomImage
Next
Banner
