Storefront.Mutation (buy3 9.0.1 API)

java.lang.Object
- <any>
- - com.shopify.buy3.Storefront.Mutation

Enclosing class:

Storefront
```
public static class Storefront.Mutation
extends <any>
```
The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start.

Constructor Summary

Constructors
Constructor and Description

Mutation()

Mutation(JsonObject fields)

Constructors
Constructor and Description
`Mutation()`
`Mutation(JsonObject fields)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`Storefront.CheckoutAttributesUpdatePayload`	`getCheckoutAttributesUpdate()` Deprecated. Use `checkoutAttributesUpdateV2` instead
`Storefront.CheckoutAttributesUpdateV2Payload`	`getCheckoutAttributesUpdateV2()` Updates the attributes of a checkout.
`Storefront.CheckoutCompleteFreePayload`	`getCheckoutCompleteFree()` Completes a checkout without providing payment information.
`Storefront.CheckoutCompleteWithCreditCardPayload`	`getCheckoutCompleteWithCreditCard()` Deprecated. Use `checkoutCompleteWithCreditCardV2` instead
`Storefront.CheckoutCompleteWithCreditCardV2Payload`	`getCheckoutCompleteWithCreditCardV2()` Completes a checkout using a credit card token from Shopify's card vault.
`Storefront.CheckoutCompleteWithTokenizedPaymentPayload`	`getCheckoutCompleteWithTokenizedPayment()` Deprecated. Use `checkoutCompleteWithTokenizedPaymentV2` instead
`Storefront.CheckoutCompleteWithTokenizedPaymentV2Payload`	`getCheckoutCompleteWithTokenizedPaymentV2()` Deprecated. Use `checkoutCompleteWithTokenizedPaymentV3` instead
`Storefront.CheckoutCompleteWithTokenizedPaymentV3Payload`	`getCheckoutCompleteWithTokenizedPaymentV3()` Completes a checkout with a tokenized payment.
`Storefront.CheckoutCreatePayload`	`getCheckoutCreate()` Creates a new checkout.
`Storefront.CheckoutCustomerAssociatePayload`	`getCheckoutCustomerAssociate()` Deprecated. Use `checkoutCustomerAssociateV2` instead
`Storefront.CheckoutCustomerAssociateV2Payload`	`getCheckoutCustomerAssociateV2()` Associates a customer to the checkout.
`Storefront.CheckoutCustomerDisassociatePayload`	`getCheckoutCustomerDisassociate()` Deprecated. Use `checkoutCustomerDisassociateV2` instead
`Storefront.CheckoutCustomerDisassociateV2Payload`	`getCheckoutCustomerDisassociateV2()` Disassociates the current checkout customer from the checkout.
`Storefront.CheckoutDiscountCodeApplyPayload`	`getCheckoutDiscountCodeApply()` Deprecated. Use `checkoutDiscountCodeApplyV2` instead
`Storefront.CheckoutDiscountCodeApplyV2Payload`	`getCheckoutDiscountCodeApplyV2()` Applies a discount to an existing checkout using a discount code.
`Storefront.CheckoutDiscountCodeRemovePayload`	`getCheckoutDiscountCodeRemove()` Removes the applied discount from an existing checkout.
`Storefront.CheckoutEmailUpdatePayload`	`getCheckoutEmailUpdate()` Deprecated. Use `checkoutEmailUpdateV2` instead
`Storefront.CheckoutEmailUpdateV2Payload`	`getCheckoutEmailUpdateV2()` Updates the email on an existing checkout.
`Storefront.CheckoutGiftCardApplyPayload`	`getCheckoutGiftCardApply()` Deprecated. Use `checkoutGiftCardsAppend` instead
`Storefront.CheckoutGiftCardRemovePayload`	`getCheckoutGiftCardRemove()` Deprecated. Use `checkoutGiftCardRemoveV2` instead
`Storefront.CheckoutGiftCardRemoveV2Payload`	`getCheckoutGiftCardRemoveV2()` Removes an applied gift card from the checkout.
`Storefront.CheckoutGiftCardsAppendPayload`	`getCheckoutGiftCardsAppend()` Appends gift cards to an existing checkout.
`Storefront.CheckoutLineItemsAddPayload`	`getCheckoutLineItemsAdd()` Adds a list of line items to a checkout.
`Storefront.CheckoutLineItemsRemovePayload`	`getCheckoutLineItemsRemove()` Removes line items from an existing checkout.
`Storefront.CheckoutLineItemsReplacePayload`	`getCheckoutLineItemsReplace()` Sets a list of line items to a checkout.
`Storefront.CheckoutLineItemsUpdatePayload`	`getCheckoutLineItemsUpdate()` Updates line items on a checkout.
`Storefront.CheckoutShippingAddressUpdatePayload`	`getCheckoutShippingAddressUpdate()` Deprecated. Use `checkoutShippingAddressUpdateV2` instead
`Storefront.CheckoutShippingAddressUpdateV2Payload`	`getCheckoutShippingAddressUpdateV2()` Updates the shipping address of an existing checkout.
`Storefront.CheckoutShippingLineUpdatePayload`	`getCheckoutShippingLineUpdate()` Updates the shipping lines on an existing checkout.
`Storefront.CustomerAccessTokenCreatePayload`	`getCustomerAccessTokenCreate()` Creates a customer access token.
`Storefront.CustomerAccessTokenCreateWithMultipassPayload`	`getCustomerAccessTokenCreateWithMultipass()` Creates a customer access token using a multipass token instead of email and password.
`Storefront.CustomerAccessTokenDeletePayload`	`getCustomerAccessTokenDelete()` Permanently destroys a customer access token.
`Storefront.CustomerAccessTokenRenewPayload`	`getCustomerAccessTokenRenew()` Renews a customer access token.
`Storefront.CustomerActivatePayload`	`getCustomerActivate()` Activates a customer.
`Storefront.CustomerActivateByUrlPayload`	`getCustomerActivateByUrl()` Activates a customer with the activation url received from `customerCreate`.
`Storefront.CustomerAddressCreatePayload`	`getCustomerAddressCreate()` Creates a new address for a customer.
`Storefront.CustomerAddressDeletePayload`	`getCustomerAddressDelete()` Permanently deletes the address of an existing customer.
`Storefront.CustomerAddressUpdatePayload`	`getCustomerAddressUpdate()` Updates the address of an existing customer.
`Storefront.CustomerCreatePayload`	`getCustomerCreate()` Creates a new customer.
`Storefront.CustomerDefaultAddressUpdatePayload`	`getCustomerDefaultAddressUpdate()` Updates the default address of an existing customer.
`Storefront.CustomerRecoverPayload`	`getCustomerRecover()` Sends a reset password email to the customer, as the first step in the reset password process.
`Storefront.CustomerResetPayload`	`getCustomerReset()` Resets a customer’s password with a token received from `CustomerRecover`.
`Storefront.CustomerResetByUrlPayload`	`getCustomerResetByUrl()` Resets a customer’s password with the reset password url received from `CustomerRecover`.
`Storefront.CustomerUpdatePayload`	`getCustomerUpdate()` Updates an existing customer.
`java.lang.String`	`getGraphQlTypeName()`
`Storefront.Mutation`	`setCheckoutAttributesUpdate(Storefront.CheckoutAttributesUpdatePayload arg)`
`Storefront.Mutation`	`setCheckoutAttributesUpdateV2(Storefront.CheckoutAttributesUpdateV2Payload arg)`
`Storefront.Mutation`	`setCheckoutCompleteFree(Storefront.CheckoutCompleteFreePayload arg)`
`Storefront.Mutation`	`setCheckoutCompleteWithCreditCard(Storefront.CheckoutCompleteWithCreditCardPayload arg)`
`Storefront.Mutation`	`setCheckoutCompleteWithCreditCardV2(Storefront.CheckoutCompleteWithCreditCardV2Payload arg)`
`Storefront.Mutation`	`setCheckoutCompleteWithTokenizedPayment(Storefront.CheckoutCompleteWithTokenizedPaymentPayload arg)`
`Storefront.Mutation`	`setCheckoutCompleteWithTokenizedPaymentV2(Storefront.CheckoutCompleteWithTokenizedPaymentV2Payload arg)`
`Storefront.Mutation`	`setCheckoutCompleteWithTokenizedPaymentV3(Storefront.CheckoutCompleteWithTokenizedPaymentV3Payload arg)`
`Storefront.Mutation`	`setCheckoutCreate(Storefront.CheckoutCreatePayload arg)`
`Storefront.Mutation`	`setCheckoutCustomerAssociate(Storefront.CheckoutCustomerAssociatePayload arg)`
`Storefront.Mutation`	`setCheckoutCustomerAssociateV2(Storefront.CheckoutCustomerAssociateV2Payload arg)`
`Storefront.Mutation`	`setCheckoutCustomerDisassociate(Storefront.CheckoutCustomerDisassociatePayload arg)`
`Storefront.Mutation`	`setCheckoutCustomerDisassociateV2(Storefront.CheckoutCustomerDisassociateV2Payload arg)`
`Storefront.Mutation`	`setCheckoutDiscountCodeApply(Storefront.CheckoutDiscountCodeApplyPayload arg)`
`Storefront.Mutation`	`setCheckoutDiscountCodeApplyV2(Storefront.CheckoutDiscountCodeApplyV2Payload arg)`
`Storefront.Mutation`	`setCheckoutDiscountCodeRemove(Storefront.CheckoutDiscountCodeRemovePayload arg)`
`Storefront.Mutation`	`setCheckoutEmailUpdate(Storefront.CheckoutEmailUpdatePayload arg)`
`Storefront.Mutation`	`setCheckoutEmailUpdateV2(Storefront.CheckoutEmailUpdateV2Payload arg)`
`Storefront.Mutation`	`setCheckoutGiftCardApply(Storefront.CheckoutGiftCardApplyPayload arg)`
`Storefront.Mutation`	`setCheckoutGiftCardRemove(Storefront.CheckoutGiftCardRemovePayload arg)`
`Storefront.Mutation`	`setCheckoutGiftCardRemoveV2(Storefront.CheckoutGiftCardRemoveV2Payload arg)`
`Storefront.Mutation`	`setCheckoutGiftCardsAppend(Storefront.CheckoutGiftCardsAppendPayload arg)`
`Storefront.Mutation`	`setCheckoutLineItemsAdd(Storefront.CheckoutLineItemsAddPayload arg)`
`Storefront.Mutation`	`setCheckoutLineItemsRemove(Storefront.CheckoutLineItemsRemovePayload arg)`
`Storefront.Mutation`	`setCheckoutLineItemsReplace(Storefront.CheckoutLineItemsReplacePayload arg)`
`Storefront.Mutation`	`setCheckoutLineItemsUpdate(Storefront.CheckoutLineItemsUpdatePayload arg)`
`Storefront.Mutation`	`setCheckoutShippingAddressUpdate(Storefront.CheckoutShippingAddressUpdatePayload arg)`
`Storefront.Mutation`	`setCheckoutShippingAddressUpdateV2(Storefront.CheckoutShippingAddressUpdateV2Payload arg)`
`Storefront.Mutation`	`setCheckoutShippingLineUpdate(Storefront.CheckoutShippingLineUpdatePayload arg)`
`Storefront.Mutation`	`setCustomerAccessTokenCreate(Storefront.CustomerAccessTokenCreatePayload arg)`
`Storefront.Mutation`	`setCustomerAccessTokenCreateWithMultipass(Storefront.CustomerAccessTokenCreateWithMultipassPayload arg)`
`Storefront.Mutation`	`setCustomerAccessTokenDelete(Storefront.CustomerAccessTokenDeletePayload arg)`
`Storefront.Mutation`	`setCustomerAccessTokenRenew(Storefront.CustomerAccessTokenRenewPayload arg)`
`Storefront.Mutation`	`setCustomerActivate(Storefront.CustomerActivatePayload arg)`
`Storefront.Mutation`	`setCustomerActivateByUrl(Storefront.CustomerActivateByUrlPayload arg)`
`Storefront.Mutation`	`setCustomerAddressCreate(Storefront.CustomerAddressCreatePayload arg)`
`Storefront.Mutation`	`setCustomerAddressDelete(Storefront.CustomerAddressDeletePayload arg)`
`Storefront.Mutation`	`setCustomerAddressUpdate(Storefront.CustomerAddressUpdatePayload arg)`
`Storefront.Mutation`	`setCustomerCreate(Storefront.CustomerCreatePayload arg)`
`Storefront.Mutation`	`setCustomerDefaultAddressUpdate(Storefront.CustomerDefaultAddressUpdatePayload arg)`
`Storefront.Mutation`	`setCustomerRecover(Storefront.CustomerRecoverPayload arg)`
`Storefront.Mutation`	`setCustomerReset(Storefront.CustomerResetPayload arg)`
`Storefront.Mutation`	`setCustomerResetByUrl(Storefront.CustomerResetByUrlPayload arg)`
`Storefront.Mutation`	`setCustomerUpdate(Storefront.CustomerUpdatePayload arg)`
`boolean`	`unwrapsToObject(java.lang.String key)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Mutation
```
public Mutation()
```

