Mutations

activateEnrollment

Type: Enrollment!

Activate a enrollment by changing the status to ACTIVE

Arguments

Name	Description
enrollmentId ID!

addAssortmentFilter

Type: AssortmentFilter!

Add a new filter to an assortment

Arguments

Name	Description
assortmentId ID!
filterId ID!
tags [LowerCaseString!]

addAssortmentLink

Type: AssortmentLink!

Add a new child assortment to an assortment

Arguments

Name	Description
parentAssortmentId ID!
childAssortmentId ID!
tags [LowerCaseString!]

addAssortmentProduct

Type: AssortmentProduct!

Add a new product to an assortment

Arguments

Name	Description
assortmentId ID!
productId ID!
tags [LowerCaseString!]

addCartDiscount

Type: OrderDiscount!

Add a new discount to the cart, a new order gets generated with status = open (= order before checkout / cart) if necessary

Arguments

Name	Description
orderId ID
code String!

addCartProduct

Type: OrderItem!

Add a new item to the cart. Order gets generated with status = open (= order before checkout / cart) if necessary.

Arguments

Name	Description
orderId ID
productId ID!
quantity Int
configuration [ProductConfigurationParameterInput!]

addCartQuotation

Type: OrderItem!

Add a new quotation to the cart.

Arguments

Name	Description
orderId ID
quotationId ID!
quantity Int
configuration [ProductConfigurationParameterInput!]

addEmail

Type: User!

Update E-Mail address of any user or logged in user if userId is not provided

Arguments

Name	Description
email String!
userId ID

addMultipleCartProducts

Type: Order!

Add multiple new item to the cart. Order gets generated with status = open (= order before checkout / cart) if necessary.

Arguments

Name	Description
orderId ID
items [OrderItemInput!]!

addProductAssignment

Type: Product!

Link a new product to a ConfigurableProduct by providing a configuration combination that uniquely identifies a row in the assignment matrix

Arguments

Name	Description
proxyId ID!
productId ID!
vectors [ProductAssignmentVectorInput!]!

addProductReviewVote

Type: ProductReview!

Add a vote to a ProductReview. If there there is a previous vote from the user invoking this it will be removed and updated with the new vote

Arguments

Name	Description
productReviewId ID!
type ProductReviewVoteType!
meta JSON

addPushSubscription

Type: User!

Store user W3C Push subscription object

Arguments

Name	Description
subscription JSON!
unsubscribeFromOtherUsers Boolean

addWeb3Address

Type: User!

Web3

Arguments

Name	Description
address String!

addWebAuthnCredentials

Type: User!

Register WebAuthn Credentials for current user

Arguments

Name	Description
credentials JSON!

addWork

Type: Work

Add work to the work queue. Each type has its own input shape. If you pinpoint the worker by setting it during creation, the work will be only run by the worker who identifies as that worker.

Arguments

Name	Description
type WorkType!
priority Int!
input JSON
originalWorkId ID
scheduled Timestamp
retries Int!
worker String

allocateWork

Type: Work

Get the next task from the worker queue. This will also mark the task as "started". Optional worker to identify the worker.

Arguments

Name	Description
types [WorkType]
worker String

bookmark

Type: Bookmark!

Toggle Bookmark state on a product as currently logged in user, Does not work when multiple bookmarks with different explicit meta configurations exist. In those cases please use createBookmark and removeBookmark

Arguments

Name	Description
productId ID!
bookmarked Boolean

changePassword

Type: SuccessResponse

Change the current user's password. Must be logged in.

Arguments

Name	Description
oldPassword String
newPassword String

checkoutCart

Type: Order!

Process the checkout (automatically charge & deliver if possible), the cart will get transformed to an ordinary order if everything goes well.

Arguments

Name	Description
orderId ID
paymentContext JSON
deliveryContext JSON

confirmMediaUpload

Type: Media!

Arguments

Name	Description
mediaUploadTicketId ID!
size Int!
type String!

confirmOrder

Type: Order!

Manually confirm an order which is in progress

Arguments

Name	Description
orderId ID!
paymentContext JSON
deliveryContext JSON
comment String

createAssortment

Type: Assortment!

Creates new assortment.

Arguments

Name	Description
assortment CreateAssortmentInput!
texts [AssortmentTextInput!]

