import { ShopifyMutation } from '@daffodil/driver/shopify'
The schema’s entry-point for mutations. This acts as the public, top-level API from which all mutation queries must start.
interface ShopifyMutation {
__typename: "Mutation"
cartAttributesUpdate: ShopifyCartAttributesUpdatePayload
cartBuyerIdentityUpdate: ShopifyCartBuyerIdentityUpdatePayload
cartCreate: ShopifyCartCreatePayload
cartDiscountCodesUpdate: ShopifyCartDiscountCodesUpdatePayload
cartLinesAdd: ShopifyCartLinesAddPayload
cartLinesRemove: ShopifyCartLinesRemovePayload
cartLinesUpdate: ShopifyCartLinesUpdatePayload
cartMetafieldDelete: ShopifyCartMetafieldDeletePayload
cartMetafieldsSet: ShopifyCartMetafieldsSetPayload
cartNoteUpdate: ShopifyCartNoteUpdatePayload
cartPaymentUpdate: ShopifyCartPaymentUpdatePayload
cartSelectedDeliveryOptionsUpdate: ShopifyCartSelectedDeliveryOptionsUpdatePayload
cartSubmitForCompletion: ShopifyCartSubmitForCompletionPayload
checkoutAttributesUpdateV2: ShopifyCheckoutAttributesUpdateV2Payload
checkoutCompleteFree: ShopifyCheckoutCompleteFreePayload
checkoutCompleteWithCreditCardV2: ShopifyCheckoutCompleteWithCreditCardV2Payload
checkoutCompleteWithTokenizedPaymentV3: ShopifyCheckoutCompleteWithTokenizedPaymentV3Payload
checkoutCreate: ShopifyCheckoutCreatePayload
checkoutCustomerAssociateV2: ShopifyCheckoutCustomerAssociateV2Payload
checkoutCustomerDisassociateV2: ShopifyCheckoutCustomerDisassociateV2Payload
checkoutDiscountCodeApplyV2: ShopifyCheckoutDiscountCodeApplyV2Payload
checkoutDiscountCodeRemove: ShopifyCheckoutDiscountCodeRemovePayload
checkoutEmailUpdateV2: ShopifyCheckoutEmailUpdateV2Payload
checkoutGiftCardRemoveV2: ShopifyCheckoutGiftCardRemoveV2Payload
checkoutGiftCardsAppend: ShopifyCheckoutGiftCardsAppendPayload
checkoutLineItemsAdd: ShopifyCheckoutLineItemsAddPayload
checkoutLineItemsRemove: ShopifyCheckoutLineItemsRemovePayload
checkoutLineItemsReplace: ShopifyCheckoutLineItemsReplacePayload
checkoutLineItemsUpdate: ShopifyCheckoutLineItemsUpdatePayload
checkoutShippingAddressUpdateV2: ShopifyCheckoutShippingAddressUpdateV2Payload
checkoutShippingLineUpdate: ShopifyCheckoutShippingLineUpdatePayload
customerAccessTokenCreate: ShopifyCustomerAccessTokenCreatePayload
customerAccessTokenCreateWithMultipass: ShopifyCustomerAccessTokenCreateWithMultipassPayload
customerAccessTokenDelete: ShopifyCustomerAccessTokenDeletePayload
customerAccessTokenRenew: ShopifyCustomerAccessTokenRenewPayload
customerActivate: ShopifyCustomerActivatePayload
customerActivateByUrl: ShopifyCustomerActivateByUrlPayload
customerAddressCreate: ShopifyCustomerAddressCreatePayload
customerAddressDelete: ShopifyCustomerAddressDeletePayload
customerAddressUpdate: ShopifyCustomerAddressUpdatePayload
customerCreate: ShopifyCustomerCreatePayload
customerDefaultAddressUpdate: ShopifyCustomerDefaultAddressUpdatePayload
customerRecover: ShopifyCustomerRecoverPayload
customerReset: ShopifyCustomerResetPayload
customerResetByUrl: ShopifyCustomerResetByUrlPayload
customerUpdate: ShopifyCustomerUpdatePayload
}
__typename "Mutation" |
|---|
cartAttributesUpdate ShopifyCartAttributesUpdatePayload |
|---|
Updates the attributes on a cart. |
cartBuyerIdentityUpdate ShopifyCartBuyerIdentityUpdatePayload |
|---|
Updates customer information associated with a cart. Buyer identity is used to determine international pricing and should match the customer's shipping address. |
cartCreate ShopifyCartCreatePayload |
|---|
Creates a new cart. |
cartDiscountCodesUpdate ShopifyCartDiscountCodesUpdatePayload |
|---|
Updates the discount codes applied to the cart. |
cartLinesAdd ShopifyCartLinesAddPayload |
|---|
Adds a merchandise line to the cart. |
cartLinesRemove ShopifyCartLinesRemovePayload |
|---|
Removes one or more merchandise lines from the cart. |
cartLinesUpdate ShopifyCartLinesUpdatePayload |
|---|
Updates one or more merchandise lines on a cart. |
cartMetafieldDelete ShopifyCartMetafieldDeletePayload |
|---|
Deletes a cart metafield. |
cartMetafieldsSet ShopifyCartMetafieldsSetPayload |
|---|
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 ShopifyCartNoteUpdatePayload |
|---|
Updates the note on the cart. |
cartPaymentUpdate ShopifyCartPaymentUpdatePayload |
|---|
Update the customer's payment method that will be used to checkout. |
cartSelectedDeliveryOptionsUpdate ShopifyCartSelectedDeliveryOptionsUpdatePayload |
|---|
Update the selected delivery options for a delivery group. |
cartSubmitForCompletion ShopifyCartSubmitForCompletionPayload |
|---|
Submit the cart for checkout completion. |
checkoutAttributesUpdateV2 ShopifyCheckoutAttributesUpdateV2Payload |
|---|
Updates the attributes of a checkout if |
checkoutCompleteFree ShopifyCheckoutCompleteFreePayload |
|---|
Completes a checkout without providing payment information. You can use this mutation for free items or items whose purchase price is covered by a gift card. |
checkoutCompleteWithCreditCardV2 ShopifyCheckoutCompleteWithCreditCardV2Payload |
|---|
Completes a checkout using a credit card token from Shopify's card vault. Before you can complete checkouts using CheckoutCompleteWithCreditCardV2, you need to request payment processing. |
checkoutCompleteWithTokenizedPaymentV3 ShopifyCheckoutCompleteWithTokenizedPaymentV3Payload |
|---|
Completes a checkout with a tokenized payment. |
checkoutCreate ShopifyCheckoutCreatePayload |
|---|
Creates a new checkout. |
checkoutCustomerAssociateV2 ShopifyCheckoutCustomerAssociateV2Payload |
|---|
Associates a customer to the checkout. |
checkoutCustomerDisassociateV2 ShopifyCheckoutCustomerDisassociateV2Payload |
|---|
Disassociates the current checkout customer from the checkout. |
checkoutDiscountCodeApplyV2 ShopifyCheckoutDiscountCodeApplyV2Payload |
|---|
Applies a discount to an existing checkout using a discount code. |
checkoutDiscountCodeRemove ShopifyCheckoutDiscountCodeRemovePayload |
|---|
Removes the applied discounts from an existing checkout. |
checkoutEmailUpdateV2 ShopifyCheckoutEmailUpdateV2Payload |
|---|
Updates the email on an existing checkout. |
checkoutGiftCardRemoveV2 ShopifyCheckoutGiftCardRemoveV2Payload |
|---|
Removes an applied gift card from the checkout. |
checkoutGiftCardsAppend ShopifyCheckoutGiftCardsAppendPayload |
|---|
Appends gift cards to an existing checkout. |
checkoutLineItemsAdd ShopifyCheckoutLineItemsAddPayload |
|---|
Adds a list of line items to a checkout. |
checkoutLineItemsRemove ShopifyCheckoutLineItemsRemovePayload |
|---|
Removes line items from an existing checkout. |
checkoutLineItemsReplace ShopifyCheckoutLineItemsReplacePayload |
|---|
Sets a list of line items to a checkout. |
checkoutLineItemsUpdate ShopifyCheckoutLineItemsUpdatePayload |
|---|
Updates line items on a checkout. |
checkoutShippingAddressUpdateV2 ShopifyCheckoutShippingAddressUpdateV2Payload |
|---|
Updates the shipping address of an existing checkout. |
checkoutShippingLineUpdate ShopifyCheckoutShippingLineUpdatePayload |
|---|
Updates the shipping lines on an existing checkout. |
customerAccessTokenCreate ShopifyCustomerAccessTokenCreatePayload |
|---|
Creates a customer access token. The customer access token is required to modify the customer object in any way. |
customerAccessTokenCreateWithMultipass ShopifyCustomerAccessTokenCreateWithMultipassPayload |
|---|
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. |
customerAccessTokenDelete ShopifyCustomerAccessTokenDeletePayload |
|---|
Permanently destroys a customer access token. |
customerAccessTokenRenew ShopifyCustomerAccessTokenRenewPayload |
|---|
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 |
customerActivate ShopifyCustomerActivatePayload |
|---|
Activates a customer. |
customerActivateByUrl ShopifyCustomerActivateByUrlPayload |
|---|
Activates a customer with the activation url received from |
customerAddressCreate ShopifyCustomerAddressCreatePayload |
|---|
Creates a new address for a customer. |
customerAddressDelete ShopifyCustomerAddressDeletePayload |
|---|
Permanently deletes the address of an existing customer. |
customerAddressUpdate ShopifyCustomerAddressUpdatePayload |
|---|
Updates the address of an existing customer. |
customerCreate ShopifyCustomerCreatePayload |
|---|
Creates a new customer. |
customerDefaultAddressUpdate ShopifyCustomerDefaultAddressUpdatePayload |
|---|
Updates the default address of an existing customer. |
customerRecover ShopifyCustomerRecoverPayload |
|---|
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 This mutation is throttled by IP. With private access,
you can provide a Make sure that the value provided to |
customerReset ShopifyCustomerResetPayload |
|---|
"Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the |
customerResetByUrl ShopifyCustomerResetByUrlPayload |
|---|
"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 |
customerUpdate ShopifyCustomerUpdatePayload |
|---|
Updates an existing customer. |