Mutation Object
Fields
#
accountAddressSetDefault
Sets a default address for the authenticated user.
accountRequestDeletion
Sends an email with the account removal link for the logged-in user.
affiliateAvatarUpdate
Create an affiliate avatar. 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
affiliateBulkDelete
Deletes affiliates.
affiliateCodeBulkSetActive
Activate or deactivate affiliate codes.
affiliateCodeChannelUpdate
Updates an affiliate code channel
affiliateCodeCreate
Creates a new affiliate code
affiliateCodeSetActive
Sets whether code is active
affiliateCodeUse
Increments affiliate code uses
affiliateCreate
Creates a new affiliate.
affiliateDelete
Deletes a affiliate.
affiliateUpdate
Updates an existing affiliate.
assignNavigation
Assigns storefront's navigation menus.
bidAccept
Accepts the specificed bid.
bidCreate
Creates a new Bid.
bidReject
Rejects the specificed bid.
brandingImagesDelete
Delete branding images.
catalogExport
Export catalog.
channelCreate
Creates a new channel
channelUpdate
Updates a channel.
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.
checkoutCustomerDetach
Removes the user assigned as the owner of the checkout.
checkoutMarketplaceShippingMethodUpdate
Updates the marketplace shipping methods of the 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.
coreDataUpdate
Update existing core data instance, return ok = True and coredata = None if no matching core data instance found.
customAttributeUnassign
Un-assign attributes from a given custom field template.
dashboardConfigurationUpdate
Updates dashboard configuration.
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
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.
documentRemove
Delete or detach a document. Must only receive one of either target_ids or delete = True in input.
draftOrderLinePriceOverride
Overrides unit net price of an order line of a draft, quote, or offer order.
draftOrderSetTransactionCurrency
Update currency in the existing draft order object.
exchangeRatesRefresh
Refreshes currency exchange rates. Must have a currency exchange app enabled in the app marketplace.
fulfillmentBulkReturn
Processes return requests by grabbing the return status and
groupedProductAddProducts
Adds products to a grouped product.
groupedProductRemoveProducts
Remove products from a grouped product.
instanceAttributeUnassign
Unassign the specified attribute from an instance.
journalEntryBackfill
Backfill all orders and refunds that are not connected to a VendorPayout into the ledger system. The actual backfill will run asynchronously in a task.
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.
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.
nauticalHistoricalOrderCreate
Creates a new Nautical historical order.
nauticalOrderChannelUpdate
Updates a marketplace order channel.
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
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.
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.
nauticalQuoteOrderSendToCustomer
Sends a quote order to a customer.
orderChannelUpdate
Updates an order channel
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.
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.
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
orderOfferConvertToNauticalQuoteOrder
Converts a seller or marketplace offer order to a nautical quote order.
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.
payoutUpdate
Update vendor payouts connected to the given payout with adjustments and penalties
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
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.
productReviewSubmit
Submit a rating and review for a product.
productSetAvailabilityForPurchase
Set product availability for purchase date.
productSetLocationType
Sets a location 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.
productVariantSetDefault
Set default variant for a product. Mutation triggers PRODUCT_UPDATED webhook.
refundPaymentsDelete
Deletes specified refund payments. The refund must be in the PROCESSING state.
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
saleCataloguesRemove
Removes products, variants, categories, or collections from a sale.
sellerAgreementAcknowledge
Acknowledge the seller agreement for seller id
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
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
sellerOnboardingChecklistComplete
Marks manually one checklist item as completed.
sellerOnboardingSettingsCreate
Create new seller onboarding settings.
sellerOwnerDelete
Removes the user owner from a seller (including user's membership in the seller)
sellerWithOwnerCreate
Create new Seller and a new staff user and assign created user as Seller owner.
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.
shopSettingsUpdate
Updates shop settings.
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.
tokensDeactivateAll
Deactivate all JWT tokens of the currently authenticated user.
updatePeriodicTaskEnabled
Update whether process_pending_webhook_transactions periodic django celery beat task is enabled
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
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.
vendorPayoutOnboardingLinkRequest
Retrieves an onboarding link for the given vendor from the given gateway if available.
voucherCataloguesAdd
Adds products, variants, categories, or collections to a voucher.
voucherCataloguesRemove
Removes products, variants, categories, or collections from a voucher.
wishlistCreateForBuyer
Creates a new wishlist for any buyer if requestor is MPO
wishlistRemoveVariant
Remove product variant from the current user's wishlist.