Mutation

Object

accountAddressCreate

Create a new address for the customer.

accountAddressDelete

Delete an address of the logged-in user.

accountAddressSetDefault

Sets a default address for the authenticated user.

accountAddressUpdate

Updates an address of the logged-in user.

accountConfirm

Confirm user account with token sent by email during registration.

accountDelete

Remove user account.

accountRegister

Register a new user.

accountRequestDeletion

Sends an email with the account removal link for the logged-in user.

accountUpdate

Updates the account of the logged-in user.

addressCreate

Creates user address.

addressDelete

Deletes an address.

addressSetDefault

Sets a default address for the given user.

addressUpdate

Updates an address.

agreementBulkDelete

Deletes agreements.

agreementBulkPublish

Publish agreements.

agreementCommissionCreate

Creates a new agreement commission.

agreementCommissionDelete

Deletes an agreement commission.

agreementCreate

Creates a new agreement.

agreementDelete

Deletes a agreement.

agreementFeeCreate

Creates a new agreement fee.

agreementFeeDelete

Deletes an agreement fee.

agreementUpdate

Updates an existing agreement.

appActivate

Activate the app.

appCreate

Creates a new app.

appDeactivate

Deactivate the app.

appDelete

Deletes an app.

appDeleteFailedInstallation

Delete failed installation.

appFetchManifest

Fetch and validate manifest.

appInstall

Install new app by using app manifest.

appRetryInstall

Retry failed installation of new app.

appTokenCreate

Creates a new token.

appTokenDelete

Deletes an authentication token assigned to app.

appTokenVerify

Verify provided app token.

appUpdate

Updates an existing app.

attributeAssign

Assign attributes to a given product type.

attributeBulkDelete

Deletes attributes.

attributeCreate

Creates an attribute.

attributeDelete

Deletes an attribute.

attributeUnassign

Un-assign attributes from a given product type.

attributeUpdate

Updates attribute.

attributeValueBulkCreate

Creates attribute values for a given attribute.

attributeValueBulkDelete

Deletes values of attributes.

attributeValueCreate

Creates a value for an attribute.

attributeValueDelete

Deletes a value of an attribute.

attributeValueUpdate

Updates value of an attribute.

attributeValuesReorder

Reorder the values of an attribute.

authUrlGenerate

Create authorization URL.

bidAccept

Accepts the specificed bid.

bidCreate

Creates a new Bid.

bidReject

Rejects the specificed bid.

catalogExport

Export catalog.

catalogImport

Import foreign catalog.

categoryBulkDelete

Deletes categories.

categoryCreate

Creates a new category.

categoryDelete

Deletes a category.

categoryUpdate

Updates a category.

checkoutAddPoNumbers

Adds purchase order number to a checkout.

checkoutAddPromoCode

Adds a gift card or a voucher to a checkout.

checkoutBillingAddressUpdate

Update billing address in the existing checkout.

checkoutComplete

Completes the checkout. As a result a new order is created and a payment charge is made. This action requires a successful payment before it can be performed. In case additional confirmation step as 3D secure is required confirmationNeeded flag will be set to True and no order created until payment is confirmed with second call of this mutation.

checkoutConvertToNauticalQuoteOrder

Converts checkout to nautical quote order with the same id as checkout has when checkout is ready to be converted into quote order. This mutation should delete current checkout in case when order is created.

checkoutCreate

Create a new checkout.

checkoutCustomerAttach

Sets the customer as the owner of the checkout.

checkoutCustomerDetach

Removes the user assigned as the owner of the checkout.

checkoutDelete

Deletes a checkout.

checkoutEmailUpdate

Updates email address in the existing checkout object.

checkoutEventTriggered

Create a checkout event.

checkoutLineAddNote

Add a note to a checkout line.

checkoutLineDelete

Deletes a CheckoutLine.

checkoutLinesAdd

Adds a checkout line to the existing checkout.

checkoutLinesUpdate

Updates checkout line in the existing checkout.

checkoutMarketplaceShippingMethodUpdate

Updates the marketplace shipping methods of the checkout.

