Mutation
This is the schema's entry point for all mutation operations.
Anchor to FieldsFields
- Anchor to companyLocationAssignAddresscompany•Company
Location Assign Address Location Assign Address Payload Updates an address on a company location.
- 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 Deletes a specific address for a customer.
- Anchor to customerAddressUpdatecustomer•Customer
Address Update Address Update Payload Updates a specific address for a customer.
- 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 metafieldsDeletemetafields•Metafields
Delete Delete Payload Deletes multiple metafields in bulk.
- 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 orderRequestReturnorder•Order
Request Return Request Return Payload Request a new return on behalf of a customer.
- Anchor to subscriptionBillingCycleSkipsubscription•Subscription
Billing Cycle Skip Billing Cycle Skip Payload Skips a Subscription Billing Cycle.
- Anchor to subscriptionBillingCycleUnskipsubscription•Subscription
Billing Cycle Unskip Billing Cycle Unskip Payload Unskips a Subscription Billing Cycle.
- Anchor to subscriptionContractActivatesubscription•Subscription
Contract Activate Contract Activate Payload Activates a Subscription Contract. Contract status must be either active, paused, or failed.
- Anchor to subscriptionContractCancelsubscription•Subscription
Contract Cancel Contract Cancel Payload Cancels a Subscription Contract.
- Anchor to subscriptionContractFetchDeliveryOptionssubscription•Subscription
Contract Fetch Delivery Options Contract Fetch Delivery Options Payload Fetches the available delivery options for a Subscription Contract.
- Anchor to subscriptionContractPausesubscription•Subscription
Contract Pause Contract Pause Payload Pauses a Subscription Contract.
- 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 storefrontCustomerAccessTokenCreatestorefront•Storefront
Customer Access Token Create Customer Access Token Create Payload Deprecated