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

Inheritance diagram for Shopify.Unity.Mutation:

Public Member Functions
	Mutation (Dictionary< string, object > dataJSON)
	Accepts deserialized json data. Will further parse passed in data. More...

CheckoutAttributesUpdatePayload	checkoutAttributesUpdate (string alias=null)
	Updates the attributes of a checkout. More...

CheckoutAttributesUpdateV2payload	checkoutAttributesUpdateV2 (string alias=null)
	Updates the attributes of a checkout. More...

CheckoutCompleteFreePayload	checkoutCompleteFree (string alias=null)
	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. More...

CheckoutCompleteWithCreditCardPayload	checkoutCompleteWithCreditCard (string alias=null)
	Completes a checkout using a credit card token from Shopify's Vault. More...

CheckoutCompleteWithCreditCardV2payload	checkoutCompleteWithCreditCardV2 (string alias=null)
	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. More...

CheckoutCompleteWithTokenizedPaymentPayload	checkoutCompleteWithTokenizedPayment (string alias=null)
	Completes a checkout with a tokenized payment. More...

CheckoutCompleteWithTokenizedPaymentV2payload	checkoutCompleteWithTokenizedPaymentV2 (string alias=null)
	Completes a checkout with a tokenized payment. More...

CheckoutCreatePayload	checkoutCreate (string alias=null)
	Creates a new checkout. More...

CheckoutCustomerAssociatePayload	checkoutCustomerAssociate (string alias=null)
	Associates a customer to the checkout. More...

CheckoutCustomerAssociateV2payload	checkoutCustomerAssociateV2 (string alias=null)
	Associates a customer to the checkout. More...

CheckoutCustomerDisassociatePayload	checkoutCustomerDisassociate (string alias=null)
	Disassociates the current checkout customer from the checkout. More...

CheckoutCustomerDisassociateV2payload	checkoutCustomerDisassociateV2 (string alias=null)
	Disassociates the current checkout customer from the checkout. More...

CheckoutDiscountCodeApplyPayload	checkoutDiscountCodeApply (string alias=null)
	Applies a discount to an existing checkout using a discount code. More...

CheckoutDiscountCodeApplyV2payload	checkoutDiscountCodeApplyV2 (string alias=null)
	Applies a discount to an existing checkout using a discount code. More...

CheckoutDiscountCodeRemovePayload	checkoutDiscountCodeRemove (string alias=null)
	Removes the applied discount from an existing checkout. More...

CheckoutEmailUpdatePayload	checkoutEmailUpdate (string alias=null)
	Updates the email on an existing checkout. More...

CheckoutEmailUpdateV2payload	checkoutEmailUpdateV2 (string alias=null)
	Updates the email on an existing checkout. More...

CheckoutGiftCardApplyPayload	checkoutGiftCardApply (string alias=null)
	Applies a gift card to an existing checkout using a gift card code. This will replace all currently applied gift cards. More...

CheckoutGiftCardRemovePayload	checkoutGiftCardRemove (string alias=null)
	Removes an applied gift card from the checkout. More...

CheckoutGiftCardRemoveV2payload	checkoutGiftCardRemoveV2 (string alias=null)
	Removes an applied gift card from the checkout. More...

CheckoutGiftCardsAppendPayload	checkoutGiftCardsAppend (string alias=null)
	Appends gift cards to an existing checkout. More...

CheckoutLineItemsAddPayload	checkoutLineItemsAdd (string alias=null)
	Adds a list of line items to a checkout. More...

CheckoutLineItemsRemovePayload	checkoutLineItemsRemove (string alias=null)
	Removes line items from an existing checkout. More...

CheckoutLineItemsReplacePayload	checkoutLineItemsReplace (string alias=null)
	Sets a list of line items to a checkout. More...

CheckoutLineItemsUpdatePayload	checkoutLineItemsUpdate (string alias=null)
	Updates line items on a checkout. More...

CheckoutShippingAddressUpdatePayload	checkoutShippingAddressUpdate (string alias=null)
	Updates the shipping address of an existing checkout. More...

CheckoutShippingAddressUpdateV2payload	checkoutShippingAddressUpdateV2 (string alias=null)
	Updates the shipping address of an existing checkout. More...

CheckoutShippingLineUpdatePayload	checkoutShippingLineUpdate (string alias=null)
	Updates the shipping lines on an existing checkout. More...

CustomerAccessTokenCreatePayload	customerAccessTokenCreate (string alias=null)
	Creates a customer access token. The customer access token is required to modify the customer object in any way. More...