checkoutNoteUpdate

Updates the checkout note on the provided checkout.

checkoutPaymentCreate

Create a new payment for given checkout.

checkoutRemovePoNumbers

Remove a purchase order from a checkout.

checkoutRemovePromoCode

Remove a gift card or a voucher from a checkout.

checkoutSellerShippingMethodsBulkUpdate

Bulk clears the seller shipping methods of the checkout.

checkoutSellerShippingMethodsClear

Clears the seller shipping methods of the checkout.

checkoutSellerShippingMethodsUpdate

Updates the seller shipping methods of the checkout.

checkoutSetTransactionCurrency

Update currency in the existing checkout object.

checkoutShippingAddressUpdate

Update shipping address in the existing checkout.

checkoutThemeCreate

Create a new checkout theme.

checkoutThemeUpdate

Update a checkout theme.

collectionAddProducts

Adds products to a collection.

collectionAddVariants

Adds variants to a collection.

collectionBulkDelete

Deletes collections.

collectionBulkPublish

Publish collections.

collectionCreate

Creates a new collection.

collectionDelete

Deletes a collection.

collectionRemoveProducts

Remove products from a collection.

collectionRemoveVariants

Remove variants from a collection.

collectionReorderProducts

Reorder the products of a collection.

collectionUpdate

Updates a collection.

contentCreate

Creates a new content object.

contentDelete

Deletes a voucher.

contentDiscard

Discards the latest changes of a content object.

contentDuplicate

Duplicate an existing content object.

contentPageDataCreate

Creates a content page data object.

contentPageDataUpdate

Updates a content page data object.

contentPublish

Publishes a content object.

contentSave

Auto saves a content object.

createCustomerToken

Creates a new Nautical customer token.

customAttributeAssign

Assign attributes to a given custom field template.

customAttributeUnassign

Un-assign attributes from a given custom field template.

customDomainCreate

Creates a custom domain

customDomainDelete

Deletes a custom domain

customerBulkDelete

Deletes customers.

customerCreate

Creates a new customer.

customerDelete

Deletes a customer.

customerUpdate

Updates an existing customer.

customersExport

Export customer list.

dashboardEmbeddingToken

Gets and sets Explo dashboard embedding token in cookies

designerDataCreate

Create designer data.

designerDataUpdate

Update existing designer data.

digitalContentCreate

Create new digital content. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

digitalContentDelete

Remove digital content assigned to given variant.

digitalContentUpdate

Update digital content.

digitalContentUrlCreate

Generate new URL to digital content.

documentAdd

Add or attach a document to any allowed entity (note: consider to use DocumentAttach for 'attach' action). Must only receive one of either file or document_id in input.

documentAttach

Attach a document to any allowed entities.

documentRemove

Delete or detach a document. Must only receive one of either target_ids or delete = True in input.

documentUpdate

Updates an existing document.

draftOrderBulkDelete

Deletes draft or quote orders.

draftOrderComplete

Completes creating an order.

draftOrderCreate

Creates a new draft order.

draftOrderDelete

Deletes a draft order.

draftOrderLineDelete

Deletes an order line from a draft or quote order.

draftOrderLinePriceOverride

Overrides unit net price of an order line of a draft, quote, or offer order.

draftOrderLineUpdate

Updates an order line of a draft, quote or offer order.

draftOrderLinesBulkDelete

Deletes order lines.

draftOrderLinesCreate

Create order lines for draft or quote orders.

draftOrderSetTransactionCurrency

Update currency in the existing draft order object.

draftOrderUpdate

Updates a draft order.

emailChangeConfirm

Confirm the email change of the logged-in user.

emailChangeRequest

Request email change for the current user.

emailTemplateUpdate

EmailTemplate update mutation.

exchangeRatesRefresh

Refreshes currency exchange rates. Must have a currency exchange app enabled in the app marketplace.

featureCreate

Creates a new feature for either a product or a variant.

featureDelete

Deletes a feature.

featureUpdate

Updates a feature.

fulfillmentBulkReturn

Processes return requests by grabbing the return status and

instanceAttributeUnassign

