Mutation
The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start.
Anchor to FieldsFields
- Anchor to cartAttributesUpdatecart•Cart
Attributes Update Attributes Update Payload Updates the attributes on a cart.
- Anchor to attributesattributes•[Attribute
Input!]! required An array of key-value pairs that contains additional information about the cart.
The input must not contain more than
250values.- Anchor to cartIdcart•ID!
Id required The ID of the cart.
Arguments
- Anchor to cartBuyerIdentityUpdatecart•Cart
Buyer Identity Update Buyer Identity Update Payload Updates customer information associated with a cart. Buyer identity is used to determine international pricing and should match the customer's shipping address.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to buyerIdentitybuyer•Cart
Identity Buyer Identity Input! required The customer associated with the cart. Used to determine international pricing. Buyer identity should match the customer's shipping address.
Arguments
- Anchor to cartCreatecart•Cart
Create Create Payload Creates a new cart.
- Anchor to inputinput•Cart
Input The fields used to create a cart.
Arguments
- Anchor to cartDeliveryAddressesAddcart•Cart
Delivery Addresses Add Delivery Addresses Add Payload Adds delivery addresses to the cart.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to addressesaddresses•[Cart
Selectable Address Input!]! required A list of delivery addresses to add to the cart.
The input must not contain more than
250values.
Arguments
- Anchor to cartDeliveryAddressesRemovecart•Cart
Delivery Addresses Remove Delivery Addresses Remove Payload Removes delivery addresses from the cart.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to addressIdsaddress•[ID!]!
Ids required A list of delivery addresses by handle to remove from the cart.
The input must not contain more than
250values.
Arguments
- Anchor to cartDeliveryAddressesReplacecart•Cart
Delivery Addresses Replace Delivery Addresses Replace Payload Replaces delivery addresses on the cart.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to addressesaddresses•[Cart
Selectable Address Input!]! required A list of delivery addresses to replace on the cart.
The input must not contain more than
250values.
Arguments
- Anchor to cartDeliveryAddressesUpdatecart•Cart
Delivery Addresses Update Delivery Addresses Update Payload Updates one or more delivery addresses on a cart.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to addressesaddresses•[Cart
Selectable Address Update Input!]! required The delivery addresses to update.
The input must not contain more than
250values.
Arguments
- Anchor to cartDiscountCodesUpdatecart•Cart
Discount Codes Update Discount Codes Update Payload Updates the discount codes applied to the cart.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to discountCodesdiscount•[String!]!
Codes required The case-insensitive discount codes that the customer added at checkout.
The input must not contain more than
250values.
Arguments
- Anchor to cartGiftCardCodesAddcart•Cart
Gift Card Codes Add Gift Card Codes Add Payload Adds gift card codes to the cart without replacing existing ones.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to giftCardCodesgift•[String!]!
Card Codes required The case-insensitive gift card codes to add.
The input must not contain more than
250values.
Arguments
- Anchor to cartGiftCardCodesRemovecart•Cart
Gift Card Codes Remove Gift Card Codes Remove Payload Removes the gift card codes applied to the cart.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to appliedGiftCardIdsapplied•[ID!]!
Gift Card Ids required The gift cards to remove.
The input must not contain more than
250values.
Arguments
- Anchor to cartGiftCardCodesUpdatecart•Cart
Gift Card Codes Update Gift Card Codes Update Payload Updates the gift card codes applied to the cart.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to giftCardCodesgift•[String!]!
Card Codes required The case-insensitive gift card codes.
The input must not contain more than
250values.
Arguments
- Anchor to cartLinesAddcart•Cart
Lines Add Lines Add Payload Adds a merchandise line to the cart.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to lineslines•[Cart
Line Input!]! required A list of merchandise lines to add to the cart.
The input must not contain more than
250values.
Arguments
- Anchor to cartLinesRemovecart•Cart
Lines Remove Lines Remove Payload Removes one or more merchandise lines from the cart.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to lineIdsline•[ID!]!
Ids required The merchandise line IDs to remove.
The input must not contain more than
250values.
Arguments
- Anchor to cartLinesUpdatecart•Cart
Lines Update Lines Update Payload Updates one or more merchandise lines on a cart.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to lineslines•[Cart
Line Update Input!]! required The merchandise lines to update.
The input must not contain more than
250values.
Arguments
- Anchor to cartMetafieldDeletecart•Cart
Metafield Delete Metafield Delete Payload Deletes a cart metafield.
- Anchor to inputinput•Cart
Metafield Delete Input! required The input fields used to delete a cart metafield.
Arguments
- Anchor to cartMetafieldsSetcart•Cart
Metafields Set Metafields Set Payload 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.
- Anchor to metafieldsmetafields•[Cart
Metafields Set Input!]! required The list of Cart metafield values to set. Maximum of 25.
The input must not contain more than
250values.
Arguments
- Anchor to cartNoteUpdatecart•Cart
Note Update Note Update Payload Updates the note on the cart.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to notenote•String!required
The note on the cart.
Arguments
- Anchor to cartSelectedDeliveryOptionsUpdatecart•Cart
Selected Delivery Options Update Selected Delivery Options Update Payload Update the selected delivery options for a delivery group.
- Anchor to cartIdcart•ID!
Id required The ID of the cart.
- Anchor to selectedDeliveryOptionsselected•[Cart
Delivery Options Selected Delivery Option Input!]! required The selected delivery options.
The input must not contain more than
250values.
Arguments
- Anchor to customerAccessTokenCreatecustomer•Customer
Access Token Create Access Token Create Payload Token access required Creates a customer access token. The customer access token is required to modify the customer object in any way.
- Anchor to inputinput•Customer
Access Token Create Input! required The fields used to create a customer access token.
Arguments
- Anchor to customerAccessTokenCreateWithMultipasscustomer•Customer
Access Token Create With Multipass Access Token Create With Multipass Payload Token access required Creates a customer access token using a multipass token 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.
- Anchor to multipassTokenmultipass•String!
Token required A valid multipass token to be authenticated.
Arguments
- Anchor to customerAccessTokenDeletecustomer•Customer
Access Token Delete Access Token Delete Payload Token access required Permanently destroys a customer access token.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
Arguments
- Anchor to customerAccessTokenRenewcustomer•Customer
Access Token Renew Access Token Renew Payload Token access required 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
.- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
Arguments
- Anchor to customerActivatecustomer•Customer
Activate Activate Payload Token access required Activates a customer.
- •ID!required
Specifies the customer to activate.
- Anchor to inputinput•Customer
Activate Input! required The fields used to activate a customer.
Arguments
- •ID!
- Anchor to customerActivateByUrlcustomer•Customer
Activate By Url Activate By Url Payload Token access required Activates a customer with the activation url received from
.- Anchor to activationUrlactivation•URL!
Url required The customer activation URL.
- Anchor to passwordpassword•String!required
A new password set during activation.
Arguments
- Anchor to customerAddressCreatecustomer•Customer
Address Create Address Create Payload Token access required Creates a new address for a customer.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
- Anchor to addressaddress•Mailing
Address Input! required The customer mailing address to create.
Arguments
- Anchor to customerAddressDeletecustomer•Customer
Address Delete Address Delete Payload Token access required Permanently deletes the address of an existing customer.
- •ID!required
Specifies the address to delete.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
Arguments
- •ID!
- Anchor to customerAddressUpdatecustomer•Customer
Address Update Address Update Payload Token access required Updates the address of an existing customer.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
- •ID!required
Specifies the customer address to update.
- Anchor to addressaddress•Mailing
Address Input! required The customer’s mailing address.
Arguments
- Anchor to customerCreatecustomer•Customer
Create Create Payload Token access required Creates a new customer.
- Anchor to inputinput•Customer
Create Input! required The fields used to create a new customer.
Arguments
- Anchor to customerDefaultAddressUpdatecustomer•Customer
Default Address Update Default Address Update Payload Token access required Updates the default address of an existing customer.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
- Anchor to addressIdaddress•ID!
Id required ID of the address to set as the new default for the customer.
Arguments
- Anchor to customerRecovercustomer•Customer
Recover Recover Payload Token access required 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
ormutation to reset the customer password.This mutation is throttled by IP. With private access, you can provide a
instead of the request IP. The header is case-sensitive and must be sent as.Make sure that the value provided to
is trusted. Unthrottled access to this mutation presents a security risk.- Anchor to emailemail•String!required
The email address of the customer to recover.
Arguments
- Anchor to customerResetcustomer•Customer
Reset Reset Payload Token access required "Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the
mutation."- •ID!required
Specifies the customer to reset.
- Anchor to inputinput•Customer
Reset Input! required The fields used to reset a customer’s password.
Arguments
- •ID!
- Anchor to customerResetByUrlcustomer•Customer
Reset By Url Reset By Url Payload Token access required "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
mutation."- Anchor to resetUrlreset•URL!
Url required The customer's reset password url.
- Anchor to passwordpassword•String!required
New password that will be set as part of the reset password process.
Arguments
- Anchor to customerUpdatecustomer•Customer
Update Update Payload Token access required Updates an existing customer.
- Anchor to customerAccessTokencustomer•String!
Access Token required The access token used to identify the customer.
- Anchor to customercustomer•Customer
Update Input! required The customer object input.
Arguments
- Anchor to shopPayPaymentRequestSessionCreateshop•Shop
Pay Payment Request Session Create Pay Payment Request Session Create Payload Create a new Shop Pay payment request session.
- Anchor to sourceIdentifiersource•String!
Identifier required A unique identifier for the payment request session.
- Anchor to paymentRequestpayment•Shop
Request Pay Payment Request Input! required A payment request object.
Arguments
- Anchor to shopPayPaymentRequestSessionSubmitshop•Shop
Pay Payment Request Session Submit Pay Payment Request Session Submit Payload Submits a Shop Pay payment request session.
- Anchor to tokentoken•String!required
A token representing a payment session request.
- Anchor to paymentRequestpayment•Shop
Request Pay Payment Request Input! required The final payment request object.
- Anchor to idempotencyKeyidempotency•String!
Key required The idempotency key is used to guarantee an idempotent result.
- Anchor to orderNameorder•String
Name The order name to be used for the order created from the payment request.
Arguments