createBookmark

Type: Bookmark!

Create a bookmark for a specific user

Arguments

Name	Description
productId ID!
userId ID!
meta JSON

createCart

Type: Order!

Creates an alternative cart. If you use this feature, you should use explicit orderId's when using the cart mutations. Else it will work like a stack and the checkout will use the very first cart of the user.

Arguments

Name	Description
orderNumber String!

createCountry

Type: Country!

Arguments

Name	Description
country CreateCountryInput!

createCurrency

Type: Currency!

Arguments

Name	Description
currency CreateCurrencyInput!

createDeliveryProvider

Type: DeliveryProvider!

Creates new delivery provider

Arguments

Name	Description
deliveryProvider CreateDeliveryProviderInput!

createEnrollment

Type: Enrollment!

Create a enrollment.

Arguments

Name	Description
plan EnrollmentPlanInput!
billingAddress AddressInput
contact ContactInput
payment EnrollmentPaymentInput
delivery EnrollmentDeliveryInput
meta JSON

createFilter

Type: Filter!

Creates new Filter along with the user who created it.

Arguments

Name	Description
filter CreateFilterInput!
texts [FilterTextInput!]

createFilterOption

Type: Filter!

Adds new option to filters

Arguments

Name	Description
filterId ID!
option String!
texts [FilterTextInput!]

createLanguage

Type: Language!

Adds new language along with the user who created it

Arguments

Name	Description
language CreateLanguageInput!

createPaymentProvider

Type: PaymentProvider!

Adds new payment provider

Arguments

Name	Description
paymentProvider CreatePaymentProviderInput!

createProduct

Type: Product!

Create a new product

Arguments

Name	Description
product CreateProductInput!
texts [ProductTextInput!]

createProductBundleItem

Type: Product!

Adds one product as bundle for another products

Arguments

Name	Description
productId ID!
item CreateProductBundleItemInput!

createProductReview

Type: ProductReview!

Add a new ProductReview

Arguments

Name	Description
productId ID!
productReview ProductReviewInput!

createProductVariation

Type: ProductVariation!

Creates new product variation for a product.

Arguments

Name	Description
productId ID!
variation CreateProductVariationInput!
texts [ProductVariationTextInput!]

createProductVariationOption

Type: ProductVariation!

Adds variation option to an existing product variations

Arguments

Name	Description
productVariationId ID!
option String!
texts [ProductVariationTextInput!]

createUser

Type: LoginMethodResponse

Create a new user.

Arguments

Name	Description
username String
email String
webAuthnPublicKeyCredentials JSON
password String
profile UserProfileInput

createWarehousingProvider

Type: WarehousingProvider!

Creates new warehouse provider.

Arguments

Name	Description
warehousingProvider CreateWarehousingProviderInput!

createWebAuthnCredentialCreationOptions

Type: JSON!

Create WebAuthn PublicKeyCredentialCreationOptions to use for Registering a new WebAuthn Device

Arguments

Name	Description
username String!
extensionOptions JSON

createWebAuthnCredentialRequestOptions

Type: JSON!

Create WebAuthn PublicKeyCredentialRequestrOptions to use for WebAuthn Login Flow

Arguments

Name	Description
username String
extensionOptions JSON

deliverOrder

Type: Order!

Manually mark a undelivered order as delivered

Arguments

Name	Description
orderId ID!

emptyCart

Type: Order

Remove all items of an open order (cart) if possible. if you want to remove single cart item use removeCartItem instead

Arguments

Name	Description
orderId ID

enrollUser

Type: User!

Enroll a new user, setting enroll to true will let the user choose his password (e-mail gets sent)

Arguments

Name	Description
profile UserProfileInput!
email String!
password String

exportToken

Type: Token!

Arguments

Name	Description
tokenId ID!
quantity Int!
recipientWalletAddress String!

finishWork

Type: Work!

Register a work attempt manually. Note: Usually, work attempts are handled internally by the inbuilt cron worker. This mutation is part of the interface for "outside" workers.

Arguments

Name	Description
workId ID!
result JSON
error JSON
success Boolean
worker String
started Timestamp
finished Timestamp

forgotPassword

Type: SuccessResponse

Request a forgot password email.

Arguments