Mutation

public Mutation(JsonObject fields)
         throws SchemaViolationError

Throws:: SchemaViolationError

Method Detail

getGraphQlTypeName

public java.lang.String getGraphQlTypeName()

getCheckoutAttributesUpdate
```
public Storefront.CheckoutAttributesUpdatePayload getCheckoutAttributesUpdate()
```
Deprecated. Use `checkoutAttributesUpdateV2` instead

Updates the attributes of a checkout.

setCheckoutAttributesUpdate

public Storefront.Mutation setCheckoutAttributesUpdate(Storefront.CheckoutAttributesUpdatePayload arg)

getCheckoutAttributesUpdateV2

public Storefront.CheckoutAttributesUpdateV2Payload getCheckoutAttributesUpdateV2()

Updates the attributes of a checkout.

setCheckoutAttributesUpdateV2

public Storefront.Mutation setCheckoutAttributesUpdateV2(Storefront.CheckoutAttributesUpdateV2Payload arg)

getCheckoutCompleteFree
```
public Storefront.CheckoutCompleteFreePayload getCheckoutCompleteFree()
```
Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card.

setCheckoutCompleteFree

public Storefront.Mutation setCheckoutCompleteFree(Storefront.CheckoutCompleteFreePayload arg)

getCheckoutCompleteWithCreditCard
```
public Storefront.CheckoutCompleteWithCreditCardPayload getCheckoutCompleteWithCreditCard()
```
Deprecated. Use `checkoutCompleteWithCreditCardV2` instead

