Mutations
addCustomersToGroup
"""
Add Customers to a CustomerGroup
"""
type Mutation {
}
addFulfillmentToOrder
addItemToDraftOrder
"""
Adds an item to the draft Order.
"""
type Mutation {
}
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 paymentcan then be manually arranged by the administrator, and the details used to create a new
Payment.
"""
type Mutation {
addManualPaymentToOrder(input: ManualPaymentInput!): AddManualPaymentToOrderResult!
}
addMembersToZone
addNoteToCustomer
addNoteToOrder
addOptionGroupToProduct
"""
Add an OptionGroup to a Product
"""
type Mutation {
}
adjustDraftOrderLine
"""
Adjusts a draft OrderLine. If custom fields are defined on the OrderLine entity, a third argument 'customFields' of type
OrderLineCustomFieldsInput
will be available."""
type Mutation {
}
applyCouponCodeToDraftOrder
"""
Applies the given coupon code to the draft Order
"""
type Mutation {
}
assignAssetsToChannel
"""
Assign assets to channel
"""
type Mutation {
assignAssetsToChannel(input: AssignAssetsToChannelInput!): [Asset!]!
}
assignCollectionsToChannel
"""
Assigns Collections to the specified Channel
"""
type Mutation {
assignCollectionsToChannel(input: AssignCollectionsToChannelInput!): [Collection!]!
}
assignFacetsToChannel
"""
Assigns Facets to the specified Channel
"""
type Mutation {
assignFacetsToChannel(input: AssignFacetsToChannelInput!): [Facet!]!
}
assignPaymentMethodsToChannel
"""
Assigns PaymentMethods to the specified Channel
"""
type Mutation {
assignPaymentMethodsToChannel(input: AssignPaymentMethodsToChannelInput!): [PaymentMethod!]!
}
assignProductVariantsToChannel
"""
Assigns ProductVariants to the specified Channel
"""
type Mutation {
assignProductVariantsToChannel(input: AssignProductVariantsToChannelInput!): [ProductVariant!]!
}
assignProductsToChannel
"""
Assigns all ProductVariants of Product to the specified Channel
"""
type Mutation {
assignProductsToChannel(input: AssignProductsToChannelInput!): [Product!]!
}
assignPromotionsToChannel
"""
Assigns Promotions to the specified Channel
"""
type Mutation {
assignPromotionsToChannel(input: AssignPromotionsToChannelInput!): [Promotion!]!
}
assignRoleToAdministrator
"""
Assign a Role to an Administrator
"""
type Mutation {
}
assignShippingMethodsToChannel
"""
Assigns ShippingMethods to the specified Channel
"""
type Mutation {
assignShippingMethodsToChannel(input: AssignShippingMethodsToChannelInput!): [ShippingMethod!]!
}
assignStockLocationsToChannel
"""
Assigns StockLocations to the specified Channel
"""
type Mutation {
assignStockLocationsToChannel(input: AssignStockLocationsToChannelInput!): [StockLocation!]!
}
authenticate
"""
Authenticates the user using a named authentication strategy
"""
type Mutation {
}
cancelJob
cancelOrder
cancelPayment
createAdministrator
"""
Create a new Administrator
"""
type Mutation {
createAdministrator(input: CreateAdministratorInput!): Administrator!
}
createAssets
"""
Create a new Asset
"""
type Mutation {
createAssets(input: [CreateAssetInput!]!): [CreateAssetResult!]!
}
createChannel
"""
Create a new Channel
"""
type Mutation {
createChannel(input: CreateChannelInput!): CreateChannelResult!
}
createCollection
"""
Create a new Collection
"""
type Mutation {
createCollection(input: CreateCollectionInput!): Collection!
}
createCountry
createCustomer
"""
Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer.
"""
type Mutation {
}
createCustomerAddress
"""
Create a new Address and associate it with the Customer specified by customerId
"""
type Mutation {
}
createCustomerGroup
"""
Create a new CustomerGroup
"""
type Mutation {
createCustomerGroup(input: CreateCustomerGroupInput!): CustomerGroup!
}
createDraftOrder
createFacet
createFacetValues
"""
Create one or more FacetValues
"""
type Mutation {
createFacetValues(input: [CreateFacetValueInput!]!): [FacetValue!]!
}
createPaymentMethod
"""
Create existing PaymentMethod
"""
type Mutation {
createPaymentMethod(input: CreatePaymentMethodInput!): PaymentMethod!
}
createProduct
createProductOption
"""
Create a new ProductOption within a ProductOptionGroup
"""
type Mutation {
createProductOption(input: CreateProductOptionInput!): ProductOption!
}
createProductOptionGroup
"""
Create a new ProductOptionGroup
"""
type Mutation {
createProductOptionGroup(input: CreateProductOptionGroupInput!): ProductOptionGroup!
}
createProductVariants
"""
Create a set of ProductVariants based on the OptionGroups assigned to the given Product
"""
type Mutation {
createProductVariants(input: [CreateProductVariantInput!]!): [ProductVariant]!
}
createPromotion
createProvince
createRole
createSeller
createShippingMethod
"""
Create a new ShippingMethod
"""
type Mutation {
createShippingMethod(input: CreateShippingMethodInput!): ShippingMethod!
}
createStockLocation
createTag
createTaxCategory
"""
Create a new TaxCategory
"""
type Mutation {
createTaxCategory(input: CreateTaxCategoryInput!): TaxCategory!
}
createTaxRate
createZone
deleteAdministrator
deleteAdministrators
"""
Delete multiple Administrators
"""
type Mutation {
deleteAdministrators(ids: [ID!]!): [DeletionResponse!]!
}
deleteAsset
deleteAssets
"""
Delete multiple Assets
"""
type Mutation {
deleteAssets(input: DeleteAssetsInput!): DeletionResponse!
}
deleteChannel
deleteChannels
deleteCollection
"""
Delete a Collection and all of its descendants
"""
type Mutation {
deleteCollection(id: ID!): DeletionResponse!
}
deleteCollections
"""
Delete multiple Collections and all of their descendants
"""
type Mutation {
deleteCollections(ids: [ID!]!): [DeletionResponse!]!
}
deleteCountries
deleteCountry
deleteCustomer
deleteCustomerAddress
deleteCustomerGroup
deleteCustomerGroups
"""
Delete multiple CustomerGroups
"""
type Mutation {
deleteCustomerGroups(ids: [ID!]!): [DeletionResponse!]!
}
deleteCustomerNote
deleteCustomers
deleteDraftOrder
deleteFacet
"""
Delete an existing Facet
"""
type Mutation {
}
deleteFacetValues
"""
Delete one or more FacetValues
"""
type Mutation {
}
deleteFacets
"""
Delete multiple existing Facets
"""
type Mutation {
}
deleteOrderNote
deletePaymentMethod
"""
Delete a PaymentMethod
"""
type Mutation {
}
deletePaymentMethods
"""
Delete multiple PaymentMethods
"""
type Mutation {
}
deleteProduct
deleteProductOption
deleteProductVariant
deleteProductVariants
"""
Delete multiple ProductVariants
"""
type Mutation {
deleteProductVariants(ids: [ID!]!): [DeletionResponse!]!
}
deleteProducts
deletePromotion
deletePromotions
deleteProvince
deleteRole
deleteRoles
deleteSeller
deleteSellers
deleteShippingMethod
deleteShippingMethods
"""
Delete multiple ShippingMethods
"""
type Mutation {
deleteShippingMethods(ids: [ID!]!): [DeletionResponse!]!
}
deleteStockLocation
deleteStockLocations
deleteTag
deleteTaxCategories
"""
Deletes multiple TaxCategories
"""
type Mutation {
deleteTaxCategories(ids: [ID!]!): [DeletionResponse!]!
}
deleteTaxCategory
deleteTaxRate
deleteTaxRates
deleteZone
deleteZones
duplicateEntity
"""
Duplicate an existing entity using a specific EntityDuplicator.
Since v2.2.0.
"""
type Mutation {
duplicateEntity(input: DuplicateEntityInput!): DuplicateEntityResult!
}
flushBufferedJobs
importProducts
login
"""
Authenticates the user using the native authentication strategy. This mutation is an alias for
authenticate({ native: { ... }})
"""
type Mutation {
}
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."""
type Mutation {
modifyOrder(input: ModifyOrderInput!): ModifyOrderResult!
}
moveCollection
"""
Move a Collection to a different parent or index
"""
type Mutation {
moveCollection(input: MoveCollectionInput!): Collection!
}
refundOrder
reindex
removeCollectionsFromChannel
"""
Removes Collections from the specified Channel
"""
type Mutation {
removeCollectionsFromChannel(input: RemoveCollectionsFromChannelInput!): [Collection!]!
}
removeCouponCodeFromDraftOrder
"""
Removes the given coupon code from the draft Order
"""
type Mutation {
}
removeCustomersFromGroup
"""
Remove Customers from a CustomerGroup
"""
type Mutation {
}
removeDraftOrderLine
"""
Remove an OrderLine from the draft Order
"""
type Mutation {
}
removeFacetsFromChannel
"""
Removes Facets from the specified Channel
"""
type Mutation {
removeFacetsFromChannel(input: RemoveFacetsFromChannelInput!): [RemoveFacetFromChannelResult!]!
}
removeMembersFromZone
"""
Remove members from a Zone
"""
type Mutation {
}
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.
"""
type Mutation {
removeOptionGroupFromProduct(productId: ID!, optionGroupId: ID!, force: Boolean): RemoveOptionGroupFromProductResult!
}
removePaymentMethodsFromChannel
"""
Removes PaymentMethods from the specified Channel
"""
type Mutation {
removePaymentMethodsFromChannel(input: RemovePaymentMethodsFromChannelInput!): [PaymentMethod!]!
}
removeProductVariantsFromChannel
"""
Removes ProductVariants from the specified Channel
"""
type Mutation {
removeProductVariantsFromChannel(input: RemoveProductVariantsFromChannelInput!): [ProductVariant!]!
}
removeProductsFromChannel
"""
Removes all ProductVariants of Product from the specified Channel
"""
type Mutation {
removeProductsFromChannel(input: RemoveProductsFromChannelInput!): [Product!]!
}
removePromotionsFromChannel
"""
Removes Promotions from the specified Channel
"""
type Mutation {
removePromotionsFromChannel(input: RemovePromotionsFromChannelInput!): [Promotion!]!
}
removeSettledJobs
"""
Remove all settled jobs in the given queues older than the given date. Returns the number of jobs deleted.
"""
type Mutation {
}
removeShippingMethodsFromChannel
"""
Removes ShippingMethods from the specified Channel
"""
type Mutation {
removeShippingMethodsFromChannel(input: RemoveShippingMethodsFromChannelInput!): [ShippingMethod!]!
}
removeStockLocationsFromChannel
"""
Removes StockLocations from the specified Channel
"""
type Mutation {
removeStockLocationsFromChannel(input: RemoveStockLocationsFromChannelInput!): [StockLocation!]!
}
runPendingSearchIndexUpdates
setCustomerForDraftOrder
type Mutation {
setCustomerForDraftOrder(orderId: ID!, customerId: ID, input: CreateCustomerInput): SetCustomerForDraftOrderResult!
}
setDraftOrderBillingAddress
"""
Sets the billing address for a draft Order
"""
type Mutation {
}
setDraftOrderCustomFields
"""
Allows any custom fields to be set for the active order
"""
type Mutation {
}
setDraftOrderShippingAddress
"""
Sets the shipping address for a draft Order
"""
type Mutation {
}
setDraftOrderShippingMethod
"""
Sets the shipping method by id, which can be obtained with the
eligibleShippingMethodsForDraftOrder
query"""
type Mutation {
}
setOrderCustomFields
setOrderCustomer
"""
Allows a different Customer to be assigned to an Order. Added in v2.2.0.
"""
type Mutation {
setOrderCustomer(input: SetOrderCustomerInput!): Order
}
settlePayment
settleRefund
transitionFulfillmentToState
type Mutation {
}
transitionOrderToState
transitionPaymentToState
updateActiveAdministrator
"""
Update the active (currently logged-in) Administrator
"""
type Mutation {
updateActiveAdministrator(input: UpdateActiveAdministratorInput!): Administrator!
}
updateAdministrator
"""
Update an existing Administrator
"""
type Mutation {
updateAdministrator(input: UpdateAdministratorInput!): Administrator!
}
updateAsset
updateChannel
"""
Update an existing Channel
"""
type Mutation {
updateChannel(input: UpdateChannelInput!): UpdateChannelResult!
}
updateCollection
"""
Update an existing Collection
"""
type Mutation {
updateCollection(input: UpdateCollectionInput!): Collection!
}
updateCountry
updateCustomer
"""
Update an existing Customer
"""
type Mutation {
updateCustomer(input: UpdateCustomerInput!): UpdateCustomerResult!
}
updateCustomerAddress
"""
Update an existing Address
"""
type Mutation {
updateCustomerAddress(input: UpdateAddressInput!): Address!
}
updateCustomerGroup
"""
Update an existing CustomerGroup
"""
type Mutation {
updateCustomerGroup(input: UpdateCustomerGroupInput!): CustomerGroup!
}
updateCustomerNote
updateFacet
updateFacetValues
"""
Update one or more FacetValues
"""
type Mutation {
updateFacetValues(input: [UpdateFacetValueInput!]!): [FacetValue!]!
}
updateGlobalSettings
type Mutation {
updateGlobalSettings(input: UpdateGlobalSettingsInput!): UpdateGlobalSettingsResult!
}
updateOrderNote
updatePaymentMethod
"""
Update an existing PaymentMethod
"""
type Mutation {
updatePaymentMethod(input: UpdatePaymentMethodInput!): PaymentMethod!
}
updateProduct
updateProductOption
"""
Create a new ProductOption within a ProductOptionGroup
"""
type Mutation {
updateProductOption(input: UpdateProductOptionInput!): ProductOption!
}
updateProductOptionGroup
"""
Update an existing ProductOptionGroup
"""
type Mutation {
updateProductOptionGroup(input: UpdateProductOptionGroupInput!): ProductOptionGroup!
}
updateProductVariants
"""
Update existing ProductVariants
"""
type Mutation {
updateProductVariants(input: [UpdateProductVariantInput!]!): [ProductVariant]!
}
updateProducts
"""
Update multiple existing Products
"""
type Mutation {
updateProducts(input: [UpdateProductInput!]!): [Product!]!
}
updatePromotion
updateProvince
"""
Update an existing Province
"""
type Mutation {
updateProvince(input: UpdateProvinceInput!): Province!
}
updateRole
updateSeller
updateShippingMethod
"""
Update an existing ShippingMethod
"""
type Mutation {
updateShippingMethod(input: UpdateShippingMethodInput!): ShippingMethod!
}
updateStockLocation
updateTag
updateTaxCategory
"""
Update an existing TaxCategory
"""
type Mutation {
updateTaxCategory(input: UpdateTaxCategoryInput!): TaxCategory!
}