younifyd
Menu

Shopify actions

Pick an action to see its parameters, request body and response fields.

677 actions

Abandoned · 2

Abandonment · 3

Article · 6

Articles · 1

Assigned · 1

Automatic · 1

Available · 3

Backup · 2

Blog · 4

Blogs · 2

Bulk · 6

QUERYbulkOperationThe current bulk operation for this app — poll its `status` and download the JSONL result from its `url`.MUTATIONbulkOperationCancelStarts 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.MUTATIONbulkOperationRunMutationStart an async bulk import — runs a mutation once per line of an uploaded JSONL file.MUTATIONbulkOperationRunQueryStart an async bulk export — runs a query against every matching object and writes the results to a downloadable JSONL file.QUERYbulkOperationsReturns the app's bulk operations meeting the specified filters. Defaults to sorting by createdat, with newest operations first.MUTATIONbulkProductResourceFeedbackCreateCreates product feedback for multiple products.

Business · 2

Cart · 3

MUTATIONcartTransformCreateCreates a cart transform function that lets merchants customize how products are bundled and presented during checkout. This gives merchants powerful control over their merchandising strategy by allowing apps to modify cart line items programmatically, supporting advanced approaches like dynamic bundles or personalized product recommendations. For example, a bundle app might create a cart transform that automatically groups related products (like a camera, lens, and case) into a single bundle line item when customers add them to their cart, complete with bundle pricing and unified presentation. Use `CartTransformCreate` to: - Deploy custom bundling logic to merchant stores - Enable dynamic product grouping during checkout - Implement personalized product recommendations - Create conditional offers based on cart contents - Support complex pricing strategies for product combinations The mutation processes synchronously and returns the created cart transform along with any validation errors. Once created, the cart transform function becomes active for the shop and will process cart modifications according to your defined logic. Cart transforms integrate with [Shopify Functions](https://shopify.dev/docs/api/functions) to provide powerful customization capabilities while maintaining checkout performance. Cart Transform functions can be configured to block checkout on failure or allow graceful degradation, giving you control over how errors are handled in the customer experience. Learn more about [customized bundles](https://shopify.dev/docs/apps/selling-strategies/bundles/add-a-customized-bundle).MUTATIONcartTransformDeleteRemoves an existing cart transform function from the merchant's store, disabling any customized bundle or cart modification logic it provided. This mutation persistently deletes the transform configuration and stops all associated cart processing. For example, when discontinuing a bundle app or removing specific merchandising features, you would delete the corresponding cart transform to ensure customers no longer see the bundled products or modified cart behavior. Use `CartTransformDelete` to: - Deactivate customized bundle logic when removing app features - Clean up unused transform functions - Disable cart modifications during app uninstallation - Remove outdated merchandising strategies - Restore default cart behavior for merchants The deletion processes immediately and returns the ID of the removed cart transform for confirmation. Once deleted, the transform function stops processing new cart operations, though existing cart sessions may retain their current state until refresh. This ensures a clean transition without disrupting active customer sessions. Consider the timing of deletions carefully, as removing transforms during peak shopping periods could affect customer experience if they have active carts with transformed items. Learn more about [managing cart transforms](https://shopify.dev/docs/apps/selling-strategies/bundles).QUERYcartTransformsRetrieves all cart transform functions currently deployed by your app within the merchant's store. This query provides comprehensive access to your active cart modification logic, enabling management and monitoring of bundling and merchandising features. The query returns paginated results with full cart transform details, including function IDs, configuration settings, and operational status. Cart Transform ownership is scoped to your API client, ensuring you only see and manage functions deployed by your specific app. This isolation prevents conflicts between different apps while maintaining security boundaries for sensitive merchandising logic. Learn more about [managing cart transforms](https://shopify.dev/docs/api/functions/latest/cart-transform).

Cash · 12

QUERYcashDrawerFetch a single cash drawer by its ID.MUTATIONcashDrawerCreateCreates a cash drawer in a provided location.MUTATIONcashDrawerFindOrCreateFinds or creates a cash drawer for cash management. Also ensures the provided device is assigned to the drawer.QUERYcashDrawersQuery cash drawers — supports a search `query`, `sortKey`, and cursor paging.MUTATIONcashDrawerUpdateUpdates a cash drawer.QUERYcashManagementLocationSummarySummary of cash management data for a location. Data is returned only if the location has a POS Pro subscription.MUTATIONcashManagementReasonCodeCreateCreate a cash management reason code.MUTATIONcashManagementReasonCodeDeleteDeletes a cash management reason code.QUERYcashManagementReasonCodesReturns the cash management reason codes for the shop.QUERYcashManagementShopSummarySummary of cash management data across all locations with a POS Pro subscription for a shop, filtered by currency.QUERYcashTrackingSessionFetch a single cash tracking session by its ID.QUERYcashTrackingSessionsReturns a shop's cash tracking sessions for locations with a POS Pro subscription. Tip: To query for cash tracking sessions in bulk, you can perform a bulk operation.

Catalog · 6

QUERYcatalogRetrieves a catalog by its ID. A catalog represents a list of products with publishing and pricing information, and can be associated with a context, such as a market, company location, or app.MUTATIONcatalogContextUpdateModifies which contexts, like markets or B2B company locations, can access a Catalog. You can add or remove contexts to control where the catalog's products and prices are available.MUTATIONcatalogCreateCreates a Catalog that controls product availability and pricing for specific contexts like markets or B2B company locations.MUTATIONcatalogDeleteDelete a catalog.QUERYcatalogOperationsReturns the most recent catalog operations for the shop.MUTATIONcatalogUpdateUpdates an existing catalog's configuration. Catalogs control product publishing and pricing for specific contexts like markets or B2B company locations.

Catalogs · 2

Channel · 6

QUERYchannelReturns a Channel by ID. The channel must belong to the calling application.QUERYchannelByHandleReturns a Channel by its unique string handle. The handle is either set explicitly during channelCreate or auto-generated from the specification handle and account ID.MUTATIONchannelCreateCreates a Channel representing a connection between the shop and an external selling platform account.MUTATIONchannelDeleteDeletes a Channel from the shop. All associated product feeds are removed.MUTATIONchannelFullSyncTriggers a full product resync for the specified Channel. All published products are added to the channel's product feed attention set, causing the next poll or event-triggered consumption to receive current state…MUTATIONchannelUpdateUpdates the properties of an existing Channel. Use this mutation to update account information — such as the display name shown in Shopify Admin — or to bind the channel to a different channel specification.

Channels · 1

Checkout · 3

Code · 2

Collection · 14

QUERYcollectionRetrieves a collection by its ID. A collection represents a grouping of products that merchants can display and sell as a group in their online store and other sales channels.QUERYcollectionByIdentifierFetch a single collection by its ID.QUERYcollectionConditionMetafieldDefinitionsLists all metafield definitions that can be used to create collection conditions.MUTATIONcollectionConditionsSourceCreateCreates a shareable collection source that can later be linked to one or more collections.MUTATIONcollectionConditionsSourceDeleteDeletes a shareable collection source owned by the calling app.QUERYcollectionConditionsSourcesReturns the shareable collection sources owned by the given app for the shop.QUERYcollectionConditionsSourcesByAppReturns the apps that publish shareable collection sources for the shop, paginated.MUTATIONcollectionConditionsSourceUpdateUpdates a shareable collection source owned by the calling app.MUTATIONcollectionCreateCreates a collection to group products together in the online store and other sales channels.MUTATIONcollectionDeleteDeletes a collection and removes it permanently from the store. This operation cannot be undone and will remove the collection from all sales channels where it was published.MUTATIONcollectionDuplicateDuplicates a collection. An existing collection ID and new title are required.MUTATIONcollectionReorderProductsAsynchronously reorders products within a specified collection. Instead of returning an updated collection, this mutation returns a job, which should be polled.QUERYcollectionSavedSearchesReturns a list of the shop's collection saved searches.MUTATIONcollectionUpdateUpdates a collection, modifying its properties, products, or publication settings. Collections help organize products together in the online store and other sales channels.

Collections · 2

Combined · 1

Comment · 5

QUERYcommentFetch a single comment by its ID.MUTATIONcommentApproveApproves a pending comment, making it visible to store visitors on the associated blog article.MUTATIONcommentDeletePermanently removes a comment from a blog article. For example, when a comment contains spam links or inappropriate language that violates store policies, merchants can delete it entirely.MUTATIONcommentNotSpamReverses a spam classification on a comment, restoring it to normal moderation status. This mutation allows merchants to change their decision when a comment has been manually marked as spam.MUTATIONcommentSpamMarks a comment as spam, removing it from public view. This mutation enables merchants to quickly handle unwanted promotional content, malicious links, or other spam that appears in blog discussions.

Comments · 1

Companies · 3

Company · 32

QUERYcompanyFetch a single company by its ID.MUTATIONcompanyAddressDeleteDeletes a company address.MUTATIONcompanyAssignCustomerAsContactAdds an existing Customer as a contact to a Company. Companies are business entities that make purchases from the merchant's store.MUTATIONcompanyAssignMainContactAssigns the main contact for the company.QUERYcompanyContactFetch a single company contact by its ID.MUTATIONcompanyContactAssignRoleAssigns a role to a contact for a location.MUTATIONcompanyContactAssignRolesAssigns roles on a company contact.MUTATIONcompanyContactCreateCreates a company contact and the associated customer.MUTATIONcompanyContactDeleteDeletes a company contact.MUTATIONcompanyContactRemoveFromCompanyRemoves a company contact from a Company.MUTATIONcompanyContactRevokeRoleRevokes a role on a company contact.MUTATIONcompanyContactRevokeRolesRevokes roles on a company contact.QUERYcompanyContactRoleFetch a single company contact role by its ID.MUTATIONcompanyContactsDeleteDeletes one or more company contacts.MUTATIONcompanyContactSendWelcomeEmailSends the company contact a welcome email.MUTATIONcompanyContactUpdateUpdates a company contact.MUTATIONcompanyCreateCreates a Company for B2B commerce. This mutation creates the company and can optionally create an initial CompanyContact and CompanyLocation in a single operation.MUTATIONcompanyDeleteDeletes a company.QUERYcompanyLocationFetch a single company location by its ID.MUTATIONcompanyLocationAssignAddressUpdates an address on a company location.MUTATIONcompanyLocationAssignRolesAssigns roles on a company location.MUTATIONcompanyLocationAssignStaffMembersCreates one or more mappings between a staff member at a shop and a company location.MUTATIONcompanyLocationCreateCreates a new location for a Company. Company locations are branches or offices where B2B customers can place orders with specific pricing, catalogs, and payment terms.MUTATIONcompanyLocationDeleteDeletes a company location.MUTATIONcompanyLocationRemoveStaffMembersDeletes one or more existing mappings between a staff member at a shop and a company location.MUTATIONcompanyLocationRevokeRolesRevokes roles on a company location.QUERYcompanyLocationsA paginated list of CompanyLocation objects for B2B customers. Company locations represent individual branches or offices of a Company where B2B orders can be placed.MUTATIONcompanyLocationsDeleteDeletes a list of company locations.MUTATIONcompanyLocationTaxSettingsUpdateSets the tax settings for a company location.MUTATIONcompanyLocationUpdateUpdates a company location's information and B2B checkout settings. Company locations are branches or offices where CompanyContact members place orders on behalf of the company.MUTATIONcompanyRevokeMainContactRevokes the main contact from the company.MUTATIONcompanyUpdateUpdates a Company with new information. Companies represent business customers that can have multiple contacts and locations with specific pricing, payment terms, and checkout settings.

Consent · 3

Current · 1

Customer · 40

QUERYcustomerFetch a single customer by its ID.QUERYcustomerAccountPageFetch a single customer account page by its ID.QUERYcustomerAccountPagesQuery customer account pages with cursor paging.MUTATIONcustomerAddressCreateCreates a new MailingAddress for a Customer. You can optionally set the address as the customer's default address.MUTATIONcustomerAddressDeleteDeletes a customer's address.MUTATIONcustomerAddressUpdateUpdates a Customer's MailingAddress. You can modify any field of the address and optionally set it as the customer's default address.MUTATIONcustomerAddTaxExemptionsAdd tax exemptions for the customer.QUERYcustomerByIdentifierFetch a single customer by its ID.MUTATIONcustomerCancelDataErasureCancels a pending erasure of a customer's data. Read more here.MUTATIONcustomerCreateCreates a new Customer in the store. Accepts customer details including contact information, marketing consent preferences, and tax exemptions through the CustomerInput input object.MUTATIONcustomerDeleteDeletes a Customer from the store. You can only delete customers who haven't placed any orders.MUTATIONcustomerEmailMarketingConsentUpdateUpdates a Customer's email marketing consent information. The customer must have an email address to update their consent.MUTATIONcustomerGenerateAccountActivationUrlGenerates a one-time activation URL for a Customer whose legacy customer account isn't yet enabled.MUTATIONcustomerMergeMerges two customers. The customerOneId and customerTwoId arguments don't guarantee which customer is kept.QUERYcustomerMergeJobStatusReturns the status of a customer merge request job.QUERYcustomerMergePreviewReturns a preview of a customer merge request. The customerOneId and customerTwoId arguments don't guarantee which customer is kept.QUERYcustomerPaymentMethodReturns a vaulted customer payment method by its ID, including the instrument type (credit card, PayPal, etc.MUTATIONcustomerPaymentMethodCreateFromDuplicationDataCreates a vaulted payment method for a customer from duplication data. This data must be obtained from another shop within the same organization.MUTATIONcustomerPaymentMethodCreditCardCreateCreates 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.MUTATIONcustomerPaymentMethodCreditCardUpdateUpdates an existing vaulted credit card payment method for a customer, including billing address and card details.MUTATIONcustomerPaymentMethodGetDuplicationDataReturns encrypted data that can be used to duplicate the payment method in another shop within the same organization.MUTATIONcustomerPaymentMethodGetUpdateUrlReturns a URL that allows the customer to update a specific payment method. Currently, customerPaymentMethodGetUpdateUrl only supports Shop Pay.MUTATIONcustomerPaymentMethodPaypalBillingAgreementCreateCreates a vaulted PayPal billing agreement for a customer, enabling recurring charges through PayPal.MUTATIONcustomerPaymentMethodPaypalBillingAgreementUpdateUpdates the billing address associated with a customer's vaulted PayPal billing agreement.MUTATIONcustomerPaymentMethodRemoteCreateCreates a customer payment method using identifiers from remote payment gateways like Stripe, Authorize.MUTATIONcustomerPaymentMethodRevokeRevokes a customer's vaulted payment method, preventing it from being used for future charges such as subscriptions, draft orders, or other payments.MUTATIONcustomerPaymentMethodSendUpdateEmailSends an email to a customer containing a secure link to update a specific vaulted payment method.MUTATIONcustomerRemoveTaxExemptionsRemove tax exemptions from a customer.MUTATIONcustomerReplaceTaxExemptionsReplace tax exemptions for a customer.MUTATIONcustomerRequestDataErasureEnqueues a request to erase customer's data. Read more here.QUERYcustomerSegmentMembersA paginated list of customers that belong to an individual Segment. Segments group customers based on criteria defined through ShopifyQL queries.QUERYcustomerSegmentMembershipWhether a member, which is a customer, belongs to a segment.QUERYcustomerSegmentMembersQueryFetch a single customer segment members query by its ID.MUTATIONcustomerSegmentMembersQueryCreateCreates a customer segment members query.MUTATIONcustomerSendAccountInviteEmailSends an email invitation for a customer to create a legacy customer account. The invitation lets customers set up their password and activate their account in the online store.MUTATIONcustomerSetCreates or updates a customer in a single mutation. Use this mutation when syncing information from an external data source into Shopify.MUTATIONcustomerSmsMarketingConsentUpdateUpdates a customer's SMS marketing consent information. The customer must have a phone number on their account to receive SMS marketing.MUTATIONcustomerUpdateUpdates a Customer's attributes including personal information and tax exemptions. Apps using protected customer data must meet Shopify's protected customer data requirements.MUTATIONcustomerUpdateDefaultAddressUpdates a customer's default address.MUTATIONcustomerWhatsAppMarketingConsentUpdateUpdates a customer's WhatsApp marketing consent information. Shopify identifies the customer's WhatsApp account by their phone number.

Customers · 2

Data · 1

Delegate · 2

Delivery · 11

QUERYdeliveryProfileRetrieves a DeliveryProfile by ID. Delivery profiles group shipping settings for specific Product objects that ship from selected Location objects to delivery zones.MUTATIONdeliveryProfileCreateCreates a DeliveryProfile that defines shipping rates for specific products and locations.MUTATIONdeliveryProfileRemoveEnqueue the removal of a delivery profile.QUERYdeliveryProfilesReturns a paginated list of DeliveryProfile objects for the shop. Delivery profiles group Product and ProductVariant objects that share shipping rates and zones.MUTATIONdeliveryProfileUpdateUpdates a DeliveryProfile's configuration, including its shipping zones, rates, and associated products.QUERYdeliveryPromiseParticipantsQuery delivery promise participants with cursor paging.MUTATIONdeliveryPromiseParticipantsUpdateUpdates the delivery promise participants by adding or removing owners based on a branded promise handle.QUERYdeliveryPromiseProviderFetch a single delivery promise provider by its ID.MUTATIONdeliveryPromiseProviderUpsertCreates or updates a delivery promise provider. Currently restricted to select approved delivery promise partners.QUERYdeliveryPromiseSettingsRepresents the delivery promise settings for a shop.MUTATIONdeliverySettingUpdateSet the delivery settings for a shop.

Discount · 37

MUTATIONdiscountAutomaticActivateActivates an automatic discount.MUTATIONdiscountAutomaticAppCreateCreates an automatic discount that's managed by an app. Use this mutation with Shopify Functions when you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native discount types.MUTATIONdiscountAutomaticAppUpdateUpdates an existing automatic discount that's managed by an app using Shopify Functions. Use this mutation when you need advanced, custom, or dynamic discount capabilities that aren't supported by Shopify's native…MUTATIONdiscountAutomaticBasicCreateCreates an amount off discount that's automatically applied on a cart and at checkout. Note: To create code discounts, use the discountCodeBasicCreate mutation.MUTATIONdiscountAutomaticBasicUpdateUpdates an existing amount off discount that's automatically applied on a cart and at checkout.MUTATIONdiscountAutomaticBulkDeleteDeletes multiple automatic discounts in a single operation, providing efficient bulk management for stores with extensive discount catalogs.MUTATIONdiscountAutomaticBxgyCreateCreates a buy X get Y discount (BXGY) that's automatically applied on a cart and at checkout.MUTATIONdiscountAutomaticBxgyUpdateUpdates an existing buy X get Y discount (BXGY) that's automatically applied on a cart and at checkout.MUTATIONdiscountAutomaticDeactivateDeactivates an automatic discount.MUTATIONdiscountAutomaticDeleteDeletes an existing automatic discount from the store, permanently removing it from all future order calculations.MUTATIONdiscountAutomaticFreeShippingCreateCreates automatic free shipping discounts that apply to qualifying orders without requiring discount codes.MUTATIONdiscountAutomaticFreeShippingUpdateUpdates existing automatic free shipping discounts, allowing merchants to modify promotion criteria, shipping destinations, and eligibility requirements without recreating the entire discount structure.MUTATIONdiscountBulkTagsAddAdds tags to multiple discounts asynchronously using one of the following: - A search query - A saved search ID - A list of discount IDs For example, you can add tags to price rules that match a search criteria, or…MUTATIONdiscountBulkTagsRemoveRemoves tags from multiple discounts asynchronously using one of the following: - A search query - A saved search ID - A list of discount IDs For example, you can delete tags from price rules that match a search…MUTATIONdiscountCodeActivateActivates a previously created code discount, making it available for customers to use during checkout.MUTATIONdiscountCodeAppCreateCreates a code discount. The discount type must be provided by an app extension that uses Shopify Functions.MUTATIONdiscountCodeAppUpdateUpdates a code discount, where the discount type is provided by an app extension that uses Shopify Functions.MUTATIONdiscountCodeBasicCreateCreates an amount off discount that's applied on a cart and at checkout when a customer enters a code.MUTATIONdiscountCodeBasicUpdateUpdates an amount off discount that's applied on a cart and at checkout when a customer enters a code.MUTATIONdiscountCodeBulkActivateActivates multiple code discounts asynchronously using one of the following: - A search query - A saved search ID - A list of discount code IDs For example, you can activate discounts for all codes that match a…MUTATIONdiscountCodeBulkDeactivateDeactivates multiple code-based discounts asynchronously using one of the following: - A search query - A saved search ID - A list of discount code IDs For example, you can deactivate discounts for all codes that…MUTATIONdiscountCodeBulkDeleteDeletes multiple code-based discounts asynchronously using one of the following: - A search query - A saved search ID - A list of discount code IDs For example, you can delete discounts for all codes that match a…MUTATIONdiscountCodeBxgyCreateCreates a buy X get Y discount (BXGY) that's applied on a cart and at checkout when a customer enters a code.MUTATIONdiscountCodeBxgyUpdateUpdates a buy X get Y discount (BXGY) that's applied on a cart and at checkout when a customer enters a code.MUTATIONdiscountCodeDeactivateTemporarily suspends a code discount without permanently removing it from the store. Deactivation allows merchants to pause promotional campaigns while preserving the discount configuration for potential future use.MUTATIONdiscountCodeDeleteRemoves a code discount from the store, making it permanently unavailable for customer use.MUTATIONdiscountCodeFreeShippingCreateCreates an free shipping discount that's applied on a cart and at checkout when a customer enters a code.MUTATIONdiscountCodeFreeShippingUpdateUpdates a free shipping discount that's applied on a cart and at checkout when a customer enters a code.MUTATIONdiscountCodeRedeemCodeBulkDeleteAsynchronously delete discount codes in bulk that customers can use to redeem a discount.QUERYdiscountCodesCountThe total number of discount codes for the shop. Limited to a maximum of 10000 by default.QUERYdiscountNodeFetch a single discount node by its ID.QUERYdiscountNodesQuery discount nodes — supports a search `query`, `sortKey`, and cursor paging.QUERYdiscountNodesCountThe total number of discounts for the shop. Limited to a maximum of 10000 by default.MUTATIONdiscountRedeemCodeBulkAddAsynchronously add discount codes in bulk that customers can use to redeem a discount. You can use the discountRedeemCodeBulkAdd mutation to automate the distribution of discount codes through emails or other…QUERYdiscountRedeemCodeBulkCreationFetch a single discount redeem code bulk creation by its ID.QUERYdiscountRedeemCodeSavedSearchesQuery saved searches — supports a search `query`, `sortKey`, and cursor paging.QUERYdiscountTagsQuery discount tags — supports a search `query`, `sortKey`, and cursor paging.

Dispute · 3

Disputes · 1

Domain · 1

Draft · 18

QUERYdraftOrderRetrieves a draft order by its ID. A draft order is an order created by a merchant on behalf of their customers.QUERYdraftOrderAvailableDeliveryOptionsAvailable delivery options for a DraftOrder based on the provided input. The query returns shipping rates, local delivery rates, and pickup locations that merchants can choose from when creating draft orders.MUTATIONdraftOrderBulkAddTagsAdds tags to multiple draft orders.MUTATIONdraftOrderBulkDeleteDeletes multiple draft orders.MUTATIONdraftOrderBulkRemoveTagsRemoves tags from multiple draft orders.MUTATIONdraftOrderCalculateCalculates the properties of a DraftOrder without creating it. Returns pricing information including CalculatedDraftOrderLineItem totals, shipping charges, applicable discounts, and tax calculations based on the…MUTATIONdraftOrderCompleteCompletes a draft order and converts it into a regular order. The order appears in the merchant's orders list, and the customer can be notified about their order.MUTATIONdraftOrderCreateCreates a draft order with attributes such as customer information, line items, shipping and billing addresses, and payment terms.MUTATIONdraftOrderCreateFromOrderCreates a draft order from order.MUTATIONdraftOrderDeleteDeletes a draft order.MUTATIONdraftOrderDuplicateDuplicates a draft order.MUTATIONdraftOrderInvoicePreviewPreviews a draft order invoice email.MUTATIONdraftOrderInvoiceSendSends an invoice email for a DraftOrder. The invoice includes a secure checkout link for reviewing and paying for the order.QUERYdraftOrdersQuery draft orders — supports a search `query`, `sortKey`, and cursor paging.QUERYdraftOrderSavedSearchesQuery saved searches with cursor paging.QUERYdraftOrdersCountReturns the number of draft orders that match the query. Limited to a maximum of 10000 by default.QUERYdraftOrderTagFetch a single draft order tag by its ID.MUTATIONdraftOrderUpdateUpdates a draft order. If a checkout has been started for a draft order, any update to the draft will unlink the checkout.

Event · 2

Events · 2

File · 5

Files · 1

Finance · 2

Fulfillment · 34

QUERYfulfillmentRetrieves a Fulfillment by its ID. A fulfillment is a record that the merchant has completed their work required for one or more line items in an Order.MUTATIONfulfillmentCancelCancels an existing Fulfillment and reverses its effects on associated FulfillmentOrder objects.MUTATIONfulfillmentConstraintRuleCreateCreates a fulfillment constraint rule and its metafield.MUTATIONfulfillmentConstraintRuleDeleteDeletes a fulfillment constraint rule and its metafields.QUERYfulfillmentConstraintRulesThe fulfillment constraint rules that belong to a shop.MUTATIONfulfillmentConstraintRuleUpdateUpdate a fulfillment constraint rule.MUTATIONfulfillmentCreateCreates a fulfillment for one or more FulfillmentOrder objects. The fulfillment orders are associated with the same Order and are assigned to the same Location.MUTATIONfulfillmentEventCreateCreates a FulfillmentEvent to track the shipment status and location of items that have shipped.QUERYfulfillmentOrderFetch a single fulfillment order by its ID.MUTATIONfulfillmentOrderAcceptCancellationRequestAccept a cancellation request sent to a fulfillment service for a fulfillment order.MUTATIONfulfillmentOrderAcceptFulfillmentRequestAccepts a fulfillment request that the fulfillment service has received for a FulfillmentOrder which signals that the fulfillment service will process and fulfill the order.MUTATIONfulfillmentOrderCancelCancels a FulfillmentOrder and creates a replacement fulfillment order to represent the work left to be done.MUTATIONfulfillmentOrderCloseMarks an in-progress fulfillment order as incomplete, indicating the fulfillment service is unable to ship any remaining items, and closes the fulfillment request.MUTATIONfulfillmentOrderHoldApplies a fulfillment hold on a fulfillment order. As of the 2025-01 API version, the mutation can be successfully executed on fulfillment orders that are already on hold.MUTATIONfulfillmentOrderLineItemsPreparedForPickupMarks fulfillment order line items as ready for customer pickup. When executed, this mutation automatically sends a "Ready For Pickup" notification to the customer.MUTATIONfulfillmentOrderMergeMerges a set or multiple sets of fulfillment orders together into one based on line item inputs and quantities.MUTATIONfulfillmentOrderMoveChanges the location which is assigned to fulfill a number of unfulfilled fulfillment order line items.MUTATIONfulfillmentOrderOpenMarks a scheduled fulfillment order as open. From API version 2026-01, this will also mark a fulfillment order as open when it is assigned to a merchant managed location and has had progress reported.MUTATIONfulfillmentOrderRejectCancellationRequestRejects a cancellation request sent to a fulfillment service for a fulfillment order.MUTATIONfulfillmentOrderRejectFulfillmentRequestRejects a fulfillment request sent to a fulfillment service for a fulfillment order.MUTATIONfulfillmentOrderReleaseHoldReleases the fulfillment hold on a fulfillment order.MUTATIONfulfillmentOrderReportProgressReports the progress of an open or in-progress fulfillment order.MUTATIONfulfillmentOrderRescheduleReschedules a scheduled fulfillment order. Updates the value of the fulfillAt field on a scheduled fulfillment order.QUERYfulfillmentOrdersThe paginated list of all fulfillment orders. The returned fulfillment orders are filtered according to the fulfillment order access scopes granted to the app.MUTATIONfulfillmentOrderSplitSplits FulfillmentOrder objects by moving the specified LineItem objects and quantities into a new fulfillment order.MUTATIONfulfillmentOrdersRerouteRoute the fulfillment orders to an alternative location, according to the shop's order routing settings.MUTATIONfulfillmentOrdersSetFulfillmentDeadlineSets the latest date and time by which the fulfillment orders need to be fulfilled.MUTATIONfulfillmentOrderSubmitCancellationRequestSends a cancellation request to the fulfillment service of a fulfillment order.MUTATIONfulfillmentOrderSubmitFulfillmentRequestSends a fulfillment request to the fulfillment service assigned to a FulfillmentOrder. The fulfillment service must then accept or reject the request before processing can begin.QUERYfulfillmentServiceReturns a FulfillmentService by its ID. The service can manage inventory, process fulfillment requests, and provide tracking details through callback endpoints or directly calling Shopify's APIs.MUTATIONfulfillmentServiceCreateCreates 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.MUTATIONfulfillmentServiceDeleteDeletes a fulfillment service.MUTATIONfulfillmentServiceUpdateUpdates the FulfillmentService configuration, including its name, callback URL, and operational settings.MUTATIONfulfillmentTrackingInfoUpdateUpdates tracking information for a fulfillment, including the carrier name, tracking numbers, and tracking URLs.

Gift · 12

QUERYgiftCardRetrieves a GiftCard by its ID. Returns the gift card's balance, transaction history, Customer information, and whether it's enabled.QUERYgiftCardConfigurationFetch a single gift card configuration by its ID.MUTATIONgiftCardCreateCreates a new GiftCard with a specified initial value. You can assign the gift card to a Customer or create it without assignment for manual distribution.MUTATIONgiftCardCreditAdds funds to an existing gift card, increasing its available balance. Use this when a merchant wants to top up a customer's gift card — for example, as a promotional bonus, a customer service gesture, or to reload a…MUTATIONgiftCardDeactivateDeactivate a gift card. A deactivated gift card cannot be used by a customer.MUTATIONgiftCardDebitRemoves funds from a gift card, decreasing its available balance. Use this for manual balance adjustments — for example, correcting an accidental over-credit or applying a fee.MUTATIONgiftCardProductSetCreates or updates a gift card product. This mutation is specifically designed for gift card products and automatically sets the giftCard field to true, applies gift card variant defaults (non-taxable, no shipping…QUERYgiftCardsReturns a paginated list of GiftCard objects issued for the shop. You can filter gift cards by attributes such as status, last characters of the code, balance status, and other values using the query parameter.QUERYgiftCardsCountReturns the total count of gift cards that have been issued by the shop. Use this for dashboard summaries or to understand the scale of a merchant's gift card program.MUTATIONgiftCardSendNotificationToCustomerSends a notification to the customer who purchased a gift card, including the gift card details and code.MUTATIONgiftCardSendNotificationToRecipientSends a notification to the designated recipient of a gift card, delivering the gift card code and redemption instructions.MUTATIONgiftCardUpdateUpdates the properties of an existing gift card, such as its expiration date, note, or template suffix.

Inventory · 34

MUTATIONinventoryActivateActivates an inventory item at a Location by creating an InventoryLevel that tracks stock quantities.MUTATIONinventoryAdjustQuantitiesApply relative (delta) changes to inventory quantities at one or more locations.MUTATIONinventoryBulkToggleActivationActivates or deactivates an inventory item at multiple locations. When you activate an InventoryItem at a Location, that location can stock and track quantities for that item.MUTATIONinventoryDeactivateRemoves an inventory item's quantities from a location, and turns off inventory at the location.QUERYinventoryItemFetch a single inventory item by its ID.QUERYinventoryItemsQuery inventory items — supports a search `query`, `sortKey`, and cursor paging.MUTATIONinventoryItemUpdateUpdates an InventoryItem's properties including whether inventory is tracked, cost, SKU, and whether shipping is required.QUERYinventoryLevelFetch a single inventory level by its ID.MUTATIONinventoryMoveQuantitiesMoves inventory quantities for a single inventory item between different states at a single location.QUERYinventoryPropertiesReturns the shop's inventory configuration, including all inventory quantity names. Quantity names represent different inventory states that merchants use to track inventory.MUTATIONinventorySetQuantitiesSet on-hand / available inventory to absolute values at one or more locations.QUERYinventoryShipmentRetrieves an InventoryShipment by ID. Returns tracking details, InventoryShipmentLineItem objects with quantities, and the shipment's current InventoryShipmentStatus.MUTATIONinventoryShipmentAddItemsAdds items to an inventory shipment. Caution: As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive.MUTATIONinventoryShipmentCreateAdds a draft shipment to an inventory transfer. Caution: As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive.MUTATIONinventoryShipmentCreateInTransitAdds an in-transit shipment to an inventory transfer. Caution: As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive.MUTATIONinventoryShipmentDeleteDeletes an inventory shipment. Only draft shipments can be deleted.MUTATIONinventoryShipmentMarkInTransitMarks a draft inventory shipment as in transit.MUTATIONinventoryShipmentReceiveReceive an inventory shipment. Caution: As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive.MUTATIONinventoryShipmentRemoveItemsRemove items from an inventory shipment.QUERYinventoryShipmentsReturns a paginated list of InventoryShipment objects. Supports filtering by barcode (e.MUTATIONinventoryShipmentSetBarcodeSets the barcode on an inventory shipment.MUTATIONinventoryShipmentSetTrackingEdits the tracking info on an inventory shipment.MUTATIONinventoryShipmentUpdateItemQuantitiesUpdates items on an inventory shipment.QUERYinventoryTransferReturns an InventoryTransfer by ID. Inventory transfers track the movement of inventory between locations, including origin and destination details, InventoryTransferLineItem objects, quantities, and…MUTATIONinventoryTransferCancelCancels an inventory transfer.MUTATIONinventoryTransferCreateCreates a draft inventory transfer to move inventory items between Location objects in your store.MUTATIONinventoryTransferCreateAsReadyToShipCreates an inventory transfer in ready to ship. Caution: As of 2026-01, this mutation supports an optional idempotency key using the @idempotent directive.MUTATIONinventoryTransferDeleteDeletes an inventory transfer.MUTATIONinventoryTransferDuplicateThis mutation allows duplicating an existing inventory transfer. The duplicated transfer will have the same line items and quantities as the original transfer, but will be in a draft state with no shipments.MUTATIONinventoryTransferEditEdits an inventory transfer.MUTATIONinventoryTransferMarkAsReadyToShipSets an inventory transfer to ready to ship.MUTATIONinventoryTransferRemoveItemsThis mutation removes InventoryTransferLineItems, or portions of them, from a DRAFT or READYTOSHIP Transfer.QUERYinventoryTransfersReturns a paginated list of InventoryTransfer objects between locations. Transfers track the movement of InventoryItem objects between Location objects.MUTATIONinventoryTransferSetItemsThis mutation sets the quantity for one or more line items on a Transfer. Only the items you include in the lineItems field are updated.

Job · 1

Location · 9

QUERYlocationRetrieves a Location by its ID. Locations are physical places where merchants store inventory, such as warehouses, retail stores, or fulfillment centers.MUTATIONlocationActivateActivates a location so that you can stock inventory at the location. Refer to the isActive and activatable fields on the Location object.MUTATIONlocationAddAdds a new Location where you can stock inventory and fulfill orders. Locations represent physical places like warehouses, retail stores, or fulfillment centers.QUERYlocationByIdentifierFetch a single location by its ID.MUTATIONlocationDeactivateDeactivates a location and moves inventory, pending orders, and moving transfers " "to a destination location.MUTATIONlocationDeleteDeletes a location.MUTATIONlocationEditUpdates the properties of an existing Location. You can modify the location's name, address, whether it fulfills online orders, and custom metafields.MUTATIONlocationLocalPickupDisableDisables local pickup for a location.MUTATIONlocationLocalPickupEnableEnables local pickup for a location so customers can collect their orders in person. Configures the estimated pickup time that customers see at checkout and optional instructions for finding or accessing the pickup…

Locations · 3

Manual · 1

Market · 9

QUERYmarketFetch a single market by its ID.MUTATIONmarketCreateCreates a Market to deliver customized shopping experiences. Markets define various aspects of the buyer experience including pricing, product availability, custom content, inventory and fulfillment priorities, and…MUTATIONmarketDeleteDeletes a market definition.QUERYmarketLocalizableResourceA resource that can have localized values for different markets.QUERYmarketLocalizableResourcesResources that can have localized values for different markets.QUERYmarketLocalizableResourcesByIdsResources that can have localized values for different markets.MUTATIONmarketLocalizationsRegisterCreates or updates market localizations.MUTATIONmarketLocalizationsRemoveDeletes market localizations.MUTATIONmarketUpdateUpdates the properties of a market.

Marketing · 2

Markets · 2

Menu · 4

Menus · 1

Metafield · 8

QUERYmetafieldDefinitionRetrieves a MetafieldDefinition by its identifier. You can identify a definition using either its owner type, namespace, and key, or its global ID.MUTATIONmetafieldDefinitionCreateCreates a MetafieldDefinition that establishes structure and validation rules for metafields.MUTATIONmetafieldDefinitionDeleteDeletes a MetafieldDefinition. You can identify the definition by providing either its owner type, namespace, and key, or its global ID.MUTATIONmetafieldDefinitionPinYou can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions.QUERYmetafieldDefinitionsQuery metafield definitions — supports a search `query`, `sortKey`, and cursor paging.QUERYmetafieldDefinitionTypesThe available metafield types that you can use when creating MetafieldDefinition objects. Each type specifies what kind of data it stores (such as boolean, color, date, or references), its category, and which…MUTATIONmetafieldDefinitionUnpinYou can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions.MUTATIONmetafieldDefinitionUpdateUpdates a MetafieldDefinition's configuration and settings. You can modify the definition's name, description, validation rules, access settings, capabilities, and constraints.

Metafields · 2

Metaobject · 13

QUERYmetaobjectRetrieves a single Metaobject by its global ID. Metaobjects store custom structured data based on defined schemas.MUTATIONmetaobjectBulkDeleteAsynchronously delete metaobjects and their associated metafields in bulk.QUERYmetaobjectByHandleRetrieves a Metaobject by its handle and type. Handles are unique identifiers within a metaobject type.MUTATIONmetaobjectCreateCreates a metaobject entry based on an existing MetaobjectDefinition. The type must match a definition that already exists in the shop.QUERYmetaobjectDefinitionRetrieves a MetaobjectDefinition by its global ID. Metaobject definitions provide the structure and fields for metaobjects.QUERYmetaobjectDefinitionByTypeRetrieves a MetaobjectDefinition by its type. The type serves as a unique identifier that distinguishes one metaobject definition from another.MUTATIONmetaobjectDefinitionCreateCreates a metaobject definition that establishes the structure for custom data objects in your store.MUTATIONmetaobjectDefinitionDeleteDeletes the specified metaobject definition. Also deletes all related metafield definitions, metaobjects, and metafields asynchronously.QUERYmetaobjectDefinitionsReturns a paginated list of all MetaobjectDefinition objects configured for the store. Metaobject definitions provide the schema for creating custom data structures composed of individual fields.MUTATIONmetaobjectDefinitionUpdateUpdates a MetaobjectDefinition's configuration and field structure. You can modify the definition's name, description, display name key, access controls, and capabilities, as well as those of all its fields.MUTATIONmetaobjectDeleteDeletes the specified metaobject and its associated metafields.MUTATIONmetaobjectUpdateUpdates a Metaobject with new field values, handle, or capabilities. Metaobjects are custom data structures that extend Shopify's data model.MUTATIONmetaobjectUpsertCreates or updates a Metaobject based on its handle. If a metaobject with the specified handle exists, the mutation updates it with the provided field values.

Metaobjects · 1

Node · 1

Nodes · 1

Online · 1

Order · 33

QUERYorderThe order query retrieves an order by its ID. This query provides access to comprehensive order information such as customer details, line items, financial data, and fulfillment status.MUTATIONorderAttributionDefinitionDeleteDeletes an order attribution definition for the calling app on the current shop. Existing orders attributed to this definition are preserved.QUERYorderAttributionDefinitionsReturns approved order attribution definitions for the calling app on the current shop. Learn more in the order attribution guide.MUTATIONorderAttributionDefinitionUpsertUpserts an order attribution definition for the calling app on the current shop. Apps can use attribution definitions to label orders they route to a shop, replacing or augmenting any definitions shipped…QUERYorderByIdentifierFetch a single order by its ID.MUTATIONorderCancelCancels an order, with options for refunding, restocking inventory, and customer notification.MUTATIONorderCaptureCaptures payment for an authorized transaction on an order. Use this mutation to claim the money that was previously reserved by an authorization transaction.MUTATIONorderCloseMarks an open Order as closed. A closed order is one where merchants fulfill or cancel all LineItem objects and complete all financial transactions.MUTATIONorderCreateCreates an order with attributes such as customer information, line items, and shipping and billing addresses.MUTATIONorderCreateMandatePaymentCreates a payment for an Order using a stored PaymentMandate. A payment mandate represents the customer's authorization to charge their payment method for deferred payments, such as pre-orders or try-before-you-buy…MUTATIONorderCreateManualPaymentRecords a manual payment for an Order that isn't fully paid. Use this mutation to track payments received outside the standard checkout process, such as cash, check, bank transfer, or other offline payment methods.MUTATIONorderCustomerRemoveRemoves customer from an order.MUTATIONorderCustomerSetSets a customer on an order.MUTATIONorderDeletePermanently deletes an Order from the store. You can only delete specific order types.MUTATIONorderEditAddCustomItemAdds a custom line item to an existing Order. Custom line items represent products or services not in your catalog, such as gift wrapping, installation fees, or one-off charges.MUTATIONorderEditAddLineItemDiscountApplies a discount to a LineItem during an order edit session. The discount can be either a fixed amount or percentage value.MUTATIONorderEditAddShippingLineAdds a custom shipping line to an Order during an edit session. Specify the shipping title and price to create a new ShippingLine.MUTATIONorderEditAddVariantAdds a ProductVariant as a line item to an Order that's being edited. The mutation respects the variant's contextual pricing.MUTATIONorderEditBeginStart an order edit session — returns a `calculatedOrder` you then modify with the other `orderEdit*` mutations before `orderEditCommit`.MUTATIONorderEditCommitFinalise an order edit session, applying the staged line-item / discount / shipping changes to the real order.MUTATIONorderEditRemoveDiscountRemoves a discount 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.MUTATIONorderEditRemoveShippingLineRemoves a shipping line from an existing order. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.QUERYorderEditSessionFetch a single order edit session by its ID.MUTATIONorderEditSetQuantitySets the quantity of a line item on an order that's being edited. Use this mutation to increase, decrease, or remove items by adjusting their quantities.MUTATIONorderEditUpdateDiscountUpdates a manual line level discount 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.MUTATIONorderEditUpdateShippingLineUpdates a shipping line 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.MUTATIONorderInvoiceSendSends an email invoice for an Order. You can customize the email recipient, sender, and subject line using the email argument.MUTATIONorderMarkAsPaidMarks an order as paid by recording a payment transaction for the outstanding amount. Use the orderMarkAsPaid mutation to record payments received outside the standard checkout process.MUTATIONorderOpenOpens a closed order.QUERYorderPaymentStatusRetrieves the status of a deferred payment by its payment reference ID. Use this query to monitor the processing status of payments that are initiated through payment mutations.MUTATIONorderRiskAssessmentCreateCreates a risk assessment for a specific order using the provided risk level and facts. Shopify sends an orders/riskassessmentchanged webhook when the assessment is created.QUERYorderSavedSearchesReturns saved searches for orders in the shop. Saved searches store search queries with their filters and search terms.MUTATIONorderUpdateUpdates the attributes of an order, such as the customer's email, the shipping address for the order, tags, and metafields associated with the order.

Orders · 2

Page · 4

Pages · 2

Payment · 6

MUTATIONpaymentReminderSendSends an email payment reminder for a payment schedule.MUTATIONpaymentScheduleCaptureCaptures payment for a due PaymentSchedule using the vaulted payment method associated with the order.MUTATIONpaymentTermsCreateCreate payment terms on an order. To create payment terms on a draft order, use a draft order mutation and include the request with the DraftOrderInput.MUTATIONpaymentTermsDeleteDelete payment terms for an order. To delete payment terms on a draft order, use a draft order mutation and include the request with the DraftOrderInput.QUERYpaymentTermsTemplatesThe list of payment terms templates eligible for all shops and users.MUTATIONpaymentTermsUpdateUpdate payment terms on an order. To update payment terms on a draft order, use a draft order mutation and include the request with the DraftOrderInput.

Pending · 1

Point · 8

QUERYpointOfSaleDeviceFetch a single point of sale device by its ID.MUTATIONpointOfSaleDeviceAssignToCashDrawerAssigns a point of sale device to a cash drawer, removing any prior assignment.QUERYpointOfSaleDevicePaymentSessionLookup a point of sale device payment session by ID.MUTATIONpointOfSaleDevicePaymentSessionAdjustAdds an adjustment to a point of sale device payment session.MUTATIONpointOfSaleDevicePaymentSessionCloseCloses a point of sale device payment session.MUTATIONpointOfSaleDevicePaymentSessionCountRecords a mid-session cash count for a point of sale device payment session.MUTATIONpointOfSaleDevicePaymentSessionOpenOpens a point of sale device payment session.QUERYpointOfSaleDevicePaymentSessionsA list of point of sale device payment sessions in the shop. Cash management data is returned only for locations with a POS Pro subscription.

Preview · 1

Price · 9

QUERYpriceListReturns a PriceList by ID. You can use price lists to specify either fixed prices or adjusted relative prices that override initial Product prices.MUTATIONpriceListCreateCreates a PriceList. Price lists enable contextual pricing by defining fixed prices or percentage-based adjustments.MUTATIONpriceListDeleteDeletes a price list. For example, you can delete a price list so that it no longer applies for products in the associated market.MUTATIONpriceListFixedPricesAddCreates or updates fixed prices on a PriceList. Use this mutation to set specific prices for ProductVariant objects that override the price list's default percentage-based adjustments.MUTATIONpriceListFixedPricesByProductUpdateSets or removes fixed prices for all variants of a Product on a PriceList. Simplifies pricing management when all variants of a product should have the same price on a price list, rather than setting individual…MUTATIONpriceListFixedPricesDeleteDeletes specific fixed prices from a price list using a product variant ID. You can use the priceListFixedPricesDelete mutation to delete a set of fixed prices from a price list.MUTATIONpriceListFixedPricesUpdateUpdates fixed prices on a PriceList. This mutation lets you add new fixed prices for specific ProductVariant objects and remove existing prices in a single operation.QUERYpriceListsAll price lists for a shop.MUTATIONpriceListUpdateUpdates a PriceList's configuration, including its name, currency, Catalog association, and pricing adjustments.

Privacy · 2

Product · 41

QUERYproductRetrieves a product by its ID. A product is an item that a merchant can sell in their store.MUTATIONproductBundleCreateCreates a product bundle that groups multiple Product objects together as components. The bundle appears as a single product in the store, with its price determined by the parent product and inventory calculated from…MUTATIONproductBundleUpdateUpdates a product bundle or componentized product.QUERYproductByIdentifierFetch a single product by its ID.MUTATIONproductCreateCreates a product with attributes such as title, description, vendor, and media. The productCreate mutation helps you create many products at once, avoiding the tedious or time-consuming process of adding them one by…MUTATIONproductDeletePermanently deletes a product and all its associated data, including variants, media, publications, and inventory items.MUTATIONproductDuplicateDuplicates 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.QUERYproductDuplicateJobFetch a single product duplicate job by its ID.QUERYproductFeedFetch a single product feed by its ID.MUTATIONproductFeedCreateCreates a product feed for a specific publication.MUTATIONproductFeedDeleteDeletes a product feed for a specific publication.QUERYproductFeedsQuery product feeds with cursor paging.MUTATIONproductFullSyncRuns the full product sync for a given shop.MUTATIONproductJoinSellingPlanGroupsAdds multiple selling plan groups to a product.MUTATIONproductLeaveSellingPlanGroupsRemoves multiple groups from a product.QUERYproductOperationReturns a ProductOperation resource by ID. This can be used to query the ProductSetOperation, using the ID that was returned when the product was created or updated by the ProductSet mutation.MUTATIONproductOptionsCreateCreates one or more options on a product, such as size, color, or material. Each option includes a name, position, and a list of values.MUTATIONproductOptionsDeleteDeletes one or more options from a product. Product options define the choices available for a product, such as size, color, or material.MUTATIONproductOptionsReorderReorders the options and option values on a product, updating the order in which product variants are presented to customers.MUTATIONproductOptionUpdateUpdates an option on a product, such as size, color, or material. Each option includes a name, position, and a list of values.MUTATIONproductReorderMediaReorders media attached to a product, changing their sequence in product displays. The operation processes asynchronously to handle products with large media collections.QUERYproductResourceFeedbackRetrieves product resource feedback for the currently authenticated app, providing insights into product data quality, completeness, and optimization opportunities.QUERYproductSavedSearchesReturns a list of the shop's product saved searches.MUTATIONproductSetDeclaratively create or update a product and its options, variants, and media in a single call — the state you pass becomes the product's state.QUERYproductTagsReturns tags added to Product objects in the shop. Provides a paginated list of tag strings.QUERYproductTypesReturns a paginated list of product types assigned to products in the store. The maximum page size is 1000.MUTATIONproductUpdateUpdates a product with attributes such as title, description, vendor, and media. The productUpdate mutation helps you modify many products at once, avoiding the tedious or time-consuming process of updating them one…QUERYproductVariantRetrieves a product variant by its ID. A product variant is a specific version of a product that comes in more than one option, such as size or color.MUTATIONproductVariantAppendMediaAppends existing media from a product to specific variants of that product, creating associations between media files and particular product options.QUERYproductVariantByIdentifierFetch a single product variant by its ID.MUTATIONproductVariantDetachMediaDetaches media from product variants.MUTATIONproductVariantJoinSellingPlanGroupsAdds multiple selling plan groups to a product variant.MUTATIONproductVariantLeaveSellingPlanGroupsRemove multiple groups from a product variant.MUTATIONproductVariantRelationshipBulkUpdateCreates new bundles, updates component quantities in existing bundles, and removes bundle components for one or multiple ProductVariant objects.QUERYproductVariantsRetrieves a list of product variants associated with a product. A product variant is a specific version of a product that comes in more than one option, such as size or color.MUTATIONproductVariantsBulkCreateCreates multiple product variants for a single product in one operation. You can run this mutation directly or as part of a bulk operation for large-scale catalog updates.MUTATIONproductVariantsBulkDeleteDeletes multiple variants in a single Product. Specify the product ID and an array of variant IDs to remove variants in bulk.MUTATIONproductVariantsBulkReorderReorders multiple variants in a single product. This mutation can be called directly or via the bulkOperation.MUTATIONproductVariantsBulkUpdateUpdates multiple product variants for a single product in one operation. You can run this mutation directly or as part of a bulk operation for large-scale catalog updates.QUERYproductVariantsCountCount of product variants. Limited to a maximum of 10000 by default.QUERYproductVendorsThe list of vendors added to products. The maximum page size is 1000.

Products · 2

Pub · 1

Public · 1

Publication · 4

Publications · 2

Publishable · 2

Published · 1

Quantity · 3

Refund · 2

Remove · 1

Return · 11

QUERYreturnRetrieves a return by its ID. A return represents the intent of a buyer to ship one or more items from an order back to a merchant or a third-party fulfillment location.MUTATIONreturnApproveRequestApproves a customer's return request. If this mutation is successful, then the Return.QUERYreturnCalculateCalculates the financial outcome of a Return without creating it. Use this query to preview return costs before initiating the actual return process.MUTATIONreturnCancelCancels a return and restores the items back to being fulfilled. Canceling a return is only available before any work has been done on the return (such as an inspection or refund).MUTATIONreturnCloseIndicates a return is complete, either when a refund has been made and items restocked, or simply when it has been marked as returned in the system.MUTATIONreturnCreateCreates a return from an existing order that has at least one fulfilled line item that hasn't yet been refunded.MUTATIONreturnDeclineRequestDeclines a return on an order. When a return is declined, each ReturnLineItem.MUTATIONreturnProcessProcesses a return by confirming which items customers return and exchange, handling their disposition, and optionally issuing refunds.QUERYreturnReasonDefinitionsReturns the full library of available return reason definitions. Use this query to retrieve the standardized return reasons available for creating returns.MUTATIONreturnReopenReopens a closed return.MUTATIONreturnRequestCreates a return request that requires merchant approval before processing. The return has its status set to REQUESTED and the merchant must approve or decline it.

Returnable · 2

Reverse · 5

Segment · 7

Segments · 2

Selling · 9

QUERYsellingPlanGroupFetch a single selling plan group by its ID.MUTATIONsellingPlanGroupAddProductsAdds multiple products to a selling plan group.MUTATIONsellingPlanGroupAddProductVariantsAdds multiple product variants to a selling plan group.MUTATIONsellingPlanGroupCreateCreates a selling plan group that defines how products can be sold and purchased. A selling plan group represents a selling method such as "Subscribe and save", "Pre-order", or "Try before you buy" and contains one…MUTATIONsellingPlanGroupDeleteDelete a Selling Plan Group. This does not affect subscription contracts.MUTATIONsellingPlanGroupRemoveProductsRemoves multiple products from a selling plan group.MUTATIONsellingPlanGroupRemoveProductVariantsRemoves multiple product variants from a selling plan group.QUERYsellingPlanGroupsRetrieves a paginated list of SellingPlanGroup objects that belong to the app making the API call.MUTATIONsellingPlanGroupUpdateUpdate a Selling Plan Group.

Shipping · 5

Shop · 10

QUERYshopThe store itself — name, contact/billing details, currency, plan, enabled features, domains, and shop-level settings.QUERYshopBillingPreferencesThe shop's billing preferences, including the currency for paying for apps and services. Use this to create app charges in the merchant's local billing currency, helping them budget their app spend without exposure…MUTATIONshopLocaleDisableDeletes a locale for a shop. This also deletes all translations of this locale.MUTATIONshopLocaleEnableAdds a locale for a shop. The newly added locale is in the unpublished state.QUERYshopLocalesReturns the locales enabled on a shop. Each locale represents a language for translations and determines how content displays to customers in different markets.MUTATIONshopLocaleUpdateUpdates a locale for a shop.QUERYshopPayPaymentRequestReceiptReturns a single Shop Pay payment request receipt by its ID. Payment request receipts document completed Shop Pay transactions, including the amount, customer details, and payment status.QUERYshopPayPaymentRequestReceiptsReturns a paginated list of Shop Pay payment request receipts for the shop. Each receipt documents a completed Shop Pay transaction.MUTATIONshopPolicyUpdateUpdates a shop policy.MUTATIONshopResourceFeedbackCreateThe ResourceFeedback object lets your app report the status of shops and their resources. For example, if your app is a marketplace channel, then you can use resource feedback to alert merchants that they need to…

Shopify · 4

Shopifyql · 1

Staff · 2

Staged · 1

Standard · 3

Store · 4

Storefront · 2

Subscription · 38

QUERYsubscriptionBillingAttemptFetch a single subscription billing attempt by its ID.MUTATIONsubscriptionBillingAttemptCreateCreates a billing attempt to charge for a SubscriptionContract. The mutation processes either the payment for the current billing cycle or for a specific cycle, if selected.QUERYsubscriptionBillingAttemptsReturns subscription billing attempts on a store.QUERYsubscriptionBillingCycleReturns a subscription billing cycle found either by cycle index or date.MUTATIONsubscriptionBillingCycleChargeCreates a new subscription billing attempt for a specified billing cycle. This is the alternative mutation for subscriptionBillingAttemptCreate.MUTATIONsubscriptionBillingCycleContractDraftCommitCommits the updates of a Subscription Billing Cycle Contract draft.MUTATIONsubscriptionBillingCycleContractDraftConcatenateConcatenates a contract to a Subscription Draft.MUTATIONsubscriptionBillingCycleContractEditEdit the contents of a subscription contract for the specified billing cycle.MUTATIONsubscriptionBillingCycleEditDeleteDelete the schedule and contract edits of the selected subscription billing cycle.MUTATIONsubscriptionBillingCycleEditsDeleteDelete the current and future schedule and contract edits of a list of subscription billing cycles.QUERYsubscriptionBillingCyclesReturns subscription billing cycles for a contract ID.MUTATIONsubscriptionBillingCycleScheduleEditModify the schedule of a specific billing cycle.MUTATIONsubscriptionBillingCycleSkipSkips a Subscription Billing Cycle.MUTATIONsubscriptionBillingCycleUnskipUnskips a Subscription Billing Cycle.QUERYsubscriptionContractRetrieves a SubscriptionContract by ID. The contract tracks the subscription's lifecycle through various statuses, and links to related billing attempts, generated Order objects, and the customer's CustomerPaymentMethod.MUTATIONsubscriptionContractActivateActivates a Subscription Contract. Contract status must be either active, paused, or failed.MUTATIONsubscriptionContractAtomicCreateCreates a Subscription Contract.MUTATIONsubscriptionContractCancelCancels a Subscription Contract.MUTATIONsubscriptionContractCreateCreates a subscription contract draft, which is an intention to create a new subscription.MUTATIONsubscriptionContractExpireExpires a Subscription Contract.MUTATIONsubscriptionContractFailFails a Subscription Contract.MUTATIONsubscriptionContractPausePauses a Subscription Contract.MUTATIONsubscriptionContractProductChangeAllows for the easy change of a Product in a Contract or a Product price change.QUERYsubscriptionContractsReturns a SubscriptionContractConnection containing subscription contracts. Subscription contracts are agreements between customers and merchants for recurring purchases with defined billing and delivery schedules.MUTATIONsubscriptionContractSetNextBillingDateSets the next billing date of a Subscription Contract. This field is managed by the apps.MUTATIONsubscriptionContractUpdateCreates a draft of an existing SubscriptionContract. The draft captures the current state of the contract and allows incremental modifications through draft mutations such as subscriptionDraftLineAdd,…QUERYsubscriptionDraftFetch a single subscription draft by its ID.MUTATIONsubscriptionDraftCommitCommits the updates of a Subscription Contract draft.MUTATIONsubscriptionDraftDiscountAddAdds a subscription discount to a subscription draft.MUTATIONsubscriptionDraftDiscountCodeApplyApplies a code discount on the subscription draft.MUTATIONsubscriptionDraftDiscountRemoveRemoves a subscription discount from a subscription draft.MUTATIONsubscriptionDraftDiscountUpdateUpdates a subscription discount on a subscription draft.MUTATIONsubscriptionDraftFreeShippingDiscountAddAdds a subscription free shipping discount to a subscription draft.MUTATIONsubscriptionDraftFreeShippingDiscountUpdateUpdates a subscription free shipping discount on a subscription draft.MUTATIONsubscriptionDraftLineAddAdds a subscription line to a subscription draft.MUTATIONsubscriptionDraftLineRemoveRemoves a subscription line from a subscription draft.MUTATIONsubscriptionDraftLineUpdateUpdates a subscription line on a subscription draft.MUTATIONsubscriptionDraftUpdateUpdates a Subscription Draft.

Tags · 2

Tax · 2

Taxonomy · 1

Tender · 1

Theme · 9

QUERYthemeReturns an OnlineStoreTheme by its ID. Use this query to retrieve theme metadata and access the theme's files, which include templates, assets, translations, and configuration files.MUTATIONthemeCreateCreates a theme from an external URL or staged upload. The theme source can either be a ZIP file hosted at a public URL or files previously uploaded using the stagedUploadsCreate mutation.MUTATIONthemeDeleteDeletes a theme.MUTATIONthemeDuplicateDuplicates a theme.MUTATIONthemeFilesCopyCopy theme files. Copying to existing theme files will overwrite them.MUTATIONthemeFilesDeleteDeletes a theme's files.MUTATIONthemeFilesUpsertCreates or updates theme files in an online store theme. This mutation allows batch operations on multiple theme files, either creating new files or overwriting existing ones with the same filename.MUTATIONthemePublishPublishes a theme.MUTATIONthemeUpdateUpdates a theme.

Themes · 1

Transaction · 1

Translatable · 3

Translations · 2

Url · 14

QUERYurlRedirectFetch a single URL redirect by its ID.MUTATIONurlRedirectBulkDeleteAllAsynchronously delete URL redirects in bulk.MUTATIONurlRedirectBulkDeleteByIdsAsynchronously delete URLRedirect objects in bulk by IDs. Learn more about URLRedirect objects.MUTATIONurlRedirectBulkDeleteBySavedSearchAsynchronously delete redirects in bulk.MUTATIONurlRedirectBulkDeleteBySearchAsynchronously delete redirects in bulk.MUTATIONurlRedirectCreateCreates a UrlRedirect object.MUTATIONurlRedirectDeleteDeletes a UrlRedirect object.QUERYurlRedirectImportFetch a single URL redirect import by its ID.MUTATIONurlRedirectImportCreateCreates a UrlRedirectImport object. After creating the UrlRedirectImport object, the UrlRedirectImport request can be performed using the urlRedirectImportSubmit mutation.MUTATIONurlRedirectImportSubmitSubmits a UrlRedirectImport request to be processed. The UrlRedirectImport request is first created with the urlRedirectImportCreate mutation.QUERYurlRedirectsQuery URL redirects — supports a search `query`, `sortKey`, and cursor paging.QUERYurlRedirectSavedSearchesA list of the shop's URL redirect saved searches.QUERYurlRedirectsCountCount of redirects. Limited to a maximum of 10000 by default.MUTATIONurlRedirectUpdateUpdates a URL redirect.

Web · 4

Webhook · 6

Shopify actions — Documentation