com.adobe.cq.commerce.magento.graphql

Class MutationQuery

java.lang.Object

com.shopify.graphql.support.AbstractQuery<MutationQuery>

com.adobe.cq.commerce.magento.graphql.MutationQuery

public class MutationQuery
extends AbstractQuery<MutationQuery>

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	MutationQuery.AddBundleProductsToCartArguments
static interface	MutationQuery.AddBundleProductsToCartArgumentsDefinition
class	MutationQuery.AddConfigurableProductsToCartArguments
static interface	MutationQuery.AddConfigurableProductsToCartArgumentsDefinition
class	MutationQuery.AddDownloadableProductsToCartArguments
static interface	MutationQuery.AddDownloadableProductsToCartArgumentsDefinition
class	MutationQuery.AddProductsToCompareListArguments
static interface	MutationQuery.AddProductsToCompareListArgumentsDefinition
class	MutationQuery.AddSimpleProductsToCartArguments
static interface	MutationQuery.AddSimpleProductsToCartArgumentsDefinition
class	MutationQuery.AddVirtualProductsToCartArguments
static interface	MutationQuery.AddVirtualProductsToCartArgumentsDefinition
class	MutationQuery.ApplyCouponToCartArguments
static interface	MutationQuery.ApplyCouponToCartArgumentsDefinition
class	MutationQuery.ApplyGiftCardToCartArguments
static interface	MutationQuery.ApplyGiftCardToCartArgumentsDefinition
class	MutationQuery.CreateCompareListArguments
static interface	MutationQuery.CreateCompareListArgumentsDefinition
class	MutationQuery.CreateEmptyCartArguments
static interface	MutationQuery.CreateEmptyCartArgumentsDefinition
class	MutationQuery.CreateKlarnaPaymentsSessionArguments
static interface	MutationQuery.CreateKlarnaPaymentsSessionArgumentsDefinition
class	MutationQuery.MergeCartsArguments
static interface	MutationQuery.MergeCartsArgumentsDefinition
class	MutationQuery.PlaceOrderArguments
static interface	MutationQuery.PlaceOrderArgumentsDefinition
class	MutationQuery.RemoveCouponFromCartArguments
static interface	MutationQuery.RemoveCouponFromCartArgumentsDefinition
class	MutationQuery.RemoveGiftCardFromCartArguments
static interface	MutationQuery.RemoveGiftCardFromCartArgumentsDefinition
class	MutationQuery.RemoveItemFromCartArguments
static interface	MutationQuery.RemoveItemFromCartArgumentsDefinition
class	MutationQuery.RemoveProductsFromCompareListArguments
static interface	MutationQuery.RemoveProductsFromCompareListArgumentsDefinition
class	MutationQuery.SendEmailToFriendArguments
static interface	MutationQuery.SendEmailToFriendArgumentsDefinition
class	MutationQuery.SetBillingAddressOnCartArguments
static interface	MutationQuery.SetBillingAddressOnCartArgumentsDefinition
class	MutationQuery.SetGiftOptionsOnCartArguments
static interface	MutationQuery.SetGiftOptionsOnCartArgumentsDefinition
class	MutationQuery.SetGuestEmailOnCartArguments
static interface	MutationQuery.SetGuestEmailOnCartArgumentsDefinition
class	MutationQuery.SetPaymentMethodAndPlaceOrderArguments
static interface	MutationQuery.SetPaymentMethodAndPlaceOrderArgumentsDefinition
class	MutationQuery.SetPaymentMethodOnCartArguments
static interface	MutationQuery.SetPaymentMethodOnCartArgumentsDefinition
class	MutationQuery.SetShippingAddressesOnCartArguments
static interface	MutationQuery.SetShippingAddressesOnCartArgumentsDefinition
class	MutationQuery.SetShippingMethodsOnCartArguments
static interface	MutationQuery.SetShippingMethodsOnCartArgumentsDefinition
class	MutationQuery.UpdateCartItemsArguments
static interface	MutationQuery.UpdateCartItemsArgumentsDefinition
class	MutationQuery.UpdateCustomerAddressArguments
static interface	MutationQuery.UpdateCustomerAddressArgumentsDefinition
class	MutationQuery.UpdateWishlistArguments
static interface	MutationQuery.UpdateWishlistArgumentsDefinition

Field Summary

Fields inherited from class com.shopify.graphql.support.AbstractQuery

_queryBuilder, ALIAS_SUFFIX_SEPARATOR, CUSTOM_FIELD_LABEL

Method Summary

