vendure/docs/content/graphql-api/admin/mutations.md

---

title: "Mutations" weight: 2 date: 2023-07-04T11:02:07.589Z showtoc: true

generated: true

Mutations

addCustomersToGroup

Add Customers to a CustomerGroup

{{% gql-fields %}}

• addCustomersToGroup(customerGroupId: ID!, customerIds: [ID!]!): CustomerGroup! {{% /gql-fields %}}

addFulfillmentToOrder

{{% gql-fields %}}

• addFulfillmentToOrder(input: FulfillOrderInput!): AddFulfillmentToOrderResult! {{% /gql-fields %}}

addItemToDraftOrder

Adds an item to the draft Order.

{{% gql-fields %}}

• addItemToDraftOrder(orderId: ID!, input: AddItemToDraftOrderInput!): UpdateOrderItemsResult! {{% /gql-fields %}}

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.

{{% gql-fields %}}

• addManualPaymentToOrder(input: ManualPaymentInput!): AddManualPaymentToOrderResult! {{% /gql-fields %}}

addMembersToZone

Add members to a Zone

{{% gql-fields %}}

• addMembersToZone(zoneId: ID!, memberIds: [ID!]!): Zone! {{% /gql-fields %}}

addNoteToCustomer

{{% gql-fields %}}

• addNoteToCustomer(input: AddNoteToCustomerInput!): Customer! {{% /gql-fields %}}

addNoteToOrder

{{% gql-fields %}}

• addNoteToOrder(input: AddNoteToOrderInput!): Order! {{% /gql-fields %}}

addOptionGroupToProduct

Add an OptionGroup to a Product

{{% gql-fields %}}

• addOptionGroupToProduct(productId: ID!, optionGroupId: ID!): Product! {{% /gql-fields %}}

adjustDraftOrderLine

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

{{% gql-fields %}}

• adjustDraftOrderLine(orderId: ID!, input: AdjustDraftOrderLineInput!): UpdateOrderItemsResult! {{% /gql-fields %}}

applyCouponCodeToDraftOrder

Applies the given coupon code to the draft Order

{{% gql-fields %}}

• applyCouponCodeToDraftOrder(orderId: ID!, couponCode: String!): ApplyCouponCodeResult! {{% /gql-fields %}}

assignAssetsToChannel

Assign assets to channel

{{% gql-fields %}}

• assignAssetsToChannel(input: AssignAssetsToChannelInput!): [Asset!]! {{% /gql-fields %}}

assignCollectionsToChannel

Assigns Collections to the specified Channel

{{% gql-fields %}}

• assignCollectionsToChannel(input: AssignCollectionsToChannelInput!): [Collection!]! {{% /gql-fields %}}

assignFacetsToChannel

Assigns Facets to the specified Channel

{{% gql-fields %}}

• assignFacetsToChannel(input: AssignFacetsToChannelInput!): [Facet!]! {{% /gql-fields %}}

assignPaymentMethodsToChannel

Assigns PaymentMethods to the specified Channel

{{% gql-fields %}}

• assignPaymentMethodsToChannel(input: AssignPaymentMethodsToChannelInput!): [PaymentMethod!]! {{% /gql-fields %}}

assignProductVariantsToChannel

Assigns ProductVariants to the specified Channel

{{% gql-fields %}}

• assignProductVariantsToChannel(input: AssignProductVariantsToChannelInput!): [ProductVariant!]! {{% /gql-fields %}}

assignProductsToChannel

Assigns all ProductVariants of Product to the specified Channel

{{% gql-fields %}}

• assignProductsToChannel(input: AssignProductsToChannelInput!): [Product!]! {{% /gql-fields %}}

assignPromotionsToChannel

Assigns Promotions to the specified Channel

{{% gql-fields %}}

• assignPromotionsToChannel(input: AssignPromotionsToChannelInput!): [Promotion!]! {{% /gql-fields %}}

assignRoleToAdministrator

