Propeller Commerce Docs

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR (('user is authenticated') AND ('contactId if present in input matches JWT' AND 'companyId(s) if present in input matches JWT'))

📄️ cartSetCustomer

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR (('user is authenticated') AND ('customerId if present in input matches JWT'))

📄️ cartSetUser

Will be removed in the future, please use cartSetContact or cartSetCustomer mutations instead.

AUTH: Role=[order.OWNER,order.EDITOR,order.VIEWER] OR (('user is authenticated') AND ('userId if present in input matches JWT' AND 'contactId if present in input matches JWT' AND 'customerId if present in input matches JWT' AND 'companyId(s) if present in input matches JWT'))

📄️ cartUpdateAddress

Update cart address

📄️ cartUpdateItem

Update item in the cart

📄️ cartUpdate

Update existing cart

📄️ categoryAddProductsClusters

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

📄️ categoryCreate

AUTH: Role=[product.OWNER] OR ('user is authenticated')

📄️ categoryCsvImport

AUTH: Role=[product.OWNER] OR ('user is authenticated')

📄️ categoryDelete

Delete category by category Id

📄️ categoryRemoveProductsClusters

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

📄️ categoryUpdate

AUTH: Role=[product.OWNER,product.EDITOR] OR ('user is authenticated')

📄️ channelInvalidateCache

No description

📄️ claimsReset

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

📄️ clusterConfigAddSetting

AUTH: Role=[product.OWNER]

📄️ clusterConfigCreate

AUTH: Role=[product.OWNER]

📄️ clusterConfigDelete

AUTH: Role=[product.OWNER]

📄️ clusterConfigRemoveSetting

AUTH: Role=[product.OWNER]

📄️ clusterConfigUpdateSetting

AUTH: Role=[product.OWNER]

📄️ clusterCreate

AUTH: Role=[product.OWNER]

📄️ clusterCsvImport

AUTH: Role=[product.OWNER]

📄️ clusterDelete

AUTH: Role=[product.OWNER]

📄️ clusterOptionCreate

AUTH: Role=[product.OWNER]

📄️ clusterOptionDelete

AUTH: Role=[product.OWNER]

📄️ clusterOptionUpdate

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

📄️ clusterProductCreate

AUTH: Role=[product.OWNER]

📄️ clusterProductDelete

AUTH: Role=[product.OWNER]

📄️ clusterProductUpdate

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

📄️ clusterUpdate

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

📄️ companyAddressCreate

AUTH: Role=[user.OWNER] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT'))

📄️ companyAddressDelete

AUTH: Role=[user.OWNER] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT'))

📄️ companyAddressUpdate

AUTH: Role=[user.OWNER,user.EDITOR] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT'))

📄️ companyCreate

AUTH: Role=[user.OWNER]

📄️ companyCsvImport

AUTH: Role=[user.OWNER]

📄️ companyDelete

AUTH: Role=[user.OWNER]

📄️ companyUpdate

AUTH: Role=[user.OWNER,user.EDITOR] OR (('user is authenticated') AND ('companyId(s) if present in input matches JWT'))

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

Creates a new contact, if you want this new contact to be able to login, please use contactRegister. AUTH: Role=[user.OWNER]

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

No description

📄️ costPriceDelete

No description

📄️ costPriceUpdate

No description

📄️ costPricesBulk

No description

📄️ costPricesDelete

No description

📄️ crossupsellCreate

AUTH: Role=[product.OWNER]

📄️ crossupsellDelete

AUTH: Role=[product.OWNER]

📄️ crossupsellUpdate

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

📄️ customerAddressCreate

AUTH: Role=[user.OWNER] OR (('user is authenticated') AND ('customerId if present in input matches JWT'))

📄️ customerAddressDelete

AUTH: Role=[user.OWNER] OR (('user is authenticated') AND ('customerId if present in input matches JWT'))

📄️ customerAddressUpdate

AUTH: Role=[user.OWNER,user.EDITOR] OR (('user is authenticated') AND ('customerId if present in input matches JWT'))

📄️ customerCreateAccount

AUTH: Role=[user.OWNER]

📄️ customerCreate

Creates a new customer, if you want this new customer to be able to login, please use customerRegister. AUTH: Role=[user.OWNER]

📄️ customerCsvImport

AUTH: Role=[user.OWNER]

📄️ customerDeleteAccount

AUTH: Role=[user.OWNER]

📄️ customerDelete

AUTH: Role=[user.OWNER]

📄️ customerRegister

Creates a new customer and a new login account for this customer. AUTH: Role=[user.OWNER]

📄️ customerUpdate

AUTH: Role=[user.OWNER,user.EDITOR] OR (('user is authenticated') AND ('customerId if present in input matches JWT'))

📄️ discountCreate

AUTH: Role=[pricing.OWNER]

📄️ discountCsvImport

AUTH: Role=[pricing.OWNER]