Completes a checkout using a credit card token from Shopify's Vault.

setCheckoutCompleteWithCreditCard

public Storefront.Mutation setCheckoutCompleteWithCreditCard(Storefront.CheckoutCompleteWithCreditCardPayload arg)

getCheckoutCompleteWithCreditCardV2
```
public Storefront.CheckoutCompleteWithCreditCardV2Payload getCheckoutCompleteWithCreditCardV2()
```
Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to [_request payment processing_](https://help.shopify.com/api/guides/sales-channel-sdk/getting-started#request-payment-p rocessing).

setCheckoutCompleteWithCreditCardV2

public Storefront.Mutation setCheckoutCompleteWithCreditCardV2(Storefront.CheckoutCompleteWithCreditCardV2Payload arg)

getCheckoutCompleteWithTokenizedPayment
```
public Storefront.CheckoutCompleteWithTokenizedPaymentPayload getCheckoutCompleteWithTokenizedPayment()
```
Deprecated. Use `checkoutCompleteWithTokenizedPaymentV2` instead

Completes a checkout with a tokenized payment.

setCheckoutCompleteWithTokenizedPayment

public Storefront.Mutation setCheckoutCompleteWithTokenizedPayment(Storefront.CheckoutCompleteWithTokenizedPaymentPayload arg)

getCheckoutCompleteWithTokenizedPaymentV2
```
public Storefront.CheckoutCompleteWithTokenizedPaymentV2Payload getCheckoutCompleteWithTokenizedPaymentV2()
```
Deprecated. Use `checkoutCompleteWithTokenizedPaymentV3` instead

Completes a checkout with a tokenized payment.

setCheckoutCompleteWithTokenizedPaymentV2

public Storefront.Mutation setCheckoutCompleteWithTokenizedPaymentV2(Storefront.CheckoutCompleteWithTokenizedPaymentV2Payload arg)

getCheckoutCompleteWithTokenizedPaymentV3

public Storefront.CheckoutCompleteWithTokenizedPaymentV3Payload getCheckoutCompleteWithTokenizedPaymentV3()

Completes a checkout with a tokenized payment.

setCheckoutCompleteWithTokenizedPaymentV3

public Storefront.Mutation setCheckoutCompleteWithTokenizedPaymentV3(Storefront.CheckoutCompleteWithTokenizedPaymentV3Payload arg)

getCheckoutCreate

public Storefront.CheckoutCreatePayload getCheckoutCreate()

Creates a new checkout.

setCheckoutCreate

public Storefront.Mutation setCheckoutCreate(Storefront.CheckoutCreatePayload arg)

getCheckoutCustomerAssociate
```
public Storefront.CheckoutCustomerAssociatePayload getCheckoutCustomerAssociate()
```
Deprecated. Use `checkoutCustomerAssociateV2` instead

Associates a customer to the checkout.

setCheckoutCustomerAssociate

public Storefront.Mutation setCheckoutCustomerAssociate(Storefront.CheckoutCustomerAssociatePayload arg)

getCheckoutCustomerAssociateV2

public Storefront.CheckoutCustomerAssociateV2Payload getCheckoutCustomerAssociateV2()

Associates a customer to the checkout.

setCheckoutCustomerAssociateV2

public Storefront.Mutation setCheckoutCustomerAssociateV2(Storefront.CheckoutCustomerAssociateV2Payload arg)

getCheckoutCustomerDisassociate
```
public Storefront.CheckoutCustomerDisassociatePayload getCheckoutCustomerDisassociate()
```
Deprecated. Use `checkoutCustomerDisassociateV2` instead

Disassociates the current checkout customer from the checkout.

setCheckoutCustomerDisassociate

public Storefront.Mutation setCheckoutCustomerDisassociate(Storefront.CheckoutCustomerDisassociatePayload arg)

getCheckoutCustomerDisassociateV2

public Storefront.CheckoutCustomerDisassociateV2Payload getCheckoutCustomerDisassociateV2()

Disassociates the current checkout customer from the checkout.

setCheckoutCustomerDisassociateV2

public Storefront.Mutation setCheckoutCustomerDisassociateV2(Storefront.CheckoutCustomerDisassociateV2Payload arg)

getCheckoutDiscountCodeApply
```
public Storefront.CheckoutDiscountCodeApplyPayload getCheckoutDiscountCodeApply()
```
Deprecated. Use `checkoutDiscountCodeApplyV2` instead

Applies a discount to an existing checkout using a discount code.

setCheckoutDiscountCodeApply

public Storefront.Mutation setCheckoutDiscountCodeApply(Storefront.CheckoutDiscountCodeApplyPayload arg)

getCheckoutDiscountCodeApplyV2
```
public Storefront.CheckoutDiscountCodeApplyV2Payload getCheckoutDiscountCodeApplyV2()
```
Applies a discount to an existing checkout using a discount code.

setCheckoutDiscountCodeApplyV2

public Storefront.Mutation setCheckoutDiscountCodeApplyV2(Storefront.CheckoutDiscountCodeApplyV2Payload arg)

getCheckoutDiscountCodeRemove

public Storefront.CheckoutDiscountCodeRemovePayload getCheckoutDiscountCodeRemove()

Removes the applied discount from an existing checkout.

setCheckoutDiscountCodeRemove

public Storefront.Mutation setCheckoutDiscountCodeRemove(Storefront.CheckoutDiscountCodeRemovePayload arg)

getCheckoutEmailUpdate
```
public Storefront.CheckoutEmailUpdatePayload getCheckoutEmailUpdate()
```
Deprecated. Use `checkoutEmailUpdateV2` instead

Updates the email on an existing checkout.

setCheckoutEmailUpdate

public Storefront.Mutation setCheckoutEmailUpdate(Storefront.CheckoutEmailUpdatePayload arg)

getCheckoutEmailUpdateV2

public Storefront.CheckoutEmailUpdateV2Payload getCheckoutEmailUpdateV2()

Updates the email on an existing checkout.

setCheckoutEmailUpdateV2

public Storefront.Mutation setCheckoutEmailUpdateV2(Storefront.CheckoutEmailUpdateV2Payload arg)

getCheckoutGiftCardApply
```
public Storefront.CheckoutGiftCardApplyPayload getCheckoutGiftCardApply()
```
Deprecated. Use `checkoutGiftCardsAppend` instead

Applies a gift card to an existing checkout using a gift card code. This will replace all currently applied gift cards.

setCheckoutGiftCardApply

public Storefront.Mutation setCheckoutGiftCardApply(Storefront.CheckoutGiftCardApplyPayload arg)

getCheckoutGiftCardRemove
```
public Storefront.CheckoutGiftCardRemovePayload getCheckoutGiftCardRemove()
```
Deprecated. Use `checkoutGiftCardRemoveV2` instead

Removes an applied gift card from the checkout.

setCheckoutGiftCardRemove

public Storefront.Mutation setCheckoutGiftCardRemove(Storefront.CheckoutGiftCardRemovePayload arg)

getCheckoutGiftCardRemoveV2

public Storefront.CheckoutGiftCardRemoveV2Payload getCheckoutGiftCardRemoveV2()

Removes an applied gift card from the checkout.

setCheckoutGiftCardRemoveV2

public Storefront.Mutation setCheckoutGiftCardRemoveV2(Storefront.CheckoutGiftCardRemoveV2Payload arg)

getCheckoutGiftCardsAppend

public Storefront.CheckoutGiftCardsAppendPayload getCheckoutGiftCardsAppend()

Appends gift cards to an existing checkout.

setCheckoutGiftCardsAppend

public Storefront.Mutation setCheckoutGiftCardsAppend(Storefront.CheckoutGiftCardsAppendPayload arg)

getCheckoutLineItemsAdd

public Storefront.CheckoutLineItemsAddPayload getCheckoutLineItemsAdd()

Adds a list of line items to a checkout.

setCheckoutLineItemsAdd

public Storefront.Mutation setCheckoutLineItemsAdd(Storefront.CheckoutLineItemsAddPayload arg)

getCheckoutLineItemsRemove

public Storefront.CheckoutLineItemsRemovePayload getCheckoutLineItemsRemove()

Removes line items from an existing checkout.

setCheckoutLineItemsRemove

public Storefront.Mutation setCheckoutLineItemsRemove(Storefront.CheckoutLineItemsRemovePayload arg)

getCheckoutLineItemsReplace

public Storefront.CheckoutLineItemsReplacePayload getCheckoutLineItemsReplace()

Sets a list of line items to a checkout.

setCheckoutLineItemsReplace

public Storefront.Mutation setCheckoutLineItemsReplace(Storefront.CheckoutLineItemsReplacePayload arg)

getCheckoutLineItemsUpdate

public Storefront.CheckoutLineItemsUpdatePayload getCheckoutLineItemsUpdate()

Updates line items on a checkout.

setCheckoutLineItemsUpdate

public Storefront.Mutation setCheckoutLineItemsUpdate(Storefront.CheckoutLineItemsUpdatePayload arg)

getCheckoutShippingAddressUpdate
```
public Storefront.CheckoutShippingAddressUpdatePayload getCheckoutShippingAddressUpdate()
```
Deprecated. Use `checkoutShippingAddressUpdateV2` instead

Updates the shipping address of an existing checkout.

setCheckoutShippingAddressUpdate

public Storefront.Mutation setCheckoutShippingAddressUpdate(Storefront.CheckoutShippingAddressUpdatePayload arg)

getCheckoutShippingAddressUpdateV2

public Storefront.CheckoutShippingAddressUpdateV2Payload getCheckoutShippingAddressUpdateV2()

Updates the shipping address of an existing checkout.

setCheckoutShippingAddressUpdateV2

public Storefront.Mutation setCheckoutShippingAddressUpdateV2(Storefront.CheckoutShippingAddressUpdateV2Payload arg)

getCheckoutShippingLineUpdate

public Storefront.CheckoutShippingLineUpdatePayload getCheckoutShippingLineUpdate()

Updates the shipping lines on an existing checkout.

setCheckoutShippingLineUpdate

public Storefront.Mutation setCheckoutShippingLineUpdate(Storefront.CheckoutShippingLineUpdatePayload arg)

getCustomerAccessTokenCreate
```
public Storefront.CustomerAccessTokenCreatePayload getCustomerAccessTokenCreate()
```
Creates a customer access token. The customer access token is required to modify the customer object in any way.

setCustomerAccessTokenCreate

public Storefront.Mutation setCustomerAccessTokenCreate(Storefront.CustomerAccessTokenCreatePayload arg)

getCustomerAccessTokenCreateWithMultipass
```
public Storefront.CustomerAccessTokenCreateWithMultipassPayload getCustomerAccessTokenCreateWithMultipass()
```
Creates a customer access token using a multipass token instead of email and password. A customer record is created if customer does not exist. If a customer record already exists but the record is disabled, then it's enabled.

setCustomerAccessTokenCreateWithMultipass

public Storefront.Mutation setCustomerAccessTokenCreateWithMultipass(Storefront.CustomerAccessTokenCreateWithMultipassPayload arg)

getCustomerAccessTokenDelete

public Storefront.CustomerAccessTokenDeletePayload getCustomerAccessTokenDelete()

Permanently destroys a customer access token.

setCustomerAccessTokenDelete

public Storefront.Mutation setCustomerAccessTokenDelete(Storefront.CustomerAccessTokenDeletePayload arg)

getCustomerAccessTokenRenew
```
public Storefront.CustomerAccessTokenRenewPayload getCustomerAccessTokenRenew()
```
Renews a customer access token. Access token renewal must happen *before* a token expires. If a token has already expired, a new one should be created instead via `customerAccessTokenCreate`.

setCustomerAccessTokenRenew

public Storefront.Mutation setCustomerAccessTokenRenew(Storefront.CustomerAccessTokenRenewPayload arg)

getCustomerActivate

public Storefront.CustomerActivatePayload getCustomerActivate()

Activates a customer.

setCustomerActivate

public Storefront.Mutation setCustomerActivate(Storefront.CustomerActivatePayload arg)

getCustomerActivateByUrl
```
public Storefront.CustomerActivateByUrlPayload getCustomerActivateByUrl()
```
Activates a customer with the activation url received from `customerCreate`.

setCustomerActivateByUrl

public Storefront.Mutation setCustomerActivateByUrl(Storefront.CustomerActivateByUrlPayload arg)

getCustomerAddressCreate

public Storefront.CustomerAddressCreatePayload getCustomerAddressCreate()

Creates a new address for a customer.

setCustomerAddressCreate

public Storefront.Mutation setCustomerAddressCreate(Storefront.CustomerAddressCreatePayload arg)

getCustomerAddressDelete
```
public Storefront.CustomerAddressDeletePayload getCustomerAddressDelete()
```
Permanently deletes the address of an existing customer.

setCustomerAddressDelete

public Storefront.Mutation setCustomerAddressDelete(Storefront.CustomerAddressDeletePayload arg)

getCustomerAddressUpdate

public Storefront.CustomerAddressUpdatePayload getCustomerAddressUpdate()

Updates the address of an existing customer.

setCustomerAddressUpdate

public Storefront.Mutation setCustomerAddressUpdate(Storefront.CustomerAddressUpdatePayload arg)

getCustomerCreate

public Storefront.CustomerCreatePayload getCustomerCreate()

Creates a new customer.

setCustomerCreate

public Storefront.Mutation setCustomerCreate(Storefront.CustomerCreatePayload arg)

getCustomerDefaultAddressUpdate

public Storefront.CustomerDefaultAddressUpdatePayload getCustomerDefaultAddressUpdate()

Updates the default address of an existing customer.

setCustomerDefaultAddressUpdate

public Storefront.Mutation setCustomerDefaultAddressUpdate(Storefront.CustomerDefaultAddressUpdatePayload arg)

getCustomerRecover
```
public Storefront.CustomerRecoverPayload getCustomerRecover()
```
Sends a reset password email to the customer, as the first step in the reset password process.

setCustomerRecover

public Storefront.Mutation setCustomerRecover(Storefront.CustomerRecoverPayload arg)

getCustomerReset
```
public Storefront.CustomerResetPayload getCustomerReset()
```
Resets a customer’s password with a token received from `CustomerRecover`.

setCustomerReset

public Storefront.Mutation setCustomerReset(Storefront.CustomerResetPayload arg)

getCustomerResetByUrl
```
public Storefront.CustomerResetByUrlPayload getCustomerResetByUrl()
```
Resets a customer’s password with the reset password url received from `CustomerRecover`.

setCustomerResetByUrl

public Storefront.Mutation setCustomerResetByUrl(Storefront.CustomerResetByUrlPayload arg)

getCustomerUpdate

public Storefront.CustomerUpdatePayload getCustomerUpdate()

Updates an existing customer.

setCustomerUpdate

public Storefront.Mutation setCustomerUpdate(Storefront.CustomerUpdatePayload arg)

unwrapsToObject

public boolean unwrapsToObject(java.lang.String key)

Class Storefront.Mutation

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Mutation

Mutation

Method Detail

getGraphQlTypeName

getCheckoutAttributesUpdate

setCheckoutAttributesUpdate

getCheckoutAttributesUpdateV2

setCheckoutAttributesUpdateV2

getCheckoutCompleteFree

setCheckoutCompleteFree

getCheckoutCompleteWithCreditCard

setCheckoutCompleteWithCreditCard

getCheckoutCompleteWithCreditCardV2

setCheckoutCompleteWithCreditCardV2

getCheckoutCompleteWithTokenizedPayment

setCheckoutCompleteWithTokenizedPayment

getCheckoutCompleteWithTokenizedPaymentV2

setCheckoutCompleteWithTokenizedPaymentV2

getCheckoutCompleteWithTokenizedPaymentV3

setCheckoutCompleteWithTokenizedPaymentV3

getCheckoutCreate

setCheckoutCreate

getCheckoutCustomerAssociate

setCheckoutCustomerAssociate

getCheckoutCustomerAssociateV2

setCheckoutCustomerAssociateV2

getCheckoutCustomerDisassociate

setCheckoutCustomerDisassociate

getCheckoutCustomerDisassociateV2

setCheckoutCustomerDisassociateV2

getCheckoutDiscountCodeApply

setCheckoutDiscountCodeApply

getCheckoutDiscountCodeApplyV2

setCheckoutDiscountCodeApplyV2

getCheckoutDiscountCodeRemove

setCheckoutDiscountCodeRemove

getCheckoutEmailUpdate

setCheckoutEmailUpdate

getCheckoutEmailUpdateV2

setCheckoutEmailUpdateV2

getCheckoutGiftCardApply

setCheckoutGiftCardApply

getCheckoutGiftCardRemove

setCheckoutGiftCardRemove

getCheckoutGiftCardRemoveV2

setCheckoutGiftCardRemoveV2

getCheckoutGiftCardsAppend

setCheckoutGiftCardsAppend

getCheckoutLineItemsAdd

setCheckoutLineItemsAdd

getCheckoutLineItemsRemove

setCheckoutLineItemsRemove

getCheckoutLineItemsReplace

setCheckoutLineItemsReplace

getCheckoutLineItemsUpdate

setCheckoutLineItemsUpdate

getCheckoutShippingAddressUpdate

setCheckoutShippingAddressUpdate

getCheckoutShippingAddressUpdateV2

setCheckoutShippingAddressUpdateV2

getCheckoutShippingLineUpdate

setCheckoutShippingLineUpdate

getCustomerAccessTokenCreate

setCustomerAccessTokenCreate

getCustomerAccessTokenCreateWithMultipass

setCustomerAccessTokenCreateWithMultipass

getCustomerAccessTokenDelete

setCustomerAccessTokenDelete

getCustomerAccessTokenRenew

setCustomerAccessTokenRenew

getCustomerActivate

setCustomerActivate

getCustomerActivateByUrl

setCustomerActivateByUrl

getCustomerAddressCreate