User
Represents an error in the input of a mutation.
Anchor to FieldsFields
- Anchor to fieldfield•
The path to the input field that caused the error.
- Anchor to messagemessage•String!non-null
The error message.
Anchor to MutationsMutations
- •mutation
Charges a shop for features or services one time. This type of charge is recommended for apps that aren't billed on a recurring basis. Test and demo shops aren't charged.
- Anchor to namename•String!required
The name of the one-time purchase from the app.
- Anchor to priceprice•Money
Input!required The amount to be charged to the store for the app one-time purchase.
- Anchor to returnUrlreturn•
Url URL!required The URL where the merchant is redirected after approving the app one-time purchase.
- Anchor to testtest•BooleanDefault:false
Whether the app one-time purchase is a test transaction.
Arguments
- Anchor to appPurchaseOneTimeapp•
Purchase One Time The newly created app one-time purchase.
- Anchor to confirmationUrlconfirmation•
Url The URL that the merchant can access to approve or decline the newly created app one-time purchase.
If the merchant declines, then the merchant is redirected to the app and receives a notification message stating that the charge was declined. If the merchant approves and they're successfully invoiced, then the state of the charge changes from
pendingtoactive.You get paid after the charge is activated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Cancels an app subscription on a store.
- •ID!required
The ID of the app subscription to be cancelled.
- Anchor to prorateprorate•BooleanDefault:false
Whether to issue prorated credits for the unused portion of the app subscription. There will be a corresponding deduction (based on revenue share) to your Partner account. For example, if a $10.00 app subscription (with 0% revenue share) is cancelled and prorated half way through the billing cycle, then the merchant will be credited $5.00 and that amount will be deducted from your Partner account.
Arguments
- Anchor to appSubscriptionapp•
Subscription The cancelled app subscription.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Allows an app to charge a store for features or services on a recurring basis.
- Anchor to lineItemsline•
Items [AppSubscription Line Item Input!]!required Attaches one or more pricing plans to an app subscription. Only one pricing plan can be defined for each available type.
- Anchor to namename•String!required
A descriptive name for the app subscription.
- Anchor to replacementBehaviorreplacement•
Behavior AppSubscription Replacement BehaviorDefault:STANDARD The replacement behavior when creating an app subscription for a merchant with an already existing app subscription.
- Anchor to returnUrlreturn•
Url URL!required The URL pointing to the page where the merchant is redirected after approving the app subscription.
- Anchor to testtest•BooleanDefault:false
Whether the app subscription is a test transaction.
- Anchor to trialDaystrial•
Days The number of days of the free trial period, beginning on the day that the merchant approves the app charges.
Arguments
- Anchor to appSubscriptionapp•
Subscription The newly-created app subscription.
- Anchor to confirmationUrlconfirmation•
Url The URL pointing to the page where the merchant approves or declines the charges for an app subscription.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates the capped amount on the usage pricing plan of an app subscription line item.
- Anchor to cappedAmountcapped•
Amount MoneyInput!required The new maximum amount of usage charges that can be incurred within a subscription billing interval.
- •ID!required
The ID of the app subscription line item to be updated.
Arguments
- Anchor to appSubscriptionapp•
Subscription The updated app subscription.
- Anchor to confirmationUrlconfirmation•
Url The URL where the merchant approves or declines the updated app subscription line item.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Enables an app to charge a store for features or services on a per-use basis. The usage charge value is counted towards the
limit that was specified in thefield when the app subscription was created. If you create an app usage charge that causes the total usage charges in a billing interval to exceed the capped amount, then aTotal price exceeds balance remainingerror is returned.- Anchor to descriptiondescription•String!required
The description of the app usage record.
- Anchor to idempotencyKeyidempotency•
Key A unique key generated by the client to avoid duplicate charges. Maximum length of 255 characters.
- Anchor to priceprice•Money
Input!required The price of the app usage record.
- Anchor to subscriptionLineItemIdsubscription•
Line Item Id ID!required The ID of the app subscription line item to create the usage record under. This app subscription line item must have a usage pricing plan.
Arguments
- Anchor to appUsageRecordapp•
Usage Record The newly created app usage record.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Starts the cancelation process of a running bulk operation.
There may be a short delay from when a cancelation starts until the operation is actually canceled.
- •ID!required
The ID of the bulk operation to cancel.
Arguments
- Anchor to bulkOperationbulk•
Operation The bulk operation to be canceled.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Creates and runs a bulk operation query.
See the bulk operations guide for more details.
- Anchor to queryquery•String!required
The query to be executed in bulk.
Arguments
- Anchor to bulkOperationbulk•
Operation The newly created bulk operation.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adds products to a collection.
- •ID!required
The ID of the collection that's being updated. This can't be a smart collection.
- Anchor to productIdsproduct•
Ids [ID!]!required The IDs of the products that are being added to the collection. If any of the products is already present in the input collection, then an error is raised and no products are added.
Arguments
- Anchor to collectioncollection•
The updated collection. Returns
nullif an error is raised.- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Creates a collection.
- Anchor to inputinput•Collection
Input!required The properties to use when creating the collection.
Arguments
- Anchor to collectioncollection•
The collection that has been created.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deletes a collection.
- Anchor to inputinput•Collection
Delete Input!required The collection to delete.
Arguments
- Anchor to deletedCollectionIddeleted•
Collection Id The ID of the collection that was deleted. Returns
nullif the collection doesn't exist.- Anchor to shopshop•Shop!non-null
The shop associated with the collection.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Removes a set of products from a given collection. The mutation can take a long time to run. Instead of returning an updated collection the mutation returns a job, which should be polled. For use with manual collections only.
- •ID!required
The ID of the collection to remove products from. The ID must reference an existing manual collection.
- Anchor to productIdsproduct•
Ids [ID!]!required The IDs of products to remove from the collection. The mutation doesn't validate that the products belong to the collection or whether the products exist.
Arguments
- •
The asynchronous job removing the products.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Asynchronously reorders a set of products within a specified collection. Instead of returning an updated collection, this mutation returns a job, which should be polled. The
must be. Displaced products will have their position altered in a consistent manner, with no gaps.- •ID!required
The ID of the collection on which to reorder products.
- Anchor to movesmoves•[Move
Input!]!required A list of moves to perform, which will be evaluated in order. Up to 250 moves are supported, the
does not have to be unique.
Arguments
- •
The asynchronous job reordering the products.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Updates a collection.
- Anchor to inputinput•Collection
Input!required The updated properties for the collection.
Arguments
- Anchor to collectioncollection•
The updated collection.
- •
The asynchronous job updating the products based on the new rule set.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Add tax exemptions for the customer.
- Anchor to customerIdcustomer•
Id ID!required The ID of the customer to update.
- Anchor to taxExemptionstax•
Exemptions [TaxExemption!]!required The list of tax exemptions to add for the customer, in the format of an array or a comma-separated list. Example values:
,.
Arguments
- Anchor to customercustomer•
The updated customer.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Create a new customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data requirements.
- Anchor to inputinput•Customer
Input!required The input fields to create a customer.
Arguments
- Anchor to customercustomer•
The created customer.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Delete a customer. As of API version 2022-10, apps using protected customer data must meet the protected customer data requirements.
- Anchor to inputinput•Customer
Delete Input!required Specifies the customer to delete.
Arguments
- Anchor to deletedCustomerIddeleted•
Customer Id The ID of the deleted customer.
- Anchor to shopshop•Shop!non-null
The shop of the deleted customer.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Generate an account activation URL for a customer.
- Anchor to customerIdcustomer•
Id ID!required The ID of the customer that the URL is generated for.
Arguments
- Anchor to accountActivationUrlaccount•
Activation Url The generated account activation URL.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a credit card payment method for a customer using a session id. These values are only obtained through card imports happening from a PCI compliant environment. Please use customerPaymentMethodRemoteCreate if you are not managing credit cards directly.
- Anchor to billingAddressbilling•
Address MailingAddress Input!required The billing address.
- Anchor to customerIdcustomer•
Id ID!required The ID of the customer.
- Anchor to sessionIdsession•
Id String!required The Cardserver session ID. Obtained by storing card data with Shopify's Cardsink. Exchanging raw card data for a session ID must be done in a PCI complaint environment.
Arguments
- Anchor to customerPaymentMethodcustomer•
Payment Method The customer payment method.
- Anchor to processingprocessing•
If the card verification result is processing. When this is true, customer_payment_method will be null.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates the credit card payment method for a customer.
- Anchor to billingAddressbilling•
Address MailingAddress Input!required The billing address.
- •ID!required
The ID of the customer payment method.
- Anchor to sessionIdsession•
Id String!required The Cardserver session ID.
Arguments
- Anchor to customerPaymentMethodcustomer•
Payment Method The customer payment method.
- Anchor to processingprocessing•
If the card verification result is processing. When this is true, customer_payment_method will be null.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Revokes a customer's payment method.
- Anchor to customerPaymentMethodIdcustomer•
Payment Method Id ID!required The ID of the customer payment method to be revoked.
Arguments
- Anchor to revokedCustomerPaymentMethodIdrevoked•
Customer Payment Method Id The ID of the revoked customer payment method.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Sends a link to the customer so they can update a specific payment method.
- Anchor to customerPaymentMethodIdcustomer•
Payment Method Id ID!required The payment method to be updated.
- Anchor to emailemail•
Specifies the payment method update email fields. Only the 'from' and 'bcc' fields are accepted for input.
Arguments
- Anchor to customercustomer•
The customer to whom an update payment method email was sent.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Remove tax exemptions from a customer.
- Anchor to customerIdcustomer•
Id ID!required The ID of the customer to update.
- Anchor to taxExemptionstax•
Exemptions [TaxExemption!]!required The list of tax exemptions to remove for the customer, in the format of an array or a comma-separated list. Example values:
,.
Arguments
- Anchor to customercustomer•
The updated customer.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Replace tax exemptions for a customer.
- Anchor to customerIdcustomer•
Id ID!required The ID of the customer to update.
- Anchor to taxExemptionstax•
Exemptions [TaxExemption!]!required The list of tax exemptions that will replace the current exemptions for a customer. Can be an array or a comma-separated list. Example values:
,.
Arguments
- Anchor to customercustomer•
The updated customer.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Update a customer's attributes. As of API version 2022-10, apps using protected customer data must meet the protected customer data requirements.
- Anchor to inputinput•Customer
Input!required Provides updated fields for the customer. To set marketing consent, use the
ormutations instead.
Arguments
- Anchor to customercustomer•
The updated customer.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a customer's default address.
- Anchor to addressIdaddress•
Id ID!required The ID of the customer's new default address.
- Anchor to customerIdcustomer•
Id ID!required The ID of the customer whose default address is being updated.
Arguments
- Anchor to customercustomer•
The customer whose address was updated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Create a delivery profile.
- Anchor to profileprofile•Delivery
Profile Input!required Specifies the input fields for a delivery profile.
Arguments
- Anchor to profileprofile•
The delivery profile that was created.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Enqueue the removal of a delivery profile.
- •ID!required
The ID of the delivery profile to remove.
Arguments
- •
The delivery profile deletion job triggered by the mutation.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Update a delivery profile.
- •ID!required
The ID of the delivery profile to update.
- Anchor to leaveLegacyModeProfilesleave•
Legacy Mode Profiles Whether this delivery profile should leave legacy mode.
- Anchor to profileprofile•Delivery
Profile Input!required Specifies the input fields for a delivery profile.
Arguments
- Anchor to profileprofile•
The delivery profile that was updated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Set the delivery settings for a shop.
- Anchor to settingsetting•Delivery
Setting Input!required Specifies the input fields for the delivery shop level settings.
Arguments
- Anchor to settingsetting•
The updated delivery shop level settings.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Assigns a location as the shipping origin while using legacy compatibility mode for multi-location delivery profiles.
- Anchor to locationIdlocation•
Id ID!required The ID of the location to assign as the shipping origin.
Arguments
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adds tags to multiple draft orders.
- •
The IDs of the draft orders to add tags to.
- Anchor to savedSearchIdsaved•
Search Id The ID of the draft order saved search for filtering draft orders on.
- Anchor to searchsearch•
The conditions for filtering draft orders on. See the detailed search syntax.
- •[String!]!required
List of tags to be added.
Arguments
- •
The asynchronous job for adding tags to the draft orders.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deletes multiple draft orders.
- •
The IDs of the draft orders to delete.
- Anchor to savedSearchIdsaved•
Search Id The ID of the draft order saved search for filtering draft orders on.
- Anchor to searchsearch•
The conditions for filtering draft orders on. See the detailed search syntax.
Arguments
- •
The asynchronous job for deleting the draft orders.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Removes tags from multiple draft orders.
- •
The IDs of the draft orders to remove tags from.
- Anchor to savedSearchIdsaved•
Search Id The ID of the draft order saved search for filtering draft orders on.
- Anchor to searchsearch•
The conditions for filtering draft orders on. See the detailed search syntax.
- •[String!]!required
List of tags to be removed.
Arguments
- •
The asynchronous job for removing tags from the draft orders.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Calculates the properties of a draft order. Useful for determining information such as total taxes or price without actually creating a draft order.
- Anchor to inputinput•Draft
Order Input!required The fields for the draft order.
Arguments
- Anchor to calculatedDraftOrdercalculated•
Draft Order The calculated properties for a draft order.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Completes a draft order and creates an order.
- •ID!required
The draft order to complete.
- Anchor to paymentGatewayIdpayment•
Gateway Id The gateway for the completed draft order.
- Anchor to paymentPendingpayment•
Pending BooleanDefault:false Whether the payment is pending.
- Anchor to sourceNamesource•
Name A channel definition handle used for sales channel attribution.
Arguments
- Anchor to draftOrderdraft•
Order The completed draft order.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Creates a draft order.
- Anchor to inputinput•Draft
Order Input!required The fields used to create the draft order.
Arguments
- Anchor to draftOrderdraft•
Order The created draft order.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a draft order from order.
- Anchor to orderIdorder•
Id ID!required Specifies the order's id that we create the draft order from.
Arguments
- Anchor to draftOrderdraft•
Order The created draft order.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deletes a draft order.
- Anchor to inputinput•Draft
Order Delete Input!required Specify the draft order to delete by its ID.
Arguments
- Anchor to deletedIddeleted•
Id The ID of the deleted draft order.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Duplicates a draft order.
- Anchor to draftOrderIddraft•
Order Id The ID of the draft order to duplicate.
- •
The ID of the draft order to duplicate.
Arguments
- Anchor to draftOrderdraft•
Order The newly duplicated draft order.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Previews a draft order invoice email.
- Anchor to emailemail•
Specifies the draft order invoice email fields.
- •ID!required
Specifies the draft order invoice email to preview.
Arguments
- Anchor to previewHtmlpreview•
Html The draft order invoice email rendered as HTML to allow previewing.
- Anchor to previewSubjectpreview•
Subject The subject preview for the draft order invoice email.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Sends an email invoice for a draft order.
- Anchor to emailemail•
Specifies the draft order invoice email fields.
- •ID!required
Specifies the draft order to send the invoice for.
Arguments
- Anchor to draftOrderdraft•
Order The draft order an invoice email is sent for.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a draft order.
If a checkout has been started for a draft order, any update to the draft will unlink the checkout. Checkouts are created but not immediately completed when opening the merchant credit card modal in the admin, and when a buyer opens the invoice URL. This is usually fine, but there is an edge case where a checkout is in progress and the draft is updated before the checkout completes. This will not interfere with the checkout and order creation, but if the link from draft to checkout is broken the draft will remain open even after the order is created.
- •ID!required
Specifies the draft order to update.
- Anchor to inputinput•Draft
Order Input!required The draft order properties to update.
Arguments
- Anchor to draftOrderdraft•
Order The updated draft order.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Creates a new Amazon EventBridge webhook subscription.
Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your
shopify.app.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- Anchor to topictopic•Webhook
Subscription Topic!required The type of event that triggers the webhook.
- Anchor to webhookSubscriptionwebhook•
Subscription Specifies the input fields for an EventBridge webhook subscription.
Arguments
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to webhookSubscriptionwebhook•
Subscription The webhook subscription that was created.
Fields
- •mutation
Updates an Amazon EventBridge webhook subscription.
Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your
shopify.app.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- •ID!required
The ID of the webhook subscription to update.
- Anchor to webhookSubscriptionwebhook•
Subscription Specifies the input fields for an EventBridge webhook subscription.
Arguments
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to webhookSubscriptionwebhook•
Subscription The webhook subscription that was updated.
Fields
- •
- •mutation
Triggers any workflows that begin with the trigger specified in the request body. To learn more, refer to Create Shopify Flow triggers.
- Anchor to bodybody•
The payload needed to run the Trigger.
- Anchor to handlehandle•
The handle of the trigger.
- Anchor to payloadpayload•
The payload needed to run the Trigger.
Arguments
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Cancels a fulfillment.
- •ID!required
The ID of the fulfillment to be canceled.
Arguments
- Anchor to fulfillmentfulfillment•
The canceled fulfillment.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Creates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
- Anchor to fulfillmentfulfillment•Fulfillment
Input!required The input fields used to create a fulfillment from fulfillment orders.
- Anchor to messagemessage•
An optional message for the fulfillment request.
Arguments
- Anchor to fulfillmentfulfillment•
The created fulfillment.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a fulfillment event for a specified fulfillment.
- Anchor to fulfillmentEventfulfillment•
Event FulfillmentEvent Input!required The input fields used to create a fulfillment event for a fulfillment.
Arguments
- Anchor to fulfillmentEventfulfillment•
Event The created fulfillment event.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Accept a cancellation request sent to a fulfillment service for a fulfillment order.
- •ID!required
The ID of the fulfillment order associated with the cancellation request.
- Anchor to messagemessage•
An optional reason for accepting the cancellation request.
Arguments
- Anchor to fulfillmentOrderfulfillment•
Order The fulfillment order whose cancellation request was accepted.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Accepts a fulfillment request sent to a fulfillment service for a fulfillment order.
- •ID!required
The ID of the fulfillment order associated with the fulfillment request.
- Anchor to messagemessage•
An optional reason for accepting the fulfillment request.
Arguments
- Anchor to fulfillmentOrderfulfillment•
Order The fulfillment order whose fulfillment request was accepted.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Marks a fulfillment order as canceled.
- •ID!required
The ID of the fulfillment order to mark as canceled.
Arguments
- Anchor to fulfillmentOrderfulfillment•
Order The fulfillment order that was marked as canceled.
- Anchor to replacementFulfillmentOrderreplacement•
Fulfillment Order The fulfillment order that was created to replace the canceled fulfillment order.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Marks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items, and closes the fulfillment request.
This mutation can only be called for fulfillment orders that meet the following criteria:
- Assigned to a fulfillment service location,
- The fulfillment request has been accepted,
- The fulfillment order status is
.
This mutation can only be called by the fulfillment service app that accepted the fulfillment request. Calling this mutation returns the control of the fulfillment order to the merchant, allowing them to move the fulfillment order line items to another location and fulfill from there, remove and refund the line items, or to request fulfillment from the same fulfillment service again.
Closing a fulfillment order is explained in the fulfillment service guide.
- •ID!required
The ID of the fulfillment order to mark as incomplete.
- Anchor to messagemessage•
An optional reason for marking the fulfillment order as incomplete.
Arguments
- Anchor to fulfillmentOrderfulfillment•
Order The fulfillment order that was marked as incomplete.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Changes the location which is assigned to fulfill a number of unfulfilled fulfillment order line items.
Moving a fulfillment order will fail in the following circumstances:
- The fulfillment order is closed.
- The destination location has never stocked the requested inventory item.
- The API client doesn't have the correct permissions.
Line items which have already been fulfilled can't be re-assigned and will always remain assigned to the original location.
You can't change the assigned location while a fulfillment order has a request status of
,,, or. These request statuses mean that a fulfillment order is awaiting action by a fulfillment service and can't be re-assigned without first having the fulfillment service accept a cancellation request. This behavior is intended to prevent items from being fulfilled by multiple locations or fulfillment services.How re-assigning line items affects fulfillment orders
First scenario: Re-assign all line items belonging to a fulfillment order to a new location.
In this case, the assignedLocation of the original fulfillment order will be updated to the new location.
Second scenario: Re-assign a subset of the line items belonging to a fulfillment order to a new location. You can specify a subset of line items using the
parameter (available as of the2023-04API version), or specify that the original fulfillment order contains line items which have already been fulfilled.If the new location is already assigned to another active fulfillment order, on the same order, then a new fulfillment order is created. The existing fulfillment order is closed and line items are recreated in a new fulfillment order.
- Anchor to fulfillmentOrderLineItemsfulfillment•
Order Line Items The fulfillment order line items to be moved. If left blank, all unfulfilled line items belonging to the fulfillment order are moved.
- •ID!required
The ID of the fulfillment order to be moved.
- Anchor to newLocationIdnew•
Location Id ID!required The ID of the location where the fulfillment order will be moved.
Arguments
- Anchor to movedFulfillmentOrdermoved•
Fulfillment Order The fulfillment order which now contains the moved line items and is assigned to the destination location.
If the original fulfillment order doesn't have any line items which are fully or partially fulfilled, the original fulfillment order will be moved to the new location. However if this isn't the case, the moved fulfillment order will differ from the original one.
- Anchor to originalFulfillmentOrderoriginal•
Fulfillment Order The final state of the original fulfillment order.
As a result of the move operation, the original fulfillment order might be moved to the new location or remain in the original location. The original fulfillment order might have the same status or be closed.
- Anchor to remainingFulfillmentOrderremaining•
Fulfillment Order This field is deprecated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Marks a scheduled fulfillment order as open.
- •ID!required
The ID of the fulfillment order to mark as open.
Arguments
- Anchor to fulfillmentOrderfulfillment•
Order The fulfillment order that was transitioned to open and is fulfillable.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Rejects a cancellation request sent to a fulfillment service for a fulfillment order.
- •ID!required
The ID of the fulfillment order associated with the cancellation request.
- Anchor to messagemessage•
An optional reason for rejecting the cancellation request.
Arguments
- Anchor to fulfillmentOrderfulfillment•
Order The fulfillment order whose cancellation request was rejected.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.
- •ID!required
The ID of the fulfillment order associated with the fulfillment request.
- Anchor to lineItemsline•
Items An optional array of line item rejection details. If none are provided, all line items will be assumed to be unfulfillable.
Note: After the fulfillment request has been rejected, none of the line items will be able to be fulfilled. This field documents which line items specifically were unable to be fulfilled and why.
- Anchor to messagemessage•
An optional reason for rejecting the fulfillment request.
- Anchor to reasonreason•
The reason for the fulfillment order rejection.
Arguments
- Anchor to fulfillmentOrderfulfillment•
Order The fulfillment order whose fulfillment request was rejected.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Sends a cancellation request to the fulfillment service of a fulfillment order.
- •ID!required
The ID of the fulfillment order associated with the cancellation request.
- Anchor to messagemessage•
An optional reason for the cancellation request.
Arguments
- Anchor to fulfillmentOrderfulfillment•
Order The fulfillment order specified in the cancelation request.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Sends a fulfillment request to the fulfillment service of a fulfillment order.
- Anchor to fulfillmentOrderLineItemsfulfillment•
Order Line Items The fulfillment order line items to be requested for fulfillment. If left blank, all line items of the fulfillment order are requested for fulfillment.
- •ID!required
The ID of the fulfillment order associated with fulfillment request.
- Anchor to messagemessage•
An optional message for the fulfillment request.
- Anchor to notifyCustomernotify•
Customer Whether the customer should be notified when fulfillments are created for this fulfillment order.
Arguments
- Anchor to originalFulfillmentOrderoriginal•
Fulfillment Order The original fulfillment order intended to request fulfillment for.
- Anchor to submittedFulfillmentOrdersubmitted•
Fulfillment Order The fulfillment order that was submitted to the fulfillment service. This will be the same as the original fulfillment order field. The exception to this is partial fulfillment requests or fulfillment request for cancelled or incomplete fulfillment orders.
- Anchor to unsubmittedFulfillmentOrderunsubmitted•
Fulfillment Order This field will only be present for partial fulfillment requests. This will represent the new fulfillment order with the remaining line items not submitted to the fulfillment service.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a fulfillment service.
Fulfillment service location
When creating a fulfillment service, a new location will be automatically created on the shop and will be associated with this fulfillment service. This location will be named after the fulfillment service and inherit the shop's address.
If you are using API version
2023-10or later, and you need to specify custom attributes for the fulfillment service location (for example, to change its address to a country different from the shop's country), use the LocationEdit mutation after creating the fulfillment service.- Anchor to callbackUrlcallback•
Url URL!required The URL to send requests for the fulfillment service. The following considerations apply:
- Shopify queries the
callback_url/fetch_tracking_numbersendpoint to retrieve tracking numbers for orders, ifis set totrue. - Shopify queries the
callback_url/fetch_stockendpoint to retrieve inventory levels, ifis set totrue. - Shopify uses the
callback_url/fulfillment_order_notificationendpoint to send fulfillment and cancellation requests.
- Shopify queries the
- Anchor to fulfillmentOrdersOptInfulfillment•
Orders Opt In BooleanDefault:true Whether the fulfillment service uses the fulfillment order based workflow for managing fulfillments.
As of 2022-07 API version, the fulfillment order based workflow is the only way to manage fulfillments. As the migration is now finished, the
property is deprecated and is always set totrueon correctly functioning fulfillment services.The
input field is deprecated and will be removed in the next API version. This API version makes it optional and defaults totruefor a smooth migration experience. Do not set theargument, and you are ready for the next API version release.- Anchor to inventoryManagementinventory•
Management BooleanDefault:false Whether the fulfillment service manages product inventory and provides updates to Shopify.
- Anchor to namename•String!required
The name of the fulfillment service.
- Anchor to permitsSkuSharingpermits•
Sku Sharing BooleanDefault:false Whether the fulfillment service can stock inventory alongside other locations.
- Anchor to trackingSupporttracking•
Support BooleanDefault:false Whether the fulfillment service provides tracking numbers for packages.
Arguments
- Anchor to fulfillmentServicefulfillment•
Service The created fulfillment service.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deletes a fulfillment service.
- Anchor to destinationLocationIddestination•
Location Id - •ID!required
The ID of the fulfillment service to delete.
- Anchor to inventoryActioninventory•
Action FulfillmentService Delete Inventory ActionDefault:TRANSFER The action to take with the location after the fulfillment service is deleted.
Arguments
- Anchor to deletedIddeleted•
Id The ID of the deleted fulfillment service.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a fulfillment service.
If you are using API version
2023-10or later, and you need to update the location managed by the fulfillment service (for example, to change the address of a fulfillment service), use the LocationEdit mutation.- Anchor to callbackUrlcallback•
Url The URL to send requests for the fulfillment service. The following considerations apply:
- Shopify queries the
callback_url/fetch_tracking_numbersendpoint to retrieve tracking numbers for orders, ifis set totrue. - Shopify queries the
callback_url/fetch_stockendpoint to retrieve inventory levels, ifis set totrue. - Shopify uses the
callback_url/fulfillment_order_notificationendpoint to send fulfillment and cancellation requests.
- Shopify queries the
- Anchor to fulfillmentOrdersOptInfulfillment•
Orders Opt In Whether the fulfillment service uses the fulfillment order based workflow for managing fulfillments.
As of 2022-07 API version, the fulfillment order based workflow is the only way to manage fulfillments, and
trueis the only valid value for.- •ID!required
The id of the fulfillment service.
- Anchor to inventoryManagementinventory•
Management Whether the fulfillment service tracks product inventory and provides updates to Shopify.
- Anchor to namename•
The name of the fulfillment service.
- Anchor to permitsSkuSharingpermits•
Sku Sharing Whether the fulfillment service can stock inventory alongside other locations.
- Anchor to trackingSupporttracking•
Support Whether the fulfillment service provides tracking numbers for packages.
Arguments
- Anchor to fulfillmentServicefulfillment•
Service The updated fulfillment service.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates tracking information for a fulfillment.
- Anchor to fulfillmentIdfulfillment•
Id ID!required The ID of the fulfillment.
- Anchor to notifyCustomernotify•
Customer Whether the customer will be notified of this update and future updates for the fulfillment. If this field is left blank, then notifications won't be sent to the customer when the fulfillment is updated.
- Anchor to trackingInfoInputtracking•
Info Input FulfillmentTracking Input!required The tracking input for the mutation, including tracking URL, number, and company.
Arguments
- Anchor to fulfillmentfulfillment•
The updated fulfillment with tracking information.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Update a gift card.
- •ID!required
The ID of the gift card to be updated.
- Anchor to inputinput•Gift
Card Update Input!required The input fields to update the gift card.
Arguments
- Anchor to giftCardgift•
Card The updated gift card.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Activate an inventory item at a location.
- Anchor to availableavailable•
The initial available quantity of the inventory item being activated at the location.
- Anchor to inventoryItemIdinventory•
Item Id ID!required The ID of the inventory item to activate.
- Anchor to locationIdlocation•
Id ID!required The ID of the location of the inventory item being activated.
- Anchor to onHandon•
Hand The initial on_hand quantity of the inventory item being activated at the location.
- Anchor to stockAtLegacyLocationstock•
At Legacy Location BooleanDefault:false Allow activation at or away from fulfillment service location with sku sharing off. This will deactivate inventory at all other locations.
Arguments
- Anchor to inventoryLevelinventory•
Level The inventory level that was activated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Removes an inventory item's quantities from a location, and turns off inventory at the location.
- Anchor to inventoryLevelIdinventory•
Level Id ID!required The ID of the inventory level to deactivate.
Arguments
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates an inventory item.
- •ID!required
The ID of the inventory item to update.
- Anchor to inputinput•Inventory
Item Input!required
Arguments
- Anchor to inventoryIteminventory•
Item The inventory item that was updated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Create new marketing activity.
- Anchor to inputinput•Marketing
Activity Create Input!required The Input of marketing activity create.
Arguments
- Anchor to marketingActivitymarketing•
Activity The created marketing activity.
- Anchor to redirectPathredirect•
Path The path to return back to shopify admin from embedded editor.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a marketing activity with the latest information.
- Anchor to inputinput•Marketing
Activity Update Input!required The Input of the marketing activity.
Arguments
- Anchor to marketingActivitymarketing•
Activity The updated marketing activity.
- Anchor to redirectPathredirect•
Path The redirect path from the embedded editor to the Shopify admin.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
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 deletedMetafieldsdeleted•
Metafields List of metafield identifiers that were deleted, null if the corresponding metafield isn't found.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Cancels an order.
- Anchor to notifyCustomernotify•
Customer BooleanDefault:false Whether to send a notification to the customer about the order cancellation.
- Anchor to orderIdorder•
Id ID!required The ID of the order to be canceled.
- Anchor to reasonreason•Order
Cancel Reason!required The reason for canceling the order.
- Anchor to refundrefund•Boolean!required
Indicates whether to refund the amount paid by the customer. Authorized payments will be voided regardless of this setting.
- Anchor to restockrestock•Boolean!required
Whether to restock the inventory committed to the order. For unpaid orders fulfilled from locations that have been deactivated, inventory will not be restocked to the deactivated locations even if this argument is set to true.
- Anchor to staffNotestaff•
Note StringDefault:null A staff-facing note about the order cancellation. This is not visible to the customer.
Arguments
- •
The job that asynchronously cancels the order.
- Anchor to orderCancelUserErrorsorder•
Cancel User Errors [OrderCancel User Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Captures payment for an authorized transaction on an order. An order can only be captured if it has a successful authorization transaction. Capturing an order will claim the money reserved by the authorization. orderCapture can be used to capture multiple times as long as the OrderTransaction is multi-capturable. To capture a partial payment, the included
amountvalue should be less than the total order amount. Multi-capture is available only to stores on a Shopify Plus plan.- Anchor to inputinput•Order
Capture Input!required The input for the mutation.
Arguments
- Anchor to transactiontransaction•
The created capture transaction.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Closes an open order.
- Anchor to inputinput•Order
Close Input!required The input for the mutation.
Arguments
- Anchor to orderorder•
The closed order.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adds a custom line item to an existing order. For example, you could add a gift wrapping service as a custom line item. To learn how to edit existing orders, refer to Edit an existing order with Admin API.
- •ID!required
The ID of the calculated order to which the custom item is added.
- Anchor to locationIdlocation•
Id The ID of the retail location (if applicable) from which the custom item is sold. Used for tax calculations. A default location will be chosen automatically if none is provided.
- Anchor to priceprice•Money
Input!required The unit price of the custom item. This value can't be negative.
- Anchor to quantityquantity•Int!required
The quantity of the custom item. This value must be greater than zero.
- Anchor to requiresShippingrequires•
Shipping Whether the custom item requires shipping. Defaults to
false.- Anchor to taxabletaxable•
Whether the custom item is taxable. Defaults to
true.- Anchor to titletitle•String!required
The name of the custom item to add.
Arguments
- Anchor to calculatedLineItemcalculated•
Line Item The custom line item that will be added to the order based on the current edits.
- Anchor to calculatedOrdercalculated•
Order An order with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Adds a discount to a line item on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.
- Anchor to discountdiscount•Order
Edit Applied Discount Input!required The discount to add to the line item.
- •ID!required
The ID of the calculated order to update.
- Anchor to lineItemIdline•
Item Id ID!required The ID of the calculated line item to add the discount to.
Arguments
- Anchor to addedDiscountStagedChangeadded•
Discount Staged Change The discount applied to a line item during this order edit.
- Anchor to calculatedLineItemcalculated•
Line Item The line item with the edits applied but not saved.
- Anchor to calculatedOrdercalculated•
Order An order with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adds a line item from an existing product variant. As of API version 2025-04, the orderEditAddVariant API will respect the contextual pricing of the variant.
- Anchor to allowDuplicatesallow•
Duplicates BooleanDefault:false Whether the mutation can create a line item for a variant that's already on the calculated order.
- •ID!required
The ID of the calculated order to edit.
- Anchor to locationIdlocation•
Id The ID of the location to check for inventory availability. A default location ID is chosen automatically if none is provided.
- Anchor to quantityquantity•Int!required
The quantity of the item to add to the order. Must be a positive value.
- Anchor to variantIdvariant•
Id ID!required The ID of the variant to add.
Arguments
- Anchor to calculatedLineItemcalculated•
Line Item The calculated line item that's added during this order edit.
- Anchor to calculatedOrdercalculated•
Order The calculated order with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Starts editing an order. Mutations are operating on
. All order edits start with, have any number of* mutations made, and end with.- •ID!required
The ID of the order to begin editing.
Arguments
- Anchor to calculatedOrdercalculated•
Order The order that will be edited.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Applies and saves staged changes to an order. Mutations are operating on
. All order edits start with, have any number of* mutations made, and end with.- •ID!required
The ID of the calculated order that will have its changes applied to the order.
- Anchor to notifyCustomernotify•
Customer Whether to notify the customer or not.
- Anchor to staffNotestaff•
Note Note for staff members.
Arguments
- Anchor to orderorder•
The order with changes applied.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Sets the quantity of a line item on an order that is being edited. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.
- •ID!required
The ID of the calculated order to edit. The edit changes the quantity on the line item.
- Anchor to lineItemIdline•
Item Id ID!required The ID of the calculated line item to edit.
- Anchor to locationIdlocation•
Id The ID of the location. If 'restock' is set to true, the restocked item will be made available at the specified location.
- Anchor to quantityquantity•Int!required
The new quantity to set for the line item. This value cannot be negative.
- Anchor to restockrestock•
Whether or not to restock the line item when the updated quantity is less than the original quantity.
Arguments
- Anchor to calculatedLineItemcalculated•
Line Item The calculated line item with the edits applied but not saved.
- Anchor to calculatedOrdercalculated•
Order The calculated order with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Marks an order as paid. You can only mark an order as paid if it isn't already fully paid.
- Anchor to inputinput•Order
Mark As Paid Input!required The input for the mutation.
Arguments
- Anchor to orderorder•
The order marked as paid.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Opens a closed order.
- Anchor to inputinput•Order
Open Input!required The input for the mutation.
Arguments
- Anchor to orderorder•
The opened order.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates the attributes of an order, such as the customer's email, the shipping address for the order, tags, and metafields associated with the order.
If you need to make significant updates to an order, such as adding or removing line items, changing quantities, or modifying discounts, then use the
mutation instead. Themutation initiates an order editing session, allowing you to make multiple changes before finalizing them. Learn more about using themutation to edit existing orders.Learn how to build apps that integrate with order management and fulfillment processes.
- Anchor to inputinput•Order
Input!required The attributes of the updated order.
Arguments
- Anchor to orderorder•
The updated order.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a new componentized product.
- Anchor to inputinput•Product
Bundle Create Input!required Input for creating a componentized product.
Arguments
- Anchor to productBundleOperationproduct•
Bundle Operation The asynchronous ProductBundleOperation creating the componentized product.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a componentized product.
- Anchor to inputinput•Product
Bundle Update Input!required Input for updating a componentized product.
Arguments
- Anchor to productBundleOperationproduct•
Bundle Operation The asynchronous ProductBundleOperation updating the componentized product.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a product with attributes such as title, description, and vendor. You can use the
mutation to define options and values for products with product variants, such as different sizes or colors.To create multiple product variants for a single product and manage prices, use the
mutation.To create or update a product in a single request, use the
mutation.Learn more about the product model and adding product data.
- Anchor to inputinput•
The properties of the new product.
- Anchor to mediamedia•
The media to add to the product.
- Anchor to productproduct•
The attributes of the new product.
Arguments
- Anchor to productproduct•
The product object.
- Anchor to shopshop•Shop!non-null
The shop associated with the product.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deletes a product, including all associated variants and media.
As of API version
2023-01, if you need to delete a large product, such as one that has many variants that are active at several locations, you may encounter timeout errors. To avoid these timeout errors, you can instead use the asynchronous ProductDeleteAsync mutation.- Anchor to inputinput•Product
Delete Input!required Specifies the product to delete by its ID.
- Anchor to synchronoussynchronous•BooleanDefault:true
Specifies whether or not to run the mutation synchronously.
Arguments
- Anchor to deletedProductIddeleted•
Product Id The ID of the deleted product.
- Anchor to productDeleteOperationproduct•
Delete Operation The product delete operation, returned when run in asynchronous mode.
- Anchor to shopshop•Shop!non-null
The shop associated with the product.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Duplicates a product.
If you need to duplicate a large product, such as one that has many variants that are active at several locations, you might encounter timeout errors.
To avoid these timeout errors, you can instead duplicate the product asynchronously.
In API version 2024-10 and higher, include
synchronous: falseargument in this mutation to perform the duplication asynchronously.In API version 2024-07 and lower, use the asynchronous
.Metafield values are not duplicated if the unique values capability is enabled.
- Anchor to includeImagesinclude•
Images BooleanDefault:false Specifies whether or not to duplicate images.
- Anchor to includeTranslationsinclude•
Translations BooleanDefault:false Specifies whether or not to duplicate translations.
- Anchor to newStatusnew•
Status The new status of the product. If no value is provided the status will be inherited from the original product.
- Anchor to newTitlenew•
Title String!required The new title of the product.
- Anchor to productIdproduct•
Id ID!required The ID of the product to be duplicated.
- Anchor to synchronoussynchronous•BooleanDefault:true
Specifies whether or not to run the mutation synchronously.
Arguments
- Anchor to imageJobimage•
Job The asynchronous job that duplicates the product images.
- Anchor to newProductnew•
Product The duplicated product.
- Anchor to productDuplicateOperationproduct•
Duplicate Operation The product duplicate operation, returned when run in asynchronous mode.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Asynchronously reorders the media attached to a product.
- •ID!required
The ID of the product on which to reorder medias.
- Anchor to movesmoves•[Move
Input!]!required A list of moves to perform which will be evaluated in order.
Arguments
- •
The asynchronous job which reorders the media.
- Anchor to mediaUserErrorsmedia•
User Errors [MediaUser Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Updates a product.
For versions
2024-01and older: If you update a product and only include some variants in the update, then any variants not included will be deleted.To safely manage variants without the risk of deleting excluded variants, use productVariantsBulkUpdate.
If you want to update a single variant, then use productVariantUpdate.
- Anchor to inputinput•
The updated properties for a product.
- Anchor to mediamedia•
List of new media to be added to the product.
- Anchor to productproduct•
The updated properties for a product.
Arguments
- Anchor to productproduct•
The updated product object.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Publishes a resource to a channel. If the resource is a product, then it's visible in the channel only if the product status is
active. Products that are sold exclusively on subscription () can be published only on online stores.- •ID!required
The resource to create or update publications for.
- Anchor to inputinput•[Publication
Input!]!required Specifies the input fields required to publish a resource.
Arguments
- Anchor to publishablepublishable•
Resource that has been published.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Publishes a resource to current channel. If the resource is a product, then it's visible in the channel only if the product status is
active. Products that are sold exclusively on subscription () can be published only on online stores.- •ID!required
The resource to create or update publications for.
Arguments
- Anchor to publishablepublishable•
Resource that has been published.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Unpublishes a resource from a channel. If the resource is a product, then it's visible in the channel only if the product status is
active.- •ID!required
The resource to delete or update publications for.
- Anchor to inputinput•[Publication
Input!]!required Specifies the input fields required to unpublish a resource.
Arguments
- Anchor to publishablepublishable•
Resource that has been unpublished.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Unpublishes a resource from the current channel. If the resource is a product, then it's visible in the channel only if the product status is
active.- •ID!required
The resource to delete or update publications for.
Arguments
- Anchor to publishablepublishable•
Resource that has been unpublished.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Creates a refund.
- Anchor to inputinput•Refund
Input!required The input fields that are used in the mutation for creating a refund.
Arguments
- Anchor to orderorder•
The order associated with the created refund.
- Anchor to refundrefund•
The created refund.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a saved search.
- Anchor to inputinput•Saved
Search Create Input!required Specifies the input fields for a saved search.
Arguments
- Anchor to savedSearchsaved•
Search The saved search that was created.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Delete a saved search.
- Anchor to inputinput•Saved
Search Delete Input!required The input fields to delete a saved search.
Arguments
- Anchor to deletedSavedSearchIddeleted•
Saved Search Id The ID of the saved search that was deleted.
- Anchor to shopshop•Shop!non-null
The shop of the saved search that was deleted.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a saved search.
- Anchor to inputinput•Saved
Search Update Input!required The input fields to update a saved search.
Arguments
- Anchor to savedSearchsaved•
Search The saved search that was updated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Theme app extensions
Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.
Script tag deprecation
Script tags will be sunset for the Order status page on August 28, 2025. Upgrade to Checkout Extensibility before this date. Shopify Scripts will continue to work alongside Checkout Extensibility until August 28, 2025.
Creates a new script tag.
- Anchor to inputinput•Script
Tag Input!required The input fields for a script tag.
Arguments
- Anchor to scriptTagscript•
Tag The script tag that was created.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Theme app extensions
Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.
Script tag deprecation
Script tags will be sunset for the Order status page on August 28, 2025. Upgrade to Checkout Extensibility before this date. Shopify Scripts will continue to work alongside Checkout Extensibility until August 28, 2025.
Deletes a script tag.
- •ID!required
The ID of the script tag to delete.
Arguments
- Anchor to deletedScriptTagIddeleted•
Script Tag Id The ID of the deleted script tag.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Theme app extensions
Your app might not pass App Store review if it uses script tags instead of theme app extensions. All new apps, and apps that integrate with Online Store 2.0 themes, should use theme app extensions, such as app blocks or app embed blocks. Script tags are an alternative you can use with only vintage themes. Learn more.
Script tag deprecation
Script tags will be sunset for the Order status page on August 28, 2025. Upgrade to Checkout Extensibility before this date. Shopify Scripts will continue to work alongside Checkout Extensibility until August 28, 2025.
Updates a script tag.
- •ID!required
The ID of the script tag to update.
- Anchor to inputinput•Script
Tag Input!required Specifies the input fields for a script tag.
Arguments
- Anchor to scriptTagscript•
Tag The script tag that was updated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Creates a segment.
- Anchor to namename•String!required
The name of the segment to be created. Segment names must be unique.
- Anchor to queryquery•String!required
A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers such as
with this syntax.
Arguments
- Anchor to segmentsegment•
The newly created segment.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deletes a segment.
- •ID!required
Specifies the segment to delete.
Arguments
- Anchor to deletedSegmentIddeleted•
Segment Id ID of the deleted segment.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Updates a segment.
- •ID!required
Specifies the segment to be updated.
- Anchor to namename•
The new name for the segment.
- Anchor to queryquery•
A precise definition of the segment. The definition is composed of a combination of conditions on facts about customers such as
with this syntax.
Arguments
- Anchor to segmentsegment•
The updated segment.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Deletes a shipping package.
- •ID!required
The ID of the shipping package to remove.
Arguments
- Anchor to deletedIddeleted•
Id The ID of the deleted shipping package.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Set a shipping package as the default. The default shipping package is the one used to calculate shipping costs on checkout.
- •ID!required
The ID of the shipping package to set as the default.
Arguments
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Updates a shipping package.
- •ID!required
The ID of the shipping package to update.
- Anchor to shippingPackageshipping•
Package CustomShipping Package Input!required Specifies the input fields for a shipping package.
Arguments
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Deletes a locale for a shop. This also deletes all translations of this locale.
- Anchor to localelocale•String!required
ISO code of the locale to delete.
Arguments
- Anchor to localelocale•
ISO code of the locale that was deleted.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Adds a locale for a shop. The newly added locale is in the unpublished state.
- Anchor to localelocale•String!required
ISO code of the locale to enable.
- Anchor to marketWebPresenceIdsmarket•
Web Presence Ids The list of markets web presences to add the locale to.
Arguments
- Anchor to shopLocaleshop•
Locale ISO code of the locale that was enabled.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates a locale for a shop.
- Anchor to localelocale•String!required
ISO code of the locale to update.
- Anchor to shopLocaleshop•
Locale ShopLocale Input!required Specifies the input fields for a shop locale.
Arguments
- Anchor to shopLocaleshop•
Locale The locale that was updated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates staged upload targets for each input. This is the first step in the upload process. The returned staged upload targets' URL and parameter fields can be used to send a request to upload the file described in the corresponding input.
For more information on the upload process, refer to Upload media to Shopify.
- Anchor to inputinput•[Staged
Upload Input!]!required The information required to generate staged upload targets.
Arguments
- Anchor to stagedTargetsstaged•
Targets The staged upload targets that were generated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a storefront access token for use with the Storefront API.
An app can have a maximum of 100 active storefront access tokens for each shop.
- Anchor to inputinput•Storefront
Access Token Input!required Provides the input fields for creating a storefront access token.
Arguments
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to storefrontAccessTokenstorefront•
Access Token The storefront access token.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deletes a storefront access token.
- Anchor to inputinput•
Provides the input fields required to delete a storefront access token.
Arguments
- Anchor to deletedStorefrontAccessTokenIddeleted•
Storefront Access Token Id The ID of the deleted storefront access token.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Add tags to an order, a draft order, a customer, a product, or an online store article.
- •ID!required
The ID of a resource to add tags to.
- •[String!]!required
A list of tags to add to the resource. Can be an array of strings or a single string composed of a comma-separated list of values. Example values:
["tag1", "tag2", "tag3"],"tag1, tag2, tag3".
Arguments
- •
The object that was updated.
- •[User
Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Remove tags from an order, a draft order, a customer, a product, or an online store article.
- •ID!required
The ID of the resource to remove tags from.
- •[String!]!required
A list of tags to remove from the resource in the form of an array of strings. Example value:
["tag1", "tag2", "tag3"].
Arguments
- •
The object that was updated.
- •[User
Error!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Asynchronously delete URL redirects in bulk.
- •
The asynchronous job removing the redirects.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
- •mutation
Creates a new webhook subscription.
Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your
shopify.app.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- Anchor to topictopic•Webhook
Subscription Topic!required The type of event that triggers the webhook.
- Anchor to webhookSubscriptionwebhook•
Subscription WebhookSubscription Input!required Specifies the input fields for a webhook subscription.
Arguments
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to webhookSubscriptionwebhook•
Subscription The webhook subscription that was created.
Fields
- •mutation
Deletes a webhook subscription.
Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your
shopify.app.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- •ID!required
The ID of the webhook subscription to delete.
Arguments
- Anchor to deletedWebhookSubscriptionIddeleted•
Webhook Subscription Id The ID of the deleted webhook subscription.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Updates a webhook subscription.
Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your
shopify.app.tomlmay be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read About managing webhook subscriptions.- •ID!required
The ID of the webhook subscription to update.
- Anchor to webhookSubscriptionwebhook•
Subscription WebhookSubscription Input!required Specifies the input fields for a webhook subscription.
Arguments
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to webhookSubscriptionwebhook•
Subscription The webhook subscription that was updated.
Fields
- •
Deprecated mutations
- •mutation
Publishes a collection to a channel.
- Anchor to inputinput•Collection
Publish Input!required Specify a collection to publish and the sales channels to publish it to.
Arguments
- Anchor to collectioncollection•
The published collection.
- Anchor to collectionPublicationscollection•
Publications The channels where the collection has been published.
- Anchor to shopshop•Shop!non-null
The shop associated with the collection.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Unpublishes a collection.
- Anchor to inputinput•Collection
Unpublish Input!required Specify a collection to unpublish and the sales channels to remove it from.
Arguments
- Anchor to collectioncollection•
The collection that has been unpublished.
- Anchor to shopshop•Shop!non-null
The shop associated with the collection.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a merchant checkout for the given draft order.
- •ID!required
Specifies the Draft order's id that we create the checkout for.
Arguments
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Creates a fulfillment for one or many fulfillment orders. The fulfillment orders are associated with the same order and are assigned to the same location.
- Anchor to fulfillmentfulfillment•Fulfillment
V2Input!required The input fields used to create a fulfillment from fulfillment orders.
- Anchor to messagemessage•
An optional message for the fulfillment request.
Arguments
- Anchor to fulfillmentfulfillment•
The created fulfillment.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates tracking information for a fulfillment.
- Anchor to fulfillmentIdfulfillment•
Id ID!required The ID of the fulfillment.
- Anchor to notifyCustomernotify•
Customer Whether the customer will be notified of this update and future updates for the fulfillment. If this field is left blank, then notifications won't be sent to the customer when the fulfillment is updated.
- Anchor to trackingInfoInputtracking•
Info Input FulfillmentTracking Input!required The tracking input for the mutation, including tracking URL, number, and company.
Arguments
- Anchor to fulfillmentfulfillment•
The updated fulfillment with tracking information.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deletes a metafield.
- Anchor to inputinput•Metafield
Delete Input!required
Arguments
- Anchor to deletedIddeleted•
Id The ID of the deleted metafield.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates a
record to make all metafields that belong to the specified resource and have the establishednamespaceandkeycombination visible in the Storefront API.- Anchor to inputinput•
Specifies the input fields for a
record.
Arguments
- Anchor to metafieldStorefrontVisibilitymetafield•
Storefront Visibility The
that was created.- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deletes a
record. All metafields that belongs to the specified record will no longer be visible in the Storefront API.- •ID!required
The ID of the
record to delete.
Arguments
- Anchor to deletedMetafieldStorefrontVisibilityIddeleted•
Metafield Storefront Visibility Id The ID of the deleted
record.- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •
- •mutation
Removes a line item discount that was applied as part of an order edit.
- Anchor to discountApplicationIddiscount•
Application Id ID!required The ID of the calculated discount application to remove.
- •ID!required
The ID of the calculated order from which to remove the discount.
Arguments
- Anchor to calculatedLineItemcalculated•
Line Item The calculated line item after removal of the discount.
- Anchor to calculatedOrdercalculated•
Order An order with the edits applied but not saved.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deletes a private metafield. Private metafields are automatically deleted when the app that created them is uninstalled.
- Anchor to inputinput•Private
Metafield Delete Input!required The input fields for the private metafield to delete.
Arguments
- Anchor to deletedPrivateMetafieldIddeleted•
Private Metafield Id The ID of private metafield that was deleted.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates or updates a private metafield. Use private metafields when you don't want the metafield data to be accessible by merchants or other apps. Private metafields are accessible only by the application that created them and only from the GraphQL Admin API.
An application can create a maximum of 10 private metafields per shop resource.
- Anchor to inputinput•Private
Metafield Input!required Specifies the input fields for the private metafield.
Arguments
- Anchor to privateMetafieldprivate•
Metafield The private metafield that was created or updated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Creates media for a product.
- Anchor to mediamedia•[Create
Media Input!]!required List of new media to be added to a product.
- Anchor to productIdproduct•
Id ID!required Specifies the product associated with the media.
Arguments
- Anchor to mediamedia•
The newly created media.
- Anchor to mediaUserErrorsmedia•
User Errors [MediaUser Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to productproduct•
The product associated with the media.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Deletes media for a product.
- Anchor to mediaIdsmedia•
Ids [ID!]!required The media IDs to be deleted.
- Anchor to productIdproduct•
Id ID!required Specifies the product ID from which the media will be deleted.
Arguments
- Anchor to deletedMediaIdsdeleted•
Media Ids List of media IDs which were deleted.
- Anchor to deletedProductImageIdsdeleted•
Product Image Ids List of product image IDs which were deleted.
- Anchor to mediaUserErrorsmedia•
User Errors [MediaUser Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to productproduct•
The product associated with the deleted media.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Publishes a product. Products that are sold exclusively on subscription (
) can only be published on online stores.- Anchor to inputinput•Product
Publish Input!required Specifies the product to publish and the channels to publish it to.
Arguments
- Anchor to productproduct•
The product that has been published.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to productPublicationsproduct•
Publications The channels where the product is published.
Fields
- •mutation
Unpublishes a product.
- Anchor to inputinput•Product
Unpublish Input!required Specifies the product to unpublish and the channel to unpublish it from.
Arguments
- Anchor to productproduct•
The product that has been unpublished.
- Anchor to shopshop•Shop!non-null
The user's shop.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Updates media for a product.
- Anchor to mediamedia•[Update
Media Input!]!required A list of media updates.
- Anchor to productIdproduct•
Id ID!required Specifies the product on which media will be updated.
Arguments
- Anchor to mediamedia•
The updated media object.
- Anchor to mediaUserErrorsmedia•
User Errors [MediaUser Error!]!non-null The list of errors that occurred from executing the mutation.
- Anchor to productproduct•
The product on which media was updated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Generates the URL and signed paramaters needed to upload an asset to Shopify.
- Anchor to inputinput•Staged
Upload Target Generate Input!required The input fields for generating a staged upload.
Arguments
- Anchor to parametersparameters•
The signed parameters that can be used to upload the asset.
- •String!non-null
The signed URL where the asset can be uploaded.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields
- •mutation
Uploads multiple images.
- Anchor to inputinput•[Stage
Image Input!]!required The input fields for generating staged uploads.
Arguments
- Anchor to urlsurls•
The staged upload targets that were generated.
- Anchor to userErrorsuser•
Errors [UserError!]!non-null The list of errors that occurred from executing the mutation.
Fields