CustomerAccessTokenDeletePayload	customerAccessTokenDelete (string alias=null)
	Permanently destroys a customer access token. More...

CustomerAccessTokenRenewPayload	customerAccessTokenRenew (string alias=null)
	Renews a customer access token. More...

CustomerActivatePayload	customerActivate (string alias=null)
	Activates a customer. More...

CustomerAddressCreatePayload	customerAddressCreate (string alias=null)
	Creates a new address for a customer. More...

CustomerAddressDeletePayload	customerAddressDelete (string alias=null)
	Permanently deletes the address of an existing customer. More...

CustomerAddressUpdatePayload	customerAddressUpdate (string alias=null)
	Updates the address of an existing customer. More...

CustomerCreatePayload	customerCreate (string alias=null)
	Creates a new customer. More...

CustomerDefaultAddressUpdatePayload	customerDefaultAddressUpdate (string alias=null)
	Updates the default address of an existing customer. More...

CustomerRecoverPayload	customerRecover (string alias=null)
	Sends a reset password email to the customer, as the first step in the reset password process. More...

CustomerResetPayload	customerReset (string alias=null)
	Resets a customer’s password with a token received from `CustomerRecover`. More...

CustomerResetByUrlPayload	customerResetByUrl (string alias=null)
	Resets a customer’s password with the reset password url received from `CustomerRecover`. More...

CustomerUpdatePayload	customerUpdate (string alias=null)
	Updates an existing customer. More...

object	Clone ()

Additional Inherited Members
Protected Member Functions inherited from Shopify.Unity.SDK.AbstractResponse
T	Get< T > (string field, string alias=null)

Protected Attributes inherited from Shopify.Unity.SDK.AbstractResponse
Dictionary< string, object >	Data

Properties inherited from Shopify.Unity.SDK.AbstractResponse
Dictionary< string, object >	DataJSON `[get, protected set]`

Detailed Description

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

Constructor & Destructor Documentation

◆ Mutation()

Shopify.Unity.Mutation.Mutation ( Dictionary< string, object > dataJSON )

inline

Accepts deserialized json data. Will further parse passed in data.

Parameters

dataJSON Deserialized JSON data for Mutation

Member Function Documentation

◆ checkoutAttributesUpdate()

CheckoutAttributesUpdatePayload Shopify.Unity.Mutation.checkoutAttributesUpdate ( string alias = null )

inline

Updates the attributes of a checkout.

Deprecated:: Use checkoutAttributesUpdateV2 instead

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutAttributesUpdateV2()

CheckoutAttributesUpdateV2payload Shopify.Unity.Mutation.checkoutAttributesUpdateV2 ( string alias = null )

inline

Updates the attributes of a checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutCompleteFree()

CheckoutCompleteFreePayload Shopify.Unity.Mutation.checkoutCompleteFree ( string alias = null )

inline

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.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutCompleteWithCreditCard()

CheckoutCompleteWithCreditCardPayload Shopify.Unity.Mutation.checkoutCompleteWithCreditCard ( string alias = null )

inline

Completes a checkout using a credit card token from Shopify's Vault.

Deprecated:: Use checkoutCompleteWithCreditCardV2 instead

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutCompleteWithCreditCardV2()

CheckoutCompleteWithCreditCardV2payload Shopify.Unity.Mutation.checkoutCompleteWithCreditCardV2 ( string alias = null )

inline

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.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutCompleteWithTokenizedPayment()

CheckoutCompleteWithTokenizedPaymentPayload Shopify.Unity.Mutation.checkoutCompleteWithTokenizedPayment ( string alias = null )

inline

Completes a checkout with a tokenized payment.

Deprecated:: Use checkoutCompleteWithTokenizedPaymentV2 instead

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutCompleteWithTokenizedPaymentV2()

CheckoutCompleteWithTokenizedPaymentV2payload Shopify.Unity.Mutation.checkoutCompleteWithTokenizedPaymentV2 ( string alias = null )

inline

Completes a checkout with a tokenized payment.

Deprecated:: Use checkoutCompleteWithTokenizedPaymentV3 instead

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutCreate()

CheckoutCreatePayload Shopify.Unity.Mutation.checkoutCreate ( string alias = null )

inline

Creates a new checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutCustomerAssociate()

CheckoutCustomerAssociatePayload Shopify.Unity.Mutation.checkoutCustomerAssociate ( string alias = null )