Modifier and Type	Method and Description
MutationQuery	addBundleProductsToCart(AddBundleProductsToCartOutputQueryDefinition queryDef)
MutationQuery	addBundleProductsToCart(MutationQuery.AddBundleProductsToCartArgumentsDefinition argsDef, AddBundleProductsToCartOutputQueryDefinition queryDef)
MutationQuery	addConfigurableProductsToCart(AddConfigurableProductsToCartOutputQueryDefinition queryDef)
MutationQuery	addConfigurableProductsToCart(MutationQuery.AddConfigurableProductsToCartArgumentsDefinition argsDef, AddConfigurableProductsToCartOutputQueryDefinition queryDef)
MutationQuery	addDownloadableProductsToCart(AddDownloadableProductsToCartOutputQueryDefinition queryDef)
MutationQuery	addDownloadableProductsToCart(MutationQuery.AddDownloadableProductsToCartArgumentsDefinition argsDef, AddDownloadableProductsToCartOutputQueryDefinition queryDef)
MutationQuery	addFragment(Fragment fragment) Adds a GraphQL "named" fragment to the query.
MutationQuery	addFragmentReference(Fragment<MutationQuery> fragment) Adds a MutationQuery fragment reference at the current position of the query.
MutationQuery	addProductsToCart(String cartId, List<CartItemInput> cartItems, AddProductsToCartOutputQueryDefinition queryDef) Add any type of product to the cart
MutationQuery	addProductsToCompareList(CompareListQueryDefinition queryDef) Add products to the specified compare list
MutationQuery	addProductsToCompareList(MutationQuery.AddProductsToCompareListArgumentsDefinition argsDef, CompareListQueryDefinition queryDef) Add products to the specified compare list
MutationQuery	addProductsToWishlist(ID wishlistId, List<WishlistItemInput> wishlistItems, AddProductsToWishlistOutputQueryDefinition queryDef) Adds one or more products to the specified wish list.
MutationQuery	addReturnComment(AddReturnCommentInput input, AddReturnCommentOutputQueryDefinition queryDef) Add a comment to an existing return
MutationQuery	addReturnTracking(AddReturnTrackingInput input, AddReturnTrackingOutputQueryDefinition queryDef) Add tracking information to the return
MutationQuery	addSimpleProductsToCart(AddSimpleProductsToCartOutputQueryDefinition queryDef)
MutationQuery	addSimpleProductsToCart(MutationQuery.AddSimpleProductsToCartArgumentsDefinition argsDef, AddSimpleProductsToCartOutputQueryDefinition queryDef)
MutationQuery	addVirtualProductsToCart(AddVirtualProductsToCartOutputQueryDefinition queryDef)
MutationQuery	addVirtualProductsToCart(MutationQuery.AddVirtualProductsToCartArgumentsDefinition argsDef, AddVirtualProductsToCartOutputQueryDefinition queryDef)
MutationQuery	applyCouponToCart(ApplyCouponToCartOutputQueryDefinition queryDef)
MutationQuery	applyCouponToCart(MutationQuery.ApplyCouponToCartArgumentsDefinition argsDef, ApplyCouponToCartOutputQueryDefinition queryDef)
MutationQuery	applyGiftCardToCart(ApplyGiftCardToCartOutputQueryDefinition queryDef) Apply a pre-defined gift card code to the specified cart.
MutationQuery	applyGiftCardToCart(MutationQuery.ApplyGiftCardToCartArgumentsDefinition argsDef, ApplyGiftCardToCartOutputQueryDefinition queryDef) Apply a pre-defined gift card code to the specified cart.
MutationQuery	applyRewardPointsToCart(ID cartId, ApplyRewardPointsToCartOutputQueryDefinition queryDef) Apply all available points, up to the cart total.
MutationQuery	applyStoreCreditToCart(ApplyStoreCreditToCartInput input, ApplyStoreCreditToCartOutputQueryDefinition queryDef) Apply store credit to the specified cart.
MutationQuery	assignCompareListToCustomer(ID uid, AssignCompareListToCustomerOutputQueryDefinition queryDef) Assign the specified compare list to the logged in customer
MutationQuery	changeCustomerPassword(String currentPassword, String newPassword, CustomerQueryDefinition queryDef) Changes the password for the logged-in customer
MutationQuery	copyProductsBetweenWishlists(ID sourceWishlistUid, ID destinationWishlistUid, List<WishlistItemCopyInput> wishlistItems, CopyProductsBetweenWishlistsOutputQueryDefinition queryDef) Copy products from one wish list to another
MutationQuery	createBraintreeClientToken() Creates Client Token for Braintree Javascript SDK initialization.
MutationQuery	createCompareList(CompareListQueryDefinition queryDef) Creates a new compare list.
MutationQuery	createCompareList(MutationQuery.CreateCompareListArgumentsDefinition argsDef, CompareListQueryDefinition queryDef) Creates a new compare list.
MutationQuery	createCustomer(CustomerInput input, CustomerOutputQueryDefinition queryDef) Create customer account
MutationQuery	createCustomerAddress(CustomerAddressInput input, CustomerAddressQueryDefinition queryDef) Create customer address
MutationQuery	createCustomerV2(CustomerCreateInput input, CustomerOutputQueryDefinition queryDef) Create customer account
MutationQuery	createEmptyCart() Creates an empty shopping cart for a guest or logged in user
MutationQuery	createEmptyCart(MutationQuery.CreateEmptyCartArgumentsDefinition argsDef) Creates an empty shopping cart for a guest or logged in user
static Fragment<MutationQuery>	createFragment(String name, MutationQueryDefinition queryDef) Creates a GraphQL "named" fragment with the specified query type definition.
MutationQuery	createKlarnaPaymentsSession(createKlarnaPaymentsSessionOutputQueryDefinition queryDef) Creates a Klarna Payments Session.
MutationQuery	createKlarnaPaymentsSession(MutationQuery.CreateKlarnaPaymentsSessionArgumentsDefinition argsDef, createKlarnaPaymentsSessionOutputQueryDefinition queryDef) Creates a Klarna Payments Session.
MutationQuery	createPayflowProToken(PayflowProTokenInput input, CreatePayflowProTokenOutputQueryDefinition queryDef) Initiates a transaction and receives a token.
MutationQuery	createPaypalExpressToken(PaypalExpressTokenInput input, PaypalExpressTokenOutputQueryDefinition queryDef) Initiates an Express Checkout transaction and receives a token.
MutationQuery	createProductReview(CreateProductReviewInput input, CreateProductReviewOutputQueryDefinition queryDef) Creates a product review for the specified SKU
MutationQuery	createWishlist(CreateWishlistInput input, CreateWishlistOutputQueryDefinition queryDef) Create a new wish list
MutationQuery	deleteCompareList(ID uid, DeleteCompareListOutputQueryDefinition queryDef) Delete the specified compare list
MutationQuery	deleteCustomerAddress(int id) Delete customer address
MutationQuery	deletePaymentToken(String publicHash, DeletePaymentTokenOutputQueryDefinition queryDef) Delete a customer payment token
MutationQuery	deleteWishlist(ID wishlistId, DeleteWishlistOutputQueryDefinition queryDef) Delete the specified wish list filtered by the unique ID for a `Wishlist` object
MutationQuery	generateCustomerToken(String email, String password, CustomerTokenQueryDefinition queryDef) Retrieve the customer token
MutationQuery	generateCustomerTokenAsAdmin(GenerateCustomerTokenAsAdminInput input, GenerateCustomerTokenAsAdminOutputQueryDefinition queryDef) Request a customer token so that an administrator can perform remote shopping assistance
MutationQuery	handlePayflowProResponse(PayflowProResponseInput input, PayflowProResponseOutputQueryDefinition queryDef) Handles payment response and saves payment in Quote.
MutationQuery	mergeCarts(String sourceCartId, CartQueryDefinition queryDef) Merges the source cart into the destination cart
MutationQuery	mergeCarts(String sourceCartId, MutationQuery.MergeCartsArgumentsDefinition argsDef, CartQueryDefinition queryDef) Merges the source cart into the destination cart
MutationQuery	moveProductsBetweenWishlists(ID sourceWishlistUid, ID destinationWishlistUid, List<WishlistItemMoveInput> wishlistItems, MoveProductsBetweenWishlistsOutputQueryDefinition queryDef) Move products from one wish list to another
MutationQuery	placeOrder(MutationQuery.PlaceOrderArgumentsDefinition argsDef, PlaceOrderOutputQueryDefinition queryDef)
MutationQuery	placeOrder(PlaceOrderOutputQueryDefinition queryDef)
MutationQuery	redeemGiftCardBalanceAsStoreCredit(GiftCardAccountInput input, GiftCardAccountQueryDefinition queryDef) Redeem gift card for store credit.
MutationQuery	removeCouponFromCart(MutationQuery.RemoveCouponFromCartArgumentsDefinition argsDef, RemoveCouponFromCartOutputQueryDefinition queryDef)
MutationQuery	removeCouponFromCart(RemoveCouponFromCartOutputQueryDefinition queryDef)
MutationQuery	removeGiftCardFromCart(MutationQuery.RemoveGiftCardFromCartArgumentsDefinition argsDef, RemoveGiftCardFromCartOutputQueryDefinition queryDef)
MutationQuery	removeGiftCardFromCart(RemoveGiftCardFromCartOutputQueryDefinition queryDef)
MutationQuery	removeItemFromCart(MutationQuery.RemoveItemFromCartArgumentsDefinition argsDef, RemoveItemFromCartOutputQueryDefinition queryDef)
MutationQuery	removeItemFromCart(RemoveItemFromCartOutputQueryDefinition queryDef)
MutationQuery	removeProductsFromCompareList(CompareListQueryDefinition queryDef) Remove products from the specified compare list
MutationQuery	removeProductsFromCompareList(MutationQuery.RemoveProductsFromCompareListArgumentsDefinition argsDef, CompareListQueryDefinition queryDef) Remove products from the specified compare list
MutationQuery	removeProductsFromWishlist(ID wishlistId, List<ID> wishlistItemsIds, RemoveProductsFromWishlistOutputQueryDefinition queryDef) Removes one or more products from the specified wish list
MutationQuery	removeReturnTracking(RemoveReturnTrackingInput input, RemoveReturnTrackingOutputQueryDefinition queryDef) Remove a tracked shipment from a return
MutationQuery	removeRewardPointsFromCart(ID cartId, RemoveRewardPointsFromCartOutputQueryDefinition queryDef) Cancel the application of reward points to the cart
MutationQuery	removeStoreCreditFromCart(RemoveStoreCreditFromCartInput input, RemoveStoreCreditFromCartOutputQueryDefinition queryDef) Remove applied store credit from the specified cart.
MutationQuery	reorderItems(String orderNumber, ReorderItemsOutputQueryDefinition queryDef) Adds all products from a customer's previous order to the cart.
MutationQuery	requestPasswordResetEmail(String email) Request an email with a reset password token for the registered customer identified by the specified email.
MutationQuery	requestReturn(RequestReturnInput input, RequestReturnOutputQueryDefinition queryDef) Initiates a buyer's request to return an item for replacement or refund
MutationQuery	resetPassword(String email, String resetPasswordToken, String newPassword) Reset a customer's password using the reset password token that the customer received in an email after requesting it using requestPasswordResetEmail.
MutationQuery	revokeCustomerToken(RevokeCustomerTokenOutputQueryDefinition queryDef) Revoke the customer token
MutationQuery	sendEmailToFriend(MutationQuery.SendEmailToFriendArgumentsDefinition argsDef, SendEmailToFriendOutputQueryDefinition queryDef) Recommends Product by Sending Single/Multiple Email
MutationQuery	sendEmailToFriend(SendEmailToFriendOutputQueryDefinition queryDef) Recommends Product by Sending Single/Multiple Email
MutationQuery	setBillingAddressOnCart(MutationQuery.SetBillingAddressOnCartArgumentsDefinition argsDef, SetBillingAddressOnCartOutputQueryDefinition queryDef)
MutationQuery	setBillingAddressOnCart(SetBillingAddressOnCartOutputQueryDefinition queryDef)
MutationQuery	setGiftOptionsOnCart(MutationQuery.SetGiftOptionsOnCartArgumentsDefinition argsDef, SetGiftOptionsOnCartOutputQueryDefinition queryDef) Set gift options like gift wrapping or gift message for the entire cart
MutationQuery	setGiftOptionsOnCart(SetGiftOptionsOnCartOutputQueryDefinition queryDef) Set gift options like gift wrapping or gift message for the entire cart
MutationQuery	setGuestEmailOnCart(MutationQuery.SetGuestEmailOnCartArgumentsDefinition argsDef, SetGuestEmailOnCartOutputQueryDefinition queryDef)
MutationQuery	setGuestEmailOnCart(SetGuestEmailOnCartOutputQueryDefinition queryDef)
MutationQuery	setPaymentMethodAndPlaceOrder(MutationQuery.SetPaymentMethodAndPlaceOrderArgumentsDefinition argsDef, PlaceOrderOutputQueryDefinition queryDef) Deprecated. Should use setPaymentMethodOnCart and placeOrder mutations in single request.
MutationQuery	setPaymentMethodAndPlaceOrder(PlaceOrderOutputQueryDefinition queryDef) Deprecated. Should use setPaymentMethodOnCart and placeOrder mutations in single request.
MutationQuery	setPaymentMethodOnCart(MutationQuery.SetPaymentMethodOnCartArgumentsDefinition argsDef, SetPaymentMethodOnCartOutputQueryDefinition queryDef)
MutationQuery	setPaymentMethodOnCart(SetPaymentMethodOnCartOutputQueryDefinition queryDef)
MutationQuery	setShippingAddressesOnCart(MutationQuery.SetShippingAddressesOnCartArgumentsDefinition argsDef, SetShippingAddressesOnCartOutputQueryDefinition queryDef)
MutationQuery	setShippingAddressesOnCart(SetShippingAddressesOnCartOutputQueryDefinition queryDef)
MutationQuery	setShippingMethodsOnCart(MutationQuery.SetShippingMethodsOnCartArgumentsDefinition argsDef, SetShippingMethodsOnCartOutputQueryDefinition queryDef)
MutationQuery	setShippingMethodsOnCart(SetShippingMethodsOnCartOutputQueryDefinition queryDef)
MutationQuery	subscribeEmailToNewsletter(String email, SubscribeEmailToNewsletterOutputQueryDefinition queryDef) Subscribes the specified email to a newsletter
String	toString()
MutationQuery	updateCartItems(MutationQuery.UpdateCartItemsArgumentsDefinition argsDef, UpdateCartItemsOutputQueryDefinition queryDef)
MutationQuery	updateCartItems(UpdateCartItemsOutputQueryDefinition queryDef)
MutationQuery	updateCustomer(CustomerInput input, CustomerOutputQueryDefinition queryDef) Deprecated.
MutationQuery	updateCustomerAddress(int id, CustomerAddressQueryDefinition queryDef) Update customer address
MutationQuery	updateCustomerAddress(int id, MutationQuery.UpdateCustomerAddressArgumentsDefinition argsDef, CustomerAddressQueryDefinition queryDef) Update customer address
MutationQuery	updateCustomerEmail(String email, String password, CustomerOutputQueryDefinition queryDef)
MutationQuery	updateCustomerV2(CustomerUpdateInput input, CustomerOutputQueryDefinition queryDef) Update the customer's personal information
MutationQuery	updateProductsInWishlist(ID wishlistId, List<WishlistItemUpdateInput> wishlistItems, UpdateProductsInWishlistOutputQueryDefinition queryDef) Updates one or more products in the specified wish list
MutationQuery	updateWishlist(ID wishlistId, MutationQuery.UpdateWishlistArgumentsDefinition argsDef, UpdateWishlistOutputQueryDefinition queryDef) Change the name and visibility of the specified wish list
MutationQuery	updateWishlist(ID wishlistId, UpdateWishlistOutputQueryDefinition queryDef) Change the name and visibility of the specified wish list

