MageSmith
40 queries · 75 mutations · Magento 2.4.9

Magento 2 GraphQL Explorer

Every Magento 2 GraphQL query and mutation grouped by module, with arguments, return types, resolver classes, and copy-paste headers, variables, body, and cURL.

Open interactive explorer →
All 115Queries 40Mutations 75

75 result(s) in Mutations · Clear

Mutation

addBundleProductsToCart

Add one or more bundle products to the specified cart. We recommend using `addProductsToCart` instead.

Bundle · returns AddBundleProductsToCartOutput

→
Mutation

addConfigurableProductsToCart

Add one or more configurable products to the specified cart. We recommend using `addProductsToCart` instead.

ConfigurableProduct · returns AddConfigurableProductsToCartOutput

→
Mutation

addDownloadableProductsToCart

Add one or more downloadable products to the specified cart. We recommend using `addProductsToCart` instead.

Downloadable · returns AddDownloadableProductsToCartOutput

→
Mutation

addProductsToCart

Add any type of product to the cart.

Quote · returns AddProductsToCartOutput

→
Mutation

addProductsToCompareList

Add products to the specified compare list.

CompareList · returns CompareList

→
Mutation

addProductsToNewCart

Creates a new cart and add any type of product to it

PaymentServicesPaypal · returns AddProductsToNewCartOutput

→
Mutation

addProductsToWishlist

Add one or more products to the specified wish list. This mutation supports all product types.

Wishlist · returns AddProductsToWishlistOutput

→
Mutation

addSimpleProductsToCart

Add one or more simple products to the specified cart. We recommend using `addProductsToCart` instead.

Quote · returns AddSimpleProductsToCartOutput

→
Mutation

addVirtualProductsToCart

Add one or more virtual products to the specified cart. We recommend using `addProductsToCart` instead.

Quote · returns AddVirtualProductsToCartOutput

→
Mutation

addWishlistItemsToCart

Add items in the specified wishlist to the customer's cart.

Wishlist · returns AddWishlistItemsToCartOutput

→
Mutation

applyCouponToCart

Apply a pre-defined coupon code to the specified cart.

Quote · returns ApplyCouponToCartOutput

→
Mutation

assignCompareListToCustomer

Assign the specified compare list to the logged in customer.

CompareList · returns AssignCompareListToCustomerOutput

→
Mutation

assignCustomerToGuestCart

phpcs:ignore Magento2.GraphQL.ValidArgumentName

Quote · returns Cart!

→
Mutation

cancelOrder

Cancel the specified customer order.

OrderCancellation · returns CancelOrderOutput

→
Mutation

changeCustomerPassword

Change the password for the logged-in customer.

Customer · returns Customer

→
Mutation

clearCart

Remove all items from the specified cart.

QuoteCommerceCe · returns ClearCartOutput!

→
Mutation

clearWishlist

Remove all the products from the specified wish list.

Wishlist · returns RemoveProductsFromWishlistOutput

→
Mutation

completeOrder

Synchronizes order details and place the order

PaymentServicesPaypal · returns PlaceOrderOutput

→
Mutation

confirmCancelOrder

Cancel the specified guest customer order.

OrderCancellation · returns CancelOrderOutput

→
Mutation

confirmEmail

Confirms the email address for a customer.

Customer · returns CustomerOutput

→
Mutation

contactUs

Send a 'Contact Us' email to the merchant.

Contact · returns ContactUsOutput

→
Mutation

createBraintreeClientToken

Creates Client Token for Braintree Javascript SDK initialization.

Braintree · returns String!

→
Mutation

createBraintreePayPalClientToken

Creates Client Token for Braintree PayPal Javascript SDK initialization.

Braintree · returns String!

→
Mutation

createBraintreePayPalVaultClientToken

Creates Client Token for Braintree PayPal Vault Javascript SDK initialization.

Braintree · returns String!

→
Mutation

createCompareList

Create a new compare list. The compare list is saved for logged in customers.

CompareList · returns CompareList

→
Mutation

createCustomer

Deprecated

Customer · returns CustomerOutput

→
Mutation

createCustomerAddress

Create a billing or shipping address for a customer or guest.

Customer · returns CustomerAddress

→
Mutation

createCustomerV2

Create a customer account.

Customer · returns CustomerOutput

→
Mutation

createEmptyCart

Deprecated

Create an empty shopping cart for a guest or logged in user

Quote · returns String

→
Mutation

createGuestCart

Create a new shopping cart

Quote · returns CreateGuestCartOutput

→
Mutation

createPayflowProToken

Initiate a transaction and receive a token. Use this mutation for Payflow Pro and Payments Pro payment methods

Paypal · returns CreatePayflowProTokenOutput

→
Mutation

createPaymentOrder

Creates a payment order for further payment processing

PaymentServicesPaypal · returns CreatePaymentOrderOutput

→
Mutation

createPaypalExpressToken

Initiate an Express Checkout transaction and receive a token. Use this mutation for Express Checkout and Payments Standard payment methods.

Paypal · returns PaypalExpressTokenOutput

→
Mutation

createProductReview

Create a product review for the specified product.

Review · returns CreateProductReviewOutput!

→
Mutation

createVaultCardPaymentToken

Creates a vault payment token

PaymentServicesPaypal · returns CreateVaultCardPaymentTokenOutput

→
Mutation

createVaultCardSetupToken

Creates a vault card setup token

PaymentServicesPaypal · returns CreateVaultCardSetupTokenOutput

→
Mutation

deleteCompareList

