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 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 cartCreatecart•Cart
Create Create Payload Creates a new cart.
- Anchor to cartDeliveryAddressesAddcart•Cart
Delivery Addresses Add Delivery Addresses Add Payload Adds delivery addresses to the cart.
- Anchor to cartDeliveryAddressesRemovecart•Cart
Delivery Addresses Remove Delivery Addresses Remove Payload Removes delivery addresses from the cart.
- Anchor to cartDeliveryAddressesUpdatecart•Cart
Delivery Addresses Update Delivery Addresses Update Payload Updates one or more delivery addresses on a cart.
- Anchor to cartDiscountCodesUpdatecart•Cart
Discount Codes Update Discount Codes Update Payload Updates the discount codes applied to the cart.
- Anchor to cartGiftCardCodesRemovecart•Cart
Gift Card Codes Remove Gift Card Codes Remove Payload Removes the gift card codes applied to the cart.
- Anchor to cartGiftCardCodesUpdatecart•Cart
Gift Card Codes Update Gift Card Codes Update Payload Updates the gift card codes applied to the cart.
- Anchor to cartLinesAddcart•Cart
Lines Add Lines Add Payload Adds a merchandise line to the cart.
- Anchor to cartLinesRemovecart•Cart
Lines Remove Lines Remove Payload Removes one or more merchandise lines from the cart.
- Anchor to cartLinesUpdatecart•Cart
Lines Update Lines Update Payload Updates one or more merchandise lines on a cart.
- Anchor to cartMetafieldDeletecart•Cart
Metafield Delete Metafield Delete Payload Deletes a cart metafield.
- 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 cartNoteUpdatecart•Cart
Note Update Note Update Payload Updates the note on the cart.
- Anchor to cartSelectedDeliveryOptionsUpdatecart•Cart
Selected Delivery Options Update Selected Delivery Options Update Payload Update the selected delivery options for a delivery group.
- Anchor to customerAccessTokenCreatecustomer•Customer
Access Token Create Access Token Create Payload Creates a customer access token. The customer access token is required to modify the customer object in any way.
- Anchor to customerAccessTokenCreateWithMultipasscustomer•Customer
Access Token Create With Multipass Access Token Create With Multipass Payload 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 customerAccessTokenDeletecustomer•Customer
Access Token Delete Access Token Delete Payload Permanently destroys a customer access token.
- Anchor to customerAccessTokenRenewcustomer•Customer
Access Token Renew Access Token Renew Payload 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 customerActivatecustomer•Customer
Activate Activate Payload Activates a customer.
- Anchor to customerActivateByUrlcustomer•Customer
Activate By Url Activate By Url Payload Activates a customer with the activation url received from
.- Anchor to customerAddressCreatecustomer•Customer
Address Create Address Create Payload Creates a new address for a customer.
- Anchor to customerAddressDeletecustomer•Customer
Address Delete Address Delete Payload Permanently deletes the address of an existing customer.
- Anchor to customerAddressUpdatecustomer•Customer
Address Update Address Update Payload Updates the address of an existing customer.
- Anchor to customerCreatecustomer•Customer
Create Create Payload Creates a new customer.
- Anchor to customerDefaultAddressUpdatecustomer•Customer
Default Address Update Default Address Update Payload Updates the default address of an existing customer.
- Anchor to customerRecovercustomer•Customer
Recover Recover Payload 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 customerResetcustomer•Customer
Reset Reset Payload "Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the
mutation."- Anchor to customerResetByUrlcustomer•Customer
Reset By Url Reset By Url Payload "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 customerUpdatecustomer•Customer
Update Update Payload Updates an existing customer.
- 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 shopPayPaymentRequestSessionSubmitshop•Shop
Pay Payment Request Session Submit Pay Payment Request Session Submit Payload Submits a Shop Pay payment request session.