Name	Description
email String!

heartbeat

Type: User!

Update hearbeat (updates user activity information such as last login and logged in user IP address, locale and country where they accessed the system)

invalidateToken

Type: Token!

Tokenize

Arguments

Name	Description
tokenId ID!

loginAsGuest

Type: LoginMethodResponse

Login as Guest User (creates an anonymous user and returns logged in token)

loginWithPassword

Type: LoginMethodResponse

Log the user in with a password.

Arguments

Name	Description
username String
email String
password String

loginWithWebAuthn

Type: LoginMethodResponse

Log the user in with a WebAuthn device

Arguments

Name	Description
webAuthnPublicKeyCredentials JSON!

logout

Type: SuccessResponse

Log the user out.

makeQuotationProposal

Type: Quotation!

Make a proposal as answer to the RFP by changing its status to PROCESSED

Arguments

Name	Description
quotationId ID!
quotationContext JSON

markPaymentCredentialsPreferred

Type: PaymentCredentials

Make's the provided payment credential as the users preferred method of payment.

Arguments

Name	Description
paymentCredentialsId ID!

pageView

Type: String!

Arguments

Name	Description
path String!
referrer String

payOrder

Type: Order!

Manually mark an unpaid/partially paid order as fully paid

Arguments

Name	Description
orderId ID!

prepareAssortmentMediaUpload

Type: MediaUploadTicket!

Arguments

Name	Description
mediaName String!
assortmentId ID!

prepareProductMediaUpload

Type: MediaUploadTicket!

Arguments

Name	Description
mediaName String!
productId ID!

prepareUserAvatarUpload

Type: MediaUploadTicket!

Arguments

Name	Description
mediaName String!
userId ID

processNextWork

Type: Work

This will pick up non-external work, execute, await result and finish it up on the target system. This function allows you to do work queue "ticks" from outside instead of waiting for default Cron and Event Listener to trigger and can be helpful in serverless environments.

Arguments

Name	Description
worker String

publishProduct

Type: Product!

Make the product visible on any shop listings (product queries)

Arguments

Name	Description
productId ID!

registerPaymentCredentials

Type: PaymentCredentials

Register credentials for an existing payment provider allowing to store and use them for later payments (1-click checkout or enrollments)

Arguments

Name	Description
transactionContext JSON!
paymentProviderId ID!

rejectOrder

Type: Order!

Manually reject an order which is in progress

Arguments

Name	Description
orderId ID!
paymentContext JSON
deliveryContext JSON
comment String

rejectQuotation

Type: Quotation!

Reject an RFP, this is possible as long as a quotation is not fullfilled

Arguments

Name	Description
quotationId ID!
quotationContext JSON

removeAssortment

Type: Assortment!

Removes assortment with the provided ID

Arguments

Name	Description
assortmentId ID!

removeAssortmentFilter

Type: AssortmentFilter!

Remove a product from an assortment

Arguments

Name	Description
assortmentFilterId ID!

removeAssortmentLink

Type: AssortmentLink!

Remove a child/parent assortment link from it's parent

Arguments

Name	Description
assortmentLinkId ID!

removeAssortmentMedia

Type: AssortmentMedia!

Remove a media asset from a assortment

Arguments

Name	Description
assortmentMediaId ID!

removeAssortmentProduct

Type: AssortmentProduct!

Remove a product from an assortment

Arguments

Name	Description
assortmentProductId ID!

removeBookmark

Type: Bookmark!

Remove an existing bookmark by ID

Arguments

Name	Description
bookmarkId ID!

removeBundleItem

Type: Product!

Removes products bundle item found at the given 0 based index.

Arguments

Name	Description
productId ID!
index Int!

removeCartDiscount

Type: OrderDiscount!

Remove a discount from the cart

Arguments

Name	Description
discountId ID!

removeCartItem

Type: OrderItem!

Remove an item from an open order

Arguments

Name	Description
itemId ID!

removeCountry

Type: Country!

Deletes the specified country

Arguments

Name	Description
countryId ID!

removeCurrency

Type: Currency!

Deletes the specified currency

Arguments

Name	Description
currencyId ID!

removeDeliveryProvider

Type: DeliveryProvider!

Deletes a delivery provider by setting the deleted field to current timestamp. Note the delivery provider still exists.

