Magidoc

Mutation
Object

Fields

#

abortPaymentRequest

Non-null

addProductsToProductGroup

Non-null

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

cancelHandoff

Non-null

createMobileHandoff

Non-null

createPaidOrder

Non-null

createTrackedURL

Non-null

createUserAndOrganisationForCustomIntegration

Non-null

deleteCheckoutFlows

Non-null

Allows deletion of checkout flows

deleteCloudshelves

Non-null

Allows deletion of Cloudshelves

deleteDevices

Non-null

Allows deletion of Devices

deleteLocations

Non-null

Allows deletion of locations

deletePlugin

Non-null

Deletes a plugin

deleteProductGroups

Non-null

Allows deletion of product groups

deleteProducts

Non-null

Allows the deletion of Products

deleteSalesAssistants

Non-null

Allows the deletion of sales assistants

deleteThemes

Non-null

Allows the deletion of Themes

duplicateCloudshelves

Non-null

duplicateThemes

Non-null

editSubscription

Non-null

endSession

Non-null

keepKnownProductGroupsViaFile

Non-null

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

Non-null

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

keepKnownVariantsViaFile

Non-null

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

leaveOrganisation

Non-null

Allows the current user leave an Organisation.

markInstallComplete

Non-null

markShopifyOrganisationUninstallStarted

Non-null

newSession

Non-null

registerWebhook

Non-null

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

removeProductsFromProductGroup

Non-null

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

reportCatalogStats

Non-null

reportDeviceOnline

Non-null

requestShopifySubscriptionCheck

Non-null

revokeAccessRight

Non-null

runInternalTool

Non-null

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

saveSurveyAnswers

Non-null

selectCurrentOrganisationAccess

Non-null

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

setActingAs

Non-null

setActiveVersion

Non-null

setHandoffImageUrl

Non-null

setVariables

Non-null

Allows settings of an variables

startPaymentRequest

Non-null

subscribe

Non-null

toggleInMaintenanceMode

Non-null

unregisterWebhooks

Non-null

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

Non-null

updateCustomCSSRules

Non-null

updateMyUser

Non-null

Allows updating basic user information

updateProductsInProductGroup

Non-null

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

updateSalesAssistantRules

Non-null

updateSession

Non-null

upsertCheckoutFlows

Non-null

Allows upserting of checkout flows

upsertCloudshelves

Non-null

Allows upserting of Cloudshelves

upsertDevices

Non-null

Allows upserting of Devices

upsertDraftOrders

Non-null

Allows upserting of Draft Order entities

upsertLocations

Non-null

Allows upserting of locations

upsertOrders

Non-null

Allows upserting of Order entities

upsertOrganisation

Non-null

Allows upserting of an organisation

upsertPlugin

Non-null

Create or updates a plugin, overriding any previous settings

upsertProductGroups

Non-null

Allows upserting of product groups

upsertProductVariants

Non-null

upsertProducts

Non-null

Allows upserting of Products

upsertSalesAssistants

Non-null

Allows upserting of sales assistants

upsertShopifyOrganisation

Non-null

upsertTheme

Non-null

Allows upserting of Themes

upsertUser

Non-null

Allows upserting of user access to the current organisation