Delete the specified compare list.

CompareList · returns DeleteCompareListOutput

→
Mutation

deleteCustomer

Delete customer account

Customer · returns Boolean

→
Mutation

deleteCustomerAddress

Deprecated

Delete the billing or shipping address of a customer.

Customer · returns Boolean

→
Mutation

deleteCustomerAddressV2

Delete the billing or shipping address of a customer.

Customer · returns Boolean

→
Mutation

deletePaymentToken

phpcs:ignore Magento2.GraphQL.ValidArgumentName

Vault · returns DeletePaymentTokenOutput

→
Mutation

estimateShippingMethods

Estimate shipping method(s) for cart based on address

Quote · returns [AvailableShippingMethod]

→
Mutation

estimateTotals

Estimate totals for cart based on the address

Quote · returns EstimateTotalsOutput!

→
Mutation

generateCustomerToken

Generate a token for specified customer.

Customer · returns CustomerToken

→
Mutation

generateCustomerTokenAsAdmin

Request a customer token so that an administrator can perform remote shopping assistance.

LoginAsCustomer · returns GenerateCustomerTokenAsAdminOutput

→
Mutation

handlePayflowProResponse

Handle a payment response and save the payment in Quote. Use this mutation for Payflow Pro and Payments Pro payment methods.

Paypal · returns PayflowProResponseOutput

→
Mutation

mergeCarts

phpcs:ignore Magento2.GraphQL.ValidArgumentName

Quote · returns Cart!

→
Mutation

placeOrder

Convert the quote into an order.

Quote · returns PlaceOrderOutput

→
Mutation

removeCouponFromCart

Remove a previously-applied coupon from the cart. The cart must contain at least one item in order to remove the coupon.

Quote · returns RemoveCouponFromCartOutput

→
Mutation

removeItemFromCart

Delete the entire quantity of a specified item from the cart. If you remove all items from the cart, the cart continues to exist.

Quote · returns RemoveItemFromCartOutput

→
Mutation

removeProductsFromCompareList

Remove products from the specified compare list.

CompareList · returns CompareList

→
Mutation

removeProductsFromWishlist

Remove one or more products from the specified wish list.

Wishlist · returns RemoveProductsFromWishlistOutput

→
Mutation

reorderItems

Add all products from a customer's previous order to the cart.

Sales · returns ReorderItemsOutput

→
Mutation

requestGuestOrderCancel

Request to cancel specified guest order.

OrderCancellation · returns CancelOrderOutput

→
Mutation

requestPasswordResetEmail

Request an email with a reset password token for the registered customer identified by the specified email.

Customer · returns Boolean

→
Mutation

resendConfirmationEmail

Resends the confirmation email to a customer.

Customer · returns Boolean

→
Mutation

resetPassword

Reset a customer's password using the reset password token that the customer received in an email after requesting it using `requestPasswordResetEmail`.

Customer · returns Boolean

→
Mutation

revokeCustomerToken

Revoke the customer token.

Customer · returns RevokeCustomerTokenOutput

→
Mutation

sendEmailToFriend

Send a message on behalf of a customer to the specified email addresses.

SendFriend · returns SendEmailToFriendOutput

→
Mutation

setBillingAddressOnCart

Set the billing address on a specific cart.

Quote · returns SetBillingAddressOnCartOutput

→
Mutation

setCartAsInactive

Sets the cart as inactive

PaymentServicesPaypal · returns SetCartAsInactiveOutput

→
Mutation

setGuestEmailOnCart

Assign the email address of a guest to the cart.

Quote · returns SetGuestEmailOnCartOutput

→
Mutation

setPaymentMethodAndPlaceOrder

Deprecated

Set the cart payment method and convert the cart into an order.

Quote · returns PlaceOrderOutput

→
Mutation

setPaymentMethodOnCart

Apply a payment method to the cart.

Quote · returns SetPaymentMethodOnCartOutput

→
Mutation

setShippingAddressesOnCart

Set one or more shipping addresses on a specific cart.

Quote · returns SetShippingAddressesOnCartOutput

→
Mutation

setShippingMethodsOnCart

Set one or more delivery methods on a cart.

Quote · returns SetShippingMethodsOnCartOutput

→
Mutation

subscribeEmailToNewsletter

Subscribe the specified email to the store's newsletter.

Newsletter · returns SubscribeEmailToNewsletterOutput

→
Mutation

syncPaymentOrder

Synchronizes the payment order details for further payment processing

PaymentServicesPaypal · returns Boolean

→
Mutation

updateCartItems

Modify items in the cart.

Quote · returns UpdateCartItemsOutput

→
Mutation

updateCustomer

Deprecated

Customer · returns CustomerOutput

→
Mutation

updateCustomerAddress

Deprecated

Update the billing or shipping address of a customer or guest.

Customer · returns CustomerAddress

→
Mutation

updateCustomerAddressV2

Update the billing or shipping address of a customer or guest.

Customer · returns CustomerAddress

→
Mutation

updateCustomerEmail

Change the email address for the logged-in customer.

Customer · returns CustomerOutput

→
Mutation

updateCustomerV2

Update the customer's personal information.

Customer · returns CustomerOutput

→
Mutation

updateProductsInWishlist

Update one or more products in the specified wish list.

Wishlist · returns UpdateProductsInWishlistOutput

→
Last verified: against Magento 2.4.9.

Every Magento dev tool, in one hosted workspace.

Free to sign up. Nothing to install. Drafts, audits, and projects saved across every tool.

Open app →