Arguments

Name	Description
deliveryProviderId ID!

removeEmail

Type: User!

Update E-Mail address of any user or logged in user if userId is not provided

Arguments

Name	Description
email String!
userId ID

removeFilter

Type: Filter!

Deletes the specified filter

Arguments

Name	Description
filterId ID!

removeFilterOption

Type: Filter!

Removes the filter option from the specified filter.

Arguments

Name	Description
filterId ID!
filterOptionValue String!

removeLanguage

Type: Language!

Deletes the specified languages

Arguments

Name	Description
languageId ID!

removeOrder

Type: Order!

Remove an order while it's still open

Arguments

Name	Description
orderId ID!

removePaymentCredentials

Type: PaymentCredentials

Deletes the specified payment credential.

Arguments

Name	Description
paymentCredentialsId ID!

removePaymentProvider

Type: PaymentProvider!

Deletes the specified payment provider by setting the deleted filed to current timestamp. Note the payment provider is still available only it’s status is deleted

Arguments

Name	Description
paymentProviderId ID!

removeProduct

Type: Product!

Remove the product completely!

Arguments

Name	Description
productId ID!

removeProductAssignment

Type: Product!

Unlinks a product from a ConfigurableProduct by providing a configuration combination that uniquely identifies a row in the assignment matrix

Arguments

Name	Description
proxyId ID!
vectors [ProductAssignmentVectorInput!]!

removeProductMedia

Type: ProductMedia!

Remove a media asset from a product's visualization

Arguments

Name	Description
productMediaId ID!

removeProductReview

Type: ProductReview!

Remove an existing ProductReview. The logic to allow/dissallow removal is controlled by product plugin logic

Arguments

Name	Description
productReviewId ID!

removeProductReviewVote

Type: ProductReview!

Remove a vote from a ProductReview

Arguments

Name	Description
productReviewId ID!
type ProductReviewVoteType

removeProductVariation

Type: ProductVariation!

Removes product variation with the provided ID

Arguments

Name	Description
productVariationId ID!

removeProductVariationOption

Type: ProductVariation!

Removes product option value for product variation with the provided variation option value

Arguments

Name	Description
productVariationId ID!
productVariationOptionValue String!

removePushSubscription

Type: User!

Remove user W3C push subscription object

Arguments

Name	Description
p256dh String!

removeUser

Type: User!

Remove any user or logged in user if userId is not provided

Arguments

Name	Description
userId ID

removeWarehousingProvider

Type: WarehousingProvider!

Deletes the specified warehousing provider by setting the deleted filed to current timestamp. Note warehousing provider still exists in the system after successful completing of this operation with status deleted.

Arguments

Name	Description
warehousingProviderId ID!

removeWeb3Address

Type: User!

Arguments

Name	Description
address String!

removeWebAuthnCredentials

Type: User!

Remove WebAuthn Credentials for current user

Arguments

Name	Description
credentialsId ID!

removeWork

Type: Work!

Manually remove a work

Arguments

Name	Description
workId ID!

reorderAssortmentFilters

Type: [AssortmentFilter!]!

Reorder the products in an assortment

Arguments

Name	Description
sortKeys [ReorderAssortmentFilterInput!]!

reorderAssortmentLinks

Type: [AssortmentLink!]!

Reorder the child assortment links in it's parent

Arguments

Name	Description
sortKeys [ReorderAssortmentLinkInput!]!

reorderAssortmentMedia

Type: [AssortmentMedia!]!

Reorder a media asset (first is primary)

Arguments

Name	Description
sortKeys [ReorderAssortmentMediaInput!]!

reorderAssortmentProducts

Type: [AssortmentProduct!]!

Reorder the products in an assortment

Arguments

Name	Description
sortKeys [ReorderAssortmentProductInput!]!

reorderProductMedia

Type: [ProductMedia!]!

Reorder a media asset (first is primary)

Arguments

Name	Description
sortKeys [ReorderProductMediaInput!]!

requestQuotation

Type: Quotation!

Request for Proposal (RFP) for the specified product

Arguments

Name	Description
productId ID!
configuration [ProductConfigurationParameterInput!]

resetPassword

Type: LoginMethodResponse

