Mutations

addCustomersToGroup

Add Customers to a CustomerGroup

addFulfillmentToOrder

addItemToDraftOrder

Adds an item to the draft Order.

addManualPaymentToOrder

Used to manually create a new Payment against an Order. This can be used by an Administrator when an Order is in the ArrangingPayment state.

It is also used when a completed Order has been modified (using modifyOrder) and the price has increased. The extra payment can then be manually arranged by the administrator, and the details used to create a new Payment.

addMembersToZone

Add members to a Zone

addNoteToCustomer

addNoteToOrder

addOptionGroupToProduct

Add an OptionGroup to a Product

adjustDraftOrderLine

Adjusts a draft OrderLine. If custom fields are defined on the OrderLine entity, a third argument ‘customFields’ of type OrderLineCustomFieldsInput will be available.

applyCouponCodeToDraftOrder

Applies the given coupon code to the draft Order

assignAssetsToChannel

Assign assets to channel

assignCollectionsToChannel

Assigns Collections to the specified Channel

assignFacetsToChannel

Assigns Facets to the specified Channel

assignPaymentMethodsToChannel

Assigns PaymentMethods to the specified Channel

assignProductVariantsToChannel

Assigns ProductVariants to the specified Channel

assignProductsToChannel

Assigns all ProductVariants of Product to the specified Channel

assignPromotionsToChannel

Assigns Promotions to the specified Channel

assignRoleToAdministrator

Assign a Role to an Administrator

assignShippingMethodsToChannel

Assigns ShippingMethods to the specified Channel

assignStockLocationsToChannel

Assigns StockLocations to the specified Channel

authenticate

Authenticates the user using a named authentication strategy

cancelJob

cancelOrder

cancelPayment

createAdministrator

Create a new Administrator

createAssets

Create a new Asset

createChannel

Create a new Channel

createCollection

Create a new Collection

createCountry

Create a new Country

createCustomer

Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer.

createCustomerAddress

Create a new Address and associate it with the Customer specified by customerId

createCustomerGroup

Create a new CustomerGroup

createDraftOrder

Creates a draft Order

createFacet

Create a new Facet

createFacetValues

Create one or more FacetValues

createPaymentMethod

Create existing PaymentMethod

createProduct

Create a new Product

createProductOption

Create a new ProductOption within a ProductOptionGroup

createProductOptionGroup

Create a new ProductOptionGroup

createProductVariants

Create a set of ProductVariants based on the OptionGroups assigned to the given Product

createPromotion

createProvince

Create a new Province

createRole

Create a new Role

createSeller

Create a new Seller

createShippingMethod

Create a new ShippingMethod

createStockLocation

createTag

Create a new Tag

createTaxCategory

Create a new TaxCategory

createTaxRate

Create a new TaxRate

createZone

Create a new Zone

deleteAdministrator

Delete an Administrator

deleteAdministrators

Delete multiple Administrators

deleteAsset

Delete an Asset

deleteAssets

Delete multiple Assets

deleteChannel

Delete a Channel

deleteChannels

Delete multiple Channels

deleteCollection

Delete a Collection and all of its descendants

deleteCollections

Delete multiple Collections and all of their descendants

deleteCountries

Delete multiple Countries

deleteCountry

Delete a Country

deleteCustomer

Delete a Customer

deleteCustomerAddress

Update an existing Address

deleteCustomerGroup

Delete a CustomerGroup

deleteCustomerGroups

Delete multiple CustomerGroups

deleteCustomerNote

deleteCustomers

Deletes Customers

deleteDraftOrder

Deletes a draft Order

deleteFacet

Delete an existing Facet

deleteFacetValues

Delete one or more FacetValues

deleteFacets

Delete multiple existing Facets

deleteOrderNote

deletePaymentMethod

Delete a PaymentMethod

deletePaymentMethods

Delete multiple PaymentMethods

deleteProduct

Delete a Product

deleteProductOption

Delete a ProductOption

deleteProductVariant

Delete a ProductVariant

deleteProductVariants

Delete multiple ProductVariants

deleteProducts

Delete multiple Products

deletePromotion