inline

Associates a customer to the checkout.

Deprecated:: Use checkoutCustomerAssociateV2 instead

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutCustomerAssociateV2()

CheckoutCustomerAssociateV2payload Shopify.Unity.Mutation.checkoutCustomerAssociateV2 ( string alias = null )

inline

Associates a customer to the checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutCustomerDisassociate()

CheckoutCustomerDisassociatePayload Shopify.Unity.Mutation.checkoutCustomerDisassociate ( string alias = null )

inline

Disassociates the current checkout customer from the checkout.

Deprecated:: Use checkoutCustomerDisassociateV2 instead

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutCustomerDisassociateV2()

CheckoutCustomerDisassociateV2payload Shopify.Unity.Mutation.checkoutCustomerDisassociateV2 ( string alias = null )

inline

Disassociates the current checkout customer from the checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutDiscountCodeApply()

CheckoutDiscountCodeApplyPayload Shopify.Unity.Mutation.checkoutDiscountCodeApply ( string alias = null )

inline

Applies a discount to an existing checkout using a discount code.

Deprecated:: Use checkoutDiscountCodeApplyV2 instead

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutDiscountCodeApplyV2()

CheckoutDiscountCodeApplyV2payload Shopify.Unity.Mutation.checkoutDiscountCodeApplyV2 ( string alias = null )

inline

Applies a discount to an existing checkout using a discount code.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutDiscountCodeRemove()

CheckoutDiscountCodeRemovePayload Shopify.Unity.Mutation.checkoutDiscountCodeRemove ( string alias = null )

inline

Removes the applied discount from an existing checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutEmailUpdate()

CheckoutEmailUpdatePayload Shopify.Unity.Mutation.checkoutEmailUpdate ( string alias = null )

inline

Updates the email on an existing checkout.

Deprecated:: Use checkoutEmailUpdateV2 instead

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutEmailUpdateV2()

CheckoutEmailUpdateV2payload Shopify.Unity.Mutation.checkoutEmailUpdateV2 ( string alias = null )

inline

Updates the email on an existing checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutGiftCardApply()

CheckoutGiftCardApplyPayload Shopify.Unity.Mutation.checkoutGiftCardApply ( string alias = null )

inline

Applies a gift card to an existing checkout using a gift card code. This will replace all currently applied gift cards.

Deprecated:: Use checkoutGiftCardsAppend instead

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutGiftCardRemove()

CheckoutGiftCardRemovePayload Shopify.Unity.Mutation.checkoutGiftCardRemove ( string alias = null )

inline

Removes an applied gift card from the checkout.

Deprecated:: Use checkoutGiftCardRemoveV2 instead

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutGiftCardRemoveV2()

CheckoutGiftCardRemoveV2payload Shopify.Unity.Mutation.checkoutGiftCardRemoveV2 ( string alias = null )

inline

Removes an applied gift card from the checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutGiftCardsAppend()

CheckoutGiftCardsAppendPayload Shopify.Unity.Mutation.checkoutGiftCardsAppend ( string alias = null )

inline

Appends gift cards to an existing checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutLineItemsAdd()

CheckoutLineItemsAddPayload Shopify.Unity.Mutation.checkoutLineItemsAdd ( string alias = null )

inline

Adds a list of line items to a checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutLineItemsRemove()

CheckoutLineItemsRemovePayload Shopify.Unity.Mutation.checkoutLineItemsRemove ( string alias = null )

inline

Removes line items from an existing checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutLineItemsReplace()

CheckoutLineItemsReplacePayload Shopify.Unity.Mutation.checkoutLineItemsReplace ( string alias = null )

inline

Sets a list of line items to a checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutLineItemsUpdate()

CheckoutLineItemsUpdatePayload Shopify.Unity.Mutation.checkoutLineItemsUpdate ( string alias = null )

inline

Updates line items on a checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutShippingAddressUpdate()

CheckoutShippingAddressUpdatePayload Shopify.Unity.Mutation.checkoutShippingAddressUpdate ( string alias = null )

inline

Updates the shipping address of an existing checkout.

Deprecated:: Use checkoutShippingAddressUpdateV2 instead

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutShippingAddressUpdateV2()

CheckoutShippingAddressUpdateV2payload Shopify.Unity.Mutation.checkoutShippingAddressUpdateV2 ( string alias = null )

inline

Updates the shipping address of an existing checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ checkoutShippingLineUpdate()

