Mutation

Object

abortPaymentRequest

addCatalogMetadataField

Adds a metadata field record to catalog metadata so it will sync on the next ingestion.

addProductsToProductGroup

Adds the given list of products to the product group, if they are not already part of the product group

aiGenerateBuyersGuide

Starts a background job to generate buyers guide

aiGenerateBuyersGuideAnswerTags

Starts a background job that re-generates only the answer tags on an existing buyers guide and then re-tags the products. Existing question/answer text is preserved.

aiGenerateBuyersGuideContext

Starts a background job to generate buyers guide context

aiGenerateBuyersGuideQuestions

Starts a background job to generate buyers guide questions

aiGenerateBuyersGuideTagProducts

Starts a background job to generate buyers guide tag products

bookOnboardingCall

Books an onboarding call for the logged-in user at one of the slots returned by onboardingCallAvailability. HubSpot chooses the host from its round-robin rotation.

cancelHandoff

completeDraftOrder

createAiModel

createAiWorkflowStepDraft

createCatalogMetadataTransform

Creates or reuses a catalog metadata view/split transform for the current organisation.

createDashboard

Creates a new dashboard

createDraftOrder

createMobileHandoff

createOrganisationApiKey

createOrganisationAsStaff

Allows Cloudshelf staff to create a new Custom-platform organisation with default roles seeded.

createPaidOrder

createPresignedFontUpload

createStaffApiKey

createTrackedURL

createUserAndLinkOrganisation

deleteAiModel

deleteAiWorkflowStepDraft

deleteCatalogMetadataTransform

Deletes a catalog metadata transform.

deleteCheckoutFlows

Allows deletion of checkout flows

deleteCheckoutFlowsUsingFilter

Allows deletion of checkout flows using a filter

deleteCloudshelves

Allows deletion of Cloudshelves

deleteCloudshelvesUsingFilter

Allows deletion of cloudshelves using a filter

deleteDashboard

Deletes a dashboard

deleteDashboardChart

Removes a curated chart from the dashboards section. Requires Cloudshelf staff.

deleteDevices

Allows deletion of Devices

deleteDevicesUsingFilter

Deletes devices using a filter

deleteLocations

Allows deletion of locations

deleteLocationsUsingFilter

Allows deletion of locations using a filter

deleteOrganisationAsStaff

Allows Cloudshelf staff to permanently delete a custom organisation (and all of its owned data). Rejects Shopify, Salesforce B2C, and any organisation whose eCommercePlatformDisplayName contains "cloudshelf".

deletePlugin

Deletes a plugin

deleteProductGroups

Allows deletion of product groups

deleteProducts

Allows the deletion of Products

deleteRoles

Deletes custom roles by their IDs. Users assigned to deleted roles are reassigned to the specified replacement role. System roles cannot be deleted.

deleteSalesAssistants

Allows the deletion of sales assistants

deleteSalesAssistantsUsingFilter

Allows deletion of sales assistants using a filter

deleteThemes

Allows the deletion of Themes

deleteThemesUsingFilter

Allows deletion of themes using a filter

deleteTutorial

Deletes a tutorial and every user completion record for it. Requires Cloudshelf staff.

duplicateCheckoutFlows

duplicateCheckoutFlowsUsingFilter

Allows duplication of checkout flows using a filter

duplicateCloudshelves

duplicateCloudshelvesUsingFilter

Allows duplication of cloudshelves using a filter

duplicateThemes

duplicateThemesUsingFilter

Allows duplication of themes using a filter

editSubscription

endRemoteSession

endSession

evictUserByEmail

Removes a user's access from the current organisation by their email address.

finalizeFontUpload

forcePublishOrganisation

This is an internal function. This allows Cloudshelf staff to force publishing all entites for an organisation

generateCode

Generates code using AI based on user instructions and context

generateRemoteControlNonce

heartbeatRemoteSession

importCatalogProductTypesCsv

Imports catalog product type attributes from a CSV export for the current organisation.

importCatalogProductsCsv

Imports catalog product attribute values from a CSV export for the current organisation.

keepKnownProductGroupsViaFile

Allows the user to provide a file with known product variants to keep, any other product groups already in their organisation will be deleted. (with the exception of the all products group)

keepKnownProductsViaFile

Allows the user to provide a file with known products to keep, any other products already in their organisation will be deleted