deletePromotions

deleteProvince

Delete a Province

deleteRole

Delete an existing Role

deleteRoles

Delete multiple Roles

deleteSeller

Delete a Seller

deleteSellers

Delete multiple Sellers

deleteShippingMethod

Delete a ShippingMethod

deleteShippingMethods

Delete multiple ShippingMethods

deleteStockLocation

deleteStockLocations

deleteTag

Delete an existing Tag

deleteTaxCategories

Deletes multiple TaxCategories

deleteTaxCategory

Deletes a TaxCategory

deleteTaxRate

Delete a TaxRate

deleteTaxRates

Delete multiple TaxRates

deleteZone

Delete a Zone

deleteZones

Delete a Zone

flushBufferedJobs

importProducts

login

Authenticates the user using the native authentication strategy. This mutation is an alias for authenticate({ native: { ... }})

logout

modifyOrder

Allows an Order to be modified after it has been completed by the Customer. The Order must first be in the Modifying state.

moveCollection

Move a Collection to a different parent or index

refundOrder

reindex

removeCollectionsFromChannel

Removes Collections from the specified Channel

removeCouponCodeFromDraftOrder

Removes the given coupon code from the draft Order

removeCustomersFromGroup

Remove Customers from a CustomerGroup

removeDraftOrderLine

Remove an OrderLine from the draft Order

removeFacetsFromChannel

Removes Facets from the specified Channel

removeMembersFromZone

Remove members from a Zone

removeOptionGroupFromProduct

Remove an OptionGroup from a Product. If the OptionGroup is in use by any ProductVariants the mutation will return a ProductOptionInUseError, and the OptionGroup will not be removed. Setting the force argument to true will override this and remove the OptionGroup anyway, as well as removing any of the group’s options from the Product’s ProductVariants.

removePaymentMethodsFromChannel

Removes PaymentMethods from the specified Channel

removeProductVariantsFromChannel

Removes ProductVariants from the specified Channel

removeProductsFromChannel

Removes all ProductVariants of Product from the specified Channel

removePromotionsFromChannel

Removes Promotions from the specified Channel

removeSettledJobs

Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted.

removeShippingMethodsFromChannel

Removes ShippingMethods from the specified Channel

removeStockLocationsFromChannel

Removes StockLocations from the specified Channel

runPendingSearchIndexUpdates

setCustomerForDraftOrder

setDraftOrderBillingAddress

Sets the billing address for a draft Order

setDraftOrderCustomFields

Allows any custom fields to be set for the active order

setDraftOrderShippingAddress

Sets the shipping address for a draft Order

setDraftOrderShippingMethod

Sets the shipping method by id, which can be obtained with the eligibleShippingMethodsForDraftOrder query

setOrderCustomFields

settlePayment

settleRefund

transitionFulfillmentToState

transitionOrderToState

transitionPaymentToState

updateActiveAdministrator

Update the active (currently logged-in) Administrator

updateAdministrator

Update an existing Administrator

updateAsset

Update an existing Asset

updateChannel

Update an existing Channel

updateCollection

Update an existing Collection

updateCountry

Update an existing Country

updateCustomer

Update an existing Customer

updateCustomerAddress

Update an existing Address

updateCustomerGroup

Update an existing CustomerGroup

updateCustomerNote

updateFacet

Update an existing Facet

updateFacetValues

Update one or more FacetValues

updateGlobalSettings

updateOrderNote

updatePaymentMethod

Update an existing PaymentMethod

updateProduct

Update an existing Product

updateProductOption

Create a new ProductOption within a ProductOptionGroup

updateProductOptionGroup

Update an existing ProductOptionGroup

updateProductVariants

Update existing ProductVariants

updateProducts

Update multiple existing Products

updatePromotion

updateProvince

Update an existing Province

updateRole

Update an existing Role

updateSeller

Update an existing Seller

updateShippingMethod

Update an existing ShippingMethod

updateStockLocation

updateTag

Update an existing Tag

updateTaxCategory

Update an existing TaxCategory

updateTaxRate

Update an existing TaxRate

updateZone

Update an existing Zone