Methods inherited from class com.shopify.graphql.support.AbstractQuery

addCustomObjectField, addCustomSimpleField, appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

addBundleProductsToCart

public MutationQuery addBundleProductsToCart(AddBundleProductsToCartOutputQueryDefinition queryDef)

addBundleProductsToCart

public MutationQuery addBundleProductsToCart(MutationQuery.AddBundleProductsToCartArgumentsDefinition argsDef,
                                             AddBundleProductsToCartOutputQueryDefinition queryDef)

addConfigurableProductsToCart

public MutationQuery addConfigurableProductsToCart(AddConfigurableProductsToCartOutputQueryDefinition queryDef)

addConfigurableProductsToCart

public MutationQuery addConfigurableProductsToCart(MutationQuery.AddConfigurableProductsToCartArgumentsDefinition argsDef,
                                                   AddConfigurableProductsToCartOutputQueryDefinition queryDef)

addDownloadableProductsToCart

public MutationQuery addDownloadableProductsToCart(AddDownloadableProductsToCartOutputQueryDefinition queryDef)

addDownloadableProductsToCart

public MutationQuery addDownloadableProductsToCart(MutationQuery.AddDownloadableProductsToCartArgumentsDefinition argsDef,
                                                   AddDownloadableProductsToCartOutputQueryDefinition queryDef)

