OBJECT
Mutation

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

type Mutation {
#   Updates the attributes of a checkout.
# 
# Arguments
#   checkoutId: The ID of the checkout.
#   input: [Not documented]
checkoutAttributesUpdate(
checkoutId: ID!,
input: CheckoutAttributesUpdateInput!
): CheckoutAttributesUpdatePayload 
# Arguments
#   checkoutId: The ID of the checkout.
checkoutCompleteFree(checkoutId: ID!): CheckoutCompleteFreePayload 
#   Completes a checkout using a credit card token from Shopify's Vault.
# 
# Arguments
#   checkoutId: The ID of the checkout.
#   payment: [Not documented]
checkoutCompleteWithCreditCard(
checkoutId: ID!,
payment: CreditCardPaymentInput!
): CheckoutCompleteWithCreditCardPayload 
#   Completes a checkout with a tokenized payment.
# 
# Arguments
#   checkoutId: The ID of the checkout.
#   payment: [Not documented]
checkoutCompleteWithTokenizedPayment(
checkoutId: ID!,
payment: TokenizedPaymentInput!
): CheckoutCompleteWithTokenizedPaymentPayload 
#   Creates a new checkout.
# 
# Arguments
#   input: [Not documented]
checkoutCreate(input: CheckoutCreateInput!): CheckoutCreatePayload 
#   Associates a customer to the checkout.
# 
# Arguments
#   checkoutId: The ID of the checkout.
#   customerAccessToken: The customer access token of the customer 
#   to associate.
checkoutCustomerAssociate(
checkoutId: ID!,
customerAccessToken: String!
): CheckoutCustomerAssociatePayload 
#   Disassociates the current checkout customer from the checkout.
# 
# Arguments
#   checkoutId: The ID of the checkout.
checkoutCustomerDisassociate(checkoutId: ID!): CheckoutCustomerDisassociatePayload 
#   Updates the email on an existing checkout.
# 
# Arguments
#   checkoutId: The ID of the checkout.
#   email: The email to update the checkout with.
checkoutEmailUpdate(checkoutId: ID!, email: String!): CheckoutEmailUpdatePayload 
#   Applies a gift card to an existing checkout using a gift card code.
# 
# Arguments
#   giftCardCode: The code of the gift card to apply on the 
#   checkout.
#   checkoutId: The ID of the checkout.
checkoutGiftCardApply(
giftCardCode: String!,
checkoutId: ID!
): CheckoutGiftCardApplyPayload 
#   Removes an applied gift card from the checkout.
# 
# Arguments
#   appliedGiftCardId: The ID of the Applied Gift Card to remove 
#   from the Checkout
#   checkoutId: The ID of the Checkout
checkoutGiftCardRemove(
appliedGiftCardId: ID!,
checkoutId: ID!
): CheckoutGiftCardRemovePayload 
#   Adds a list of line items to a checkout.
# 
# Arguments
#   lineItems: A list of line item objects to add to the checkout.
#   checkoutId: The ID of the checkout.
checkoutLineItemsAdd(
lineItems: [CheckoutLineItemInput!]!,
checkoutId: ID!
): CheckoutLineItemsAddPayload 
#   Removes line items from an existing checkout
# 
# Arguments
#   checkoutId: the checkout on which to remove line items
#   lineItemIds: line item ids to remove
checkoutLineItemsRemove(
checkoutId: ID!,
lineItemIds: [ID!]!
): CheckoutLineItemsRemovePayload 
#   Updates line items on a checkout.
# 
# Arguments
#   checkoutId: the checkout on which to update line items.
#   lineItems: line items to update.
checkoutLineItemsUpdate(
checkoutId: ID!,
lineItems: [CheckoutLineItemUpdateInput!]!
): CheckoutLineItemsUpdatePayload 
#   Updates the shipping address of an existing checkout.
# 
# Arguments
#   shippingAddress: The shipping address to where the line items 
#   will be shipped.
#   checkoutId: The ID of the checkout.
checkoutShippingAddressUpdate(
shippingAddress: MailingAddressInput!,
checkoutId: ID!
): CheckoutShippingAddressUpdatePayload 
#   Updates the shipping lines on an existing checkout.
# 
# Arguments
#   checkoutId: The ID of the checkout.
#   shippingRateHandle: A concatenation of a Checkout’s shipping 
#   provider, price, and title, enabling the customer to select the 
#   availableShippingRates.
checkoutShippingLineUpdate(
checkoutId: ID!,
shippingRateHandle: String!
): CheckoutShippingLineUpdatePayload 
#   Creates a customer access token.
#   The customer access token is required to modify the customer object in any way.
# 
# Arguments
#   input: [Not documented]
customerAccessTokenCreate(
input: CustomerAccessTokenCreateInput!
): CustomerAccessTokenCreatePayload 
#   Permanently destroys a customer access token.
# 
# Arguments
#   customerAccessToken: The access token used to identify the 
#   customer.
customerAccessTokenDelete(
customerAccessToken: String!
): CustomerAccessTokenDeletePayload 
#   Renews a customer access token.
# 
# Arguments
#   customerAccessToken: The access token used to identify the 
#   customer.
customerAccessTokenRenew(customerAccessToken: String!): CustomerAccessTokenRenewPayload 
#   Activates a customer.
# 
# Arguments
#   id: Specifies the customer to activate.
#   input: [Not documented]
customerActivate(id: ID!, input: CustomerActivateInput!): CustomerActivatePayload 
#   Creates a new address for a customer.
# 
# Arguments
#   customerAccessToken: The access token used to identify the 
#   customer.
#   address: The customer mailing address to create.
customerAddressCreate(
customerAccessToken: String!,
address: MailingAddressInput!
): CustomerAddressCreatePayload 
#   Permanently deletes the address of an existing customer.
# 
# Arguments
#   id: Specifies the address to delete.
#   customerAccessToken: The access token used to identify the 
#   customer.
customerAddressDelete(id: ID!, customerAccessToken: String!): CustomerAddressDeletePayload 
#   Updates the address of an existing customer.
# 
# Arguments
#   customerAccessToken: The access token used to identify the 
#   customer.
#   id: Specifies the customer address to update.
#   address: The customer’s mailing address.
customerAddressUpdate(
customerAccessToken: String!,
id: ID!,
address: MailingAddressInput!
): CustomerAddressUpdatePayload 
#   Creates a new customer.
# 
# Arguments
#   input: [Not documented]
customerCreate(input: CustomerCreateInput!): CustomerCreatePayload 
#   Sends a reset password email to the customer, as the first step in the reset 
#   password process.
# 
# Arguments
#   email: The email address of the customer to recover.
customerRecover(email: String!): CustomerRecoverPayload 
#   Resets a customer’s password with a token received from `CustomerRecover`.
# 
# Arguments
#   id: Specifies the customer to reset.
#   input: [Not documented]
customerReset(id: ID!, input: CustomerResetInput!): CustomerResetPayload 
#   Updates an existing customer.
# 
# Arguments
#   customerAccessToken: The access token used to identify the 
#   customer.
#   customer: The customer object input.
customerUpdate(
customerAccessToken: String!,
customer: CustomerUpdateInput!
): CustomerUpdatePayload 
}
Require by

This element is not required by anyone
Mutation

link GraphQL Schema definition

link Require by

GraphQL Schema definition

Require by
