📄️ addCompanyManager
This mutation is deprecated and will be removed in a future version
📄️ addSurchargesToProduct
Associate surcharges with a specific product.
📄️ adminUserCreate
Create a new administrative user with specified profile information and system access.
📄️ adminUserDelete
Permanently delete an administrative user from the system.
📄️ adminUserTenantCreate
Create a new tenant in the multi-tenancy system.
📄️ adminUserTenantDelete
Permanently delete a tenant from the multi-tenancy system.
📄️ adminUserUpdate
Update profile information for an existing administrative user.
📄️ attributeCreate
Create a new attribute with typed values and complete configuration.
📄️ attributeCsvImport
Import attributes from CSV file for efficient bulk operations and data migration.
📄️ attributeDelete
Permanently delete an attribute and all associated data from the system.
📄️ attributeDescriptionCreate
Create a new attribute description in the system.
📄️ attributeDescriptionCsvImport
Import attribute descriptions from CSV file for bulk operations.
📄️ attributeDescriptionDelete
Permanently delete an attribute description from the system.
📄️ attributeDescriptionUpdate
Update an existing attribute description's configuration.
📄️ attributeUpdate
Update an existing attribute's values and configuration.
📄️ authenticationCreate
Create a new user account and establish authentication session.
📄️ authenticationDelete
Permanently delete a user account from the system.
📄️ bulkCostPriceCreate
Create a new bulk cost price record for quantity-based cost pricing.
📄️ bulkCostPriceCsvImport
Import bulk cost price data from CSV file format.
📄️ bulkCostPriceDelete
Permanently delete a bulk cost price record from the system.
📄️ bulkCostPriceUpdate
Update an existing bulk cost price record.
📄️ bulkCostPricesBulk
Create multiple bulk cost price records in a single operation.
📄️ bulkCostPricesDelete
Delete all bulk cost price records associated with a specific price.
📄️ bulkPriceCreate
Create a new bulk price record for quantity-based pricing.
📄️ bulkPriceCsvImport
Import bulk price data from CSV file format.
📄️ bulkPriceDelete
Permanently delete a bulk price record from the system.
📄️ bulkPriceUpdate
Update an existing bulk price record.
📄️ bulkPricesCreate
Create multiple bulk price records in a single operation.
📄️ bulkPricesDelete
Delete all bulk price records associated with a specific price.
📄️ bundleAddItemsAndReturnBundle
Add products to an existing bundle and return the updated bundle.
📄️ bundleAddItems
Use bundleAddItemsAndReturnBundle instead
📄️ bundleCreate
Create a new product bundle in the system.
📄️ bundleDelete
Permanently delete a bundle from the system.
📄️ bundleRemoveItemAndReturnBundle
Remove a product from an existing bundle and return the updated bundle.
📄️ bundleRemoveItem
Use bundleRemoveItemAndReturnBundle instead
📄️ bundleUpdate
Update an existing bundle's configuration.
📄️ businessRuleCreate
Create a new business rule with specified configuration and logic.
📄️ businessRuleDecisionTableAddColumn
Add a new column to a decision table in a business rule.
📄️ businessRuleDecisionTableAddRow
Add a new row to a decision table in a business rule.
📄️ businessRuleDecisionTableDeleteColumn
Delete a column from a decision table in a business rule.
📄️ businessRuleDecisionTableDeleteRow
Delete a row from a decision table in a business rule.
📄️ businessRuleDecisionTableMoveRow
Move a row to a different position within a decision table.
📄️ businessRuleDecisionTableSetCell
Set the value of a specific cell in a decision table row.
📄️ businessRuleDecisionTableUpdate
Update the basic configuration and metadata of a decision table.
📄️ businessRuleDelete
Permanently delete a business rule and all its associated data from the system.
📄️ businessRuleUpdate
Update an existing business rule's basic configuration and metadata.
📄️ carrierAssignWarehouseAndReturnCarrier
Assign a warehouse to a carrier and return the updated carrier.
📄️ carrierAssignWarehouse
Use carrierAssignWarehouseAndReturnCarrier instead.
📄️ carrierCreate
Create a new shipping carrier in the system.
📄️ carrierDelete
Permanently delete a carrier from the system.
📄️ carrierUnassignWarehouseAndReturnCarrier
Remove warehouse assignment from a carrier and return the updated carrier.
📄️ carrierUnassignWarehouse
Use carrierUnassignWarehouseAndReturnCarrier instead.
📄️ carrierUpdate
Update an existing carrier's configuration.
📄️ cartAcceptPurchaseAuthorizationRequest
Accept cart purchase authorization request. Use it to accept ownership of a cart that requires purchase authorization and finalize it.
📄️ cartAddActionCode
Apply a promotional action code to the cart.
📄️ cartAddBundle
Add a product bundle to the shopping cart.
📄️ cartAddItem
Add a product item to the shopping cart.
📄️ cartDeleteItem
Remove an item from the shopping cart.
📄️ cartDelete
Permanently delete a shopping cart.
📄️ cartInvalidateCache
Invalidate cache for a specific cart or all carts if no id is provided.
📄️ cartItemBulk
Perform bulk operations on multiple cart items.
📄️ cartProcess
Process cart and convert it to an order.
📄️ cartRemoveActionCode
Remove a promotional action code from the cart.
📄️ cartRequestPurchaseAuthorization
Request cart purchase authorization. Use it to finalize a cart that cannot be processed because purchase authorization (by an authorization manager) is required. The cart status will be changed to PENDINGPURCHASEAUTHORIZATION.
📄️ cartSetContact
Associate a contact with an existing cart.
📄️ cartSetCustomer
Associate a customer with an existing cart.
📄️ cartSetUser
Will be removed in the future, please use cartSetContact or cartSetCustomer mutations instead.
📄️ cartStart
Create a new shopping cart session.
📄️ cartUpdateAddress
Update cart delivery and billing addresses.
📄️ cartUpdateItem
Update an existing item in the shopping cart.
📄️ cartUpdate
Update an existing cart's information and settings.
📄️ categoryAddProductsClusters
Add products and clusters to a category.
📄️ categoryCreate
Create a new product category.
📄️ categoryCsvImport
Import categories from CSV file.
📄️ categoryDelete
Delete a category by its identifier.
📄️ categoryRemoveProductsClusters
Remove products and clusters from a category.
📄️ categoryUpdate
Update an existing product category.
📄️ channelInvalidateCache
No description
📄️ claimsResetAll
Reset authorization claims for all users in the current environment.
📄️ claimsReset
Reset and refresh user authorization claims.
📄️ clusterAssignProducts
AUTH: Role=[product.OWNER] Assigns existing products to a cluster.
📄️ clusterConfigAddSetting
Add a new setting to a cluster configuration template.
📄️ clusterConfigCreate
Create a new cluster configuration template.
📄️ clusterConfigDelete
Permanently delete a cluster configuration template.
📄️ clusterConfigRemoveSetting
Remove a setting from a cluster configuration template.
📄️ clusterConfigUpdateSetting
Update an existing setting in a cluster configuration template.
📄️ clusterCreate
AUTH: Role=[product.OWNER]
📄️ clusterCsvImport
AUTH: Role=[product.OWNER]
📄️ clusterDelete
AUTH: Role=[product.OWNER]
📄️ clusterOptionCreate
Create a new configuration option for a product cluster.
📄️ clusterOptionDelete
Permanently delete a cluster option.
📄️ clusterOptionUpdate
Update an existing cluster option's configuration.
📄️ clusterProductCreate
AUTH: Role=[product.OWNER]
📄️ clusterProductDelete
AUTH: Role=[product.OWNER]
📄️ clusterProductUpdate
AUTH: Role=[product.OWNER,product.EDITOR]
📄️ clusterUnassignProducts
AUTH: Role=[product.OWNER] Unassigns specified products from a cluster, moving them to either a specified category or another cluster.
📄️ clusterUpdate
AUTH: Role=[product.OWNER,product.EDITOR]
📄️ companyAddressCreate
Create a new address for a company.
📄️ companyAddressDelete
Delete a company address permanently from the system.
📄️ companyAddressUpdate
Update an existing company address with new information.
📄️ companyCreate
Create a new company in the system.
📄️ companyCsvImport
Import companies from a CSV file.
📄️ companyDelete
Permanently delete a company from the system.
📄️ companySearchCleanupOrphanedIndices
Clean up orphaned search indices from failed operations.
📄️ companySearchFixAliasWriteIndex
Fix Elasticsearch alias write index configuration issues.
📄️ companySearchIndexUpdateMapping
Update Elasticsearch index mapping configuration.
📄️ companySearchReindex
Reindex company data to a new search index.
📄️ companyUpdate
Update an existing company's information.
📄️ contactAddToCompanies
AUTH: Role=[user.OWNER,user.EDITOR] OR (('user is authenticated') AND ('contactId if present in input matches JWT'))
📄️ contactCreateAccount
AUTH: Role=[user.OWNER]
📄️ contactCreate
Create a new contact without authentication capabilities.
📄️ contactCsvImport
AUTH: Role=[user.OWNER]
📄️ contactDeleteAccount
AUTH: Role=[user.OWNER]
📄️ contactDelete
AUTH: Role=[user.OWNER]
📄️ contactRegister
Creates a new contact and a new login account for this contact. AUTH: Role=[user.OWNER]
📄️ contactRemoveFromCompanies
AUTH: Role=[user.OWNER,user.EDITOR] OR (('user is authenticated') AND ('contactId if present in input matches JWT'))
📄️ contactUpdate
AUTH: Role=[user.OWNER,user.EDITOR] OR (('user is authenticated') AND ('contactId if present in input matches JWT'))
📄️ costPriceCreate
Create a new cost price record in the system.
📄️ costPriceDelete
Permanently delete a cost price record from the system.
📄️ costPriceUpdate
Update an existing cost price record.
📄️ costPricesBulk
Create multiple cost price records in a single operation.
📄️ costPricesDelete
Delete all cost price records associated with a specific price.
📄️ crossupsellCreate
Create a cross-sell/upsell recommendation.
📄️ crossupsellDelete
Permanently delete a cross-sell/upsell recommendation.
📄️ crossupsellUpdate
Update a cross-sell/upsell recommendation.
📄️ customerAddressCreate
Create a new address for a customer account.
📄️ customerAddressDelete
Delete a customer address permanently from the system.
📄️ customerAddressUpdate
Update an existing customer address with new information.
📄️ customerCreateAccount
AUTH: Role=[user.OWNER]
📄️ customerCreate
Create a new customer profile without authentication capabilities.
📄️ customerCsvImport
AUTH: Role=[user.OWNER]
📄️ customerDeleteAccount
AUTH: Role=[user.OWNER]
📄️ customerDelete
AUTH: Role=[user.OWNER]
📄️ customerRegister
Create a new customer profile with authentication capabilities.
📄️ customerUpdate
AUTH: Role=[user.OWNER,user.EDITOR] OR (('user is authenticated') AND ('customerId if present in input matches JWT'))
📄️ discountCreate
Create a new discount record with percentage-based pricing reductions.
📄️ discountCsvImport
Import discount records from a CSV file with comprehensive validation and mapping.
📄️ discountDelete
Permanently remove a specific discount record from the system.
📄️ discountUpdate
Update an existing discount record with new values and settings.
📄️ discountsDeleteByPricesheetId
Remove all discount records associated with a specific pricesheet.
📄️ documentTemplateCreate
Create a new document template for PDF generation.
📄️ documentTemplateRenderToPDF
Generate PDF document from template with provided data.
📄️ documentTemplateUpdate
Update an existing document template's configuration.
📄️ emailTemplateAddAttachment
Add a document attachment to an email template.
📄️ emailTemplateCreate
Create a new email template for messaging campaigns.
📄️ emailTemplateRemoveAttachment
Remove a document attachment from an email template.
📄️ emailTemplateRenderAndSend
Render email template with data and send immediately.
📄️ emailTemplateUpdate
Update an existing email template's configuration.
📄️ eventActionConfigDelete
Permanently delete an event action configuration from the automation system.
📄️ eventToEmailConfigCreate
Create a new email event action configuration.
📄️ eventToEmailConfigUpdate
Update an existing email event action configuration.
📄️ eventToWebHookConfigCreate
Create a new webhook event action configuration.
📄️ eventToWebHookConfigUpdate
Update an existing webhook event action configuration.
📄️ exchangeRefreshToken
Exchange a refresh token for new access tokens.
📄️ externalAddressCreate
External addresses are deprecated and will be removed in a future version.
📄️ externalAddressDelete
External addresses are deprecated and will be removed in a future version.
📄️ externalAddressUpdate
External addresses are deprecated and will be removed in a future version.
📄️ favoriteListAddItems
Add products and clusters to a favorite list.
📄️ favoriteListClearItems
Clear all or specific types of items from a favorite list.
📄️ favoriteListCreate
Create a new favorite list for a customer or contact.
📄️ favoriteListDelete
Permanently delete a favorite list from the system.
📄️ favoriteListRemoveItems
Remove products and clusters from a favorite list.
📄️ favoriteListUpdate
Update an existing favorite list's configuration.
📄️ incentiveRuleCreate
Create a specialized business rule configured for incentive and discount management.
📄️ incentiveRuleSetAction
Configure the incentive action and discount settings for an incentive rule.
📄️ incentiveRuleSetOrderItemConditions
Configure order item conditions for an incentive rule using complex expressions.
📄️ inventoryCreate
Create a new inventory record in the system.
📄️ inventoryCsvImport
Import inventory records from a CSV file.
📄️ inventoryDelete
Permanently delete an inventory record from the system.
📄️ inventoryUpdate
Update an existing inventory record's information.
📄️ login
Authenticate user and establish secure session.
📄️ logout
signOut mutation will be available in the future
📄️ machineCreate
Create a new spare parts machine.
📄️ machineDelete
Delete a spare parts machine and all its child machines.
📄️ machineUpsert
Create or update a spare parts machine.
📄️ magicTokenCreate
Create a new magic token for passwordless authentication.
📄️ magicTokenDelete
Permanently delete a magic token.
📄️ magicTokenLogin
Authenticate using a magic token and create a user session.
📄️ magicTokenUpdate
Update an existing magic token's properties.
📄️ mediaAttachmentCreate
AUTH: Role=[order.OWNER,product.OWNER] OR (('user is authenticated') AND ('customerId or companyId if present in input matches JWT'))
📄️ mediaAttachmentDelete
AUTH: Role=[order.OWNER,product.OWNER]
📄️ mediaAttachmentUpdate
AUTH: Role=[order.OWNER,order.EDITOR,product.OWNER,product.EDITOR]
📄️ mediaDocumentCreate
AUTH: Role=[product.OWNER]
📄️ mediaDocumentCsvImport
AUTH: Role=[product.OWNER]
📄️ mediaDocumentDelete
AUTH: Role=[product.OWNER]
📄️ mediaDocumentUpdate
AUTH: Role=[product.OWNER,product.EDITOR]
📄️ mediaImageCreate
AUTH: Role=[product.OWNER]
📄️ mediaImageCsvImport
AUTH: Role=[product.OWNER]
📄️ mediaImageDelete
AUTH: Role=[product.OWNER]
📄️ mediaImageUpdate
AUTH: Role=[product.OWNER,product.EDITOR]
📄️ mediaVideoCreate
AUTH: Role=[product.OWNER]
📄️ mediaVideoCsvImport
AUTH: Role=[product.OWNER]
📄️ mediaVideoDelete
AUTH: Role=[product.OWNER]
📄️ mediaVideoUpdate
AUTH: Role=[product.OWNER,product.EDITOR]
📄️ orderAddressUpdate
Update an existing order address with new information.
📄️ orderCreate
Create a new order with comprehensive order data and associated entities.
📄️ orderDelete
Permanently delete an order from the system.
📄️ orderItemCreate
Add a new item to an existing order.
📄️ orderItemDelete
Remove an order item from an order.
📄️ orderItemUpdate
Update an existing order item's information.
📄️ orderRevisionRestore
Restore an order to a specific revision state.
📄️ orderRevisionsInvalidate
Invalidate multiple order revisions based on specified criteria.
📄️ orderSendConfirmationEmail
Deprecated in favor of using triggerOrderSendConfirm
📄️ orderSetStatus
Set the status of an order.
📄️ orderStatusCreate
Create a new order status in the workflow system.
📄️ orderStatusDelete
Permanently delete an order status from the workflow system.
📄️ orderStatusSetAddOrderStatuses
Add order statuses to an existing order status set.
📄️ orderStatusSetCreate
Create a new order status set for workflow organization.
📄️ orderStatusSetDelete
Permanently delete an order status set from the workflow system.
📄️ orderStatusSetRemoveOrderStatuses
Remove order statuses from an existing order status set.
📄️ orderStatusSetUpdate
Update an existing order status set configuration.
📄️ orderStatusUpdate
Update an existing order status configuration.
📄️ orderUpdateAddress
Use orderAddressUpdate
📄️ orderUpdate
Update an existing order's information.
📄️ orderlistAddItems
Add products and clusters to an order list.
📄️ orderlistAssignCompanies
AUTH: Role=[shop.OWNER,shop.EDITOR]
📄️ orderlistAssignUsers
AUTH: Role=[shop.OWNER,shop.EDITOR]
📄️ orderlistCreate
Create a new order list for bulk ordering operations with comprehensive configuration.
📄️ orderlistDelete
Permanently delete an order list and all its associations from the system.
📄️ orderlistRemoveItems
Remove products and clusters from an order list.
📄️ orderlistUnassignCompanies
AUTH: Role=[shop.OWNER,shop.EDITOR]
📄️ orderlistUnassignUsers
AUTH: Role=[shop.OWNER,shop.EDITOR]
📄️ orderlistUpdate
Update an existing order list's configuration.
📄️ passwordResetLink
Generate a secure password recovery link for email inclusion.
📄️ payMethodCreate
Create a new payment method in the system.
📄️ payMethodDelete
Permanently delete a payment method from the system.
📄️ payMethodUpdate
Update an existing payment method's configuration.
📄️ paymentCreate
Create a new payment record in the system.
📄️ paymentDelete
Permanently delete a payment from the system.
📄️ paymentUpdate
Update an existing payment's information.
📄️ priceCreate
Create a new price record in the system.
📄️ priceCsvImport
Import price records from a CSV file.
📄️ priceDelete
Permanently delete a price record from the system.
📄️ priceUpdate
Update an existing price record's information.
📄️ pricesheetAssign
AUTH: Role=[pricing.OWNER,pricing.EDITOR]
📄️ pricesheetCreate
Create a new pricesheet in the system.
📄️ pricesheetCsvImport
AUTH: Role=[pricing.OWNER]
📄️ pricesheetDelete
AUTH: Role=[pricing.OWNER]
📄️ pricesheetUnassign
AUTH: Role=[pricing.OWNER,pricing.EDITOR]
📄️ pricesheetUpdate
AUTH: Role=[pricing.OWNER,pricing.EDITOR]
📄️ productCreate
Create a new product in the catalog.
📄️ productCsvImport
Import products from a CSV file.
📄️ productDelete
Permanently delete a product from the catalog.
📄️ productUpdate
Update an existing product's information.
📄️ publishEmailEvent
Trigger email processing through event-driven architecture.
📄️ publishEmailSendEvent
Send pre-processed email directly through messaging system.
📄️ publishPasswordResetEmailEvent
Deprecated in favor of using the triggerPasswordSendResetEmailEvent that utilizes the event-action-manager and template-engine
📄️ purchaseAuthorizationConfigCreate
Create a new purchase authorization configuration for a contact.
📄️ purchaseAuthorizationConfigDelete
Remove a purchase authorization configuration.
📄️ purchaseAuthorizationConfigUpdate
Update an existing purchase authorization configuration.
📄️ removeCompanyManager
This mutation is deprecated and will be removed in a future version
📄️ removeSurchargesFromProduct
Remove surcharge associations from a specific product.
📄️ roleCreate
Create a new role in the authorization system.
📄️ roleDefinitionCreate
Create a new role definition in the authorization system.
📄️ roleDefinitionDelete
Permanently delete a role definition from the authorization system.
📄️ roleDefinitionUpdate
Update an existing role definition's configuration.
📄️ roleDelete
Permanently delete a role from the authorization system.
📄️ roleUpdate
Update an existing role's configuration.
📄️ shipmentCreate
Create a new shipment for order fulfillment with items and tracking information.
📄️ shipmentDelete
Delete a shipment and all associated data permanently.
📄️ shipmentItemCreate
AUTH: Role=[order.OWNER,order.EDITOR]
📄️ shipmentItemDelete
AUTH: Role=[order.OWNER,order.EDITOR]
📄️ shipmentItemUpdate
AUTH: Role=[order.OWNER,order.EDITOR]
📄️ shipmentUpdate
Update an existing shipment with new information and status changes.
📄️ shopInvalidateCache
This mutation will be removed in a future version
📄️ startSession
Initialize an anonymous authentication session.
📄️ surchargeCreate
Create a new surcharge in the pricing system.
📄️ surchargeDelete
Permanently delete a surcharge from the pricing system.
📄️ surchargeUpdate
Update an existing surcharge's configuration.
📄️ taxCreate
Create a new tax configuration in the system.
📄️ taxDelete
Permanently delete a tax configuration from the system.
📄️ taxUpdate
Update an existing tax configuration.
📄️ templateDelete
Permanently delete a message template from the system.
📄️ templateRenderToHTML
Preview template output as HTML with provided data.
📄️ tenderAddItems
Add new items to an existing tender.
📄️ tenderApplyIncentives
Apply available incentives to an existing tender.
📄️ tenderDeleteBonusItem
Remove a bonus item from an existing tender.
📄️ tenderDeleteItem
Remove an item from an existing tender.
📄️ tenderDelete
Permanently delete an existing tender from the system.
📄️ tenderProcess
Process a tender to convert it into a confirmed order.
📄️ tenderStart
Create a new tender in the system.
📄️ tenderUpdateAddress
Update address information for an existing tender.
📄️ tenderUpdateDiscount
Update discount information for an existing tender.
📄️ tenderUpdateInvoiceUser
Update the invoice user for an existing tender.
📄️ tenderUpdateItem
Update an existing item in a tender.
📄️ tenderUpdatePayment
Update payment information for an existing tender.
📄️ tenderUpdatePostage
Update shipping and postage information for an existing tender.
📄️ tenderUpdate
Update general information for an existing tender.
📄️ trackAndTraceCreate
Create new tracking information for a shipment with carrier details and tracking codes.
📄️ trackAndTraceDelete
Delete a tracking record permanently.