Mutations

Mutations

createAdministrator

Create a new Administrator

updateAdministrator

Update an existing Administrator

assignRoleToAdministrator

Assign a Role to an Administrator

createAssets

Create a new Asset

login

logout

registerCustomerAccount

Register a Customer account with the given credentials

verifyCustomerAccount

Verify a Customer email address with the token sent to that address. Only applicable if authOptions.requireVerification is set to true.

refreshCustomerVerification

Regenerate and send a verification token for a new Customer registration. Only applicable if authOptions.requireVerification is set to true.

createChannel

Create a new Channel

updateChannel

Update an existing Channel

createCountry

Create a new Country

updateCountry

Update an existing Country

deleteCountry

Delete a Country

createCustomerGroup

Create a new CustomerGroup

updateCustomerGroup

Update an existing CustomerGroup

addCustomersToGroup

Add Customers to a CustomerGroup

removeCustomersFromGroup

Remove Customers from a CustomerGroup

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

createCustomer

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

updateCustomer

Update an existing Customer

deleteCustomer

Delete a Customer

createCustomerAddress

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

updateCustomerAddress

Update an existing Address

createFacet

Create a new Facet

updateFacet

Update an existing Facet

deleteFacet

Delete an existing Facet

createFacetValues

Create one or more FacetValues

updateFacetValues

Update one or more FacetValues

deleteFacetValues

Delete one or more FacetValues

updateGlobalSettings

importProducts

addItemToOrder

  • addItemToOrder(productVariantId: ID!, quantity: Int!): Order

removeItemFromOrder

  • removeItemFromOrder(orderItemId: ID!): Order

adjustItemQuantity

  • adjustItemQuantity(orderItemId: ID!, quantity: Int!): Order

transitionOrderToState

setOrderShippingAddress

setOrderShippingMethod

  • setOrderShippingMethod(shippingMethodId: ID!): Order

addPaymentToOrder

setCustomerForOrder

updatePaymentMethod

Update an existing PaymentMethod

createProductCategory

Create a new ProductCategory

updateProductCategory

Update an existing ProductCategory

moveProductCategory

Move a ProductCategory to a different parent or index

createProductOptionGroup

Create a new ProductOptionGroup

updateProductOptionGroup

Update an existing ProductOptionGroup

createProduct

Create a new Product

updateProduct

Update an existing Product

deleteProduct

Delete a Product

addOptionGroupToProduct

Add an OptionGroup to a Product

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

removeOptionGroupFromProduct

Remove an OptionGroup from a Product

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

generateVariantsForProduct

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

  • generateVariantsForProduct(productId: ID!, defaultTaxCategoryId: ID, defaultPrice: Int, defaultSku: String): Product!

updateProductVariants

Update existing ProductVariants

createPromotion

updatePromotion

deletePromotion

createRole

Create a new Role

updateRole

Update an existing Role

reindex

createShippingMethod

Create a new ShippingMethod

updateShippingMethod

Update an existing ShippingMethod

createTaxCategory

Create a new TaxCategory

updateTaxCategory

Update an existing TaxCategory

createTaxRate

Create a new TaxRate

updateTaxRate

Update an existing TaxRate

createZone

Create a new Zone

updateZone

Update an existing Zone

deleteZone

Delete a Zone

addMembersToZone

Add members to a Zone

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

removeMembersFromZone

Remove members from a Zone

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