Unassign the specified attribute from an instance.

invoiceCancel

Cancels an invoice.

invoiceCreate

Creates a ready to send invoice.

invoiceDelete

Deletes an invoice.

invoiceFinalize

Finalizes an invoice.

invoiceRefresh

Refreshes an invoice.

invoiceRequest

Request an invoice for the order using plugin.

invoiceRequestDelete

Requests deletion of an invoice.

invoiceSendNotification

Send an invoice notification to the customer.

invoiceUpdate

Updates an invoice.

journalEntryCorrect

Correct a previous journal entry by supplying

marketplaceConfigurationUpdate

Updates marketplace configuration.

mediaBulkDelete

Deletes medias.

mediaCreate

Creates a new media object.

mediaUpdate

Update a media object.

menuBulkDelete

Deletes menus.

menuCreate

Creates a new Menu.

menuDelete

Deletes a menu.

menuItemBulkDelete

Deletes menu items.

menuItemCreate

Creates a new menu item.

menuItemDelete

Deletes a menu item.

menuItemMove

Moves items of menus.

menuItemUpdate

Updates a menu item.

menuUpdate

Updates a menu.

metadataDelete

Delete metadata of an object.

metadataUpdate

Updates metadata of an object.

micrositeAddProducts

Adds products to a microsite.

micrositeBulkDelete

Deletes microsites.

micrositeBulkPublish

Publish microsites.

micrositeCreate

Creates a new microsite.

micrositeDelete

Deletes a microsite.

micrositeRemoveProducts

Remove products from a microsite.

micrositeReorderProducts

Reorder the products of a microsite.

micrositeUpdate

Updates a microsite.

nauticalConfigurationUpdate

Updates nautical configuration.

nauticalDraftOrderBulkDelete

Deletes draft or quote orders.

nauticalDraftOrderComplete

Completes creating an order.

nauticalDraftOrderCreate

Creates a new Nautical draft order.

nauticalDraftOrderDelete

Deletes a draft order.

nauticalDraftOrderLineDelete

Deletes an order line from a draft or quote order.

nauticalDraftOrderLinePriceOverride

Overrides unit net price of a marketplace order line of a draft, quote, or offer order.

nauticalDraftOrderLineUpdate

Updates an order line of a draft order.

nauticalDraftOrderLinesBulkDelete

Deletes order lines.

nauticalDraftOrderLinesCreate

Create order lines for a draft or quote order.

nauticalDraftOrderSetTransactionCurrency

Update currency in the existing nautical draft order object, related nautical order lines, child order and their lines.

nauticalDraftOrderUpdate

Updates a draft or quote nautical order.

nauticalHistoricalOrderCreate

Creates a new Nautical historical order.

nauticalOrderAddNote

Adds note to the order.

nauticalOrderCancel

Cancel an order.

nauticalOrderCapture

Capture a nautical order.

nauticalOrderLineAddNote

Add a note to a nautical order line.

nauticalOrderLineBulkCancel

Cancels nautical order lines, associated order lines, and removes allocations for that order line.

nauticalOrderLinesCsvUpload

Uploads lines for a draft order via CSV. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

nauticalOrderMarkAsPaid

Mark order as manually paid.

nauticalOrderPaymentCreate

Create and process a new payment for given nautical order. Be aware that in nautical orders flow, payment will be handled as part of this mutation; while in checkout flow, it will be processed as part of CheckoutComplete mutation.

nauticalOrderRefreshTaxes

Attempts to force a refresh of the existing taxes on a non-placed nautical order.

nauticalOrderReturnFromStorefrontNotification

Adds return notification note to the order.

nauticalOrderReturnNotification

Adds return notification note to the order.

nauticalOrderUpdate

Updates an order.

nauticalOrderUpdateApplyVoucherCode

Apply an existing voucher code to a nautical order to give a discount.

nauticalOrderUpdateDeleteDiscount

Remove a discount from a nautical order.

nauticalOrderUpdateMarketplaceShipping

Updates a marketplace shipping method of the order.

nauticalOrderUpdateShipping