addProductsToCart

public MutationQuery addProductsToCart(String cartId,
                                       List<CartItemInput> cartItems,
                                       AddProductsToCartOutputQueryDefinition queryDef)

Add any type of product to the cart

addProductsToCompareList

public MutationQuery addProductsToCompareList(CompareListQueryDefinition queryDef)

Add products to the specified compare list

addProductsToCompareList

public MutationQuery addProductsToCompareList(MutationQuery.AddProductsToCompareListArgumentsDefinition argsDef,
                                              CompareListQueryDefinition queryDef)

Add products to the specified compare list

addProductsToWishlist

public MutationQuery addProductsToWishlist(ID wishlistId,
                                           List<WishlistItemInput> wishlistItems,
                                           AddProductsToWishlistOutputQueryDefinition queryDef)

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

addReturnComment

public MutationQuery addReturnComment(AddReturnCommentInput input,
                                      AddReturnCommentOutputQueryDefinition queryDef)

Add a comment to an existing return

addReturnTracking

public MutationQuery addReturnTracking(AddReturnTrackingInput input,
                                       AddReturnTrackingOutputQueryDefinition queryDef)

Add tracking information to the return

addSimpleProductsToCart

public MutationQuery addSimpleProductsToCart(AddSimpleProductsToCartOutputQueryDefinition queryDef)

