Propeller Commerce Docs

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

Resets claims for all users within the current tenant in batches of 50. AUTH: Role=[system]

📄️ claimsReset

AUTH: Role=[system] OR ('user is authenticated')

📄️ 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 DocumentTemplateAUTH: Role=[configuration.OWNER]

📄️ documentTemplateRenderToPDF

Render a DocumentTemplate to a PDF file (Base64 string) with the given payloadAUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]

📄️ documentTemplateUpdate

Update a DocumentTemplate by IDAUTH: Role=[configuration.OWNER,configuration.EDITOR]

📄️ emailTemplateAddAttachment

Add an attachment to an EmailTemplate by ID

📄️ emailTemplateCreate

Create a new EmailTemplateAUTH: Role=[configuration.OWNER]

📄️ emailTemplateRemoveAttachment

Remove an attachment from an EmailTemplate by ID

📄️ emailTemplateRenderAndSend

Send out an email based on the provided email template and payloadAUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]

📄️ emailTemplateUpdate

Update an EmailTemplate by IDAUTH: Role=[configuration.OWNER,configuration.EDITOR]

📄️ 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

No description

📄️ 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

AUTH: Role=[configuration.OWNER]

📄️ incentiveRuleSetAction

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

📄️ incentiveRuleSetOrderItemConditions

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

📄️ 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

Logs in the authenticated user and returns a GCIP user session which includes the accessToken and refreshToken.

📄️ 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

AUTH: Role=[system]

📄️ magicTokenDelete

AUTH: Role=[system]

📄️ magicTokenLogin

Authenticates and logs in a contact or customer using a magic token, returning a session object with access and refresh tokens.

📄️ magicTokenUpdate

AUTH: Role=[system]

📄️ 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

AUTH: Role=[order.OWNER]

📄️ orderStatusDelete

AUTH: Role=[order.OWNER]

📄️ orderStatusSetAddOrderStatuses

AUTH: Role=[order.OWNER,order.EDITOR]

📄️ orderStatusSetCreate

AUTH: Role=[order.OWNER]

📄️ orderStatusSetDelete

AUTH: Role=[order.OWNER]

📄️ orderStatusSetRemoveOrderStatuses

AUTH: Role=[order.OWNER]

📄️ orderStatusSetUpdate

AUTH: Role=[order.OWNER,order.EDITOR]

📄️ orderStatusUpdate

AUTH: Role=[order.OWNER,order.EDITOR]

📄️ 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

Generates a password recovery link, that can be included in a password recovery e-mail. AUTH: Role=[user.OWNER]

📄️ 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

AUTH: Role=[order.OWNER]

📄️ paymentDelete

AUTH: Role=[order.OWNER]

📄️ paymentUpdate

AUTH: Role=[order.OWNER,order.EDITOR]

📄️ 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

Publishes an email trigger event to pub/sub, containing the abstract event data. AUTH: Role=[system]

📄️ publishEmailSendEvent

