Mutation

Object

abortPaymentRequest

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

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

cancelHandoff

completeDraftOrder

createDraftOrder

createMobileHandoff

createPaidOrder

createTrackedURL

createUserAndLinkOrganisation

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

deleteDevices

Allows deletion of Devices

deleteDevicesUsingFilter

Deletes devices using a filter

deleteLocations

Allows deletion of locations

deleteLocationsUsingFilter

Allows deletion of locations using a filter

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

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

endSession

evictUserByEmail

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

forcePublishOrganisation

This is an internal function. This allows Cloudshelf staff to force publishing all entites for an 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

newSession

notice

registerWebhook

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

removeProductsFromProductGroup

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

reportCatalogStats

reportDeviceOnline

requestShopifySubscriptionCheck

revokeAccessRight

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.

sendEmailVerification

Sends an email verification

setActingAs

setActiveVersion

setHandoffImageUrl

setOrganisationSyncStatus

setVariables

Allows settings of an variables

setVariantEditableByPlatformIds

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

startPaymentRequest

startSync

startSyncWithDomainName

subscribe

toggleInMaintenanceMode

transferToShopifyPOS

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

updateCloudshelfStaffRole

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

updateCustomCSSRules

updateMyUser

Allows updating basic user information

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

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

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

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

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.