addSimpleProductsToCart

public MutationQuery addSimpleProductsToCart(MutationQuery.AddSimpleProductsToCartArgumentsDefinition argsDef,
                                             AddSimpleProductsToCartOutputQueryDefinition queryDef)

addVirtualProductsToCart

public MutationQuery addVirtualProductsToCart(AddVirtualProductsToCartOutputQueryDefinition queryDef)

addVirtualProductsToCart

public MutationQuery addVirtualProductsToCart(MutationQuery.AddVirtualProductsToCartArgumentsDefinition argsDef,
                                              AddVirtualProductsToCartOutputQueryDefinition queryDef)

applyCouponToCart

public MutationQuery applyCouponToCart(ApplyCouponToCartOutputQueryDefinition queryDef)

applyCouponToCart

public MutationQuery applyCouponToCart(MutationQuery.ApplyCouponToCartArgumentsDefinition argsDef,
                                       ApplyCouponToCartOutputQueryDefinition queryDef)

applyGiftCardToCart

public MutationQuery applyGiftCardToCart(ApplyGiftCardToCartOutputQueryDefinition queryDef)

Apply a pre-defined gift card code to the specified cart.

applyGiftCardToCart

public MutationQuery applyGiftCardToCart(MutationQuery.ApplyGiftCardToCartArgumentsDefinition argsDef,
                                         ApplyGiftCardToCartOutputQueryDefinition queryDef)

Apply a pre-defined gift card code to the specified cart.

applyRewardPointsToCart

public MutationQuery applyRewardPointsToCart(ID cartId,
                                             ApplyRewardPointsToCartOutputQueryDefinition queryDef)

Apply all available points, up to the cart total. Partial redemption is not available

applyStoreCreditToCart

public MutationQuery applyStoreCreditToCart(ApplyStoreCreditToCartInput input,
                                            ApplyStoreCreditToCartOutputQueryDefinition queryDef)

Apply store credit to the specified cart.

assignCompareListToCustomer

public MutationQuery assignCompareListToCustomer(ID uid,
                                                 AssignCompareListToCustomerOutputQueryDefinition queryDef)

Assign the specified compare list to the logged in customer

changeCustomerPassword

public MutationQuery changeCustomerPassword(String currentPassword,
                                            String newPassword,
                                            CustomerQueryDefinition queryDef)