Publishes an email send trigger event to pub/sub containing all (processed) fields needed to send a single email. AUTH: Role=[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

AUTH: Role=[role.OWNER]

📄️ roleDefinitionCreate

No description

📄️ roleDefinitionDelete

No description

📄️ roleDefinitionUpdate

No description

📄️ roleDelete

AUTH: Role=[role.OWNER]

📄️ roleUpdate

AUTH: Role=[role.OWNER,role.EDITOR]

📄️ 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

Starts an anonymous firebase 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

Delete an existing Template by IDAUTH: Role=[configuration.OWNER]

📄️ templateRenderToHTML

Render a Template to HTML string, this mutation can be used to preview your template with a given payloadAUTH: Role=[configuration.OWNER,configuration.EDITOR,configuration.VIEWER]

📄️ 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.

📄️ trackAndTraceUpdate

Update existing tracking information with new status, location, or delivery details.

📄️ triggerContactSendWelcomeEmailEvent

No description

📄️ triggerCustomEvent

Execute custom event actions with dynamic payload data.

📄️ triggerCustomerSendWelcomeEmailEvent

No description

📄️ triggerOrderSendConfirm

Trigger order confirmation email sending event.

📄️ triggerPasswordSendInitEmailEvent

Trigger the event to send out an initialize password email. AUTH: Role=[user.OWNER]

📄️ triggerPasswordSendResetEmailEvent

Trigger the event to send out an reset password email. AUTH: Role=[] OR ('undefined')

📄️ triggerQuoteSendRequest

Trigger quote send request event.

📄️ triggerQuoteSendValidation

Trigger quote send validation event.

📄️ triggerQuoteSend

Trigger quote send event.

📄️ userAddressCreate

Create a new address for a user account.

📄️ userAddressDelete

Delete a user address permanently from the system.

📄️ userAddressUpdate

Update an existing user address with new information.

📄️ usergroupCreate

This mutation is deprecated and will be removed in a future

📄️ usergroupDelete

This mutation is deprecated and will be removed in a future

📄️ usergroupUpdate

This mutation is deprecated and will be removed in a future

📄️ valuesetCreate

AUTH: Role=[configuration.OWNER]

📄️ valuesetDelete

AUTH: Role=[configuration.OWNER]

📄️ valuesetItemCreate

AUTH: Role=[configuration.OWNER]

📄️ valuesetItemDelete

AUTH: Role=[configuration.OWNER]

📄️ valuesetItemUpdate

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

📄️ valuesetUpdate

AUTH: Role=[configuration.OWNER,configuration.EDITOR]

📄️ verifyToken

No description

📄️ warehouseAddressCreate

Create a new address for a warehouse.

📄️ warehouseAddressDelete

Permanently delete a warehouse address.

📄️ warehouseAddressUpdate

Update an existing warehouse address.

📄️ warehouseCreate

Create a new warehouse in the system.

📄️ warehouseDelete

Permanently delete a warehouse from the system.

📄️ warehouseUpdate

Update an existing warehouse's information.

📄️ zoneTaxCodeCreate

Create a new zone tax code record with geographic and tax associations.

📄️ zoneTaxCodeDelete

Permanently remove a specific zone tax code record from the system.

📄️ zoneTaxCodeUpdate

Update an existing zone tax code record with new values and settings.

📄️ zoneTaxCodesCreate

Create multiple zone tax code records in a single operation.

📄️ zoneTaxCodesDelete

Remove all zone tax code records associated with a specific price.

📄️ addCompanyManager

📄️ addSurchargesToProduct

📄️ adminUserCreate

📄️ adminUserDelete

📄️ adminUserTenantCreate

📄️ adminUserTenantDelete

📄️ adminUserUpdate

📄️ attributeCreate

📄️ attributeCsvImport

📄️ attributeDelete

📄️ attributeDescriptionCreate

📄️ attributeDescriptionCsvImport

📄️ attributeDescriptionDelete

📄️ attributeDescriptionUpdate

📄️ attributeUpdate

📄️ authenticationCreate

📄️ authenticationDelete

📄️ bulkCostPriceCreate

📄️ bulkCostPriceCsvImport

📄️ bulkCostPriceDelete

📄️ bulkCostPriceUpdate

📄️ bulkCostPricesBulk

📄️ bulkCostPricesDelete

📄️ bulkPriceCreate

📄️ bulkPriceCsvImport

📄️ bulkPriceDelete

📄️ bulkPriceUpdate

📄️ bulkPricesCreate

📄️ bulkPricesDelete

📄️ bundleAddItemsAndReturnBundle

📄️ bundleAddItems

📄️ bundleCreate

📄️ bundleDelete

📄️ bundleRemoveItemAndReturnBundle

📄️ bundleRemoveItem

📄️ bundleUpdate

📄️ businessRuleCreate

📄️ businessRuleDecisionTableAddColumn

📄️ businessRuleDecisionTableAddRow

📄️ businessRuleDecisionTableDeleteColumn

📄️ businessRuleDecisionTableDeleteRow

📄️ businessRuleDecisionTableMoveRow

📄️ businessRuleDecisionTableSetCell

📄️ businessRuleDecisionTableUpdate

📄️ businessRuleDelete

📄️ businessRuleUpdate

📄️ carrierAssignWarehouseAndReturnCarrier

📄️ carrierAssignWarehouse

📄️ carrierCreate

📄️ carrierDelete

📄️ carrierUnassignWarehouseAndReturnCarrier

📄️ carrierUnassignWarehouse

📄️ carrierUpdate

📄️ cartAcceptPurchaseAuthorizationRequest

📄️ cartAddActionCode

📄️ cartAddBundle

📄️ cartAddItem

📄️ cartDeleteItem

📄️ cartDelete

📄️ cartInvalidateCache

📄️ cartItemBulk

📄️ cartProcess

📄️ cartRemoveActionCode

📄️ cartRequestPurchaseAuthorization

📄️ cartSetContact

📄️ cartSetCustomer

📄️ cartSetUser

📄️ cartStart

📄️ cartUpdateAddress

📄️ cartUpdateItem

📄️ cartUpdate

📄️ categoryAddProductsClusters

📄️ categoryCreate

📄️ categoryCsvImport

📄️ categoryDelete

📄️ categoryRemoveProductsClusters

📄️ categoryUpdate

📄️ channelInvalidateCache

📄️ claimsResetAll

📄️ claimsReset