Mutations
addCustomersToGroup
Add Customers to a CustomerGroup
- addCustomersToGroup(customerGroupId: ID!, customerIds: [ID!]!): CustomerGroup!
addFulfillmentToOrder
- addFulfillmentToOrder(input: FulfillOrderInput!): AddFulfillmentToOrderResult!
addItemToDraftOrder
Adds an item to the draft Order.
- addItemToDraftOrder(orderId: ID!, input: AddItemToDraftOrderInput!): UpdateOrderItemsResult!
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.
- addManualPaymentToOrder(input: ManualPaymentInput!): AddManualPaymentToOrderResult!
addMembersToZone
Add members to a Zone
addNoteToCustomer
- addNoteToCustomer(input: AddNoteToCustomerInput!): Customer!
addNoteToOrder
- addNoteToOrder(input: AddNoteToOrderInput!): Order!
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.
- adjustDraftOrderLine(orderId: ID!, input: AdjustDraftOrderLineInput!): UpdateOrderItemsResult!
applyCouponCodeToDraftOrder
Applies the given coupon code to the draft Order
- applyCouponCodeToDraftOrder(orderId: ID!, couponCode: String!): ApplyCouponCodeResult!
assignAssetsToChannel
Assign assets to channel
- assignAssetsToChannel(input: AssignAssetsToChannelInput!): [Asset!]!
assignCollectionsToChannel
Assigns Collections to the specified Channel
- assignCollectionsToChannel(input: AssignCollectionsToChannelInput!): [Collection!]!
assignFacetsToChannel
Assigns Facets to the specified Channel
- assignFacetsToChannel(input: AssignFacetsToChannelInput!): [Facet!]!
assignPaymentMethodsToChannel
Assigns PaymentMethods to the specified Channel
- assignPaymentMethodsToChannel(input: AssignPaymentMethodsToChannelInput!): [PaymentMethod!]!
assignProductVariantsToChannel
Assigns ProductVariants to the specified Channel
- assignProductVariantsToChannel(input: AssignProductVariantsToChannelInput!): [ProductVariant!]!
assignProductsToChannel
Assigns all ProductVariants of Product to the specified Channel
- assignProductsToChannel(input: AssignProductsToChannelInput!): [Product!]!
assignPromotionsToChannel
Assigns Promotions to the specified Channel
- assignPromotionsToChannel(input: AssignPromotionsToChannelInput!): [Promotion!]!
assignRoleToAdministrator
Assign a Role to an Administrator
- assignRoleToAdministrator(administratorId: ID!, roleId: ID!): Administrator!
assignShippingMethodsToChannel
Assigns ShippingMethods to the specified Channel
- assignShippingMethodsToChannel(input: AssignShippingMethodsToChannelInput!): [ShippingMethod!]!
assignStockLocationsToChannel
Assigns StockLocations to the specified Channel
- assignStockLocationsToChannel(input: AssignStockLocationsToChannelInput!): [StockLocation!]!
authenticate
Authenticates the user using a named authentication strategy
- authenticate(input: AuthenticationInput!, rememberMe: Boolean): AuthenticationResult!
cancelJob
cancelOrder
- cancelOrder(input: CancelOrderInput!): CancelOrderResult!
cancelPayment
- cancelPayment(id: ID!): CancelPaymentResult!
createAdministrator
Create a new Administrator
- createAdministrator(input: CreateAdministratorInput!): Administrator!
createAssets
Create a new Asset
- createAssets(input: [CreateAssetInput!]!): [CreateAssetResult!]!
createChannel
Create a new Channel
- createChannel(input: CreateChannelInput!): CreateChannelResult!
createCollection
Create a new Collection
- createCollection(input: CreateCollectionInput!): Collection!
createCountry
Create a new Country
- createCountry(input: CreateCountryInput!): Country!
createCustomer
Create a new Customer. If a password is provided, a new User will also be created an linked to the Customer.
- createCustomer(input: CreateCustomerInput!, password: String): CreateCustomerResult!
createCustomerAddress
Create a new Address and associate it with the Customer specified by customerId
- createCustomerAddress(customerId: ID!, input: CreateAddressInput!): Address!
createCustomerGroup
Create a new CustomerGroup
- createCustomerGroup(input: CreateCustomerGroupInput!): CustomerGroup!
createDraftOrder
Creates a draft Order
- createDraftOrder: Order!
createFacet
Create a new Facet
- createFacet(input: CreateFacetInput!): Facet!
createFacetValues
Create one or more FacetValues
- createFacetValues(input: [CreateFacetValueInput!]!): [FacetValue!]!
createPaymentMethod
Create existing PaymentMethod
- createPaymentMethod(input: CreatePaymentMethodInput!): PaymentMethod!
createProduct
Create a new Product
- createProduct(input: CreateProductInput!): Product!
createProductOption
Create a new ProductOption within a ProductOptionGroup
- createProductOption(input: CreateProductOptionInput!): ProductOption!
createProductOptionGroup
Create a new ProductOptionGroup
- createProductOptionGroup(input: CreateProductOptionGroupInput!): ProductOptionGroup!
createProductVariants
Create a set of ProductVariants based on the OptionGroups assigned to the given Product
- createProductVariants(input: [CreateProductVariantInput!]!): [ProductVariant]!
createPromotion
- createPromotion(input: CreatePromotionInput!): CreatePromotionResult!
createProvince
Create a new Province
- createProvince(input: CreateProvinceInput!): Province!
createRole
Create a new Role
- createRole(input: CreateRoleInput!): Role!
createSeller
Create a new Seller
- createSeller(input: CreateSellerInput!): Seller!
createShippingMethod
Create a new ShippingMethod
- createShippingMethod(input: CreateShippingMethodInput!): ShippingMethod!
createStockLocation
- createStockLocation(input: CreateStockLocationInput!): StockLocation!
createTag
Create a new Tag
- createTag(input: CreateTagInput!): Tag!
createTaxCategory
Create a new TaxCategory
- createTaxCategory(input: CreateTaxCategoryInput!): TaxCategory!
createTaxRate
Create a new TaxRate
- createTaxRate(input: CreateTaxRateInput!): TaxRate!
createZone
Create a new Zone
- createZone(input: CreateZoneInput!): Zone!
deleteAdministrator
Delete an Administrator
- deleteAdministrator(id: ID!): DeletionResponse!
deleteAdministrators
Delete multiple Administrators
- deleteAdministrators(ids: [ID!]!): [DeletionResponse!]!
deleteAsset
Delete an Asset
- deleteAsset(input: DeleteAssetInput!): DeletionResponse!
deleteAssets
Delete multiple Assets
- deleteAssets(input: DeleteAssetsInput!): DeletionResponse!
deleteChannel
Delete a Channel
- deleteChannel(id: ID!): DeletionResponse!
deleteChannels
Delete multiple Channels
- deleteChannels(ids: [ID!]!): [DeletionResponse!]!
deleteCollection
Delete a Collection and all of its descendants
- deleteCollection(id: ID!): DeletionResponse!
deleteCollections
Delete multiple Collections and all of their descendants
- deleteCollections(ids: [ID!]!): [DeletionResponse!]!
deleteCountries
Delete multiple Countries
- deleteCountries(ids: [ID!]!): [DeletionResponse!]!
deleteCountry
Delete a Country
- deleteCountry(id: ID!): DeletionResponse!
deleteCustomer
Delete a Customer
- deleteCustomer(id: ID!): DeletionResponse!
deleteCustomerAddress
Update an existing Address
deleteCustomerGroup
Delete a CustomerGroup
- deleteCustomerGroup(id: ID!): DeletionResponse!
deleteCustomerGroups
Delete multiple CustomerGroups
- deleteCustomerGroups(ids: [ID!]!): [DeletionResponse!]!
deleteCustomerNote
- deleteCustomerNote(id: ID!): DeletionResponse!
deleteCustomers
Deletes Customers
- deleteCustomers(ids: [ID!]!): [DeletionResponse!]!
deleteDraftOrder
Deletes a draft Order
- deleteDraftOrder(orderId: ID!): DeletionResponse!
deleteFacet
Delete an existing Facet
- deleteFacet(id: ID!, force: Boolean): DeletionResponse!
deleteFacetValues
Delete one or more FacetValues
- deleteFacetValues(ids: [ID!]!, force: Boolean): [DeletionResponse!]!
deleteFacets
Delete multiple existing Facets
- deleteFacets(ids: [ID!]!, force: Boolean): [DeletionResponse!]!
deleteOrderNote
- deleteOrderNote(id: ID!): DeletionResponse!
deletePaymentMethod
Delete a PaymentMethod
- deletePaymentMethod(id: ID!, force: Boolean): DeletionResponse!
deletePaymentMethods
Delete multiple PaymentMethods
- deletePaymentMethods(ids: [ID!]!, force: Boolean): [DeletionResponse!]!
deleteProduct
Delete a Product
- deleteProduct(id: ID!): DeletionResponse!
deleteProductOption
Delete a ProductOption
- deleteProductOption(id: ID!): DeletionResponse!
deleteProductVariant
Delete a ProductVariant
- deleteProductVariant(id: ID!): DeletionResponse!
deleteProductVariants
Delete multiple ProductVariants
- deleteProductVariants(ids: [ID!]!): [DeletionResponse!]!
deleteProducts
Delete multiple Products
- deleteProducts(ids: [ID!]!): [DeletionResponse!]!
deletePromotion
- deletePromotion(id: ID!): DeletionResponse!
deletePromotions
- deletePromotions(ids: [ID!]!): [DeletionResponse!]!
deleteProvince
Delete a Province
- deleteProvince(id: ID!): DeletionResponse!
deleteRole
Delete an existing Role
- deleteRole(id: ID!): DeletionResponse!
deleteRoles
Delete multiple Roles
- deleteRoles(ids: [ID!]!): [DeletionResponse!]!
deleteSeller
Delete a Seller
- deleteSeller(id: ID!): DeletionResponse!
deleteSellers
Delete multiple Sellers
- deleteSellers(ids: [ID!]!): [DeletionResponse!]!
deleteShippingMethod
Delete a ShippingMethod
- deleteShippingMethod(id: ID!): DeletionResponse!
deleteShippingMethods
Delete multiple ShippingMethods
- deleteShippingMethods(ids: [ID!]!): [DeletionResponse!]!
deleteStockLocation
- deleteStockLocation(input: DeleteStockLocationInput!): DeletionResponse!
deleteStockLocations
- deleteStockLocations(input: [DeleteStockLocationInput!]!): [DeletionResponse!]!
deleteTag
Delete an existing Tag
- deleteTag(id: ID!): DeletionResponse!
deleteTaxCategories
Deletes multiple TaxCategories
- deleteTaxCategories(ids: [ID!]!): [DeletionResponse!]!
deleteTaxCategory
Deletes a TaxCategory
- deleteTaxCategory(id: ID!): DeletionResponse!
deleteTaxRate
Delete a TaxRate
- deleteTaxRate(id: ID!): DeletionResponse!
deleteTaxRates
Delete multiple TaxRates
- deleteTaxRates(ids: [ID!]!): [DeletionResponse!]!
deleteZone
Delete a Zone
- deleteZone(id: ID!): DeletionResponse!
deleteZones
Delete a Zone
- deleteZones(ids: [ID!]!): [DeletionResponse!]!
flushBufferedJobs
importProducts
- importProducts(csvFile: Upload!): ImportInfo
login
Authenticates the user using the native authentication strategy. This mutation is an alias for authenticate({ native: { ... }})
- login(username: String!, password: String!, rememberMe: Boolean): NativeAuthenticationResult!
logout
- logout: Success!
modifyOrder
Allows an Order to be modified after it has been completed by the Customer. The Order must first
be in the Modifying
state.
- modifyOrder(input: ModifyOrderInput!): ModifyOrderResult!
moveCollection
Move a Collection to a different parent or index
- moveCollection(input: MoveCollectionInput!): Collection!
refundOrder
- refundOrder(input: RefundOrderInput!): RefundOrderResult!
reindex
- reindex: Job!
removeCollectionsFromChannel
Removes Collections from the specified Channel
- removeCollectionsFromChannel(input: RemoveCollectionsFromChannelInput!): [Collection!]!
removeCouponCodeFromDraftOrder
Removes the given coupon code from the draft Order
removeCustomersFromGroup
Remove Customers from a CustomerGroup
- removeCustomersFromGroup(customerGroupId: ID!, customerIds: [ID!]!): CustomerGroup!
removeDraftOrderLine
Remove an OrderLine from the draft Order
- removeDraftOrderLine(orderId: ID!, orderLineId: ID!): RemoveOrderItemsResult!
removeFacetsFromChannel
Removes Facets from the specified Channel
- removeFacetsFromChannel(input: RemoveFacetsFromChannelInput!): [RemoveFacetFromChannelResult!]!
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.
- removeOptionGroupFromProduct(productId: ID!, optionGroupId: ID!, force: Boolean): RemoveOptionGroupFromProductResult!
removePaymentMethodsFromChannel
Removes PaymentMethods from the specified Channel
- removePaymentMethodsFromChannel(input: RemovePaymentMethodsFromChannelInput!): [PaymentMethod!]!
removeProductVariantsFromChannel
Removes ProductVariants from the specified Channel
- removeProductVariantsFromChannel(input: RemoveProductVariantsFromChannelInput!): [ProductVariant!]!
removeProductsFromChannel
Removes all ProductVariants of Product from the specified Channel
- removeProductsFromChannel(input: RemoveProductsFromChannelInput!): [Product!]!
removePromotionsFromChannel
Removes Promotions from the specified Channel
- removePromotionsFromChannel(input: RemovePromotionsFromChannelInput!): [Promotion!]!
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
- removeShippingMethodsFromChannel(input: RemoveShippingMethodsFromChannelInput!): [ShippingMethod!]!
removeStockLocationsFromChannel
Removes StockLocations from the specified Channel
- removeStockLocationsFromChannel(input: RemoveStockLocationsFromChannelInput!): [StockLocation!]!
runPendingSearchIndexUpdates
- runPendingSearchIndexUpdates: Success!
setCustomerForDraftOrder
- setCustomerForDraftOrder(orderId: ID!, customerId: ID, input: CreateCustomerInput): SetCustomerForDraftOrderResult!
setDraftOrderBillingAddress
Sets the billing address for a draft Order
- setDraftOrderBillingAddress(orderId: ID!, input: CreateAddressInput!): Order!
setDraftOrderCustomFields
Allows any custom fields to be set for the active order
- setDraftOrderCustomFields(orderId: ID!, input: UpdateOrderInput!): Order!
setDraftOrderShippingAddress
Sets the shipping address for a draft Order
- setDraftOrderShippingAddress(orderId: ID!, input: CreateAddressInput!): Order!
setDraftOrderShippingMethod
Sets the shipping method by id, which can be obtained with the eligibleShippingMethodsForDraftOrder
query
- setDraftOrderShippingMethod(orderId: ID!, shippingMethodId: ID!): SetOrderShippingMethodResult!
setOrderCustomFields
- setOrderCustomFields(input: UpdateOrderInput!): Order
settlePayment
- settlePayment(id: ID!): SettlePaymentResult!
settleRefund
- settleRefund(input: SettleRefundInput!): SettleRefundResult!
transitionFulfillmentToState
- transitionFulfillmentToState(id: ID!, state: String!): TransitionFulfillmentToStateResult!
transitionOrderToState
- transitionOrderToState(id: ID!, state: String!): TransitionOrderToStateResult
transitionPaymentToState
- transitionPaymentToState(id: ID!, state: String!): TransitionPaymentToStateResult!
updateActiveAdministrator
Update the active (currently logged-in) Administrator
- updateActiveAdministrator(input: UpdateActiveAdministratorInput!): Administrator!
updateAdministrator
Update an existing Administrator
- updateAdministrator(input: UpdateAdministratorInput!): Administrator!
updateAsset
Update an existing Asset
- updateAsset(input: UpdateAssetInput!): Asset!
updateChannel
Update an existing Channel
- updateChannel(input: UpdateChannelInput!): UpdateChannelResult!
updateCollection
Update an existing Collection
- updateCollection(input: UpdateCollectionInput!): Collection!
updateCountry
Update an existing Country
- updateCountry(input: UpdateCountryInput!): Country!
updateCustomer
Update an existing Customer
- updateCustomer(input: UpdateCustomerInput!): UpdateCustomerResult!
updateCustomerAddress
Update an existing Address
- updateCustomerAddress(input: UpdateAddressInput!): Address!
updateCustomerGroup
Update an existing CustomerGroup
- updateCustomerGroup(input: UpdateCustomerGroupInput!): CustomerGroup!
updateCustomerNote
- updateCustomerNote(input: UpdateCustomerNoteInput!): HistoryEntry!
updateFacet
Update an existing Facet
- updateFacet(input: UpdateFacetInput!): Facet!
updateFacetValues
Update one or more FacetValues
- updateFacetValues(input: [UpdateFacetValueInput!]!): [FacetValue!]!
updateGlobalSettings
- updateGlobalSettings(input: UpdateGlobalSettingsInput!): UpdateGlobalSettingsResult!
updateOrderNote
- updateOrderNote(input: UpdateOrderNoteInput!): HistoryEntry!
updatePaymentMethod
Update an existing PaymentMethod
- updatePaymentMethod(input: UpdatePaymentMethodInput!): PaymentMethod!
updateProduct
Update an existing Product
- updateProduct(input: UpdateProductInput!): Product!
updateProductOption
Create a new ProductOption within a ProductOptionGroup
- updateProductOption(input: UpdateProductOptionInput!): ProductOption!
updateProductOptionGroup
Update an existing ProductOptionGroup
- updateProductOptionGroup(input: UpdateProductOptionGroupInput!): ProductOptionGroup!
updateProductVariants
Update existing ProductVariants
- updateProductVariants(input: [UpdateProductVariantInput!]!): [ProductVariant]!
updateProducts
Update multiple existing Products
- updateProducts(input: [UpdateProductInput!]!): [Product!]!
updatePromotion
- updatePromotion(input: UpdatePromotionInput!): UpdatePromotionResult!
updateProvince
Update an existing Province
- updateProvince(input: UpdateProvinceInput!): Province!
updateRole
Update an existing Role
- updateRole(input: UpdateRoleInput!): Role!
updateSeller
Update an existing Seller
- updateSeller(input: UpdateSellerInput!): Seller!
updateShippingMethod
Update an existing ShippingMethod
- updateShippingMethod(input: UpdateShippingMethodInput!): ShippingMethod!
updateStockLocation
- updateStockLocation(input: UpdateStockLocationInput!): StockLocation!
updateTag
Update an existing Tag
- updateTag(input: UpdateTagInput!): Tag!
updateTaxCategory
Update an existing TaxCategory
- updateTaxCategory(input: UpdateTaxCategoryInput!): TaxCategory!
updateTaxRate
Update an existing TaxRate
- updateTaxRate(input: UpdateTaxRateInput!): TaxRate!
updateZone
Update an existing Zone
- updateZone(input: UpdateZoneInput!): Zone!