Changes the password for the logged-in customer

copyProductsBetweenWishlists

public MutationQuery copyProductsBetweenWishlists(ID sourceWishlistUid,
                                                  ID destinationWishlistUid,
                                                  List<WishlistItemCopyInput> wishlistItems,
                                                  CopyProductsBetweenWishlistsOutputQueryDefinition queryDef)

Copy products from one wish list to another

createBraintreeClientToken

public MutationQuery createBraintreeClientToken()

Creates Client Token for Braintree Javascript SDK initialization.

createCompareList

public MutationQuery createCompareList(CompareListQueryDefinition queryDef)

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

createCompareList

public MutationQuery createCompareList(MutationQuery.CreateCompareListArgumentsDefinition argsDef,
                                       CompareListQueryDefinition queryDef)

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

createCustomer

public MutationQuery createCustomer(CustomerInput input,
                                    CustomerOutputQueryDefinition queryDef)

Create customer account

createCustomerAddress

public MutationQuery createCustomerAddress(CustomerAddressInput input,
                                           CustomerAddressQueryDefinition queryDef)

Create customer address

createCustomerV2

public MutationQuery createCustomerV2(CustomerCreateInput input,
                                      CustomerOutputQueryDefinition queryDef)

Create customer account

createEmptyCart

public MutationQuery createEmptyCart()

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

createEmptyCart

public MutationQuery createEmptyCart(MutationQuery.CreateEmptyCartArgumentsDefinition argsDef)

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

createKlarnaPaymentsSession

public MutationQuery createKlarnaPaymentsSession(createKlarnaPaymentsSessionOutputQueryDefinition queryDef)

Creates a Klarna Payments Session.

createKlarnaPaymentsSession

public MutationQuery createKlarnaPaymentsSession(MutationQuery.CreateKlarnaPaymentsSessionArgumentsDefinition argsDef,
                                                 createKlarnaPaymentsSessionOutputQueryDefinition queryDef)

Creates a Klarna Payments Session.

createPayflowProToken

public MutationQuery createPayflowProToken(PayflowProTokenInput input,
                                           CreatePayflowProTokenOutputQueryDefinition queryDef)

Initiates a transaction and receives a token. Use this mutation for Payflow Pro and Payments Pro payment methods

createPaypalExpressToken

public MutationQuery createPaypalExpressToken(PaypalExpressTokenInput input,
                                              PaypalExpressTokenOutputQueryDefinition queryDef)

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

createProductReview

public MutationQuery createProductReview(CreateProductReviewInput input,
                                         CreateProductReviewOutputQueryDefinition queryDef)

Creates a product review for the specified SKU

createWishlist

public MutationQuery createWishlist(CreateWishlistInput input,
                                    CreateWishlistOutputQueryDefinition queryDef)

Create a new wish list

deleteCompareList

public MutationQuery deleteCompareList(ID uid,
                                       DeleteCompareListOutputQueryDefinition queryDef)

Delete the specified compare list

deleteCustomerAddress

public MutationQuery deleteCustomerAddress(int id)

Delete customer address

deletePaymentToken

public MutationQuery deletePaymentToken(String publicHash,
                                        DeletePaymentTokenOutputQueryDefinition queryDef)

Delete a customer payment token

deleteWishlist

public MutationQuery deleteWishlist(ID wishlistId,
                                    DeleteWishlistOutputQueryDefinition queryDef)

Delete the specified wish list filtered by the unique ID for a `Wishlist` object

generateCustomerToken

public MutationQuery generateCustomerToken(String email,
                                           String password,
                                           CustomerTokenQueryDefinition queryDef)

Retrieve the customer token

generateCustomerTokenAsAdmin

public MutationQuery generateCustomerTokenAsAdmin(GenerateCustomerTokenAsAdminInput input,
                                                  GenerateCustomerTokenAsAdminOutputQueryDefinition queryDef)

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

handlePayflowProResponse

public MutationQuery handlePayflowProResponse(PayflowProResponseInput input,
                                              PayflowProResponseOutputQueryDefinition queryDef)

Handles payment response and saves payment in Quote. Use this mutations for Payflow Pro and Payments Pro payment methods.

mergeCarts

public MutationQuery mergeCarts(String sourceCartId,
                                CartQueryDefinition queryDef)

Merges the source cart into the destination cart

mergeCarts

public MutationQuery mergeCarts(String sourceCartId,
                                MutationQuery.MergeCartsArgumentsDefinition argsDef,
                                CartQueryDefinition queryDef)

Merges the source cart into the destination cart

moveProductsBetweenWishlists

public MutationQuery moveProductsBetweenWishlists(ID sourceWishlistUid,
                                                  ID destinationWishlistUid,
                                                  List<WishlistItemMoveInput> wishlistItems,
                                                  MoveProductsBetweenWishlistsOutputQueryDefinition queryDef)

Move products from one wish list to another

placeOrder

public MutationQuery placeOrder(PlaceOrderOutputQueryDefinition queryDef)

placeOrder

public MutationQuery placeOrder(MutationQuery.PlaceOrderArgumentsDefinition argsDef,
                                PlaceOrderOutputQueryDefinition queryDef)