Updates a shipping method of the order.

nauticalOrderVoid

Void a nautical order.

nauticalQuoteOrderCancel

Cancel a nautical quote order.

nauticalQuoteOrderSendToCustomer

Sends a quote order to a customer.

orderAddNote

Adds note to the order.

orderBulkCancel

Cancels orders.

orderCancel

Cancel an order.

orderDeclineFulfillment

Decline (permanently) part of an order. The buyer will not be charged for the missing stock. Use if stock in a warehouse is damaged, expired, or unavailable.

orderFeeCreate

Creates a new order fee.

orderFeeDelete

Deletes a order fee.

orderFulfill

Creates new fulfillments for an order.

orderFulfillmentCancel

Cancels existing fulfillment and optionally restocks items.

orderFulfillmentReturn

Returns selected quantity from fulfillment lines and restocks items.

orderFulfillmentUpdateReturnStatus

Updated return status of existing fulfillment and optionally restocks items.

orderFulfillmentUpdateTracking

Updates a fulfillment for an order.

orderLineAddNote

Add a note to an order line.

orderLinesCsvUpload

Uploads lines for a draft order via CSV. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

orderMarkAsDelivered

Marks a fully fulfilled Order as delivered.

orderOfferConvertToNauticalQuoteOrder

Converts a seller or marketplace offer order to a nautical quote order.

orderPayoutStatusUpdate

Modifies the payout status of an order

orderReturnNotification

Adds return notification note to the order.

orderUpdate

Updates an order.

orderUpdateShipping

Updates a shipping method of the order.

pageBulkDelete

Deletes pages.

pageBulkPublish

Publish pages.

pageCreate

Creates a new page.

pageDelete

Deletes a page.

pageUpdate

Updates an existing page.

passwordChange

Change the password of the logged in user.

passwordRequestReset

Sends an email with the account password modification link.

passwordSet

Sets the user's password from the token sent by email using the RequestPasswordReset mutation.

paymentCapture

Captures the authorized payment amount.

paymentVoid

Voids the authorized payment.

payoutBulkArchive

Archive payouts.

payoutCreate

Creates a new payout.

payoutDatesUpdate

Modifies the dates of a payout

payoutDelete

Deletes a draft payout

payoutStatusUpdate

Modifies the status of a payout

payoutUpdate

Update vendor payouts connected to the given payout with adjustments and penalties

permissionGroupCreate

Create new permission group.

permissionGroupDelete

Delete permission group.

permissionGroupUpdate

Update permission group.

pluginFlowDelete

Delete plugin flow.

pluginFlowUpdate

Update plugin flow.

pluginUpdate

Update plugin configuration.

priceBookBulkDelete

Deletes price books.

priceBookCreate

Creates a new price book.

priceBookDelete

Deletes a price book.

priceBookProductBulkDelete

Deletes price book's products.

priceBookProductCreate

Add a product to price book.

priceBookProductDelete

Deletes a price book product.

priceBookProductTypeBulkDelete

Deletes price book's product types.

priceBookProductTypeCreate

Add a product type to price book.

priceBookProductTypeDelete

Deletes a price book product type.

priceBookProductTypeUpdate

Updates an existing price book product type.

priceBookProductUpdate

Updates an existing price book product.

priceBookUpdate

Updates an existing price book.

priceBookVariantBulkDelete

Deletes price book's variants.

priceBookVariantCreate

Add a variant to price book.

priceBookVariantDelete

Deletes a price book variant.

priceBookVariantUpdate

Updates an existing price book variant.

privateMetadataDelete

Delete object's private metadata.

privateMetadataUpdate

Updates private metadata of an object.

productBulkCategoryUpdate

Update product category for multiple products

productBulkDelete

Deletes products.

productBulkPublish

Publish products.

productCreate

Creates a new product.

productDelete

Deletes a product.

productImageBulkDelete

Deletes product images.

productImageCreate

Create a product image. If URL is present, image will be taken from provided URL. If no URL provided, then this mutation must be sent as a multipart request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

productImageDelete

Deletes a product image.

productImageReorder