keepKnownVariantsViaFile

Allows the user to provide a file with known variants to keep, any other variants already in their organisation will be deleted

leaveOrganisation

Allows the current user leave an Organisation.

linkUserToOrganisationAtSignup

markInstallComplete

markShopifyOrganisationUninstallStarted

markTutorialSeen

Records that the acting user has finished (completed or skipped) a tutorial so it is not shown again. Returns true when the completion is recorded (or already existed).

newPreviewSession

Creates a PREVIEW session for the given Cloudshelf, without requiring a device. Used by the engine when running in Cloudshelf preview mode. PREVIEW sessions are CLOUDSHELF_INTERNAL and are excluded from retailer dashboards.

newSession

notice

publishAiWorkflowStepDraft

queueCatalogAttributeCoverageBackfill

recordSessionActivity

Records a batch of activity events against an existing Session. Called by the engine at session end. Unknown sessionIds are rejected; unknown eventType values are rejected; client-supplied eventIds are deduplicated. COMPLETE and INVALID (superseded) sessions accept events within a 24h grace window so offline-retried batches still attach.

refreshAllBuyersGuideImageSearchPhrases

registerWebhook

Register a webhook for a given subject. The supplied URL will be called with a POST request when the subject is triggered.

removeCatalogMetadataField

Removes a metadata field from catalog metadata and deletes its user-defined transforms.

removeOrganisationMetadata

Removes metadata owned directly by the authenticated organisation.

removeProductsFromProductGroup

Removes the given products from the product group, if they are currently part of it

reorderDashboards

Saves the organisation's dashboard tab order. The order is stored per organisation (defaults included), so one org's arrangement never affects another's.

replaceSalesLast30Days

Atomically replaces product and variant sales counts for the acting organisation

reportCatalogStats

reportDeviceOnline

reportTriggerJobCompleted

reportTriggerJobFailed

reportTriggerJobPending

reportTriggerJobStarted

requestCurrentUserEmailVerification

requestFirebasePasswordReset

Requests a password-reset email without revealing whether an account exists.

requestShopifySubscriptionCheck

revokeAccessRight

revokeOrganisationApiKey

revokeStaffApiKey

runInternalTool

This is an internal function. This allows Cloudshelf staff to run internal tools

saveOrgHubspotData

saveSurveyAnswers

selectCurrentOrganisationAccess

Sets the users currently active organisation (actingAs), which is used to decide which organisations data is accessed in other queries.

sendBasketToStore

sendBuyersGuideSummary

sendEmailVerification

Sends an email verification

sendRemoteControlEvent

sendWishlist

setActingAs

setActiveAiWorkflowStepVersion

setActiveVersion

setAiModelEnabled

setCatalogProductAttributeValueLocked

Updates the lock state for a catalog product attribute value for the current organisation.

setCatalogProductIbvEnrichmentFieldLocked

Updates the lock state for a catalog product IBV enrichment field.

setCatalogProductTypeAttributeLocked

Updates the lock state for a catalog product type attribute for the current organisation.

setCatalogProductTypeComplementarityLocked

Updates the lock state for the nature of complementarity and call-to-action on a catalog product type.

setCatalogProductTypeComplementaryItemsLocked

Updates the lock state for the complementary product types list on a catalog product type.

setDashboardChartVisibility

Controls whether retailers can see a curated chart in the picker. Requires Cloudshelf staff.

setHandoffImageUrl

setIngestionExemptionRules

Sets the ingestion exemption rules for the given organisation, used to omit products/variants during custom-connector ingestion (staff only)

setOrgType

setOrganisationSyncStatus

setProductTagLock

setVariables

Allows settings of an variables

setVariantEditableByPlatformIds

Set editable=true for variants NOT in platform IDs within a domain

startPaymentRequest

startRemoteSession

startSync

startSyncWithDomainName

subscribe

syncMetabase

Pulls every card from Metabase into the local registry. New charts are created hidden; existing charts keep their visibility and param mappings; charts removed from Metabase are archived. Requires Cloudshelf staff.

testAiModel

testAiWorkflowStep

toggleInMaintenanceMode

transferToShopifyPOS

triggerCatalogAttributeUpdate

Triggers catalog IBV attribute workflows for the current organisation.

triggerFilterExtraction

