Storefront.Mutation (buy3 18.0.0 API)

java.lang.Object
- com.shopify.graphql.support.AbstractResponse<Storefront.Mutation>
- - com.shopify.buy3.Storefront.Mutation

All Implemented Interfaces:

java.io.Serializable

Enclosing class:

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

See Also:

Serialized Form

Field Summary
- Fields inherited from class com.shopify.graphql.support.AbstractResponse
  optimisticData, responseData

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
Modifier and Type	Method and Description
`Storefront.CartAttributesUpdatePayload`	`getCartAttributesUpdate()` Updates the attributes on a cart.
`Storefront.CartBillingAddressUpdatePayload`	`getCartBillingAddressUpdate()` Updates the billing address on the cart.
`Storefront.CartBuyerIdentityUpdatePayload`	`getCartBuyerIdentityUpdate()` Updates customer information associated with a cart.
`Storefront.CartCreatePayload`	`getCartCreate()` Creates a new cart.
`Storefront.CartDiscountCodesUpdatePayload`	`getCartDiscountCodesUpdate()` Updates the discount codes applied to the cart.
`Storefront.CartGiftCardCodesUpdatePayload`	`getCartGiftCardCodesUpdate()` Updates the gift card codes applied to the cart.
`Storefront.CartLinesAddPayload`	`getCartLinesAdd()` Adds a merchandise line to the cart.
`Storefront.CartLinesRemovePayload`	`getCartLinesRemove()` Removes one or more merchandise lines from the cart.
`Storefront.CartLinesUpdatePayload`	`getCartLinesUpdate()` Updates one or more merchandise lines on a cart.
`Storefront.CartMetafieldDeletePayload`	`getCartMetafieldDelete()` Deletes a cart metafield.
`Storefront.CartMetafieldsSetPayload`	`getCartMetafieldsSet()` Sets cart metafield values.
`Storefront.CartNoteUpdatePayload`	`getCartNoteUpdate()` Updates the note on the cart.
`Storefront.CartPaymentUpdatePayload`	`getCartPaymentUpdate()` Update the customer's payment method that will be used to checkout.
`Storefront.CartSelectedDeliveryOptionsUpdatePayload`	`getCartSelectedDeliveryOptionsUpdate()` Update the selected delivery options for a delivery group.
`Storefront.CartSubmitForCompletionPayload`	`getCartSubmitForCompletion()` Submit the cart for checkout completion.
`Storefront.CustomerAccessTokenCreatePayload`	`getCustomerAccessTokenCreate()` Creates a customer access token.
`Storefront.CustomerAccessTokenCreateWithMultipassPayload`	`getCustomerAccessTokenCreateWithMultipass()` Creates a customer access token using a [multipass token](https://shopify.dev/api/multipass) 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.
`Storefront.CustomerResetPayload`	`getCustomerReset()` "Resets a customer’s password with the token received from a reset password email.
`Storefront.CustomerResetByUrlPayload`	`getCustomerResetByUrl()` "Resets a customer’s password with the reset password URL received from a reset password email.
`Storefront.CustomerUpdatePayload`	`getCustomerUpdate()` Updates an existing customer.
`java.lang.String`	`getGraphQlTypeName()`
`Storefront.ShopPayPaymentRequestSessionCreatePayload`	`getShopPayPaymentRequestSessionCreate()` Create a new Shop Pay payment request session.
`Storefront.ShopPayPaymentRequestSessionSubmitPayload`	`getShopPayPaymentRequestSessionSubmit()` Submits a Shop Pay payment request session.
`Storefront.Mutation`	`setCartAttributesUpdate(Storefront.CartAttributesUpdatePayload arg)`
`Storefront.Mutation`	`setCartBillingAddressUpdate(Storefront.CartBillingAddressUpdatePayload arg)`
`Storefront.Mutation`	`setCartBuyerIdentityUpdate(Storefront.CartBuyerIdentityUpdatePayload arg)`
`Storefront.Mutation`	`setCartCreate(Storefront.CartCreatePayload arg)`
`Storefront.Mutation`	`setCartDiscountCodesUpdate(Storefront.CartDiscountCodesUpdatePayload arg)`
`Storefront.Mutation`	`setCartGiftCardCodesUpdate(Storefront.CartGiftCardCodesUpdatePayload arg)`
`Storefront.Mutation`	`setCartLinesAdd(Storefront.CartLinesAddPayload arg)`
`Storefront.Mutation`	`setCartLinesRemove(Storefront.CartLinesRemovePayload arg)`
`Storefront.Mutation`	`setCartLinesUpdate(Storefront.CartLinesUpdatePayload arg)`
`Storefront.Mutation`	`setCartMetafieldDelete(Storefront.CartMetafieldDeletePayload arg)`
`Storefront.Mutation`	`setCartMetafieldsSet(Storefront.CartMetafieldsSetPayload arg)`
`Storefront.Mutation`	`setCartNoteUpdate(Storefront.CartNoteUpdatePayload arg)`
`Storefront.Mutation`	`setCartPaymentUpdate(Storefront.CartPaymentUpdatePayload arg)`
`Storefront.Mutation`	`setCartSelectedDeliveryOptionsUpdate(Storefront.CartSelectedDeliveryOptionsUpdatePayload arg)`
`Storefront.Mutation`	`setCartSubmitForCompletion(Storefront.CartSubmitForCompletionPayload 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)`
`Storefront.Mutation`	`setShopPayPaymentRequestSessionCreate(Storefront.ShopPayPaymentRequestSessionCreatePayload arg)`
`Storefront.Mutation`	`setShopPayPaymentRequestSessionSubmit(Storefront.ShopPayPaymentRequestSessionSubmitPayload arg)`
`boolean`	`unwrapsToObject(java.lang.String key)`

Methods inherited from class com.shopify.graphql.support.AbstractResponse
collectNodes, get, getFieldName, getKey, jsonAsArray, jsonAsBoolean, jsonAsDouble, jsonAsInteger, jsonAsObject, jsonAsString, withAlias

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()

getCartAttributesUpdate

public Storefront.CartAttributesUpdatePayload getCartAttributesUpdate()

Updates the attributes on a cart.

setCartAttributesUpdate

public Storefront.Mutation setCartAttributesUpdate(Storefront.CartAttributesUpdatePayload arg)

getCartBillingAddressUpdate

public Storefront.CartBillingAddressUpdatePayload getCartBillingAddressUpdate()

Updates the billing address on the cart.

setCartBillingAddressUpdate

public Storefront.Mutation setCartBillingAddressUpdate(Storefront.CartBillingAddressUpdatePayload arg)

getCartBuyerIdentityUpdate
```
public Storefront.CartBuyerIdentityUpdatePayload getCartBuyerIdentityUpdate()
```
Updates customer information associated with a cart. Buyer identity is used to determine [international pricing](https://shopify.dev/custom-storefronts/internationalization/international-pricing) and should match the customer's shipping address.

setCartBuyerIdentityUpdate

public Storefront.Mutation setCartBuyerIdentityUpdate(Storefront.CartBuyerIdentityUpdatePayload arg)

getCartCreate

public Storefront.CartCreatePayload getCartCreate()

Creates a new cart.

setCartCreate

public Storefront.Mutation setCartCreate(Storefront.CartCreatePayload arg)

getCartDiscountCodesUpdate

public Storefront.CartDiscountCodesUpdatePayload getCartDiscountCodesUpdate()

Updates the discount codes applied to the cart.

setCartDiscountCodesUpdate

public Storefront.Mutation setCartDiscountCodesUpdate(Storefront.CartDiscountCodesUpdatePayload arg)

getCartGiftCardCodesUpdate

public Storefront.CartGiftCardCodesUpdatePayload getCartGiftCardCodesUpdate()

Updates the gift card codes applied to the cart.

setCartGiftCardCodesUpdate

public Storefront.Mutation setCartGiftCardCodesUpdate(Storefront.CartGiftCardCodesUpdatePayload arg)

getCartLinesAdd

public Storefront.CartLinesAddPayload getCartLinesAdd()

Adds a merchandise line to the cart.

setCartLinesAdd

public Storefront.Mutation setCartLinesAdd(Storefront.CartLinesAddPayload arg)

getCartLinesRemove
```
public Storefront.CartLinesRemovePayload getCartLinesRemove()
```
Removes one or more merchandise lines from the cart.

setCartLinesRemove

public Storefront.Mutation setCartLinesRemove(Storefront.CartLinesRemovePayload arg)

getCartLinesUpdate

public Storefront.CartLinesUpdatePayload getCartLinesUpdate()

Updates one or more merchandise lines on a cart.

setCartLinesUpdate

public Storefront.Mutation setCartLinesUpdate(Storefront.CartLinesUpdatePayload arg)

getCartMetafieldDelete

public Storefront.CartMetafieldDeletePayload getCartMetafieldDelete()

Deletes a cart metafield.

setCartMetafieldDelete

public Storefront.Mutation setCartMetafieldDelete(Storefront.CartMetafieldDeletePayload arg)

getCartMetafieldsSet
```
public Storefront.CartMetafieldsSetPayload getCartMetafieldsSet()
```
Sets cart metafield values. Cart metafield values will be set regardless if they were previously created or not. Allows a maximum of 25 cart metafields to be set at a time.

setCartMetafieldsSet

public Storefront.Mutation setCartMetafieldsSet(Storefront.CartMetafieldsSetPayload arg)

getCartNoteUpdate

public Storefront.CartNoteUpdatePayload getCartNoteUpdate()

Updates the note on the cart.

setCartNoteUpdate

public Storefront.Mutation setCartNoteUpdate(Storefront.CartNoteUpdatePayload arg)

getCartPaymentUpdate
```
public Storefront.CartPaymentUpdatePayload getCartPaymentUpdate()
```
Update the customer's payment method that will be used to checkout.

setCartPaymentUpdate

public Storefront.Mutation setCartPaymentUpdate(Storefront.CartPaymentUpdatePayload arg)

getCartSelectedDeliveryOptionsUpdate

public Storefront.CartSelectedDeliveryOptionsUpdatePayload getCartSelectedDeliveryOptionsUpdate()

Update the selected delivery options for a delivery group.

setCartSelectedDeliveryOptionsUpdate

public Storefront.Mutation setCartSelectedDeliveryOptionsUpdate(Storefront.CartSelectedDeliveryOptionsUpdatePayload arg)

getCartSubmitForCompletion

public Storefront.CartSubmitForCompletionPayload getCartSubmitForCompletion()

Submit the cart for checkout completion.

setCartSubmitForCompletion

public Storefront.Mutation setCartSubmitForCompletion(Storefront.CartSubmitForCompletionPayload 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](https://shopify.dev/api/multipass) instead of email and password. A customer record is created if the customer doesn't exist. If a customer record already exists but the record is disabled, then the customer record is 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. The reset password email contains a reset password URL and token that you can pass to the [`customerResetByUrl`](https://shopify.dev/api/storefront/latest/mutations/customerResetByUrl) or [`customerReset`](https://shopify.dev/api/storefront/latest/mutations/customerReset) mutation to reset the customer password. This mutation is throttled by IP. With private access, you can provide a [`Shopify-Storefront-Buyer-IP`](https://shopify.dev/api/usage/authentication#optional-ip-header) instead of the request IP. The header is case-sensitive and must be sent as `Shopify-Storefront-Buyer-IP`. Make sure that the value provided to `Shopify-Storefront-Buyer-IP` is trusted. Unthrottled access to this mutation presents a security risk.

setCustomerRecover

public Storefront.Mutation setCustomerRecover(Storefront.CustomerRecoverPayload arg)

getCustomerReset
```
public Storefront.CustomerResetPayload getCustomerReset()
```
"Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation."

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 a reset password email. You can send a reset password email with the [`customerRecover`](https://shopify.dev/api/storefront/latest/mutations/customerRecover) mutation."

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)

getShopPayPaymentRequestSessionCreate

public Storefront.ShopPayPaymentRequestSessionCreatePayload getShopPayPaymentRequestSessionCreate()

Create a new Shop Pay payment request session.

setShopPayPaymentRequestSessionCreate

public Storefront.Mutation setShopPayPaymentRequestSessionCreate(Storefront.ShopPayPaymentRequestSessionCreatePayload arg)

getShopPayPaymentRequestSessionSubmit

public Storefront.ShopPayPaymentRequestSessionSubmitPayload getShopPayPaymentRequestSessionSubmit()

Submits a Shop Pay payment request session.

setShopPayPaymentRequestSessionSubmit

public Storefront.Mutation setShopPayPaymentRequestSessionSubmit(Storefront.ShopPayPaymentRequestSessionSubmitPayload arg)

unwrapsToObject
```
public boolean unwrapsToObject(java.lang.String key)
```
Specified by:

unwrapsToObject in class AbstractResponse<Storefront.Mutation>

Class Storefront.Mutation

Field Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

Mutation

Mutation

Method Detail

getGraphQlTypeName

getCartAttributesUpdate

setCartAttributesUpdate

getCartBillingAddressUpdate

setCartBillingAddressUpdate

getCartBuyerIdentityUpdate

setCartBuyerIdentityUpdate

getCartCreate

setCartCreate

getCartDiscountCodesUpdate

setCartDiscountCodesUpdate

getCartGiftCardCodesUpdate

setCartGiftCardCodesUpdate

getCartLinesAdd

setCartLinesAdd

getCartLinesRemove

setCartLinesRemove

getCartLinesUpdate

setCartLinesUpdate

getCartMetafieldDelete

setCartMetafieldDelete

getCartMetafieldsSet

setCartMetafieldsSet

getCartNoteUpdate

setCartNoteUpdate

getCartPaymentUpdate

setCartPaymentUpdate

getCartSelectedDeliveryOptionsUpdate

setCartSelectedDeliveryOptionsUpdate

getCartSubmitForCompletion

setCartSubmitForCompletion

getCustomerAccessTokenCreate

setCustomerAccessTokenCreate

getCustomerAccessTokenCreateWithMultipass

setCustomerAccessTokenCreateWithMultipass

getCustomerAccessTokenDelete

setCustomerAccessTokenDelete

getCustomerAccessTokenRenew

setCustomerAccessTokenRenew

getCustomerActivate

setCustomerActivate

getCustomerActivateByUrl

setCustomerActivateByUrl

getCustomerAddressCreate

setCustomerAddressCreate

getCustomerAddressDelete

setCustomerAddressDelete

getCustomerAddressUpdate

setCustomerAddressUpdate

getCustomerCreate

setCustomerCreate

getCustomerDefaultAddressUpdate

setCustomerDefaultAddressUpdate

getCustomerRecover

setCustomerRecover

getCustomerReset

setCustomerReset

getCustomerResetByUrl

setCustomerResetByUrl

getCustomerUpdate

setCustomerUpdate

getShopPayPaymentRequestSessionCreate

setShopPayPaymentRequestSessionCreate

getShopPayPaymentRequestSessionSubmit

setShopPayPaymentRequestSessionSubmit

unwrapsToObject