Skip to main content

Mutations

addCustomersToGroup

mutationaddCustomersToGroup

addFulfillmentToOrder

mutationaddFulfillmentToOrder

addItemToDraftOrder

mutationaddItemToDraftOrder

addManualPaymentToOrder

mutationaddManualPaymentToOrder

addMembersToZone

mutationaddMembersToZone

addNoteToCustomer

mutationaddNoteToCustomer

addNoteToOrder

mutationaddNoteToOrder

addOptionGroupToProduct

mutationaddOptionGroupToProduct

adjustDraftOrderLine

mutationadjustDraftOrderLine

applyCouponCodeToDraftOrder

mutationapplyCouponCodeToDraftOrder

assignAssetsToChannel

mutationassignAssetsToChannel

assignCollectionsToChannel

mutationassignCollectionsToChannel

assignFacetsToChannel

mutationassignFacetsToChannel

assignPaymentMethodsToChannel

mutationassignPaymentMethodsToChannel

assignProductVariantsToChannel

mutationassignProductVariantsToChannel

assignProductsToChannel

mutationassignProductsToChannel

assignPromotionsToChannel

mutationassignPromotionsToChannel

assignRoleToAdministrator

mutationassignRoleToAdministrator

assignShippingMethodsToChannel

mutationassignShippingMethodsToChannel

assignStockLocationsToChannel

mutationassignStockLocationsToChannel

authenticate

mutationauthenticate

cancelJob

mutationcancelJob

cancelOrder

mutationcancelOrder

cancelPayment

mutationcancelPayment

createAdministrator

mutationcreateAdministrator

createAssets

mutationcreateAssets

createChannel

mutationcreateChannel

createCollection

mutationcreateCollection

createCountry

mutationcreateCountry

createCustomer

mutationcreateCustomer

createCustomerAddress

mutationcreateCustomerAddress

createCustomerGroup

mutationcreateCustomerGroup

createDraftOrder

mutationcreateDraftOrder

createFacet

mutationcreateFacet

createFacetValue

mutationcreateFacetValue

createFacetValues

mutationcreateFacetValues

createPaymentMethod

mutationcreatePaymentMethod

createProduct

mutationcreateProduct

createProductOption

mutationcreateProductOption

createProductOptionGroup

mutationcreateProductOptionGroup

createProductVariants

mutationcreateProductVariants

createPromotion

mutationcreatePromotion

createProvince

mutationcreateProvince

createRole

mutationcreateRole

createSeller

mutationcreateSeller

createShippingMethod

mutationcreateShippingMethod

createStockLocation

mutationcreateStockLocation

createTag

mutationcreateTag

createTaxCategory

mutationcreateTaxCategory

createTaxRate

mutationcreateTaxRate

createZone

mutationcreateZone

deleteAdministrator

mutationdeleteAdministrator

deleteAdministrators

mutationdeleteAdministrators

deleteAsset

mutationdeleteAsset

deleteAssets

mutationdeleteAssets

deleteChannel

mutationdeleteChannel

deleteChannels

mutationdeleteChannels

deleteCollection

mutationdeleteCollection

deleteCollections

mutationdeleteCollections

deleteCountries

mutationdeleteCountries

deleteCountry

mutationdeleteCountry

deleteCustomer

mutationdeleteCustomer

deleteCustomerAddress

mutationdeleteCustomerAddress

deleteCustomerGroup

mutationdeleteCustomerGroup

deleteCustomerGroups

mutationdeleteCustomerGroups

deleteCustomerNote

mutationdeleteCustomerNote

deleteCustomers

mutationdeleteCustomers

deleteDraftOrder

mutationdeleteDraftOrder

deleteFacet

mutationdeleteFacet

deleteFacetValues

mutationdeleteFacetValues

deleteFacets

mutationdeleteFacets

deleteOrderNote

mutationdeleteOrderNote

deletePaymentMethod

mutationdeletePaymentMethod

deletePaymentMethods

mutationdeletePaymentMethods

deleteProduct

mutationdeleteProduct

deleteProductOption

mutationdeleteProductOption

deleteProductVariant

mutationdeleteProductVariant

deleteProductVariants

mutationdeleteProductVariants

deleteProducts

mutationdeleteProducts

deletePromotion

mutationdeletePromotion

deletePromotions

mutationdeletePromotions

deleteProvince

mutationdeleteProvince

deleteRole

mutationdeleteRole

deleteRoles

mutationdeleteRoles

deleteSeller

mutationdeleteSeller

deleteSellers

mutationdeleteSellers

deleteShippingMethod

mutationdeleteShippingMethod

deleteShippingMethods

mutationdeleteShippingMethods

deleteStockLocation

mutationdeleteStockLocation

