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
Connectors
Shopify
Salesforce
Custom
CMS Intergration
Managed Login
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
Upcoming Changes
Queries
allIngestionStats
availablePDPBlocks
buyersGuide
canRegisterDevice
chartAverageSaleValueRecords
chartEngagementRecords
chartSalesValueRecords
checkoutFlow
checkoutFlows
cloudshelf
cloudshelfEnginePayload
cloudshelfList
cloudshelves
createPaymentAttempt
customToken
device
devices
engineProductsBlock
exchangeRates
filter
getDevices
getFractionalPaymentEligibility
getHandoffPayload
getLocations
getMobileHandoff
getPaymentRequest
getPaymentToken
getPresignedCustomisationUrl
getVersionByType
includeableFilters
ingestionStats
isInMaintenanceMode
isTrackedURLScanned
location
locations
me
metadataKeys
onlineFilterSearchBlockFast
order
orders
organisation
organisationInstallComplete
organisationList
organisationSyncStatusByDomain
organisationSyncStatusById
organisationUsers
organisations
plugins
product
productGroup
productGroups
products
publicDevice
publishedConfig
salesAssistant
salesAssistants
sessions
subscription
subscriptionCurrentOrg
subscriptionPlans
syncStats
syncStatsToConnector
tagsInBuyersGuide
testAI2
theme
themes
uptimeRecords
usageStatsSessions
user
version
webhook
webhooks
Mutations
abortPaymentRequest
addProductsToProductGroup
aiGenerateBuyersGuide
aiGenerateBuyersGuideContext
aiGenerateBuyersGuideQuestions
aiGenerateBuyersGuideTagProducts
cancelHandoff
completeDraftOrder
createDraftOrder
createMobileHandoff
createPaidOrder
createTrackedURL
createUserAndLinkOrganisation
deleteCheckoutFlows
deleteCheckoutFlowsUsingFilter
deleteCloudshelves
deleteCloudshelvesUsingFilter
deleteDevices
deleteDevicesUsingFilter
deleteLocations
deleteLocationsUsingFilter
deletePlugin
deleteProductGroups
deleteProducts
deleteSalesAssistants
deleteSalesAssistantsUsingFilter
deleteThemes
deleteThemesUsingFilter
duplicateCheckoutFlows
duplicateCheckoutFlowsUsingFilter
duplicateCloudshelves
duplicateCloudshelvesUsingFilter
duplicateThemes
duplicateThemesUsingFilter
editSubscription
endSession
forcePublishOrganisation
keepKnownProductGroupsViaFile
keepKnownProductsViaFile
keepKnownVariantsViaFile
leaveOrganisation
linkUserToOrganisationAtSignup
markInstallComplete
markShopifyOrganisationUninstallStarted
newSession
notice
registerWebhook
removeProductsFromProductGroup
reportCatalogStats
reportDeviceOnline
requestShopifySubscriptionCheck
revokeAccessRight
runInternalTool
saveOrgHubspotData
saveSurveyAnswers
selectCurrentOrganisationAccess
sendEmailVerification
setActingAs
setActiveVersion
setHandoffImageUrl
setOrganisationSyncStatus
setVariables
startPaymentRequest
startSync
startSyncWithDomainName
subscribe
toggleInMaintenanceMode
transferToShopifyPOS
unregisterWebhooks
unsubscribe
updateCustomCSSRules
updateMyUser
updateOrganisationSyncStatus
updateProductTags
updateProductsInProductGroup
updateProductsInProductGroupInBatch
updateSalesAssistantRules
updateSession
updateUserLastAccess
upsertCheckoutFlows
upsertCloudshelves
upsertDevices
upsertDraftOrders
upsertLocations
upsertOrders
upsertOrganisation
upsertPaymentProviders
upsertPlugin
upsertProductGroups
upsertProductVariants
upsertProducts
upsertSalesAssistants
upsertShopifyOrganisation
upsertStockLevels
upsertTheme
upsertUser
Subscriptions
buyersGuideAiGenerationStatusUpdated
buyersGuideContextStatusUpdated
buyersGuideProductTaggingStatusUpdated
buyersGuideQuestionsStatusUpdated
organisationSyncStatusUpdated
Types
AcquisitionOptionAvailability
AcquisitionOptionPriceType
AcquisitionType
AiGenerationStatus
AiStartedPayload
Alignment
AttractLoopProductSelectionMethod
AttributeValue
AttributeValueInput
AttributeValueOverride
AttributeValueOverrideInput
Banner
BannerBackgroundType
BannerInput
BannerLinkType
BarcodeDetectionMethod
Boolean
BuyersGuide
BuyersGuideAiGenerationStatusPayload
BuyersGuideAiProductTaggingStatusPayload
BuyersGuideAiQuestionGenerationStatusPayload
BuyersGuideAnswer
BuyersGuideAnswerInput
BuyersGuideAnswerType
BuyersGuideFilterStrictLevel
BuyersGuideInput
BuyersGuidePersona
BuyersGuidePersonaInput
BuyersGuideQuestion
BuyersGuideQuestionGenerationStep
BuyersGuideQuestionInput
BuyersGuideResultType
CapitalisationStyle
CardCheckoutDestination
CatalogStats
ChartEngagementRecord
ChartStacking
ChartTotalAndCountRecord
ChartValueRecord
CheckoutExperience
CheckoutFlowAcquisitionOption
CheckoutFlowAcquisitionOptionInput
CheckoutFlowDeletePayload
CheckoutFlowDuplicatePayload
CheckoutFlowEdge
CheckoutFlowFilterInput
CheckoutFlowInput
CheckoutFlowOptions
CheckoutFlowPageInfo
CheckoutFlowPaginatedPayload
CheckoutFlowUpsertPayload
ClearSalesAssistantRule
Cloudshelf
CloudshelfAllocationStatus
CloudshelfContent
CloudshelfContentInput
CloudshelfDeletePayload
CloudshelfDetailsPrinterBlock
CloudshelfDuplicatePayload
CloudshelfEdge
CloudshelfEnginePayload
CloudshelfFilterInput
CloudshelfIncludableFilter
CloudshelfIncludableFilterInput
CloudshelfInput
CloudshelfPageInfo
CloudshelfPaginatedPayload
CloudshelfPayloadStatus
CloudshelfPayloadType
CloudshelfSortField
CloudshelfSortInput
CloudshelfUpsertPayload
CompleteDraftOrderInput
ComplexSession
ComplexSessionEdge
ComplexSessionPageInfo
ConfigType
ContentConfigurationIssue
ContentType
CountryCode
CreateDraftOrderAttributeInput
CreateDraftOrderInput
CreatePaidOrderInput
CreatePaidOrderPayload
CreateUserAndLinkOrganisationPayloadResult
CurrencyCode
CustomCssInput
DeliveryAddressInput
Device
DeviceDeletePayload
DeviceDetailsPrinterBlock
DeviceEdge
DeviceFilterInput
DeviceInput
DevicePageInfo
DevicePaginatedPayload
DeviceSortField
DeviceSortInput
DeviceUpsertPayload
DeviceUptimeRecord
DraftOrderInput
DraftOrderPayload
ECommercePlatform
EmailVerifcationResultPayload
EngineImageWithVariantInfoBlock
EngineOrientation
EngineProductBlock
EngineProductBlockEdge
EngineProductBlockPageInfo
EngineProductBlockPayload
EngineProductGroupWithPositionBlock
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
IncludablePDPBlock
IngestionStatsPayload
InstallInformation
Int
KeyValuePair
KeyValuePairInput
KnownPlugin
KnownVersion
LabelRule
LabelRuleCheckType
LabelRuleDisplayType
LabelRuleInput
LabelRuleType
Latitude
Location
LocationDeletePayload
LocationDetailsPrinterBlock
LocationEdge
LocationFilterInput
LocationInput
LocationPageInfo
LocationPaginatedPayload
LocationSortField
LocationSortInput
LocationUpsertPayload
Longitude
MergedInFilter
MergedInFilterInput
Metadata
MetadataInput
Metaimage
MetaimageInput
MobileHandoff
Mutation
Order
OrderDetailsPrinterBlock
OrderEdge
OrderInput
OrderLine
OrderLineInput
OrderPageInfo
OrderPaginatedPayload
OrderReferencePrinterBlock
OrderStatus
OrderUpsertPayload
OrgSortInput
Organisation
OrganisationEdge
OrganisationFilterInput
OrganisationInput
OrganisationPageInfo
OrganisationPaginatedPayload
OrganisationPaymentProviderInput
OrganisationSortField
OrganisationSortOptionsInput
OrganisationStatus
OrganisationSyncRecoveryReason
OrganisationSyncStatusPayload
OrganisationSyncUpdateInput
OrganisationSyncUpdateReason
OrganisationUpsertPayload
PDPBlockInput
PDPBlockStyle
PDPBlockType
PDPBlockUnion
PDPDescriptionBlock
PDPLabelsBlock
PDPMetadataBlock
PDPMetadataDisplayType
PDPProductDataBlock
PDPProductDataType
PDPSpacerBlock
PDPVariantsBlock
PaymentDetailsPrinterBlock
PaymentGenericPayload
PaymentTokenPayload
Plugin
PluginEdge
PluginInput
PluginPageInfo
PluginPaginatedPayload
PowerTileBackgroundType
PrecutPrinterBlock
PreviousOrganisationDataPayload
PrinterBlockInput
PrinterBlocksUnion
Product
ProductDeletePayload
ProductDeletionPayload
ProductEdge
ProductGroup
ProductGroupDeletePayload
ProductGroupDeletionPayload
ProductGroupEdge
ProductGroupInput
ProductGroupPageInfo
ProductGroupPaginatedPayload
ProductGroupUpdateBatch
ProductGroupUpdateBatchItem
ProductGroupUpdateBatchPayload
ProductGroupUpsertPayload
ProductInput
ProductLanguage
ProductPageInfo
ProductPaginatedPayload
ProductTagChangeInput
ProductUpsertPayload
ProductVariant
ProductVariantDeletionPayload
ProductVariantInput
ProductVariantUpsertPayload
PublicDevicePayload
QRCheckoutDestination
Query
SalesAssistant
SalesAssistantDeletePayload
SalesAssistantDetailsPrinterBlock
SalesAssistantEdge
SalesAssistantFilterInput
SalesAssistantInput
SalesAssistantNameRule
SalesAssistantPageInfo
SalesAssistantPaginatedPayload
SalesAssistantRulesInput
SalesAssistantUpsertPayload
Session
SessionStatus
ShoeSizeUnit
ShopifyStoreInput
ShopifyStoreUninstallInput
Size
SortOptionsInput
SortOrder
SpacerPrinterBlock
StockLevel
StockLevelInput
StockLevelOptions
StockLevelUpsertPayload
String
Subscription
SubscriptionFeature
SubscriptionFeatureSetting
SubscriptionFeaturesInput
SubscriptionInterval
SubscriptionPlan
SubscriptionPlanUsage
SubscriptionRecord
SubscriptionStatus
SubscriptionType
Swatch
SwatchInput
SyncStage
SyncStatsPayload
TextPrinterBlock
Theme
ThemeDeletePayload
ThemeDuplicatePayload
ThemeEdge
ThemeFilterInput
ThemeFont
ThemeFontInput
ThemeInput
ThemePageInfo
ThemePaginatedPayload
ThemeRadius
ThemeUpsertPayload
ThirdPartyOrder
ThirdPartyTaxLine
TileSize
TimestampPrinterBlock
TrackedURL
TrackedURLPayload
TrackedURLResponse
TrackedUrlStatus
TransferToPOSInput
TransferToPOSInputAttributeInput
TransferedOrderPayload
UTCDateTime
UpsertUserInput
UpsertVariantsInput
UsageSessionType
UsageSessionsInput
UsageSessionsResponse
User
UserError
UserErrorCode
UserForOrganisation
UserForOrganisationEdge
UserForOrganisationPageInfo
UserForOrganisationPaginatedPayload
UserInput
UserOrganisationAccess
UserUpsertPayload
VersionType
VerticalAlignment
VirtualKeyboardEventType
VirtualKeyboardLanguage
VisibilityType
Webhook
WebhookEdge
WebhookPageInfo
WebhookPaginatedPayload
WebhookRegisterInput
WebhookRegisterPayload
WebhookSubject
WebhookUnregisterInput
completeDraftOrder
Mutation
Arguments
#
input
CompleteDraftOrderInput
!
Non-null
Response
#
Returns
DraftOrderPayload
!.
Example
#
Previous
cancelHandoff
Next
createDraftOrder