Reset the password for a user using a token received in email. Logs the user in afterwards.

Arguments

Name	Description
newPassword String
token String!

sendEnrollmentEmail

Type: SuccessResponse

Forcefully trigger an enrollment email for already added users by e-mail

Arguments

Name	Description
email String!

sendVerificationEmail

Type: SuccessResponse

Send an email with a link the user can use verify their email address.

Arguments

Name	Description
email String

setBaseAssortment

Type: Assortment!

Makes the assortment provided as the base assortment and make any other existing base assortment regular assortments.

Arguments

Name	Description
assortmentId ID!

setOrderDeliveryProvider

Type: Order!

Change the delivery method/provider to an order. If the delivery provider doesn’t exists new delivery provider will be created with the provided ID.

Arguments

Name	Description
orderId ID!
deliveryProviderId ID!

setOrderPaymentProvider

Type: Order!

Change the payment method/provider to an order. If the payment provider doesn’t exists new payment provider will be created with the provided ID.

Arguments

Name	Description
orderId ID!
paymentProviderId ID!

setPassword

Type: User!

Set a new password for a specific user

Arguments

Name	Description
newPassword String
userId ID!

setRoles

Type: User!

Set roles of a user

Arguments

Name	Description
roles [String!]!
userId ID!

setUsername

Type: User!

Set username for a specific user

Arguments

Name	Description
username String!
userId ID!

setUserTags

Type: User!

Set tags of user

Arguments

Name	Description
tags [LowerCaseString]!
userId ID!

signPaymentProviderForCheckout

Type: String!

Sign a generic order payment

Arguments

Name	Description
orderPaymentId ID
transactionContext JSON

signPaymentProviderForCredentialRegistration

Type: String

Sign a generic payment provider for registration

Arguments

Name	Description
paymentProviderId ID!
transactionContext JSON

terminateEnrollment

Type: Enrollment!

Terminate an actively running enrollment by changing it's status to TERMINATED

Arguments

Name	Description
enrollmentId ID!

unpublishProduct

Type: Product!

Hide the product visible from any shop listings (product queries)

Arguments

Name	Description
productId ID!

updateAssortment

Type: Assortment!

Updates the provided assortment

Arguments

Name	Description
assortment UpdateAssortmentInput!
assortmentId ID!

updateAssortmentMediaTexts

Type: [AssortmentMediaTexts!]!

Modify localized texts part of a assortment media asset

Arguments

Name	Description
assortmentMediaId ID!
texts [AssortmentMediaTextInput!]!

updateAssortmentTexts

Type: [AssortmentTexts!]!

Modify localized texts part of an assortment

Arguments

Name	Description
assortmentId ID!
texts [AssortmentTextInput!]!

updateCart

Type: Order!

Change billing address and order contact of an open order (cart). All of the parameters except order ID are optional and the update will ocure for parameters provided. If the delivery provider or payment provider ID provided doesn’t already exist new order payment will be created with the provided ID.

Arguments

Name	Description
orderId ID
billingAddress AddressInput
contact ContactInput
meta JSON
paymentProviderId ID
deliveryProviderId ID

updateCartItem

Type: OrderItem!

Change the quantity or configuration of an item in an open order.align-baselineAll of the parameters are optional except item ID and for the parameters provided the update will be performed accordingly.

Arguments

Name	Description
itemId ID!
quantity Int
configuration [ProductConfigurationParameterInput!]

updateCountry

Type: Country!

Updates provided country information

Arguments

Name	Description
country UpdateCountryInput!
countryId ID!

updateCurrency

Type: Currency!

Updates the specified currency

Arguments

Name	Description
currency UpdateCurrencyInput!
currencyId ID!

updateDeliveryProvider

Type: DeliveryProvider!

Updates the delivery provider specified

Arguments

Name	Description
deliveryProvider UpdateProviderInput!
deliveryProviderId ID!

updateEnrollment

Type: Enrollment!

Update a enrollment

Arguments

Name	Description
enrollmentId ID
plan EnrollmentPlanInput
billingAddress AddressInput
contact ContactInput
payment EnrollmentPaymentInput
delivery EnrollmentDeliveryInput
meta JSON

updateFilter

Type: Filter!

Updates the specified filter with the information passed.

Arguments

