com.shopify.buy3

Class Storefront.MutationQuery

java.lang.Object

com.shopify.graphql.support.Query<Storefront.MutationQuery>

com.shopify.buy3.Storefront.MutationQuery

Enclosing class:

Storefront

public static class Storefront.MutationQuery
extends Query<Storefront.MutationQuery>

The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	Storefront.MutationQuery.CartBillingAddressUpdateArguments
static interface	Storefront.MutationQuery.CartBillingAddressUpdateArgumentsDefinition
class	Storefront.MutationQuery.CartCreateArguments
static interface	Storefront.MutationQuery.CartCreateArgumentsDefinition
class	Storefront.MutationQuery.CartDiscountCodesUpdateArguments
static interface	Storefront.MutationQuery.CartDiscountCodesUpdateArgumentsDefinition
class	Storefront.MutationQuery.ShopPayPaymentRequestSessionSubmitArguments
static interface	Storefront.MutationQuery.ShopPayPaymentRequestSessionSubmitArgumentsDefinition

Field Summary

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

_queryBuilder, ALIAS_SUFFIX_SEPARATOR

Method Summary

Modifier and Type	Method and Description
Storefront.MutationQuery	cartAttributesUpdate(java.util.List<Storefront.AttributeInput> attributes, ID cartId, Storefront.CartAttributesUpdatePayloadQueryDefinition queryDef) Updates the attributes on a cart.
Storefront.MutationQuery	cartBillingAddressUpdate(ID cartId, Storefront.CartBillingAddressUpdatePayloadQueryDefinition queryDef) Updates the billing address on the cart.
Storefront.MutationQuery	cartBillingAddressUpdate(ID cartId, Storefront.MutationQuery.CartBillingAddressUpdateArgumentsDefinition argsDef, Storefront.CartBillingAddressUpdatePayloadQueryDefinition queryDef) Updates the billing address on the cart.
Storefront.MutationQuery	cartBuyerIdentityUpdate(ID cartId, Storefront.CartBuyerIdentityInput buyerIdentity, Storefront.CartBuyerIdentityUpdatePayloadQueryDefinition queryDef) Updates customer information associated with a cart.
Storefront.MutationQuery	cartCreate(Storefront.CartCreatePayloadQueryDefinition queryDef) Creates a new cart.
Storefront.MutationQuery	cartCreate(Storefront.MutationQuery.CartCreateArgumentsDefinition argsDef, Storefront.CartCreatePayloadQueryDefinition queryDef) Creates a new cart.
Storefront.MutationQuery	cartDiscountCodesUpdate(ID cartId, Storefront.CartDiscountCodesUpdatePayloadQueryDefinition queryDef) Updates the discount codes applied to the cart.
Storefront.MutationQuery	cartDiscountCodesUpdate(ID cartId, Storefront.MutationQuery.CartDiscountCodesUpdateArgumentsDefinition argsDef, Storefront.CartDiscountCodesUpdatePayloadQueryDefinition queryDef) Updates the discount codes applied to the cart.
Storefront.MutationQuery	cartGiftCardCodesUpdate(ID cartId, java.util.List<java.lang.String> giftCardCodes, Storefront.CartGiftCardCodesUpdatePayloadQueryDefinition queryDef) Updates the gift card codes applied to the cart.
Storefront.MutationQuery	cartLinesAdd(java.util.List<Storefront.CartLineInput> lines, ID cartId, Storefront.CartLinesAddPayloadQueryDefinition queryDef) Adds a merchandise line to the cart.
Storefront.MutationQuery	cartLinesRemove(ID cartId, java.util.List<ID> lineIds, Storefront.CartLinesRemovePayloadQueryDefinition queryDef) Removes one or more merchandise lines from the cart.
Storefront.MutationQuery	cartLinesUpdate(ID cartId, java.util.List<Storefront.CartLineUpdateInput> lines, Storefront.CartLinesUpdatePayloadQueryDefinition queryDef) Updates one or more merchandise lines on a cart.
Storefront.MutationQuery	cartMetafieldDelete(Storefront.CartMetafieldDeleteInput input, Storefront.CartMetafieldDeletePayloadQueryDefinition queryDef) Deletes a cart metafield.
Storefront.MutationQuery	cartMetafieldsSet(java.util.List<Storefront.CartMetafieldsSetInput> metafields, Storefront.CartMetafieldsSetPayloadQueryDefinition queryDef) Sets cart metafield values.
Storefront.MutationQuery	cartNoteUpdate(ID cartId, java.lang.String note, Storefront.CartNoteUpdatePayloadQueryDefinition queryDef) Updates the note on the cart.
Storefront.MutationQuery	cartPaymentUpdate(ID cartId, Storefront.CartPaymentInput payment, Storefront.CartPaymentUpdatePayloadQueryDefinition queryDef) Update the customer's payment method that will be used to checkout.
Storefront.MutationQuery	cartSelectedDeliveryOptionsUpdate(ID cartId, java.util.List<Storefront.CartSelectedDeliveryOptionInput> selectedDeliveryOptions, Storefront.CartSelectedDeliveryOptionsUpdatePayloadQueryDefinition queryDef) Update the selected delivery options for a delivery group.
Storefront.MutationQuery	cartSubmitForCompletion(ID cartId, java.lang.String attemptToken, Storefront.CartSubmitForCompletionPayloadQueryDefinition queryDef) Submit the cart for checkout completion.
Storefront.MutationQuery	customerAccessTokenCreate(Storefront.CustomerAccessTokenCreateInput input, Storefront.CustomerAccessTokenCreatePayloadQueryDefinition queryDef) Creates a customer access token.
Storefront.MutationQuery	customerAccessTokenCreateWithMultipass(java.lang.String multipassToken, Storefront.CustomerAccessTokenCreateWithMultipassPayloadQueryDefinition queryDef) Creates a customer access token using a [multipass token](https://shopify.dev/api/multipass) instead of email and password.
Storefront.MutationQuery	customerAccessTokenDelete(java.lang.String customerAccessToken, Storefront.CustomerAccessTokenDeletePayloadQueryDefinition queryDef) Permanently destroys a customer access token.
Storefront.MutationQuery	customerAccessTokenRenew(java.lang.String customerAccessToken, Storefront.CustomerAccessTokenRenewPayloadQueryDefinition queryDef) Renews a customer access token.
Storefront.MutationQuery	customerActivate(ID id, Storefront.CustomerActivateInput input, Storefront.CustomerActivatePayloadQueryDefinition queryDef) Activates a customer.
Storefront.MutationQuery	customerActivateByUrl(java.lang.String activationUrl, java.lang.String password, Storefront.CustomerActivateByUrlPayloadQueryDefinition queryDef) Activates a customer with the activation url received from `customerCreate`.
Storefront.MutationQuery	customerAddressCreate(java.lang.String customerAccessToken, Storefront.MailingAddressInput address, Storefront.CustomerAddressCreatePayloadQueryDefinition queryDef) Creates a new address for a customer.
Storefront.MutationQuery	customerAddressDelete(ID id, java.lang.String customerAccessToken, Storefront.CustomerAddressDeletePayloadQueryDefinition queryDef) Permanently deletes the address of an existing customer.
Storefront.MutationQuery	customerAddressUpdate(java.lang.String customerAccessToken, ID id, Storefront.MailingAddressInput address, Storefront.CustomerAddressUpdatePayloadQueryDefinition queryDef) Updates the address of an existing customer.
Storefront.MutationQuery	customerCreate(Storefront.CustomerCreateInput input, Storefront.CustomerCreatePayloadQueryDefinition queryDef) Creates a new customer.
Storefront.MutationQuery	customerDefaultAddressUpdate(java.lang.String customerAccessToken, ID addressId, Storefront.CustomerDefaultAddressUpdatePayloadQueryDefinition queryDef) Updates the default address of an existing customer.
Storefront.MutationQuery	customerRecover(java.lang.String email, Storefront.CustomerRecoverPayloadQueryDefinition queryDef) Sends a reset password email to the customer.
Storefront.MutationQuery	customerReset(ID id, Storefront.CustomerResetInput input, Storefront.CustomerResetPayloadQueryDefinition queryDef) "Resets a customer’s password with the token received from a reset password email.
Storefront.MutationQuery	customerResetByUrl(java.lang.String resetUrl, java.lang.String password, Storefront.CustomerResetByUrlPayloadQueryDefinition queryDef) "Resets a customer’s password with the reset password URL received from a reset password email.
Storefront.MutationQuery	customerUpdate(java.lang.String customerAccessToken, Storefront.CustomerUpdateInput customer, Storefront.CustomerUpdatePayloadQueryDefinition queryDef) Updates an existing customer.
Storefront.MutationQuery	shopPayPaymentRequestSessionCreate(java.lang.String sourceIdentifier, Storefront.ShopPayPaymentRequestInput paymentRequest, Storefront.ShopPayPaymentRequestSessionCreatePayloadQueryDefinition queryDef) Create a new Shop Pay payment request session.
Storefront.MutationQuery	shopPayPaymentRequestSessionSubmit(java.lang.String token, Storefront.ShopPayPaymentRequestInput paymentRequest, java.lang.String idempotencyKey, Storefront.MutationQuery.ShopPayPaymentRequestSessionSubmitArgumentsDefinition argsDef, Storefront.ShopPayPaymentRequestSessionSubmitPayloadQueryDefinition queryDef) Submits a Shop Pay payment request session.
Storefront.MutationQuery	shopPayPaymentRequestSessionSubmit(java.lang.String token, Storefront.ShopPayPaymentRequestInput paymentRequest, java.lang.String idempotencyKey, Storefront.ShopPayPaymentRequestSessionSubmitPayloadQueryDefinition queryDef) Submits a Shop Pay payment request session.
java.lang.String	toString()

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

appendQuotedString, startField, startInlineFragment, withAlias

Methods inherited from class java.lang.Object

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

Method Detail

cartAttributesUpdate

public Storefront.MutationQuery cartAttributesUpdate(java.util.List<Storefront.AttributeInput> attributes,
                                                     ID cartId,
                                                     Storefront.CartAttributesUpdatePayloadQueryDefinition queryDef)

Updates the attributes on a cart.

cartBillingAddressUpdate

public Storefront.MutationQuery cartBillingAddressUpdate(ID cartId,
                                                         Storefront.CartBillingAddressUpdatePayloadQueryDefinition queryDef)

Updates the billing address on the cart.

cartBillingAddressUpdate

public Storefront.MutationQuery cartBillingAddressUpdate(ID cartId,
                                                         Storefront.MutationQuery.CartBillingAddressUpdateArgumentsDefinition argsDef,
                                                         Storefront.CartBillingAddressUpdatePayloadQueryDefinition queryDef)

Updates the billing address on the cart.

cartBuyerIdentityUpdate

public Storefront.MutationQuery cartBuyerIdentityUpdate(ID cartId,
                                                        Storefront.CartBuyerIdentityInput buyerIdentity,
                                                        Storefront.CartBuyerIdentityUpdatePayloadQueryDefinition queryDef)

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.

cartCreate

public Storefront.MutationQuery cartCreate(Storefront.CartCreatePayloadQueryDefinition queryDef)

Creates a new cart.

cartCreate

public Storefront.MutationQuery cartCreate(Storefront.MutationQuery.CartCreateArgumentsDefinition argsDef,
                                           Storefront.CartCreatePayloadQueryDefinition queryDef)

Creates a new cart.

cartDiscountCodesUpdate

public Storefront.MutationQuery cartDiscountCodesUpdate(ID cartId,
                                                        Storefront.CartDiscountCodesUpdatePayloadQueryDefinition queryDef)

Updates the discount codes applied to the cart.

cartDiscountCodesUpdate

public Storefront.MutationQuery cartDiscountCodesUpdate(ID cartId,
                                                        Storefront.MutationQuery.CartDiscountCodesUpdateArgumentsDefinition argsDef,
                                                        Storefront.CartDiscountCodesUpdatePayloadQueryDefinition queryDef)

Updates the discount codes applied to the cart.

cartGiftCardCodesUpdate

public Storefront.MutationQuery cartGiftCardCodesUpdate(ID cartId,
                                                        java.util.List<java.lang.String> giftCardCodes,
                                                        Storefront.CartGiftCardCodesUpdatePayloadQueryDefinition queryDef)

Updates the gift card codes applied to the cart.

cartLinesAdd

public Storefront.MutationQuery cartLinesAdd(java.util.List<Storefront.CartLineInput> lines,
                                             ID cartId,
                                             Storefront.CartLinesAddPayloadQueryDefinition queryDef)

Adds a merchandise line to the cart.

cartLinesRemove

public Storefront.MutationQuery cartLinesRemove(ID cartId,
                                                java.util.List<ID> lineIds,
                                                Storefront.CartLinesRemovePayloadQueryDefinition queryDef)

Removes one or more merchandise lines from the cart.

cartLinesUpdate

public Storefront.MutationQuery cartLinesUpdate(ID cartId,
                                                java.util.List<Storefront.CartLineUpdateInput> lines,
                                                Storefront.CartLinesUpdatePayloadQueryDefinition queryDef)

Updates one or more merchandise lines on a cart.

cartMetafieldDelete

public Storefront.MutationQuery cartMetafieldDelete(Storefront.CartMetafieldDeleteInput input,
                                                    Storefront.CartMetafieldDeletePayloadQueryDefinition queryDef)

Deletes a cart metafield.

cartMetafieldsSet

public Storefront.MutationQuery cartMetafieldsSet(java.util.List<Storefront.CartMetafieldsSetInput> metafields,
                                                  Storefront.CartMetafieldsSetPayloadQueryDefinition queryDef)

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.

cartNoteUpdate

public Storefront.MutationQuery cartNoteUpdate(ID cartId,
                                               java.lang.String note,
                                               Storefront.CartNoteUpdatePayloadQueryDefinition queryDef)

Updates the note on the cart.

cartPaymentUpdate

public Storefront.MutationQuery cartPaymentUpdate(ID cartId,
                                                  Storefront.CartPaymentInput payment,
                                                  Storefront.CartPaymentUpdatePayloadQueryDefinition queryDef)

Update the customer's payment method that will be used to checkout.

cartSelectedDeliveryOptionsUpdate

public Storefront.MutationQuery cartSelectedDeliveryOptionsUpdate(ID cartId,
                                                                  java.util.List<Storefront.CartSelectedDeliveryOptionInput> selectedDeliveryOptions,
                                                                  Storefront.CartSelectedDeliveryOptionsUpdatePayloadQueryDefinition queryDef)

Update the selected delivery options for a delivery group.

cartSubmitForCompletion

public Storefront.MutationQuery cartSubmitForCompletion(ID cartId,
                                                        java.lang.String attemptToken,
                                                        Storefront.CartSubmitForCompletionPayloadQueryDefinition queryDef)

Submit the cart for checkout completion.

customerAccessTokenCreate

public Storefront.MutationQuery customerAccessTokenCreate(Storefront.CustomerAccessTokenCreateInput input,
                                                          Storefront.CustomerAccessTokenCreatePayloadQueryDefinition queryDef)

Creates a customer access token. The customer access token is required to modify the customer object in any way.

customerAccessTokenCreateWithMultipass

public Storefront.MutationQuery customerAccessTokenCreateWithMultipass(java.lang.String multipassToken,
                                                                       Storefront.CustomerAccessTokenCreateWithMultipassPayloadQueryDefinition queryDef)

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.

customerAccessTokenDelete

public Storefront.MutationQuery customerAccessTokenDelete(java.lang.String customerAccessToken,
                                                          Storefront.CustomerAccessTokenDeletePayloadQueryDefinition queryDef)

Permanently destroys a customer access token.

customerAccessTokenRenew

public Storefront.MutationQuery customerAccessTokenRenew(java.lang.String customerAccessToken,
                                                         Storefront.CustomerAccessTokenRenewPayloadQueryDefinition queryDef)

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`.

customerActivate

public Storefront.MutationQuery customerActivate(ID id,
                                                 Storefront.CustomerActivateInput input,
                                                 Storefront.CustomerActivatePayloadQueryDefinition queryDef)

Activates a customer.

customerActivateByUrl

public Storefront.MutationQuery customerActivateByUrl(java.lang.String activationUrl,
                                                      java.lang.String password,
                                                      Storefront.CustomerActivateByUrlPayloadQueryDefinition queryDef)

Activates a customer with the activation url received from `customerCreate`.

customerAddressCreate

public Storefront.MutationQuery customerAddressCreate(java.lang.String customerAccessToken,
                                                      Storefront.MailingAddressInput address,
                                                      Storefront.CustomerAddressCreatePayloadQueryDefinition queryDef)

Creates a new address for a customer.

customerAddressDelete

public Storefront.MutationQuery customerAddressDelete(ID id,
                                                      java.lang.String customerAccessToken,
                                                      Storefront.CustomerAddressDeletePayloadQueryDefinition queryDef)

Permanently deletes the address of an existing customer.

customerAddressUpdate

public Storefront.MutationQuery customerAddressUpdate(java.lang.String customerAccessToken,
                                                      ID id,
                                                      Storefront.MailingAddressInput address,
                                                      Storefront.CustomerAddressUpdatePayloadQueryDefinition queryDef)

Updates the address of an existing customer.

customerCreate

public Storefront.MutationQuery customerCreate(Storefront.CustomerCreateInput input,
                                               Storefront.CustomerCreatePayloadQueryDefinition queryDef)

Creates a new customer.

customerDefaultAddressUpdate

public Storefront.MutationQuery customerDefaultAddressUpdate(java.lang.String customerAccessToken,
                                                             ID addressId,
                                                             Storefront.CustomerDefaultAddressUpdatePayloadQueryDefinition queryDef)

Updates the default address of an existing customer.

customerRecover

public Storefront.MutationQuery customerRecover(java.lang.String email,
                                                Storefront.CustomerRecoverPayloadQueryDefinition queryDef)

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.

customerReset

public Storefront.MutationQuery customerReset(ID id,
                                              Storefront.CustomerResetInput input,
                                              Storefront.CustomerResetPayloadQueryDefinition queryDef)

"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."

customerResetByUrl

public Storefront.MutationQuery customerResetByUrl(java.lang.String resetUrl,
                                                   java.lang.String password,
                                                   Storefront.CustomerResetByUrlPayloadQueryDefinition queryDef)

"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."

customerUpdate

public Storefront.MutationQuery customerUpdate(java.lang.String customerAccessToken,
                                               Storefront.CustomerUpdateInput customer,
                                               Storefront.CustomerUpdatePayloadQueryDefinition queryDef)

Updates an existing customer.

shopPayPaymentRequestSessionCreate

public Storefront.MutationQuery shopPayPaymentRequestSessionCreate(java.lang.String sourceIdentifier,
                                                                   Storefront.ShopPayPaymentRequestInput paymentRequest,
                                                                   Storefront.ShopPayPaymentRequestSessionCreatePayloadQueryDefinition queryDef)

Create a new Shop Pay payment request session.

shopPayPaymentRequestSessionSubmit

public Storefront.MutationQuery shopPayPaymentRequestSessionSubmit(java.lang.String token,
                                                                   Storefront.ShopPayPaymentRequestInput paymentRequest,
                                                                   java.lang.String idempotencyKey,
                                                                   Storefront.ShopPayPaymentRequestSessionSubmitPayloadQueryDefinition queryDef)

Submits a Shop Pay payment request session.

shopPayPaymentRequestSessionSubmit

public Storefront.MutationQuery shopPayPaymentRequestSessionSubmit(java.lang.String token,
                                                                   Storefront.ShopPayPaymentRequestInput paymentRequest,
                                                                   java.lang.String idempotencyKey,
                                                                   Storefront.MutationQuery.ShopPayPaymentRequestSessionSubmitArgumentsDefinition argsDef,
                                                                   Storefront.ShopPayPaymentRequestSessionSubmitPayloadQueryDefinition queryDef)

Submits a Shop Pay payment request session.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object