redeemGiftCardBalanceAsStoreCredit

public MutationQuery redeemGiftCardBalanceAsStoreCredit(GiftCardAccountInput input,
                                                        GiftCardAccountQueryDefinition queryDef)

Redeem gift card for store credit.

removeCouponFromCart

public MutationQuery removeCouponFromCart(RemoveCouponFromCartOutputQueryDefinition queryDef)

removeCouponFromCart

public MutationQuery removeCouponFromCart(MutationQuery.RemoveCouponFromCartArgumentsDefinition argsDef,
                                          RemoveCouponFromCartOutputQueryDefinition queryDef)

removeGiftCardFromCart

public MutationQuery removeGiftCardFromCart(RemoveGiftCardFromCartOutputQueryDefinition queryDef)

removeGiftCardFromCart

public MutationQuery removeGiftCardFromCart(MutationQuery.RemoveGiftCardFromCartArgumentsDefinition argsDef,
                                            RemoveGiftCardFromCartOutputQueryDefinition queryDef)

removeItemFromCart

public MutationQuery removeItemFromCart(RemoveItemFromCartOutputQueryDefinition queryDef)

removeItemFromCart

public MutationQuery removeItemFromCart(MutationQuery.RemoveItemFromCartArgumentsDefinition argsDef,
                                        RemoveItemFromCartOutputQueryDefinition queryDef)

removeProductsFromCompareList

public MutationQuery removeProductsFromCompareList(CompareListQueryDefinition queryDef)

Remove products from the specified compare list

removeProductsFromCompareList

public MutationQuery removeProductsFromCompareList(MutationQuery.RemoveProductsFromCompareListArgumentsDefinition argsDef,
                                                   CompareListQueryDefinition queryDef)

Remove products from the specified compare list

removeProductsFromWishlist

public MutationQuery removeProductsFromWishlist(ID wishlistId,
                                                List<ID> wishlistItemsIds,
                                                RemoveProductsFromWishlistOutputQueryDefinition queryDef)

Removes one or more products from the specified wish list

removeReturnTracking

public MutationQuery removeReturnTracking(RemoveReturnTrackingInput input,
                                          RemoveReturnTrackingOutputQueryDefinition queryDef)

Remove a tracked shipment from a return

removeRewardPointsFromCart

public MutationQuery removeRewardPointsFromCart(ID cartId,
                                                RemoveRewardPointsFromCartOutputQueryDefinition queryDef)

Cancel the application of reward points to the cart

removeStoreCreditFromCart

public MutationQuery removeStoreCreditFromCart(RemoveStoreCreditFromCartInput input,
                                               RemoveStoreCreditFromCartOutputQueryDefinition queryDef)

Remove applied store credit from the specified cart.

reorderItems

public MutationQuery reorderItems(String orderNumber,
                                  ReorderItemsOutputQueryDefinition queryDef)

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

requestPasswordResetEmail

public MutationQuery requestPasswordResetEmail(String email)

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

requestReturn

public MutationQuery requestReturn(RequestReturnInput input,
                                   RequestReturnOutputQueryDefinition queryDef)

Initiates a buyer's request to return an item for replacement or refund

resetPassword

public MutationQuery resetPassword(String email,
                                   String resetPasswordToken,
                                   String newPassword)

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

revokeCustomerToken

public MutationQuery revokeCustomerToken(RevokeCustomerTokenOutputQueryDefinition queryDef)

Revoke the customer token

sendEmailToFriend

public MutationQuery sendEmailToFriend(SendEmailToFriendOutputQueryDefinition queryDef)

Recommends Product by Sending Single/Multiple Email

sendEmailToFriend

public MutationQuery sendEmailToFriend(MutationQuery.SendEmailToFriendArgumentsDefinition argsDef,
                                       SendEmailToFriendOutputQueryDefinition queryDef)

Recommends Product by Sending Single/Multiple Email

setBillingAddressOnCart

public MutationQuery setBillingAddressOnCart(SetBillingAddressOnCartOutputQueryDefinition queryDef)

setBillingAddressOnCart

public MutationQuery setBillingAddressOnCart(MutationQuery.SetBillingAddressOnCartArgumentsDefinition argsDef,
                                             SetBillingAddressOnCartOutputQueryDefinition queryDef)

setGiftOptionsOnCart

public MutationQuery setGiftOptionsOnCart(SetGiftOptionsOnCartOutputQueryDefinition queryDef)

Set gift options like gift wrapping or gift message for the entire cart

setGiftOptionsOnCart

public MutationQuery setGiftOptionsOnCart(MutationQuery.SetGiftOptionsOnCartArgumentsDefinition argsDef,
                                          SetGiftOptionsOnCartOutputQueryDefinition queryDef)

Set gift options like gift wrapping or gift message for the entire cart

setGuestEmailOnCart

public MutationQuery setGuestEmailOnCart(SetGuestEmailOnCartOutputQueryDefinition queryDef)

setGuestEmailOnCart

public MutationQuery setGuestEmailOnCart(MutationQuery.SetGuestEmailOnCartArgumentsDefinition argsDef,
                                         SetGuestEmailOnCartOutputQueryDefinition queryDef)