Assign a Role to an Administrator

{{% gql-fields %}}

• assignRoleToAdministrator(administratorId: ID!, roleId: ID!): Administrator! {{% /gql-fields %}}

assignShippingMethodsToChannel

Assigns ShippingMethods to the specified Channel

{{% gql-fields %}}

• assignShippingMethodsToChannel(input: AssignShippingMethodsToChannelInput!): [ShippingMethod!]! {{% /gql-fields %}}

assignStockLocationsToChannel

Assigns StockLocations to the specified Channel

{{% gql-fields %}}

• assignStockLocationsToChannel(input: AssignStockLocationsToChannelInput!): [StockLocation!]! {{% /gql-fields %}}

authenticate

Authenticates the user using a named authentication strategy

{{% gql-fields %}}

• authenticate(input: AuthenticationInput!, rememberMe: Boolean): AuthenticationResult! {{% /gql-fields %}}

cancelJob

{{% gql-fields %}}

• cancelJob(jobId: ID!): Job! {{% /gql-fields %}}

cancelOrder

{{% gql-fields %}}

• cancelOrder(input: CancelOrderInput!): CancelOrderResult! {{% /gql-fields %}}

cancelPayment

{{% gql-fields %}}

• cancelPayment(id: ID!): CancelPaymentResult! {{% /gql-fields %}}

createAdministrator

Create a new Administrator

{{% gql-fields %}}

• createAdministrator(input: CreateAdministratorInput!): Administrator! {{% /gql-fields %}}

createAssets

Create a new Asset

{{% gql-fields %}}

• createAssets(input: [CreateAssetInput!]!): [CreateAssetResult!]! {{% /gql-fields %}}

createChannel

Create a new Channel

{{% gql-fields %}}

• createChannel(input: CreateChannelInput!): CreateChannelResult! {{% /gql-fields %}}

createCollection

Create a new Collection

{{% gql-fields %}}

• createCollection(input: CreateCollectionInput!): Collection! {{% /gql-fields %}}

createCountry

Create a new Country

{{% gql-fields %}}

• createCountry(input: CreateCountryInput!): Country! {{% /gql-fields %}}

createCustomer

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

{{% gql-fields %}}

• createCustomer(input: CreateCustomerInput!, password: String): CreateCustomerResult! {{% /gql-fields %}}

createCustomerAddress

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

{{% gql-fields %}}

• createCustomerAddress(customerId: ID!, input: CreateAddressInput!): Address! {{% /gql-fields %}}

createCustomerGroup

Create a new CustomerGroup

{{% gql-fields %}}

• createCustomerGroup(input: CreateCustomerGroupInput!): CustomerGroup! {{% /gql-fields %}}

createDraftOrder

Creates a draft Order

{{% gql-fields %}}

• createDraftOrder: Order! {{% /gql-fields %}}

createFacet

Create a new Facet

{{% gql-fields %}}

• createFacet(input: CreateFacetInput!): Facet! {{% /gql-fields %}}

createFacetValues

Create one or more FacetValues

{{% gql-fields %}}

• createFacetValues(input: [CreateFacetValueInput!]!): [FacetValue!]! {{% /gql-fields %}}

createPaymentMethod

Create existing PaymentMethod

{{% gql-fields %}}

• createPaymentMethod(input: CreatePaymentMethodInput!): PaymentMethod! {{% /gql-fields %}}

createProduct

Create a new Product

{{% gql-fields %}}

• createProduct(input: CreateProductInput!): Product! {{% /gql-fields %}}

createProductOption

Create a new ProductOption within a ProductOptionGroup

{{% gql-fields %}}

• createProductOption(input: CreateProductOptionInput!): ProductOption! {{% /gql-fields %}}

createProductOptionGroup

Create a new ProductOptionGroup

{{% gql-fields %}}

• createProductOptionGroup(input: CreateProductOptionGroupInput!): ProductOptionGroup! {{% /gql-fields %}}