Name	Description
filter UpdateFilterInput!
filterId ID!

updateFilterTexts

Type: [FilterTexts!]!

Updates or created specified filter texts for filter with ID provided and locale and optionally filterOptionValue

Arguments

Name	Description
filterId ID!
filterOptionValue String
texts [FilterTextInput!]!

updateLanguage

Type: Language!

Updates the specified language.

Arguments

Name	Description
language UpdateLanguageInput!
languageId ID!

updateOrderDeliveryPickUp

Type: OrderDeliveryPickUp!

Update a Pick Up Delivery Provider's specific configuration

Arguments

Name	Description
orderDeliveryId ID!
orderPickUpLocationId ID!
meta JSON

updateOrderDeliveryShipping

Type: OrderDeliveryShipping!

Update a Shipping Delivery Provider's specific configuration

Arguments

Name	Description
orderDeliveryId ID!
address AddressInput
meta JSON

updateOrderPaymentCard

Type: OrderPaymentCard!

Update a Card Payment Provider's specific configuration

Arguments

Name	Description
orderPaymentId ID!
meta JSON

updateOrderPaymentGeneric

Type: OrderPaymentGeneric!

Update a Generic Payment Provider's specific configuration

Arguments

Name	Description
orderPaymentId ID!
meta JSON

updateOrderPaymentInvoice

Type: OrderPaymentInvoice!

Update an Invoice Payment Provider's specific configuration

Arguments

Name	Description
orderPaymentId ID!
meta JSON

updatePaymentProvider

Type: PaymentProvider!

Updates payment provider information with the provided ID

Arguments

Name	Description
paymentProvider UpdateProviderInput!
paymentProviderId ID!

updateProduct

Type: Product

Modify generic infos of a product (tags for ex.)

Arguments

Name	Description
productId ID!
product UpdateProductInput!

updateProductCommerce

Type: Product

Modify commerce part of a product

Arguments

Name	Description
productId ID!
commerce UpdateProductCommerceInput!

updateProductMediaTexts

Type: [ProductMediaTexts!]!

Modify localized texts part of a product's media asset

Arguments

Name	Description
productMediaId ID!
texts [ProductMediaTextInput!]!

updateProductPlan

Type: Product

Modify plan part of a product

Arguments

Name	Description
productId ID!
plan UpdateProductPlanInput!

updateProductReview

Type: ProductReview!

Update an existing ProductReview. The logic to allow/dissallow editing is controlled by product plugin logic

Arguments

Name	Description
productReviewId ID!
productReview ProductReviewInput!

updateProductSupply

Type: Product

Modify delivery part of a product

Arguments

Name	Description
productId ID!
supply UpdateProductSupplyInput!

updateProductTexts

Type: [ProductTexts!]!

Modify localized texts part of a product

Arguments

Name	Description
productId ID!
texts [ProductTextInput!]!

updateProductTokenization

Type: TokenizedProduct

Modify tokenization part of a product

Arguments

Name	Description
productId ID!
tokenization UpdateProductTokenizationInput!

updateProductVariationTexts

Type: [ProductVariationTexts!]!

Update product variation texts with the specified locales for product variations that match the provided variation ID and production option value

Arguments

Name	Description
productVariationId ID!
productVariationOptionValue String
texts [ProductVariationTextInput!]!

updateProductWarehousing

Type: Product

Modify warehousing part of a product

Arguments

Name	Description
productId ID!
warehousing UpdateProductWarehousingInput!

updateUserProfile

Type: User!

Update Profile of any user or logged in user if userId is not provided

Arguments

Name	Description
profile UserProfileInput
meta JSON
userId ID

updateWarehousingProvider

Type: WarehousingProvider!

Updates warehousing provider information with the provided ID

Arguments

Name	Description
warehousingProvider UpdateProviderInput!
warehousingProviderId ID!

verifyEmail

Type: LoginMethodResponse

Marks the user's email address as verified. Logs the user in afterwards.

Arguments

Name	Description
token String!

verifyQuotation

Type: Quotation!

Verify quotation request elligibility. and marks requested quotations as verified if it is

Arguments

Name	Description
quotationId ID!
quotationContext JSON

verifyWeb3Address

Type: User!

Arguments

Name	Description
address String!
hash String!