Triggers filter extraction for the current organisation

triggerOrganisationIbvEnrichmentWorkflow

triggerOrganisationKeyAttributesWorkflow

unregisterWebhooks

Unregister a webhook for a given subject. If an array of ids is supplied, only the webhooks corresponding to the supplied ids will be unregistered, if they exists. If no array is supplied, all webhooks for the given subject will be unregistered.

unsubscribe

updateAiModel

updateAiWorkflowStepDraft

updateCatalogMetadataTransform

Updates the display name and JavaScript body for a catalog metadata transform.

updateCatalogProductAttributeValue

Updates a catalog product attribute value for the current organisation.

updateCatalogProductIbvImpulse

Updates the impulse buy IBV signal for a catalog product.

updateCatalogProductIbvStrongestSellingPoint

Updates the strongest selling point IBV signal for a catalog product.

updateCatalogProductIbvTier

Updates the tier IBV signal for a catalog product.

updateCatalogProductTypeAttribute

Updates a catalog product type attribute for the current organisation.

updateCatalogProductTypeComplementarity

Updates the nature of complementarity and call-to-action for a catalog product type for the current organisation.

updateCatalogProductTypeComplementaryItems

Replaces the complementary product types list for a catalog product type for the current organisation.

updateCloudshelfStaffRole

Updates a Cloudshelf internal staff role. Staff roles cannot be created or deleted via the API. Requires Cloudshelf staff permissions.

updateCustomCSSRules

updateDashboard

Renames a dashboard. Cloudshelf staff admins may also toggle isDefault to share the dashboard with every organisation (or make a default private again).

updateDashboardCells

Replaces the full set of chart cells on a dashboard

updateDashboardParamLayout

Saves the arranged param bar layout (the ordered lines within the FILTER and DISPLAY sections). On a default dashboard the layout is saved per organisation, so one org's arrangement never affects another's.

updateDashboardParamValues

Replaces the full set of dashboard-level param values (the last-selected form state). On a default dashboard the values are saved per organisation, so one org's selections never affect another.

updateMyUser

Allows updating basic user information

updateOrganisationRunIbvWorkflows

updateOrganisationSyncStatus

updateProductTags

updateProductsInProductGroup

Sets the products in the product group to the given list of products

updateProductsInProductGroupInBatch

Sets the products in the product group to the given list of products

updateSalesAssistantRules

updateSession

updateTriggerTaskConfig

Updates trigger task configuration overrides for the current organisation (staff only)

updateUserLastAccess

upsertCMSDevice

Upserts a device via CMS API. Creates if platformProvidedId does not exist, updates if it does. API key authentication only.

upsertCheckoutFlows

Allows upserting of checkout flows

upsertCloudshelves

Allows upserting of Cloudshelves

upsertDashboardChart

Curates a Metabase question for the dashboards section, replacing its param mappings. Requires Cloudshelf staff.

upsertDevices

Allows upserting of Devices

upsertDraftOrders

Allows upserting of Draft Order entities

upsertLocations

Allows upserting of locations

upsertOrders

Allows upserting of Order entities

upsertOrganisation

Allows upserting of an organisation

upsertOrganisationFilters

Updates organisation-level filter configuration and filter customizations.

upsertOrganisationMetadata

Creates or updates metadata owned directly by the authenticated organisation.

upsertPaymentProviders

Allows settings payment provider settings

upsertPlugin

Create or updates a plugin, overriding any previous settings

upsertProductGroups

Allows upserting of product groups

upsertProductVariants

upsertProducts

Allows upserting of Products

upsertRole

Creates or updates a custom role. System roles cannot be modified. When updating permissions, the provided list replaces all existing permissions.

upsertSalesAssistants

Allows upserting of sales assistants

upsertShopifyOrganisation

upsertStockLevels

Upserts stock levels for product variants at specific locations.

upsertTheme

Allows upserting of Themes

upsertTutorial

Creates or updates a tutorial, replacing its steps and audience. Requires Cloudshelf staff.

upsertUser

Allows upserting of user access to the current organisation

upsertUserByEmail

Creates or updates user access to the current organisation using email as the lookup key. If the user does not exist, a new user is created. If the user exists but has no access to this organisation, access is granted. If the user already has access to this organisation, their role is updated.

verifyCurrentUserEmail