Mutation
This is the schema's entry point for all mutation operations.
Anchor to FieldsFields
- companyLocationAssignAddress (CompanyLocationAssignAddressPayload)
- customerAddressCreate (CustomerAddressCreatePayload)
- customerAddressDelete (CustomerAddressDeletePayload)
- customerAddressUpdate (CustomerAddressUpdatePayload)
- customerEmailMarketingSubscribe (CustomerEmailMarketingSubscribePayload)
- customerEmailMarketingUnsubscribe (CustomerEmailMarketingUnsubscribePayload)
- customerUpdate (CustomerUpdatePayload)
- metafieldsDelete (MetafieldsDeletePayload)
- metafieldsSet (MetafieldsSetPayload)
- orderRequestReturn (OrderRequestReturnPayload)
- subscriptionBillingCycleSkip (SubscriptionBillingCycleSkipPayload)
- subscriptionBillingCycleUnskip (SubscriptionBillingCycleUnskipPayload)
- subscriptionContractActivate (SubscriptionContractActivatePayload)
- subscriptionContractCancel (SubscriptionContractCancelPayload)
- subscriptionContractFetchDeliveryOptions (SubscriptionContractFetchDeliveryOptionsPayload)
- subscriptionContractPause (SubscriptionContractPausePayload)
- subscriptionContractSelectDeliveryMethod (SubscriptionContractSelectDeliveryMethodPayload)
- storefrontCustomerAccessTokenCreate (StorefrontCustomerAccessTokenCreatePayload): deprecated
- Anchor to companyLocationAssignAddresscompany•Company
Location Assign Address Location Assign Address Payload Updates an address on a company location.
- Anchor to locationIdlocation•ID!
Id required The ID of the company location to update addresses on.
- Anchor to addressaddress•Company
Address Input! required The input fields to use to update the address.
- Anchor to addressTypesaddress•[Company
Types Address Type!]! required The list of address types on the location to update.
Arguments
- Anchor to customerAddressCreatecustomer•Customer
Address Create Address Create Payload Creates a new address for a customer.
- Anchor to addressaddress•Customer
Address Input! required Specifies the fields to use when creating the address.
- Anchor to defaultAddressdefault•Boolean
Address Default:false The flag to set the address as the default address.
Arguments
- Anchor to customerAddressDeletecustomer•Customer
Address Delete Address Delete Payload Deletes a specific address for a customer.
- Anchor to addressIdaddress•ID!
Id required The ID of the address to be deleted.
Arguments
- Anchor to customerAddressUpdatecustomer•Customer
Address Update Address Update Payload Updates a specific address for a customer.
- Anchor to addressIdaddress•ID!
Id required The ID of the address to be updated.
- Anchor to addressaddress•Customer
Address Input Specifies the fields to use when updating the address.
- Anchor to defaultAddressdefault•Boolean
Address Default:null The flag to set the address as the default address.
Arguments
- Anchor to customerEmailMarketingSubscribecustomer•Customer
Email Marketing Subscribe Email Marketing Subscribe Payload Subscribes the customer to email marketing.
- Anchor to customerEmailMarketingUnsubscribecustomer•Customer
Email Marketing Unsubscribe Email Marketing Unsubscribe Payload Unsubscribes the customer from email marketing.
- Anchor to customerUpdatecustomer•Customer
Update Update Payload Updates the customer's personal information.
- Anchor to inputinput•Customer
Update Input! required Specifies the input fields for the customer update.
Arguments
- Anchor to metafieldsDeletemetafields•Metafields
Delete Delete Payload Deletes multiple metafields in bulk.
- Anchor to metafieldsmetafields•[Metafield
Identifier Input!]! required A list of identifiers specifying metafields to delete. At least one identifier must be specified.
Arguments
- Anchor to metafieldsSetmetafields•Metafields
Set Set Payload Sets metafield values. Metafield values will be set regardless if they were previously created or not.
Allows a maximum of 25 metafields to be set at a time.
This operation is atomic, meaning no changes are persisted if an error is encountered.
As of
2024-07, this operation supports compare-and-set functionality to better handle concurrent requests. Ifis set for any metafield, the mutation will only set that metafield if the persisted metafield value matches the digest used on. If the metafield doesn't exist yet, but you want to guarantee that the operation will run in a safe manner, settonull. Thevalue can be acquired by querying the metafield object and selectingas a field. If thevalue does not match the digest for the persisted value, the mutation will return an error. You can opt out of write guarantees by not sendingin the request.- Anchor to metafieldsmetafields•[Metafields
Set Input!]! required The list of metafield values to set. Maximum of 25.
Arguments
- Anchor to orderRequestReturnorder•Order
Request Return Request Return Payload Request a new return on behalf of a customer.
- Anchor to orderIdorder•ID!
Id required The ID of the order for which this return is being requested.
- Anchor to requestedLineItemsrequested•[Requested
Line Items Line Item Input!]! required The line items that are requested to be returned.
Arguments
- Anchor to subscriptionBillingCycleSkipsubscription•Subscription
Billing Cycle Skip Billing Cycle Skip Payload Skips a Subscription Billing Cycle.
- Anchor to billingCycleInputbilling•Subscription
Cycle Input Billing Cycle Input! required The input object for selecting and using billing cycles.
Arguments
- Anchor to subscriptionBillingCycleUnskipsubscription•Subscription
Billing Cycle Unskip Billing Cycle Unskip Payload Unskips a Subscription Billing Cycle.
- Anchor to billingCycleInputbilling•Subscription
Cycle Input Billing Cycle Input! required The input object for selecting and using billing cycles.
Arguments
- Anchor to subscriptionContractActivatesubscription•Subscription
Contract Activate Contract Activate Payload Activates a Subscription Contract. Contract status must be either active, paused, or failed.
- Anchor to subscriptionContractIdsubscription•ID!
Contract Id required The ID of the subscription contract to activate.
Arguments
- Anchor to subscriptionContractCancelsubscription•Subscription
Contract Cancel Contract Cancel Payload Cancels a Subscription Contract.
- Anchor to subscriptionContractIdsubscription•ID!
Contract Id required The ID of the Subscription Contract to cancel.
Arguments
- Anchor to subscriptionContractFetchDeliveryOptionssubscription•Subscription
Contract Fetch Delivery Options Contract Fetch Delivery Options Payload Fetches the available delivery options for a Subscription Contract.
- Anchor to subscriptionContractIdsubscription•ID!
Contract Id required The ID of the subscription contract.
- Anchor to addressaddress•Customer
Address Input The address to deliver the subscription contract to.
Arguments
- Anchor to subscriptionContractPausesubscription•Subscription
Contract Pause Contract Pause Payload Pauses a Subscription Contract.
- Anchor to subscriptionContractIdsubscription•ID!
Contract Id required The ID of the subscription contract to pause.
Arguments
- Anchor to subscriptionContractSelectDeliveryMethodsubscription•Subscription
Contract Select Delivery Method Contract Select Delivery Method Payload Selects an option from a delivery options result and updates the delivery method on a Subscription Contract.
- Anchor to subscriptionContractIdsubscription•ID!
Contract Id required The ID of the subscription contract.
- Anchor to subscriptionDeliveryOptionsResultTokensubscription•String!
Delivery Options Result Token required The token associated with the successfully fetched delivery options result for the subscription contract.
- Anchor to deliveryMethodInputdelivery•Subscription
Method Input Delivery Method Input! required The delivery method selected for the subscription contract.
Arguments
- Anchor to storefrontCustomerAccessTokenCreatestorefront•Storefront
Customer Access Token Create Customer Access Token Create Payload Deprecated