CheckoutShippingLineUpdatePayload Shopify.Unity.Mutation.checkoutShippingLineUpdate ( string alias = null )

inline

Updates the shipping lines on an existing checkout.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ customerAccessTokenCreate()

CustomerAccessTokenCreatePayload Shopify.Unity.Mutation.customerAccessTokenCreate ( string alias = null )

inline

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

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ customerAccessTokenDelete()

CustomerAccessTokenDeletePayload Shopify.Unity.Mutation.customerAccessTokenDelete ( string alias = null )

inline

Permanently destroys a customer access token.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ customerAccessTokenRenew()

CustomerAccessTokenRenewPayload Shopify.Unity.Mutation.customerAccessTokenRenew ( string alias = null )

inline

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.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ customerActivate()

CustomerActivatePayload Shopify.Unity.Mutation.customerActivate ( string alias = null )

inline

Activates a customer.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ customerAddressCreate()

CustomerAddressCreatePayload Shopify.Unity.Mutation.customerAddressCreate ( string alias = null )

inline

Creates a new address for a customer.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ customerAddressDelete()

CustomerAddressDeletePayload Shopify.Unity.Mutation.customerAddressDelete ( string alias = null )

inline

Permanently deletes the address of an existing customer.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ customerAddressUpdate()

CustomerAddressUpdatePayload Shopify.Unity.Mutation.customerAddressUpdate ( string alias = null )

inline

Updates the address of an existing customer.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ customerCreate()

CustomerCreatePayload Shopify.Unity.Mutation.customerCreate ( string alias = null )

inline

Creates a new customer.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ customerDefaultAddressUpdate()

CustomerDefaultAddressUpdatePayload Shopify.Unity.Mutation.customerDefaultAddressUpdate ( string alias = null )

inline

Updates the default address of an existing customer.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ customerRecover()

CustomerRecoverPayload Shopify.Unity.Mutation.customerRecover ( string alias = null )

inline

Sends a reset password email to the customer, as the first step in the reset password process.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ customerReset()

CustomerResetPayload Shopify.Unity.Mutation.customerReset ( string alias = null )

inline

Resets a customer’s password with a token received from CustomerRecover.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ customerResetByUrl()

CustomerResetByUrlPayload Shopify.Unity.Mutation.customerResetByUrl ( string alias = null )

inline

Resets a customer’s password with the reset password url received from CustomerRecover.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

◆ customerUpdate()

CustomerUpdatePayload Shopify.Unity.Mutation.customerUpdate ( string alias = null )

inline

Updates an existing customer.

Parameters

alias If the original field queried was queried using an alias, then pass the matching string.

The documentation for this class was generated from the following file:

Assets/Shopify/Unity/Generated/Mutation.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Mutation()

Member Function Documentation

◆ checkoutAttributesUpdate()

◆ checkoutAttributesUpdateV2()

◆ checkoutCompleteFree()

◆ checkoutCompleteWithCreditCard()

◆ checkoutCompleteWithCreditCardV2()

◆ checkoutCompleteWithTokenizedPayment()

◆ checkoutCompleteWithTokenizedPaymentV2()

◆ checkoutCreate()

◆ checkoutCustomerAssociate()

◆ checkoutCustomerAssociateV2()

◆ checkoutCustomerDisassociate()

◆ checkoutCustomerDisassociateV2()

◆ checkoutDiscountCodeApply()

◆ checkoutDiscountCodeApplyV2()

◆ checkoutDiscountCodeRemove()

◆ checkoutEmailUpdate()

◆ checkoutEmailUpdateV2()

◆ checkoutGiftCardApply()

◆ checkoutGiftCardRemove()

◆ checkoutGiftCardRemoveV2()

◆ checkoutGiftCardsAppend()

◆ checkoutLineItemsAdd()

◆ checkoutLineItemsRemove()

◆ checkoutLineItemsReplace()

◆ checkoutLineItemsUpdate()

◆ checkoutShippingAddressUpdate()

◆ checkoutShippingAddressUpdateV2()

◆ checkoutShippingLineUpdate()

◆ customerAccessTokenCreate()

◆ customerAccessTokenDelete()

◆ customerAccessTokenRenew()

◆ customerActivate()

◆ customerAddressCreate()

◆ customerAddressDelete()

◆ customerAddressUpdate()

◆ customerCreate()

◆ customerDefaultAddressUpdate()

◆ customerRecover()

◆ customerReset()

◆ customerResetByUrl()

◆ customerUpdate()