📄️ discountDelete

AUTH: Role=[pricing.OWNER]

📄️ discountUpdate

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

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

Deletes an EventActionConfig entity by ID

📄️ eventToEmailConfigCreate

Creates a new EventToEmailConfig entity

📄️ eventToEmailConfigUpdate

Updates an existing EventToEmailConfig entity

📄️ eventToWebHookConfigCreate

Creates a new EventToWebHookConfig entity

📄️ eventToWebHookConfigUpdate

Updates an existing entity

📄️ exchangeRefreshToken

No description

📄️ externalAddressCreate

AUTH: Role=[configuration.OWNER] OR (('user is authenticated') AND ('userId if present in input matches JWT'))

📄️ externalAddressDelete

AUTH: Role=[configuration.OWNER] OR (('user is authenticated') AND ('userId if present in input matches JWT'))

📄️ externalAddressUpdate

AUTH: Role=[configuration.OWNER,configuration.EDITOR] OR (('user is authenticated') AND ('userId if present in input matches JWT'))

📄️ favoriteListAddItems

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

📄️ favoriteListClearItems

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

📄️ favoriteListCreate

AUTH: Role=[shop.OWNER] OR (('user is authenticated') AND ('undefined'))

📄️ favoriteListDelete

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

📄️ favoriteListRemoveItems

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

📄️ favoriteListUpdate

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

📄️ incentiveRuleAddOrderCondition

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

📄️ incentiveRuleCreate

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

📄️ incentiveRuleRemoveOrderCondition

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

📄️ incentiveRuleSetAction

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

📄️ incentiveRuleSetOrderItemConditions

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

📄️ inventoryCreate

AUTH: Role=[logistics.OWNER]

📄️ inventoryCsvImport

AUTH: Role=[logistics.OWNER]

📄️ inventoryDelete

AUTH: Role=[logistics.OWNER]

📄️ inventoryUpdate

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

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

No description

📄️ machineDelete

No description

📄️ machineUpsert

No description

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

📄️ orderCreate

AUTH: Role=[order.OWNER] OR (('user is authenticated') AND ('userId if present in input matches JWT' AND 'companyId(s) if present in input matches JWT'))

📄️ orderDelete

AUTH: Role=[order.OWNER]

📄️ orderItemCreate

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

📄️ orderItemDelete

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

📄️ orderItemUpdate

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

📄️ orderSendConfirmationEmail

No description

📄️ orderSetStatus

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

📄️ orderStatusCreate

No description

📄️ orderStatusDelete

No description

📄️ orderStatusSetAddOrderStatuses

No description

📄️ orderStatusSetCreate

No description

📄️ orderStatusSetDelete

No description

📄️ orderStatusSetRemoveOrderStatuses

No description

📄️ orderStatusSetUpdate

No description

📄️ orderStatusUpdate

No description

📄️ orderUpdateAddress

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

📄️ orderUpdate

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

📄️ orderlistAddItems

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

📄️ orderlistAssignCompanies

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

📄️ orderlistAssignUsers

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

📄️ orderlistCreate

AUTH: Role=[shop.OWNER] OR ('user is authenticated')

📄️ orderlistDelete

AUTH: Role=[shop.OWNER]

📄️ orderlistRemoveItems

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

📄️ orderlistUnassignCompanies

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

📄️ orderlistUnassignUsers

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

📄️ orderlistUpdate

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

📄️ passwordResetLink

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

📄️ payMethodCreate

No description

📄️ payMethodDelete

No description

📄️ payMethodUpdate

No description

📄️ paymentCreate

AUTH: Role=[order.OWNER]

📄️ paymentDelete

AUTH: Role=[order.OWNER]

📄️ paymentUpdate

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

📄️ priceCreate

AUTH: Role=[pricing.OWNER]

📄️ priceCsvImport

AUTH: Role=[pricing.OWNER]

📄️ priceDelete

AUTH: Role=[pricing.OWNER]

📄️ priceUpdate

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

📄️ pricesheetAssign

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

📄️ pricesheetCreate

AUTH: Role=[pricing.OWNER]

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

AUTH: Role=[product.OWNER]

📄️ productCsvImport

AUTH: Role=[product.OWNER]

📄️ productDelete

AUTH: Role=[product.OWNER]

📄️ productUpdate

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

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

📄️ removeCompanyManager

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

📄️ removeSurchargesFromProduct

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

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

📄️ shopInvalidateCache

No description

📄️ startSession

Starts an anonymous firebase session

📄️ surchargeCreate

AUTH: Role=[pricing.OWNER]

📄️ surchargeDelete

AUTH: Role=[pricing.OWNER]

📄️ surchargeUpdate

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

📄️ taxCreate

AUTH: Role=[pricing.OWNER]

📄️ taxDelete

AUTH: Role=[pricing.OWNER]

📄️ taxUpdate

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

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