createProductVariants

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

{{% gql-fields %}}

• createProductVariants(input: [CreateProductVariantInput!]!): [ProductVariant]! {{% /gql-fields %}}

createPromotion

{{% gql-fields %}}

• createPromotion(input: CreatePromotionInput!): CreatePromotionResult! {{% /gql-fields %}}

createProvince

Create a new Province

{{% gql-fields %}}

• createProvince(input: CreateProvinceInput!): Province! {{% /gql-fields %}}

createRole

Create a new Role

{{% gql-fields %}}

• createRole(input: CreateRoleInput!): Role! {{% /gql-fields %}}

createSeller

Create a new Seller

{{% gql-fields %}}

• createSeller(input: CreateSellerInput!): Seller! {{% /gql-fields %}}

createShippingMethod

Create a new ShippingMethod

{{% gql-fields %}}

• createShippingMethod(input: CreateShippingMethodInput!): ShippingMethod! {{% /gql-fields %}}

createStockLocation

{{% gql-fields %}}

• createStockLocation(input: CreateStockLocationInput!): StockLocation! {{% /gql-fields %}}

createTag

Create a new Tag

{{% gql-fields %}}

• createTag(input: CreateTagInput!): Tag! {{% /gql-fields %}}

createTaxCategory

Create a new TaxCategory

{{% gql-fields %}}

• createTaxCategory(input: CreateTaxCategoryInput!): TaxCategory! {{% /gql-fields %}}

createTaxRate

Create a new TaxRate

{{% gql-fields %}}

• createTaxRate(input: CreateTaxRateInput!): TaxRate! {{% /gql-fields %}}

createZone

Create a new Zone

{{% gql-fields %}}

• createZone(input: CreateZoneInput!): Zone! {{% /gql-fields %}}

deleteAdministrator

Delete an Administrator

{{% gql-fields %}}