Changes ordering of the product image.

productImageUpdate

Updates a product image.

productLocationCreate

Create a new location for the product.

productLocationDelete

Delete a location for a product.

productLocationUpdate

Updates a location for a product.

productReorderVariants

Reorder the variants of a product. Mutation updates updated_at on product and triggers PRODUCT_UPDATED webhook.

productSetAvailabilityForPurchase

Set product availability for purchase date.

productSetLocationType

Sets a location type.

productTypeBulkDelete

Deletes product types.

productTypeCreate

Creates a new product type.

productTypeDelete

Deletes a product type.

productTypeFeatureCreate

Creates a new product or variant feature on a product type.

productTypeFeatureDelete

Deletes a product or variant feature on a product type.

productTypeFeatureUpdate

Updates a product or variant feature on a product type.

productTypeReorderAttributes

Reorder the attributes of a product type.

productTypeUpdate

Updates an existing product type.

productUpdate

Updates an existing product.

productVariantBulkCreate

Creates product variants for a given product.

productVariantBulkDelete

Deletes product variants.

productVariantCreate

Creates a new variant for a product.

productVariantDelete

Deletes a product variant.

productVariantImageAssign

Assign an image to a product variant.

productVariantImageUnassign

Unassign an image from a product variant.

productVariantSetDefault

Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook.

productVariantStocksCreate

Creates stocks for product variant.

productVariantStocksDelete

Delete stocks from product variant.

productVariantStocksUpdate

Update stocks for product variant.

productVariantUpdate

Updates an existing variant for product.

productsExport

Export products to csv file.

productsImport

Import products with csv file.

refundCreate

Creates a new refund.

refundLinesAdd

Adds a refund lines to the existing refund.

refundLinesDelete

Deletes all specified refund lines.

refundLinesUpdate

Update lines in a refund.

refundPaymentsAdd

Add manual payments to a refund

refundPaymentsDelete

Deletes specified refund payments. The refund must be in the PROCESSING state.

refundPaymentsUpdate

Update refund payments.

refundUpdate

Updates a refund.

refundsChangeStatus

Updates the status of all specified refunds. All refunds must be able to make the state transition for any of them to update

refundsDelete

Deletes all specified refunds. The refunds must be in the REQUESTED state to be able to be deleted

saleBulkDelete

Deletes sales.

saleCataloguesAdd

Adds products, variants, categories, or collections to a sale.

saleCataloguesRemove

Removes products, variants, categories, or collections from a sale.

saleCreate

Creates a new sale.

saleDelete

Deletes a sale.

saleUpdate

Updates a sale.

sellerAddressCreate

Creates seller address.

sellerAddressDelete

Deletes an address.

sellerAddressSetDefault

Sets a default address for the given user.

sellerAddressUpdate

Updates an address.

sellerAgreementAcknowledge

Acknowledge the seller agreement for seller id

sellerAgreementAssign

Creates a new seller agreement mapping.

sellerAgreementDecline

Decline the seller agreement for seller id

sellerAgreementDelete

Deletes a seller agreement mapping.

sellerApplicationUpdate

Updates application for the given seller.

sellerBannerDelete

Create a seller banner.This mutation must be sent as a 'multipart' request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

sellerBannerUpdate

Create a seller banner.This mutation must be sent as a 'multipart' request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

sellerDataCreate

Create seller data.

sellerDataUpdate

Updates a sellers status and override information

sellerLogoDelete

Deletes a seller logo. Only for MP Admin, MP Staff, or the seller.

sellerLogoUpdate

Create a seller logo. Only for MP Admin, MP Staff, or the seller. This mutation must be sent as a 'multipart' request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

sellerNoteCreate

Create seller note.

sellerOnboardingChecklistComplete

Marks manually one checklist item as completed.

sellerOnboardingSettingsCreate

Create new seller onboarding settings.

sellerOnboardingSettingsUpdate

Update seller onboarding settings.

sellerOwnerDelete

