Mutations

Mutations

addCustomersToGroup

Add Customers to a CustomerGroup

addMembersToZone

Add members to a Zone

  • addMembersToZone(zoneId: ID!, memberIds: [ID!]!): Zone!

addNoteToCustomer

addNoteToOrder

addOptionGroupToProduct

Add an OptionGroup to a Product

  • addOptionGroupToProduct(productId: ID!, optionGroupId: ID!): Product!

assignProductsToChannel

Assigns Products to the specified Channel

assignRoleToAdministrator

Assign a Role to an Administrator

cancelOrder

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

createFacet

Create a new Facet

createFacetValues

Create one or more FacetValues

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

createRole

Create a new Role

createShippingMethod

Create a new ShippingMethod

createTaxCategory

Create a new TaxCategory

createTaxRate

Create a new TaxRate

createZone

Create a new Zone

deleteAsset

Delete an Asset

deleteChannel

Delete a Channel

deleteCollection

Delete a Collection and all of its descendants

deleteCountry

Delete a Country

deleteCustomer

Delete a Customer

deleteCustomerAddress

Update an existing Address

deleteCustomerGroup

Delete a CustomerGroup

deleteCustomerNote

deleteFacet

Delete an existing Facet

deleteFacetValues

Delete one or more FacetValues

deleteOrderNote

deleteProduct

Delete a Product

deleteProductVariant

Delete a ProductVariant

deletePromotion

deleteRole

Delete an existing Role

deleteShippingMethod

Delete a ShippingMethod

deleteTaxCategory

Deletes a TaxCategory

deleteTaxRate

Delete a TaxRate

deleteZone

Delete a Zone

fulfillOrder

importProducts

login

logout

moveCollection

Move a Collection to a different parent or index

refundOrder

reindex

  • reindex: Job!

removeCustomersFromGroup

Remove Customers from a CustomerGroup

  • removeCustomersFromGroup(customerGroupId: ID!, customerIds: [ID!]!): CustomerGroup!

removeMembersFromZone

Remove members from a Zone

  • removeMembersFromZone(zoneId: ID!, memberIds: [ID!]!): Zone!

removeOptionGroupFromProduct

Remove an OptionGroup from a Product

  • removeOptionGroupFromProduct(productId: ID!, optionGroupId: ID!): Product!

removeProductsFromChannel

Removes Products from the specified Channel

removeSettledJobs

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

settlePayment

settleRefund

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

updatePromotion

updateRole

Update an existing Role

updateShippingMethod

Update an existing ShippingMethod

updateTaxCategory

Update an existing TaxCategory

updateTaxRate

Update an existing TaxRate

updateZone

Update an existing Zone