setPaymentMethodAndPlaceOrder

public MutationQuery setPaymentMethodAndPlaceOrder(PlaceOrderOutputQueryDefinition queryDef)

Deprecated. Should use setPaymentMethodOnCart and placeOrder mutations in single request.

setPaymentMethodAndPlaceOrder

@Deprecated
public MutationQuery setPaymentMethodAndPlaceOrder(MutationQuery.SetPaymentMethodAndPlaceOrderArgumentsDefinition argsDef,
                                                               PlaceOrderOutputQueryDefinition queryDef)

Deprecated. Should use setPaymentMethodOnCart and placeOrder mutations in single request.

setPaymentMethodOnCart

public MutationQuery setPaymentMethodOnCart(SetPaymentMethodOnCartOutputQueryDefinition queryDef)

setPaymentMethodOnCart

public MutationQuery setPaymentMethodOnCart(MutationQuery.SetPaymentMethodOnCartArgumentsDefinition argsDef,
                                            SetPaymentMethodOnCartOutputQueryDefinition queryDef)

setShippingAddressesOnCart

public MutationQuery setShippingAddressesOnCart(SetShippingAddressesOnCartOutputQueryDefinition queryDef)

setShippingAddressesOnCart

public MutationQuery setShippingAddressesOnCart(MutationQuery.SetShippingAddressesOnCartArgumentsDefinition argsDef,
                                                SetShippingAddressesOnCartOutputQueryDefinition queryDef)

setShippingMethodsOnCart

public MutationQuery setShippingMethodsOnCart(SetShippingMethodsOnCartOutputQueryDefinition queryDef)

setShippingMethodsOnCart

public MutationQuery setShippingMethodsOnCart(MutationQuery.SetShippingMethodsOnCartArgumentsDefinition argsDef,
                                              SetShippingMethodsOnCartOutputQueryDefinition queryDef)

subscribeEmailToNewsletter

public MutationQuery subscribeEmailToNewsletter(String email,
                                                SubscribeEmailToNewsletterOutputQueryDefinition queryDef)

Subscribes the specified email to a newsletter

updateCartItems

public MutationQuery updateCartItems(UpdateCartItemsOutputQueryDefinition queryDef)

updateCartItems

public MutationQuery updateCartItems(MutationQuery.UpdateCartItemsArgumentsDefinition argsDef,
                                     UpdateCartItemsOutputQueryDefinition queryDef)

updateCustomer

public MutationQuery updateCustomer(CustomerInput input,
                                    CustomerOutputQueryDefinition queryDef)

Deprecated. Use UpdateCustomerV2 instead.

updateCustomerAddress

public MutationQuery updateCustomerAddress(int id,
                                           CustomerAddressQueryDefinition queryDef)

Update customer address

updateCustomerAddress

public MutationQuery updateCustomerAddress(int id,
                                           MutationQuery.UpdateCustomerAddressArgumentsDefinition argsDef,
                                           CustomerAddressQueryDefinition queryDef)

Update customer address

updateCustomerEmail

public MutationQuery updateCustomerEmail(String email,
                                         String password,
                                         CustomerOutputQueryDefinition queryDef)

updateCustomerV2

public MutationQuery updateCustomerV2(CustomerUpdateInput input,
                                      CustomerOutputQueryDefinition queryDef)

Update the customer's personal information

updateProductsInWishlist

public MutationQuery updateProductsInWishlist(ID wishlistId,
                                              List<WishlistItemUpdateInput> wishlistItems,
                                              UpdateProductsInWishlistOutputQueryDefinition queryDef)

Updates one or more products in the specified wish list

updateWishlist

public MutationQuery updateWishlist(ID wishlistId,
                                    UpdateWishlistOutputQueryDefinition queryDef)

Change the name and visibility of the specified wish list

updateWishlist

public MutationQuery updateWishlist(ID wishlistId,
                                    MutationQuery.UpdateWishlistArgumentsDefinition argsDef,
                                    UpdateWishlistOutputQueryDefinition queryDef)

Change the name and visibility of the specified wish list

toString

public String toString()

Overrides:

toString in class Object

addFragment

public MutationQuery addFragment(Fragment fragment)

Adds a GraphQL "named" fragment to the query. If a fragment with the same name is already added, calling this method will replace the existing fragment.

Parameters:

fragment - The fragment to add.

createFragment

public static Fragment<MutationQuery> createFragment(String name,
                                                     MutationQueryDefinition queryDef)

Creates a GraphQL "named" fragment with the specified query type definition. The generics nature of fragments ensures that a fragment can only be used at the right place in the GraphQL request.

Parameters:

name - The name of the fragment, must be unique for a given GraphQL request.

queryDef - The fragment definition.

Returns:

The fragment of a given generics type.

addFragmentReference

public MutationQuery addFragmentReference(Fragment<MutationQuery> fragment)

Adds a MutationQuery fragment reference at the current position of the query. For example for a fragment named test, calling this method will add the reference ...test in the query. For GraphQL types implementing an interface, there will be some similar methods using the Query type of each implemented interface.

Parameters:

fragment - The fragment to reference.