• deleteAdministrator(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteAdministrators

Delete multiple Administrators

{{% gql-fields %}}

• deleteAdministrators(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteAsset

Delete an Asset

{{% gql-fields %}}

• deleteAsset(input: DeleteAssetInput!): DeletionResponse! {{% /gql-fields %}}

deleteAssets

Delete multiple Assets

{{% gql-fields %}}

• deleteAssets(input: DeleteAssetsInput!): DeletionResponse! {{% /gql-fields %}}

deleteChannel

Delete a Channel

{{% gql-fields %}}

• deleteChannel(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteChannels

Delete multiple Channels

{{% gql-fields %}}

• deleteChannels(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteCollection

Delete a Collection and all of its descendants

{{% gql-fields %}}

• deleteCollection(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteCollections

Delete multiple Collections and all of their descendants

{{% gql-fields %}}

• deleteCollections(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteCountries

Delete multiple Countries

{{% gql-fields %}}

• deleteCountries(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteCountry

Delete a Country

{{% gql-fields %}}

• deleteCountry(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteCustomer

Delete a Customer

{{% gql-fields %}}

• deleteCustomer(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteCustomerAddress

Update an existing Address

{{% gql-fields %}}

• deleteCustomerAddress(id: ID!): Success! {{% /gql-fields %}}

deleteCustomerGroup

Delete a CustomerGroup

{{% gql-fields %}}

• deleteCustomerGroup(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteCustomerGroups

Delete multiple CustomerGroups

{{% gql-fields %}}

• deleteCustomerGroups(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteCustomerNote

{{% gql-fields %}}

• deleteCustomerNote(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteCustomers

Deletes Customers

{{% gql-fields %}}

• deleteCustomers(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteDraftOrder

Deletes a draft Order

{{% gql-fields %}}

• deleteDraftOrder(orderId: ID!): DeletionResponse! {{% /gql-fields %}}

deleteFacet

Delete an existing Facet

{{% gql-fields %}}

• deleteFacet(id: ID!, force: Boolean): DeletionResponse! {{% /gql-fields %}}

deleteFacetValues

Delete one or more FacetValues

{{% gql-fields %}}

• deleteFacetValues(ids: [ID!]!, force: Boolean): [DeletionResponse!]! {{% /gql-fields %}}

deleteFacets

Delete multiple existing Facets

{{% gql-fields %}}

• deleteFacets(ids: [ID!]!, force: Boolean): [DeletionResponse!]! {{% /gql-fields %}}

deleteOrderNote

{{% gql-fields %}}

• deleteOrderNote(id: ID!): DeletionResponse! {{% /gql-fields %}}

deletePaymentMethod

Delete a PaymentMethod

{{% gql-fields %}}

• deletePaymentMethod(id: ID!, force: Boolean): DeletionResponse! {{% /gql-fields %}}

deletePaymentMethods

Delete multiple PaymentMethods

{{% gql-fields %}}

• deletePaymentMethods(ids: [ID!]!, force: Boolean): [DeletionResponse!]! {{% /gql-fields %}}

deleteProduct

Delete a Product

{{% gql-fields %}}

• deleteProduct(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteProductOption

Delete a ProductOption

{{% gql-fields %}}

• deleteProductOption(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteProductVariant

Delete a ProductVariant

{{% gql-fields %}}

• deleteProductVariant(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteProductVariants

Delete multiple ProductVariants

{{% gql-fields %}}

• deleteProductVariants(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteProducts

Delete multiple Products

{{% gql-fields %}}

• deleteProducts(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deletePromotion

{{% gql-fields %}}

• deletePromotion(id: ID!): DeletionResponse! {{% /gql-fields %}}

deletePromotions

{{% gql-fields %}}

• deletePromotions(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteProvince

Delete a Province

{{% gql-fields %}}

• deleteProvince(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteRole

Delete an existing Role

{{% gql-fields %}}

• deleteRole(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteRoles

Delete multiple Roles

{{% gql-fields %}}

• deleteRoles(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteSeller

Delete a Seller

{{% gql-fields %}}

• deleteSeller(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteSellers

Delete multiple Sellers

{{% gql-fields %}}

• deleteSellers(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteShippingMethod

Delete a ShippingMethod

{{% gql-fields %}}

• deleteShippingMethod(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteShippingMethods

Delete multiple ShippingMethods

{{% gql-fields %}}

• deleteShippingMethods(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteStockLocation

{{% gql-fields %}}

• deleteStockLocation(input: DeleteStockLocationInput!): DeletionResponse! {{% /gql-fields %}}

deleteStockLocations

{{% gql-fields %}}

• deleteStockLocations(input: [DeleteStockLocationInput!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteTag

Delete an existing Tag

{{% gql-fields %}}

• deleteTag(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteTaxCategories

Deletes multiple TaxCategories

{{% gql-fields %}}

• deleteTaxCategories(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteTaxCategory

Deletes a TaxCategory

{{% gql-fields %}}

• deleteTaxCategory(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteTaxRate

Delete a TaxRate

{{% gql-fields %}}

• deleteTaxRate(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteTaxRates

Delete multiple TaxRates

{{% gql-fields %}}

• deleteTaxRates(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

deleteZone

Delete a Zone

{{% gql-fields %}}

• deleteZone(id: ID!): DeletionResponse! {{% /gql-fields %}}

deleteZones

Delete a Zone

{{% gql-fields %}}

• deleteZones(ids: [ID!]!): [DeletionResponse!]! {{% /gql-fields %}}

flushBufferedJobs

{{% gql-fields %}}

• flushBufferedJobs(bufferIds: [String!]): Success! {{% /gql-fields %}}

importProducts

{{% gql-fields %}}

• importProducts(csvFile: Upload!): ImportInfo {{% /gql-fields %}}

login

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

{{% gql-fields %}}

• login(username: String!, password: String!, rememberMe: Boolean): NativeAuthenticationResult! {{% /gql-fields %}}

logout

{{% gql-fields %}}

• logout: Success! {{% /gql-fields %}}

modifyOrder

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

{{% gql-fields %}}

• modifyOrder(input: ModifyOrderInput!): ModifyOrderResult! {{% /gql-fields %}}

moveCollection

Move a Collection to a different parent or index

{{% gql-fields %}}

• moveCollection(input: MoveCollectionInput!): Collection! {{% /gql-fields %}}

refundOrder

{{% gql-fields %}}

• refundOrder(input: RefundOrderInput!): RefundOrderResult! {{% /gql-fields %}}

reindex

{{% gql-fields %}}

• reindex: Job! {{% /gql-fields %}}

removeCollectionsFromChannel

Removes Collections from the specified Channel

{{% gql-fields %}}

• removeCollectionsFromChannel(input: RemoveCollectionsFromChannelInput!): [Collection!]! {{% /gql-fields %}}

removeCouponCodeFromDraftOrder

Removes the given coupon code from the draft Order

{{% gql-fields %}}

• removeCouponCodeFromDraftOrder(orderId: ID!, couponCode: String!): Order {{% /gql-fields %}}

removeCustomersFromGroup

Remove Customers from a CustomerGroup

{{% gql-fields %}}

• removeCustomersFromGroup(customerGroupId: ID!, customerIds: [ID!]!): CustomerGroup! {{% /gql-fields %}}

removeDraftOrderLine

Remove an OrderLine from the draft Order

{{% gql-fields %}}

• removeDraftOrderLine(orderId: ID!, orderLineId: ID!): RemoveOrderItemsResult! {{% /gql-fields %}}

removeFacetsFromChannel

Removes Facets from the specified Channel

{{% gql-fields %}}

• removeFacetsFromChannel(input: RemoveFacetsFromChannelInput!): [RemoveFacetFromChannelResult!]! {{% /gql-fields %}}

removeMembersFromZone

Remove members from a Zone

{{% gql-fields %}}

• removeMembersFromZone(zoneId: ID!, memberIds: [ID!]!): Zone! {{% /gql-fields %}}

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.

{{% gql-fields %}}

• removeOptionGroupFromProduct(productId: ID!, optionGroupId: ID!, force: Boolean): RemoveOptionGroupFromProductResult! {{% /gql-fields %}}

removePaymentMethodsFromChannel

Removes PaymentMethods from the specified Channel

{{% gql-fields %}}

• removePaymentMethodsFromChannel(input: RemovePaymentMethodsFromChannelInput!): [PaymentMethod!]! {{% /gql-fields %}}

removeProductVariantsFromChannel

Removes ProductVariants from the specified Channel

{{% gql-fields %}}

• removeProductVariantsFromChannel(input: RemoveProductVariantsFromChannelInput!): [ProductVariant!]! {{% /gql-fields %}}

removeProductsFromChannel

Removes all ProductVariants of Product from the specified Channel

{{% gql-fields %}}

• removeProductsFromChannel(input: RemoveProductsFromChannelInput!): [Product!]! {{% /gql-fields %}}

removePromotionsFromChannel

Removes Promotions from the specified Channel

{{% gql-fields %}}

• removePromotionsFromChannel(input: RemovePromotionsFromChannelInput!): [Promotion!]! {{% /gql-fields %}}

removeSettledJobs

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

{{% gql-fields %}}

• removeSettledJobs(queueNames: [String!], olderThan: DateTime): Int! {{% /gql-fields %}}

removeShippingMethodsFromChannel

Removes ShippingMethods from the specified Channel

{{% gql-fields %}}

• removeShippingMethodsFromChannel(input: RemoveShippingMethodsFromChannelInput!): [ShippingMethod!]! {{% /gql-fields %}}

removeStockLocationsFromChannel

Removes StockLocations from the specified Channel

{{% gql-fields %}}

• removeStockLocationsFromChannel(input: RemoveStockLocationsFromChannelInput!): [StockLocation!]! {{% /gql-fields %}}

runPendingSearchIndexUpdates

{{% gql-fields %}}

• runPendingSearchIndexUpdates: Success! {{% /gql-fields %}}

setCustomerForDraftOrder

{{% gql-fields %}}

• setCustomerForDraftOrder(orderId: ID!, customerId: ID, input: CreateCustomerInput): SetCustomerForDraftOrderResult! {{% /gql-fields %}}

setDraftOrderBillingAddress

Sets the billing address for a draft Order

{{% gql-fields %}}

• setDraftOrderBillingAddress(orderId: ID!, input: CreateAddressInput!): Order! {{% /gql-fields %}}

setDraftOrderCustomFields

Allows any custom fields to be set for the active order

{{% gql-fields %}}

• setDraftOrderCustomFields(orderId: ID!, input: UpdateOrderInput!): Order! {{% /gql-fields %}}

setDraftOrderShippingAddress

Sets the shipping address for a draft Order

{{% gql-fields %}}

• setDraftOrderShippingAddress(orderId: ID!, input: CreateAddressInput!): Order! {{% /gql-fields %}}

setDraftOrderShippingMethod

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

{{% gql-fields %}}

• setDraftOrderShippingMethod(orderId: ID!, shippingMethodId: ID!): SetOrderShippingMethodResult! {{% /gql-fields %}}

setOrderCustomFields

{{% gql-fields %}}

• setOrderCustomFields(input: UpdateOrderInput!): Order {{% /gql-fields %}}

settlePayment

{{% gql-fields %}}

• settlePayment(id: ID!): SettlePaymentResult! {{% /gql-fields %}}

settleRefund

{{% gql-fields %}}

• settleRefund(input: SettleRefundInput!): SettleRefundResult! {{% /gql-fields %}}

transitionFulfillmentToState

{{% gql-fields %}}

• transitionFulfillmentToState(id: ID!, state: String!): TransitionFulfillmentToStateResult! {{% /gql-fields %}}

transitionOrderToState

{{% gql-fields %}}

• transitionOrderToState(id: ID!, state: String!): TransitionOrderToStateResult {{% /gql-fields %}}

transitionPaymentToState

{{% gql-fields %}}

• transitionPaymentToState(id: ID!, state: String!): TransitionPaymentToStateResult! {{% /gql-fields %}}

updateActiveAdministrator

Update the active (currently logged-in) Administrator

{{% gql-fields %}}

• updateActiveAdministrator(input: UpdateActiveAdministratorInput!): Administrator! {{% /gql-fields %}}

updateAdministrator

Update an existing Administrator

{{% gql-fields %}}

• updateAdministrator(input: UpdateAdministratorInput!): Administrator! {{% /gql-fields %}}

updateAsset

Update an existing Asset

{{% gql-fields %}}

• updateAsset(input: UpdateAssetInput!): Asset! {{% /gql-fields %}}

updateChannel

Update an existing Channel

{{% gql-fields %}}

• updateChannel(input: UpdateChannelInput!): UpdateChannelResult! {{% /gql-fields %}}

updateCollection

Update an existing Collection

{{% gql-fields %}}

• updateCollection(input: UpdateCollectionInput!): Collection! {{% /gql-fields %}}

updateCountry

Update an existing Country

{{% gql-fields %}}

• updateCountry(input: UpdateCountryInput!): Country! {{% /gql-fields %}}

updateCustomer

Update an existing Customer

{{% gql-fields %}}

• updateCustomer(input: UpdateCustomerInput!): UpdateCustomerResult! {{% /gql-fields %}}

updateCustomerAddress

Update an existing Address

{{% gql-fields %}}

• updateCustomerAddress(input: UpdateAddressInput!): Address! {{% /gql-fields %}}

updateCustomerGroup

Update an existing CustomerGroup

{{% gql-fields %}}

• updateCustomerGroup(input: UpdateCustomerGroupInput!): CustomerGroup! {{% /gql-fields %}}

updateCustomerNote

{{% gql-fields %}}

• updateCustomerNote(input: UpdateCustomerNoteInput!): HistoryEntry! {{% /gql-fields %}}

updateFacet

Update an existing Facet

{{% gql-fields %}}

• updateFacet(input: UpdateFacetInput!): Facet! {{% /gql-fields %}}

updateFacetValues

Update one or more FacetValues

{{% gql-fields %}}

• updateFacetValues(input: [UpdateFacetValueInput!]!): [FacetValue!]! {{% /gql-fields %}}

updateGlobalSettings

{{% gql-fields %}}

• updateGlobalSettings(input: UpdateGlobalSettingsInput!): UpdateGlobalSettingsResult! {{% /gql-fields %}}

updateOrderNote

{{% gql-fields %}}

• updateOrderNote(input: UpdateOrderNoteInput!): HistoryEntry! {{% /gql-fields %}}

updatePaymentMethod

Update an existing PaymentMethod

{{% gql-fields %}}

• updatePaymentMethod(input: UpdatePaymentMethodInput!): PaymentMethod! {{% /gql-fields %}}

updateProduct

Update an existing Product

{{% gql-fields %}}

• updateProduct(input: UpdateProductInput!): Product! {{% /gql-fields %}}

updateProductOption

Create a new ProductOption within a ProductOptionGroup

{{% gql-fields %}}

• updateProductOption(input: UpdateProductOptionInput!): ProductOption! {{% /gql-fields %}}

updateProductOptionGroup

Update an existing ProductOptionGroup

{{% gql-fields %}}

• updateProductOptionGroup(input: UpdateProductOptionGroupInput!): ProductOptionGroup! {{% /gql-fields %}}

updateProductVariants

Update existing ProductVariants

{{% gql-fields %}}

• updateProductVariants(input: [UpdateProductVariantInput!]!): [ProductVariant]! {{% /gql-fields %}}

updateProducts

Update multiple existing Products

{{% gql-fields %}}

• updateProducts(input: [UpdateProductInput!]!): [Product!]! {{% /gql-fields %}}

updatePromotion

{{% gql-fields %}}

• updatePromotion(input: UpdatePromotionInput!): UpdatePromotionResult! {{% /gql-fields %}}

updateProvince

Update an existing Province

{{% gql-fields %}}

• updateProvince(input: UpdateProvinceInput!): Province! {{% /gql-fields %}}

updateRole

Update an existing Role

{{% gql-fields %}}

• updateRole(input: UpdateRoleInput!): Role! {{% /gql-fields %}}

updateSeller

Update an existing Seller

{{% gql-fields %}}

• updateSeller(input: UpdateSellerInput!): Seller! {{% /gql-fields %}}

updateShippingMethod

Update an existing ShippingMethod

{{% gql-fields %}}

• updateShippingMethod(input: UpdateShippingMethodInput!): ShippingMethod! {{% /gql-fields %}}

updateStockLocation

{{% gql-fields %}}

• updateStockLocation(input: UpdateStockLocationInput!): StockLocation! {{% /gql-fields %}}

updateTag

Update an existing Tag

{{% gql-fields %}}

• updateTag(input: UpdateTagInput!): Tag! {{% /gql-fields %}}

updateTaxCategory

Update an existing TaxCategory

{{% gql-fields %}}

• updateTaxCategory(input: UpdateTaxCategoryInput!): TaxCategory! {{% /gql-fields %}}

updateTaxRate

Update an existing TaxRate

{{% gql-fields %}}

• updateTaxRate(input: UpdateTaxRateInput!): TaxRate! {{% /gql-fields %}}

updateZone

Update an existing Zone

{{% gql-fields %}}

• updateZone(input: UpdateZoneInput!): Zone! {{% /gql-fields %}}