deleteStockLocations

mutationdeleteStockLocations

deleteTag

mutationdeleteTag

deleteTaxCategories

mutationdeleteTaxCategories

deleteTaxCategory

mutationdeleteTaxCategory

deleteTaxRate

mutationdeleteTaxRate

deleteTaxRates

mutationdeleteTaxRates

deleteZone

mutationdeleteZone

deleteZones

mutationdeleteZones

duplicateEntity

mutationduplicateEntity

flushBufferedJobs

mutationflushBufferedJobs

importProducts

mutationimportProducts

login

mutationlogin

logout

mutationlogout

modifyOrder

mutationmodifyOrder

moveCollection

mutationmoveCollection

refundOrder

mutationrefundOrder

reindex

mutationreindex

removeCollectionsFromChannel

mutationremoveCollectionsFromChannel

removeCouponCodeFromDraftOrder

mutationremoveCouponCodeFromDraftOrder

removeCustomersFromGroup

mutationremoveCustomersFromGroup

removeDraftOrderLine

mutationremoveDraftOrderLine

removeFacetsFromChannel

mutationremoveFacetsFromChannel

removeMembersFromZone

mutationremoveMembersFromZone

removeOptionGroupFromProduct

mutationremoveOptionGroupFromProduct

removePaymentMethodsFromChannel

mutationremovePaymentMethodsFromChannel

removeProductVariantsFromChannel

mutationremoveProductVariantsFromChannel

removeProductsFromChannel

mutationremoveProductsFromChannel

removePromotionsFromChannel

mutationremovePromotionsFromChannel

removeSettledJobs

mutationremoveSettledJobs

removeShippingMethodsFromChannel

mutationremoveShippingMethodsFromChannel

removeStockLocationsFromChannel

mutationremoveStockLocationsFromChannel

runPendingSearchIndexUpdates

mutationrunPendingSearchIndexUpdates

runScheduledTask

mutationrunScheduledTask

setCustomerForDraftOrder

mutationsetCustomerForDraftOrder

setDraftOrderBillingAddress

mutationsetDraftOrderBillingAddress

setDraftOrderCustomFields

mutationsetDraftOrderCustomFields

setDraftOrderShippingAddress

mutationsetDraftOrderShippingAddress

setDraftOrderShippingMethod

mutationsetDraftOrderShippingMethod

setOrderCustomFields

mutationsetOrderCustomFields

setOrderCustomer

mutationsetOrderCustomer

setSettingsStoreValue

mutationsetSettingsStoreValue

setSettingsStoreValues

mutationsetSettingsStoreValues

settlePayment

mutationsettlePayment

settleRefund

mutationsettleRefund

transitionFulfillmentToState

mutationtransitionFulfillmentToState

transitionOrderToState

mutationtransitionOrderToState

transitionPaymentToState

mutationtransitionPaymentToState

unsetDraftOrderBillingAddress

mutationunsetDraftOrderBillingAddress

unsetDraftOrderShippingAddress

mutationunsetDraftOrderShippingAddress

updateActiveAdministrator

mutationupdateActiveAdministrator

updateAdministrator

mutationupdateAdministrator

updateAsset

mutationupdateAsset

updateChannel

mutationupdateChannel

updateCollection

mutationupdateCollection

updateCountry

mutationupdateCountry

updateCustomer

mutationupdateCustomer

updateCustomerAddress

mutationupdateCustomerAddress

updateCustomerGroup

mutationupdateCustomerGroup

updateCustomerNote

mutationupdateCustomerNote

updateFacet

mutationupdateFacet

updateFacetValue

mutationupdateFacetValue

updateFacetValues

mutationupdateFacetValues

updateGlobalSettings

mutationupdateGlobalSettings

updateOrderNote

mutationupdateOrderNote

updatePaymentMethod

mutationupdatePaymentMethod

updateProduct

mutationupdateProduct

updateProductOption

mutationupdateProductOption

updateProductOptionGroup

mutationupdateProductOptionGroup

updateProductVariant

mutationupdateProductVariant

updateProductVariants

mutationupdateProductVariants

updateProducts

mutationupdateProducts

updatePromotion

mutationupdatePromotion

updateProvince

mutationupdateProvince

updateRole

mutationupdateRole

updateScheduledTask

mutationupdateScheduledTask

updateSeller

mutationupdateSeller

updateShippingMethod

mutationupdateShippingMethod

updateStockLocation

mutationupdateStockLocation

updateTag

mutationupdateTag

updateTaxCategory

mutationupdateTaxCategory

updateTaxRate

mutationupdateTaxRate

updateZone

mutationupdateZone
Was this chapter helpful?
Report Issue
Edited Feb 2, 2026·Edit this page