Removes the user owner from a seller (including user's membership in the seller)

sellerSettingsUpdate

Updates settings for the given seller.

sellerShellCreate

Create seller shell.

sellerUserMappingCreate

Allows [re-]assign a user to a seller

sellerWithOwnerCreate

Create new Seller and a new staff user and assign created user as Seller owner.

shippingPriceBulkDelete

Deletes shipping prices.

shippingPriceCreate

Creates a new shipping price.

shippingPriceDelete

Deletes a shipping price.

shippingPriceUpdate

Updates a new shipping price.

shippingZoneBulkDelete

Deletes shipping zones.

shippingZoneCreate

Creates a new shipping zone.

shippingZoneDelete

Deletes a shipping zone.

shippingZoneUpdate

Updates a new shipping zone.

shopAddressUpdate

Update the shop's address. If the null value is passed, the currently selected address will be deleted.

shopDomainUpdate

Updates site domain of the shop.

shopFetchTaxRates

Fetch tax rates.

shopSettingsUpdate

Updates shop settings.

staffBulkDelete

Deletes staff users.

staffCreate

Creates a new staff user.

staffDelete

Deletes a staff user.

staffUpdate

Updates an existing staff user.

storefrontThemeCreate

Create a new storefront theme.

storefrontThemeUpdate

Update a storefront theme.

tenantUpdate

Update a tenant

tokenCreate

Create JWT token.

tokenCreateSso

Create JWT token (Also creates a user if not previously signed up)

tokenRefresh

Refresh JWT token. Mutation tries to take refreshToken from the input.If it fails it will try to take refreshToken from the http-only cookie -refreshToken. csrfToken is required when refreshToken is provided as a cookie.

tokenVerify

Verify JWT token.

tokensDeactivateAll

Deactivate all JWT tokens of the currently authenticated user.

userAddToPriceBook

Add a user to price book.

userAvatarDelete

Deletes a user avatar. Only for staff members.

userAvatarUpdate

Create a user avatar. Only for staff members. This mutation must be sent as a multipart request. More detailed specs of the upload format can be found here: https://github.com/jaydenseric/graphql-multipart-request-spec

userBulkSetActive

Activate or deactivate users.

userRemoveFromPriceBook

Removes a user from price book.

vendorOrderReturnFromStorefrontNotification

Adds return notification note to the order.

vendorPayoutCreate

Creates a VendorPayout for the specified seller in the payout if it does not already exist.

vendorPayoutNoteAdd

Adds note to the vendor payout.

vendorPayoutNoteUpdate

Edit a message in even from the vendor payout.

vendorPayoutOnboardingLinkRequest

Retrieves an onboarding link for the given vendor from the given gateway if available.

vendorPayoutStatusUpdate

Modifies the status of a vendor payout

vendorPayoutsBulkExclude

Exclude vendor payouts.

vendorPayoutsBulkInclude

Include vendor payouts.

vendorPayoutsBulkProcess

Process vendor payouts.

voucherBulkDelete

Deletes vouchers.

voucherCataloguesAdd

Adds products, variants, categories, or collections to a voucher.

voucherCataloguesRemove

Removes products, variants, categories, or collections from a voucher.

voucherCreate

Creates a new voucher.

voucherDelete

Deletes a voucher.

voucherUpdate

Updates a voucher.

warehouseCreate

Creates new warehouse.

warehouseDelete

Deletes selected warehouse.

warehouseUpdate

Updates given warehouse.

webhookCreate

Creates a new webhook subscription.

webhookDelete

Deletes a webhook subscription.

webhookUpdate

Updates a webhook subscription.

wishlistAddProduct

Add product to the current user's or target user's wishlist.

wishlistAddVariant

Add product variant to the current user's wishlist.

wishlistCreate

Creates a new wishlist

wishlistCreateForBuyer

Creates a new wishlist for any buyer if requestor is MPO

wishlistDelete

Update a wishlist

wishlistItemUpdate

Update a wishlist item

wishlistRemoveProduct

Remove product from the current user's wishlist.

wishlistRemoveVariant

Remove product variant from the current user's wishlist.

wishlistSetDefault

Set default wishlist for the user.

wishlistUpdate

Update a wishlist