Skip to content
Changelog

Report a bug

Shopify integration: operations for AI agents

Shopify connects to Type.com as an integration. This page lists the 796 operations documented for Claude and Codex in Type.com: 282 read, 381 write, 133 destructive.

About Shopify

Shopify is an e-commerce platform enabling merchants to create online stores, manage products, and process payments with themes, apps, and integrated marketing tools

Categories: Commerce & Payments

How to connect Shopify to Type.com

Connect
OAuth client credentials
Access
Organization connection: one shared account for the workspace.
MCP
Selected payment-processing operations are not available through Type’s MCP server. Other operations remain available through MCP, subject to your connection’s permissions. These MCP restrictions do not apply within Type.

To add the connection, follow the steps in Space connections.

Documented operations

796 operations. Your connection's permissions determine which operations are available. API references describe the vendor surface; they do not expand your connection's credentials or access.

796 operations listed.

Mutations

  • Write

    abandonmentEmailStateUpdate (deprecated)

    Updates the email state value for an abandonment.

    POST /graphql.json

  • Write

    abandonmentUpdateActivitiesDeliveryStatuses

    Updates the marketing activities delivery statuses for an abandonment.

    POST /graphql.json

  • Write

    appPurchaseOneTimeCreate

    Creates a one-time charge for app features or services that don't require recurring billing. This mutation is ideal for apps that sell individual features, premium content, or services on a per-use basis rather than subscription models. For example, a design app might charge merchants once for premium templates, or a marketing app could bill for individual campaign setups without ongoing monthly fees. Use the `AppPurchaseOneTimeCreate` mutation to: - Charge for premium features or content purchases - Bill for professional services or setup fees - Generate revenue from one-time digital product sales The mutation returns a confirmation URL that merchants must visit to approve the charge. Test and development stores are not charged, allowing safe testing of billing flows. Explore one-time billing options on the [app purchases page](https://shopify.dev/docs/apps/launch/billing/support-one-time-purchases).

    POST /graphql.json

  • Write

    appSubscriptionCreate

    Creates a recurring or usage-based [`AppSubscription`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscription) that charges merchants for app features and services. The subscription includes one or more [`AppSubscriptionLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscriptionLineItem) objects that define the pricing structure, billing intervals, and optional [`AppSubscriptionDiscount`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscriptionDiscount) values. Returns a [confirmation URL](https://shopify.dev/docs/api/admin-graphql/latest/mutations/appSubscriptionCreate#returns-confirmationUrl) where the merchant approves or declines the charges. After approval, the subscription becomes active and billing begins after any trial period expires. You can specify [`AppSubscriptionReplacementBehavior`](https://shopify.dev/docs/api/admin-graphql/latest/enums/AppSubscriptionReplacementBehavior) to control how this subscription interacts with existing active subscriptions. Learn more about [creating app subscriptions](https://shopify.dev/docs/apps/launch/billing/subscription-billing/create-time-based-subscriptions).

    POST /graphql.json

  • Write

    appSubscriptionLineItemUpdate

    Updates the capped amount on usage-based billing for an [`AppSubscriptionLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscriptionLineItem). Enables you to modify the maximum charge limit that prevents merchants from exceeding a specified threshold during their billing period. The mutation returns a [confirmation URL](https://shopify.dev/docs/api/admin-graphql/latest/mutations/appSubscriptionCreate#returns-confirmationUrl) where the merchant must approve the new pricing limit before it takes effect. Use this when adjusting usage limits based on merchant needs or changing pricing models. Learn more about [updating the maximum charge for a subscription](https://shopify.dev/docs/apps/launch/billing/subscription-billing/update-max-charge).

    POST /graphql.json

  • Write

    appSubscriptionTrialExtend

    Extends the trial period for an existing app subscription. Trial extensions give merchants additional time to use the app before committing to paid billing. Requires the subscription ID and the number of days to extend (between one and 1000). The extension modifies the existing trial end date, allowing continued access to subscription features without immediate billing. Returns the updated [`AppSubscription`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscription). Learn more about [offering free trials](https://shopify.dev/docs/apps/launch/billing/offer-free-trials).

    POST /graphql.json

  • Write

    appUsageRecordCreate

    Creates a usage charge for an app subscription with usage-based pricing. The charge counts toward the capped amount limit set when creating the subscription. Usage records track consumption of app features or services on a per-use basis. You provide the charge amount, a description of what you consumed, and the subscription line item ID. The optional [`idempotencyKey`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppUsageRecord#field-idempotencyKey) parameter prevents duplicate charges if you send the same request multiple times. If the new charge would cause total usage charges in the current billing interval to exceed the capped amount, then the mutation returns an error. Learn more about [creating usage-based subscriptions](https://shopify.dev/docs/apps/launch/billing/subscription-billing/create-usage-based-subscriptions).

    POST /graphql.json

  • Write

    articleCreate

    Creates an [`Article`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Article). Articles are content pieces that include a title, body text, and author information. You can publish the article immediately or schedule it with a specific publish date. You can customize the article's URL handle, apply custom templates for rendering, and add optional fields like [tags](https://shopify.dev/docs/api/admin-graphql/latest/mutations/articleCreate#arguments-article.fields.tags), an [image](https://shopify.dev/docs/api/admin-graphql/latest/mutations/articleCreate#arguments-article.fields.image), and [`Metafield`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) objects. The mutation validates article content and ensures proper blog association. Error handling provides specific feedback for content requirements.

    POST /graphql.json

  • Write

    articleUpdate

    Updates an existing [`Article`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Article). You can modify the article's content, metadata, publication status, and associated properties like author information and tags. If you update the [`handle`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/articleUpdate#arguments-article.fields.handle), then you can optionally create a redirect from the old URL to the new one by setting [`redirectNewHandle`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/articleUpdate#arguments-article.fields.redirectNewHandle) to `true`.

    POST /graphql.json

  • Write

    backupRegionUpdate

    Update the backup region that is used when we have no better signal of what region a buyer is in.

    POST /graphql.json

  • Write

    blogCreate

    Creates a new blog within a shop, establishing a container for organizing articles. For example, a fitness equipment retailer launching a wellness blog would use this mutation to create the blog, enabling them to publish workout guides and nutrition tips. Use the `blogCreate` mutation to: - Launch new content marketing initiatives - Create separate blogs for different content themes - Establish spaces for article organization The mutation validates blog settings and establishes the structure for article publishing.

    POST /graphql.json

  • Write

    blogUpdate

    Updates an existing blog's configuration and settings. This mutation allows merchants to modify blog properties to keep their content strategy current. For example, a merchant might update their blog's title from "Company News" to "Sustainability Stories" when shifting their content focus, or modify the handle to improve URL structure. Use the `blogUpdate` mutation to: - Change blog titles for rebranding - Modify blog handles for better URLs - Adjust comment settings and moderation preferences The mutation returns the updated blog with any validation errors.

    POST /graphql.json

  • Write

    bulkOperationRunMutation

    Creates and runs a [bulk operation](https://shopify.dev/docs/api/admin-graphql/latest/objects/BulkOperation) to import data asynchronously. This mutation executes a specified GraphQL mutation multiple times using input data from a [JSONL](http://jsonlines.org/) file that you've uploaded to Shopify. The operation processes each line in your JSONL file as a separate mutation execution. The operation delivers results in a JSONL file when it completes. Bulk mutation operations and [`bulkOperationRunQuery`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/bulkoperationrunquery) operations can run at the same time per shop. The number of concurrent operations that an app can run depends on the API version. For the applicable concurrency limits, refer to the [bulk operations guide](https://shopify.dev/docs/api/usage/bulk-operations/imports). Learn more about [bulk importing data](https://shopify.dev/docs/api/usage/bulk-operations/imports).

    POST /graphql.json

  • Write

    bulkOperationRunQuery

    Creates and runs a [bulk operation](https://shopify.dev/docs/api/admin-graphql/latest/objects/BulkOperation) to fetch data asynchronously. The operation processes your GraphQL query in the background and returns results in a [JSONL](http://jsonlines.org/) file when complete. Bulk query and bulk mutation operations can run at the same time per shop. The number of concurrent operations that an app can run depends on the API version. For the applicable concurrency limits, refer to the [bulk operations guide](https://shopify.dev/docs/api/usage/bulk-operations/queries). The query must include at least one connection field and supports up to five connections with a maximum nesting depth of two levels. > Note: Results remain available for seven days after completion. For more information, see the [bulk operations guide](https://shopify.dev/docs/api/usage/bulk-operations/queries).

    POST /graphql.json

  • Write

    bulkProductResourceFeedbackCreate

    Creates product feedback for multiple products.

    POST /graphql.json

  • Write

    carrierServiceCreate

    Creates a carrier service that provides real-time shipping rates to Shopify. Carrier services provide real-time shipping rates from external providers like FedEx, UPS, or custom shipping solutions. The carrier service connects to your external shipping rate calculation system through a callback URL. When customers reach checkout, Shopify sends order details to your callback URL and displays the returned shipping rates. The service must be active to provide rates during checkout.

    POST /graphql.json

  • Write

    carrierServiceUpdate

    Updates a carrier service. Only the app that creates a carrier service can update it.

    POST /graphql.json

  • Write

    cartTransformCreate

    Creates 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).

    POST /graphql.json

  • Write

    cashDrawerCreate

    Creates a cash drawer in a provided location.

    POST /graphql.json

  • Write

    cashDrawerFindOrCreate

    Finds or creates a cash drawer for cash management. Also ensures the provided device is assigned to the drawer.

    POST /graphql.json

  • Write

    cashDrawerUpdate

    Updates a cash drawer.

    POST /graphql.json

  • Write

    cashManagementReasonCodeCreate

    Create a cash management reason code.

    POST /graphql.json

  • Write

    catalogContextUpdate

    Modifies which contexts, like [markets](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) or B2B [company locations](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocation), can access a [`Catalog`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Catalog). You can add or remove contexts to control where the catalog's products and prices are available. Learn more about [managing catalog contexts](https://shopify.dev/docs/apps/build/markets/new-markets/catalogs) and [managing B2B catalogs](https://shopify.dev/docs/apps/build/b2b/manage-catalogs).

    POST /graphql.json

  • Write

    catalogCreate

    Creates a [`Catalog`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Catalog) that controls product availability and pricing for specific contexts like [markets](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) or B2B [company locations](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocation). ### Publications and Price Lists - **[`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication)** objects control which products are visible in a catalog. Publications are **optional**. When a publication isn't associated with a catalog, product availability is determined by the sales channel. - **[`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList)** objects define custom pricing for products in a catalog. You can optionally associate a publication and price list when creating the catalog, or add them later using separate mutations. ### When to use Publications **Create a publication only if you need to:** - Limit which products are visible in a specific context (e.g., show different products to different company locations or markets) - Publish a curated subset of your product catalog **Do NOT create a publication if:** - You want product availability determined by the sales channel - You only need to customize pricing (use a price list without a publication) > **Important:** For company location catalogs that only require custom pricing, create the catalog with a price list but without a publication. Learn more about [managing catalog contexts](https://shopify.dev/docs/apps/build/markets/new-markets/catalogs) and [using catalogs for different markets](https://shopify.dev/docs/apps/build/markets/catalogs-different-markets).

    POST /graphql.json

  • Write

    catalogUpdate

    Updates an existing [catalog's](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Catalog) configuration. Catalogs control product publishing and pricing for specific contexts like [markets](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) or B2B [company locations](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocation). You can modify the catalog's title, status, and associated context. You can also update the [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) that determines pricing adjustments or the [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that controls which products customers see.

    POST /graphql.json

  • Write

    channelCreate

    Creates a [`Channel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) representing a connection between the shop and an external selling platform account. Use this mutation after a merchant authenticates with an external platform to establish the publishing destination for product syndication and, for order-generating channels, order import. The platform resolves the [channel specification](https://shopify.dev/docs/apps/build/sales-channels/channel-config-extension) identified by `specificationHandle`, determines its country coverage, intersects with the shop's available region markets, and establishes product feeds for all matching regions. Product feeds immediately begin emitting events to the application's webhook or event subscription. If the specification sets `expects_online_store_parity` and no matching region markets exist, the mutation returns an error. If the specification doesn't require online store parity and no matching region markets exist, a channel subordinate to shop defaults is created automatically.

    POST /graphql.json

  • Write

    channelFullSync

    Triggers a full product resync for the specified [`Channel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/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 for the complete catalog. Use this mutation after initial channel setup, after recovering from a prolonged outage, or when the channel's external catalog has drifted from Shopify's state. The sync can be scoped to a specific country and language. When neither is specified, all country-language combinations covered by the channel's specification are triggered.

    POST /graphql.json

  • Write

    channelUpdate

    Updates the properties of an existing [`Channel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/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. Updating the `specificationHandle` triggers re-evaluation of the specification's country coverage against the shop's region markets, reconciling product feeds accordingly. This is also the mechanism for migrating legacy channel records to the multi-channel model by assigning a specification handle.

    POST /graphql.json

  • Write

    checkoutAndAccountsConfigurationUpdate

    Updates a checkout and accounts configuration.

    POST /graphql.json

  • Write

    checkoutBrandingUpsert (deprecated)

    Updates the visual branding for a [`CheckoutProfile`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CheckoutProfile), customizing how checkout displays to customers. Creates new branding settings if none exist, or modifies existing settings. The mutation accepts two levels of customization through the [`CheckoutBrandingInput`](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/CheckoutBrandingInput) input object. [`designSystem`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/checkoutBrandingUpsert#arguments-checkoutBrandingInput.fields.designSystem) defines foundational brand attributes like colors, typography, and corner radius that apply consistently throughout checkout. [`customizations`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/checkoutBrandingUpsert#arguments-checkoutBrandingInput.fields.customizations) defines styles for specific parts of the UI, individual components, or groups of components like the header, buttons, form fields, and sections. Changes to a published checkout profile display immediately in the store's checkout. You can preview draft profiles in the Shopify admin's checkout editor before publishing. Learn more about [checkout styling](https://shopify.dev/docs/apps/checkout/styling).

    POST /graphql.json

  • Write

    collectionAddProducts (deprecated)

    Adds multiple products to an existing collection in a single operation. This mutation provides an efficient way to bulk-manage collection membership without individual product updates. For example, when merchants create seasonal collections, they can add dozens of related products at once rather than updating each product individually. A clothing store might add all winter jackets to a "Winter Collection" in one operation. Use `CollectionAddProducts` to: - Bulk-add products to collections for efficient catalog management - Implement collection building tools in admin interfaces - Organize collection membership during bulk product operations - Reduce API calls when managing large product sets The mutation processes multiple product additions and returns success status along with any errors encountered during the operation. Products are added to the collection while preserving existing collection settings. Learn more about [collection management](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection).

    POST /graphql.json

  • Write

    collectionAddProductsV2 (deprecated)

    Adds products to a [`Collection`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection) asynchronously and returns a [`Job`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Job) to track the operation's progress. This mutation handles large product sets efficiently by processing them in the background. You can poll the returned job using the [`job`](https://shopify.dev/docs/api/admin-graphql/latest/queries/job) query to monitor completion status. > Note: > This mutation adds products in the order specified in the [`productIds`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/collectionAddProducts#arguments-productIds) argument.

    POST /graphql.json

  • Write

    collectionCreate

    Creates a [collection](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection) to group [products](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) together in the [online store](https://shopify.dev/docs/apps/build/online-store) and other [sales channels](https://shopify.dev/docs/apps/build/sales-channels). For example, an athletics store might create different collections for running attire, shoes, and accessories. Use the `collectionCreate` mutation when you need to: - Create a new collection for a product launch or campaign - Organize products by category, season, or promotion - Automate product grouping using conditions (for example, by tag, type, or price) Collections can include products manually and can also include products automatically based on rules, sources, or conditions. **Defining a collection's membership** Define membership with `sources` on the `collection` argument ([`CollectionCreateInput`](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/CollectionCreateInput)). Each source adds products through `conditions` (such as product tag, title, or metafield—see [`CollectionSourceInclusionConditionInput`](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/CollectionSourceInclusionConditionInput) for the full list) and through manual `selections`. > Note: > The `input` argument and its `ruleSet` field are deprecated. Existing integrations should migrate to `collection` and `sources` — a `ruleSet` rule maps to an equivalent source `condition` (for example, a tag rule becomes a `productTag` condition). If both `collection` and `input` are provided, `collection` is used. > Note: > The created collection is unpublished by default. To make it available to customers, use the [`publishablePublish`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/publishablePublish) mutation after creation. Learn more about [using metafields with collection conditions](https://shopify.dev/docs/apps/build/custom-data/metafields/use-metafield-capabilities).

    POST /graphql.json

  • Write

    collectionDuplicate

    Duplicates a [collection](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection). An existing collection ID and new title are required. ## Publication Duplication Publications may be excluded by passing `copyPublications: false` in the input. ## Metafields Metafield values are not duplicated if the unique values capability is enabled.

    POST /graphql.json

  • Write

    collectionPublish (deprecated)

    Publishes a collection to a channel.

    POST /graphql.json

  • Write

    collectionReorderProducts

    Asynchronously reorders products within a specified collection. Instead of returning an updated collection, this mutation returns a job, which should be [polled](https://shopify.dev/api/admin-graphql/latest/queries/job). The [`Collection.sortOrder`](https://shopify.dev/api/admin-graphql/latest/objects/Collection#field-collection-sortorder) must be `MANUAL`. How to use this mutation: - Provide only the products that actually moved in the `moves` list; do not send the entire product list. For example: to move the product at index 1 to index N, send a single move for that product with `newPosition: N`. - Each move is applied sequentially in the order provided. - `newPosition` is a zero-based index within the collection at the moment the move is applied (after any prior moves in the list). - Products not included in `moves` keep their relative order, aside from any displacement caused by the moves. - If `newPosition` is greater than or equal to the number of products, the product is placed at the end. Example: - Initial order: [A, B, C, D, E] (indices 0..4) - Moves (applied in order): - E -> newPosition: 1 - C -> newPosition: 4 - Result: [A, E, B, D, C] Displaced products will have their position altered in a consistent manner with no gaps.

    POST /graphql.json

  • Write

    collectionUnpublish (deprecated)

    Unpublishes a collection.

    POST /graphql.json

  • Write

    collectionUpdate

    Updates a [collection](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection), modifying its properties, products, or publication settings. Collections help organize [products](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) together in the [online store](https://shopify.dev/docs/apps/build/online-store) and other [sales channels](https://shopify.dev/docs/apps/build/sales-channels). Use the `collectionUpdate` mutation to programmatically modify collections in scenarios such as: - Updating collection details, like title, description, or image - Modifying SEO metadata for better search visibility - Changing which products are included in a collection by updating its rules, sources, or conditions - Updating custom data using [metafields](https://shopify.dev/docs/apps/build/custom-data/metafields) Collections can include products manually and can also include products automatically based on rules, sources, or conditions. When product membership is updated through rules, sources, or conditions, the operation might be processed asynchronously. In these cases, the mutation returns a [`job`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Job) object that you can use to track the progress of the update. To publish or unpublish collections to specific sales channels, use the dedicated [`publishablePublish`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/publishablePublish) and [`publishableUnpublish`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/publishableUnpublish) mutations. Learn more about [using metafields with collection conditions](https://shopify.dev/docs/apps/build/custom-data/metafields/use-metafield-capabilities).

    POST /graphql.json

  • Write

    combinedListingUpdate

    Add, remove and update `CombinedListing`s of a given Product. `CombinedListing`s are comprised of multiple products to create a single listing. There are two kinds of products used in a `CombinedListing`: 1. Parent products 2. Child products The parent product is created with a `productCreate` with a `CombinedListingRole` of `PARENT`. Once created, you can associate child products with the parent product using this mutation. Parent products represent the idea of a product (e.g. Shoe). Child products represent a particular option value (or combination of option values) of a parent product. For instance, with your Shoe parent product, you may have several child products representing specific colors of the shoe (e.g. Shoe - Blue). You could also have child products representing more than a single option (e.g. Shoe - Blue/Canvas, Shoe - Blue/Leather, etc...). The combined listing is the association of parent product to one or more child products. Learn more about [Combined Listings](https://shopify.dev/apps/selling-strategies/combined-listings).

    POST /graphql.json

  • Write

    commentApprove

    Approves a pending comment, making it visible to store visitors on the associated blog article. For example, when a customer submits a question about a product in a blog post, merchants can approve the comment to make it publicly visible. Use the `commentApprove` mutation to: - Publish pending comments after review - Enable customer discussions on blog articles - Maintain quality control over comments Once approved, the comment becomes visible to all store visitors.

    POST /graphql.json

  • Write

    commentNotSpam

    Reverses 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. For example, when a merchant reviews comments marked as spam and finds a legitimate customer question, they can use this mutation to restore the comment's normal status and make it eligible for approval. Use the `commentNotSpam` mutation to: - Unmark comments that were marked as spam - Restore comments to normal moderation status - Move comments back to the approval queue This action changes the comment's status from spam back to pending, where it can then be approved or managed according to standard moderation practices.

    POST /graphql.json

  • Write

    commentSpam

    Marks 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. For example, when a comment contains suspicious links to unrelated products or services, merchants can mark it as spam to immediately hide it from customers. Use the `commentSpam` mutation to: - Hide promotional or malicious comments from public view - Protect customers from potentially harmful links - Maintain professional discussion quality on blog articles Spam-marked comments can be reviewed later and potentially restored using the `commentNotSpam` mutation if they were incorrectly classified.

    POST /graphql.json

  • Write

    companyAssignCustomerAsContact

    Adds an existing [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) as a contact to a [`Company`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Company). Companies are business entities that make purchases from the merchant's store. Use this mutation when you have a customer who needs to be associated with a B2B company to make purchases on behalf of that company. The mutation returns the newly created [`CompanyContact`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyContact) that links the customer to the company. After assignment, the customer becomes a company contact who can place orders on behalf of the company with access to any catalogs, pricing, and payment terms configured for the company's locations.

    POST /graphql.json

  • Write

    companyAssignMainContact

    Assigns the main contact for the company.

    POST /graphql.json

  • Write

    companyContactAssignRole

    Assigns a role to a contact for a location.

    POST /graphql.json

  • Write

    companyContactAssignRoles

    Assigns roles on a company contact.

    POST /graphql.json

  • Write

    companyContactCreate

    Creates a company contact and the associated customer.

    POST /graphql.json

  • Write

    companyContactSendWelcomeEmail

    Sends the company contact a welcome email.

    POST /graphql.json

  • Write

    companyContactUpdate

    Updates a company contact.

    POST /graphql.json

  • Write

    companyCreate

    Creates a [`Company`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Company) for B2B commerce. This mutation creates the company and can optionally create an initial [`CompanyContact`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyContact) and [`CompanyLocation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocation) in a single operation. Company contacts are people who place orders on behalf of the company. Company locations are branches or offices with their own billing and shipping addresses. > Note: Creating a company without a `name` [returns an error](https://shopify.dev/docs/api/admin-graphql/latest/mutations/companycreate?example=creating-a-company-without-a-name-returns-an-error). Learn more about [creating companies for B2B](https://shopify.dev/docs/apps/build/b2b/start-building#step-1-create-a-company).

    POST /graphql.json

  • Write

    companyLocationAssignAddress

    Updates an address on a company location.

    POST /graphql.json

  • Write

    companyLocationAssignRoles

    Assigns roles on a company location.

    POST /graphql.json

  • Write

    companyLocationAssignStaffMembers

    Creates one or more mappings between a staff member at a shop and a company location.

    POST /graphql.json

  • Write

    companyLocationAssignTaxExemptions (deprecated)

    Assigns tax exemptions to the company location.

    POST /graphql.json

  • Write

    companyLocationCreate

    Creates a new location for a [`Company`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Company). Company locations are branches or offices where B2B customers can place orders with specific pricing, catalogs, and payment terms. Creates a company location. Each location can have its own billing and shipping addresses, tax settings, and [`buyer experience configuration`](https://shopify.dev/docs/api/admin-graphql/latest/objects/BuyerExperienceConfiguration). You can assign [staff members](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) and [`CompanyContact`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyContact) objects to manage the location.

    POST /graphql.json

  • Write

    companyLocationCreateTaxRegistration (deprecated)

    Creates a tax registration for a company location.

    POST /graphql.json

  • Write

    companyLocationTaxSettingsUpdate

    Sets the tax settings for a company location.

    POST /graphql.json

  • Write

    companyLocationUpdate

    Updates a company location's information and B2B checkout settings. Company locations are branches or offices where [`CompanyContact`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyContact) members place orders on behalf of the company. Contacts must be assigned to a location through `roleAssignments` to place orders. The mutation modifies details such as the location's name, contact information, preferred locale, and internal notes. You can also configure the B2B checkout experience through [`BuyerExperienceConfiguration`](https://shopify.dev/docs/api/admin-graphql/latest/objects/BuyerExperienceConfiguration) settings that control whether orders require merchant review, [`PaymentTermsTemplate`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentTermsTemplate) settings, shipping address editing permissions, and [`DepositConfiguration`](https://shopify.dev/docs/api/admin-graphql/latest/unions/DepositConfiguration) requirements. Learn more about [managing company locations](https://shopify.dev/docs/apps/build/b2b/manage-client-company-locations).

    POST /graphql.json

  • Write

    companyUpdate

    Updates a [`Company`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Company) with new information. Companies represent business customers that can have multiple contacts and locations with specific pricing, payment terms, and checkout settings. The mutation accepts the company's ID and an input object containing the fields to update. You can modify the company name, add or update internal notes, set an external ID for integration with other systems, or adjust the customer relationship start date. Learn more about [building B2B features](https://shopify.dev/docs/apps/build/b2b/start-building).

    POST /graphql.json

  • Write

    consentPolicyUpdate

    Update or create consent policies in bulk.

    POST /graphql.json

  • Write

    customerAddTaxExemptions

    Add tax exemptions for the customer.

    POST /graphql.json

  • Write

    customerAddressCreate

    Creates a new [`MailingAddress`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) for a [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer). You can optionally set the address as the customer's default address. You can only add addresses to existing customers. Each customer can have multiple addresses.

    POST /graphql.json

  • Write

    customerAddressUpdate

    Updates a [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer)'s [`MailingAddress`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress). You can modify any field of the address and optionally set it as the customer's default address.

    POST /graphql.json

  • Write

    customerCancelDataErasure

    Cancels a pending erasure of a customer's data. Read more [here](https://help.shopify.com/manual/privacy-and-security/privacy/processing-customer-data-requests#cancel-customer-data-erasure). To request an erasure of a customer's data use the [customerRequestDataErasure mutation](https://shopify.dev/api/admin-graphql/unstable/mutations/customerRequestDataErasure).

    POST /graphql.json

  • Write

    customerCreate

    Creates a new [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) in the store. Accepts customer details including contact information, marketing consent preferences, and tax exemptions through the [`CustomerInput`](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/CustomerInput) input object. You can also associate [`metafields`](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/MetafieldInput) and tags to organize and extend customer data. Apps using protected customer data must meet Shopify's [protected customer data requirements](https://shopify.dev/docs/apps/launch/protected-customer-data#requirements).

    POST /graphql.json

  • Write

    customerEmailMarketingConsentUpdate

    Updates a [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer)'s email marketing consent information. The customer must have an email address to update their consent. Records the [marketing state](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerEmailAddress#field-marketingState) (such as subscribed, pending, unsubscribed), [opt-in level](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerEmailAddress#field-marketingOptInLevel), and when and where the customer gave or withdrew consent. Only three values are accepted as input: SUBSCRIBED, UNSUBSCRIBED, and PENDING. NOT_SUBSCRIBED, REDACTED, and INVALID cannot be set via this mutation; they are read-only or internally-set states.

    POST /graphql.json

  • Write

    customerGenerateAccountActivationUrl

    Generates a one-time activation URL for a [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) whose legacy customer account isn't yet enabled. Use this after importing customers or creating accounts that need activation. The generated URL expires after 30 days and becomes invalid if you generate a new one. > Note: The generated URL only works when legacy customer accounts are enabled on the shop. It only works for customers with disabled or invited [`account states`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer#field-Customer.fields.state). Attempting to generate a URL for an already-enabled customer returns an error.

    POST /graphql.json

  • Write

    customerMerge

    Merges two customers. The `customerOneId` and `customerTwoId` arguments don't guarantee which customer is kept. Shopify selects the resulting customer in this order: 1. If `overrideFields.customerIdOfEmailToKeep` is provided and valid, then the selected customer is kept. 2. If exactly one customer has an email address, then that customer is kept. 3. If both customers have email addresses, then account state and email marketing consent determine the customer that's kept: an `enabled` account wins over other account states; otherwise, an `invited` account can win when consent doesn't already prefer `subscribed` or `pending`; otherwise the consent result is used. If those rules don't prefer either customer, then `customerTwoId` is kept. 4. If neither customer has an email address, then `customerTwoId` is kept. Use `customerMergePreview` and `resultingCustomerId` to check which customer will be kept before merging.

    POST /graphql.json

  • Write

    customerPaymentMethodCreateFromDuplicationData

    Creates a vaulted payment method for a customer from duplication data. This data must be obtained from another shop within the same organization. Currently, this only supports Shop Pay payment methods. This is only available for selected partner apps.

    POST /graphql.json

  • Write

    customerPaymentMethodCreditCardCreate

    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.

    POST /graphql.json

  • Write

    customerPaymentMethodCreditCardUpdate

    Updates an existing vaulted credit card payment method for a customer, including billing address and card details. Requires a valid cardserver session from a PCI-compliant environment. Use this when a customer's card details have changed (e.g., new expiration date or replacement card) and ongoing subscriptions or saved payment methods need to be updated.

    POST /graphql.json

  • Write

    customerPaymentMethodGetDuplicationData

    Returns encrypted data that can be used to duplicate the payment method in another shop within the same organization. Currently, this only supports Shop Pay payment methods. This is only available for selected partner apps.

    POST /graphql.json

  • Write

    customerPaymentMethodGetUpdateUrl

    Returns a URL that allows the customer to update a specific payment method. Currently, `customerPaymentMethodGetUpdateUrl` only supports Shop Pay.

    POST /graphql.json

  • Write

    customerPaymentMethodPaypalBillingAgreementCreate

    Creates a vaulted PayPal billing agreement for a customer, enabling recurring charges through PayPal. The billing agreement ID (starting with 'B-') must be obtained from PayPal. Once created, this payment method can be used for subscription billing or future order payments without requiring the customer to re-authenticate with PayPal.

    POST /graphql.json

  • Write

    customerPaymentMethodPaypalBillingAgreementUpdate

    Updates the billing address associated with a customer's vaulted PayPal billing agreement. Use this when a customer's billing information has changed and their PayPal payment method record in Shopify needs to be updated accordingly.

    POST /graphql.json

  • Write

    customerPaymentMethodRemoteCreate

    Creates a customer payment method using identifiers from remote payment gateways like Stripe, Authorize.Net, or Braintree. Imports existing payment methods from external gateways and associates them with [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) objects in Shopify. The operation processes payment methods asynchronously. The returned [`CustomerPaymentMethod`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerPaymentMethod) initially has incomplete details while Shopify validates and processes the remote gateway information. Use the [`customerPaymentMethod`](https://shopify.dev/docs/api/admin-graphql/latest/queries/customerPaymentMethod) query to retrieve the payment method status until all details are available or the payment method is revoked. Learn more about [migrating customer payment methods from remote gateways](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/migrate-to-subscriptions-api/migrate-customer-information#step-2-import-payment-methods-for-customers).

    POST /graphql.json

  • Write

    customerPaymentMethodSendUpdateEmail

    Sends an email to a customer containing a secure link to update a specific vaulted payment method. This is commonly used when a customer's credit card is expiring or has been declined, and they need to provide updated payment details for ongoing subscriptions. The email can be customized with sender and BCC fields.

    POST /graphql.json

  • Write

    customerReplaceTaxExemptions

    Replace tax exemptions for a customer.

    POST /graphql.json

  • Write

    customerSegmentMembersQueryCreate

    Creates a customer segment members query.

    POST /graphql.json

  • Write

    customerSendAccountInviteEmail

    Sends 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. You can optionally customize the email content including the subject, sender, recipients, and message body. If you don't provide email customization, the store uses its default account invitation template. > Note: The invite only works when legacy customer accounts are enabled on the shop.

    POST /graphql.json

  • Write

    customerSet

    Creates or updates a customer in a single mutation. Use this mutation when syncing information from an external data source into Shopify. This mutation can be used to create a new customer, update an existing customer by id, or upsert a customer by a unique key (email or phone). To create a new customer omit the `identifier` argument. To update an existing customer, include the `identifier` with the id of the customer to update. To perform an 'upsert' by unique key (email or phone) use the `identifier` argument to upsert a customer by a unique key (email or phone). If a customer with the specified unique key exists, it will be updated. If not, a new customer will be created with that unique key. As of API version 2022-10, apps using protected customer data must meet the protected customer data [requirements](https://shopify.dev/apps/store/data-protection/protected-customer-data) Any list field (e.g. [addresses](https://shopify.dev/api/admin-graphql/unstable/input-objects/MailingAddressInput), will be updated so that all included entries are either created or updated, and all existing entries not included will be deleted. All other fields will be updated to the value passed. Omitted fields will not be updated.

    POST /graphql.json

  • Write

    customerSmsMarketingConsentUpdate

    Updates a [customer](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer)'s SMS marketing consent information. The customer must have a phone number on their account to receive SMS marketing. You can set whether the customer subscribes or unsubscribes to SMS marketing and specify the [opt-in level](https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerSmsMarketingConsentUpdate#arguments-input.fields.smsMarketingConsent.marketingOptInLevel). Optionally include when the consent was collected and which [location](https://shopify.dev/docs/api/admin-graphql/latest/mutations/customerSmsMarketingConsentUpdate#arguments-input.fields.smsMarketingConsent.sourceLocationId) collected it.

    POST /graphql.json

  • Write

    customerUpdate

    Updates a [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer)'s attributes including personal information and [`tax exemptions`](https://shopify.dev/docs/api/admin-graphql/latest/enums/TaxExemption). Apps using protected customer data must meet Shopify's [protected customer data requirements](https://shopify.dev/docs/apps/launch/protected-customer-data#requirements).

    POST /graphql.json

  • Write

    customerUpdateDefaultAddress

    Updates a customer's default address.

    POST /graphql.json

  • Write

    dataSaleOptOut

    Opt out a customer from data sale.

    POST /graphql.json

  • Write

    delegateAccessTokenCreate

    Creates a [`DelegateAccessToken`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DelegateAccessToken) with a subset of the parent token's permissions. Delegate access tokens enable secure permission delegation to subsystems or services that need limited access to shop resources. Each token inherits only the scopes you specify, ensuring subsystems operate with minimal required permissions rather than full app access. Learn more about [delegating access tokens to subsystems](https://shopify.dev/docs/apps/build/authentication-authorization/access-tokens/use-delegate-tokens).

    POST /graphql.json

  • Write

    deliveryCustomizationActivation

    Activates and deactivates delivery customizations.

    POST /graphql.json

  • Write

    deliveryCustomizationCreate

    Creates a delivery customization.

    POST /graphql.json

  • Write

    deliveryCustomizationUpdate

    Updates a delivery customization.

    POST /graphql.json

  • Write

    deliveryProfileCreate

    Creates a [`DeliveryProfile`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryProfile) that defines shipping rates for specific products and locations. A delivery profile groups products with their shipping zones and rates. You can associate profiles with [`SellingPlanGroup`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlanGroup) objects to customize shipping for subscriptions and pre-orders. Each profile contains [`DeliveryProfileLocationGroup`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryProfileLocationGroup) objects that specify which [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) objects ship to which [`DeliveryZone`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryZone) objects with specific [`DeliveryMethodDefinition`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryMethodDefinition) objects and rates. Learn more about [building delivery profiles](https://shopify.dev/docs/apps/build/purchase-options/deferred/delivery-and-deferment/build-delivery-profiles).

    POST /graphql.json

  • Write

    deliveryProfileUpdate

    Updates a [`DeliveryProfile`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryProfile)'s configuration, including its shipping zones, rates, and associated products. Modify location groups to control which fulfillment [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) objects serve specific geographic areas. Add or remove shipping zones with custom countries and provinces. Create or update shipping methods with rate definitions and delivery conditions. Associate or dissociate [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects and [`SellingPlanGroup`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlanGroup) objects to determine which products use this profile's shipping rules. The mutation supports partial updates through dedicated input fields for creating, updating, and deleting specific components without affecting the entire profile structure. Learn more about [building delivery profiles](https://shopify.dev/docs/apps/build/purchase-options/deferred/delivery-and-deferment/build-delivery-profiles).

    POST /graphql.json

  • Write

    deliveryPromiseParticipantsUpdate

    Updates the delivery promise participants by adding or removing owners based on a branded promise handle.

    POST /graphql.json

  • Write

    deliveryPromiseProviderUpsert

    Creates or updates a delivery promise provider. Currently restricted to select approved delivery promise partners.

    POST /graphql.json

  • Write

    deliverySettingUpdate

    Set the delivery settings for a shop.

    POST /graphql.json

  • Write

    deliveryShippingOriginAssign (deprecated)

    Assigns a location as the shipping origin while using legacy compatibility mode for multi-location delivery profiles. Deprecated as of 2026-04 and will be removed in a future version as single origin shipping mode has been retired.

    POST /graphql.json

  • Write

    discountAutomaticActivate

    Activates an automatic discount.

    POST /graphql.json

  • Write

    discountAutomaticAppCreate

    Creates an automatic discount that's managed by an app. Use this mutation with [Shopify Functions](https://shopify.dev/docs/apps/build/functions) when you need advanced, custom, or dynamic discount capabilities that aren't supported by [Shopify's native discount types](https://help.shopify.com/manual/discounts/discount-types). For example, use this mutation to create an automatic discount using an app's "Volume" discount type that applies a percentage off when customers purchase more than the minimum quantity of a product. For an example implementation, refer to [our tutorial](https://shopify.dev/docs/apps/build/discounts/build-discount-function). > Note: > To create code discounts with custom logic, use the [`discountCodeAppCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountCodeAppCreate) mutation.

    POST /graphql.json

  • Write

    discountAutomaticAppUpdate

    Updates an existing automatic discount that's managed by an app using [Shopify Functions](https://shopify.dev/docs/apps/build/functions). Use this mutation when you need advanced, custom, or dynamic discount capabilities that aren't supported by [Shopify's native discount types](https://help.shopify.com/manual/discounts/discount-types). For example, use this mutation to update a new "Volume" discount type that applies a percentage off when customers purchase more than the minimum quantity of a product. For an example implementation, refer to [our tutorial](https://shopify.dev/docs/apps/build/discounts/build-discount-function). > Note: > To update code discounts with custom logic, use the [`discountCodeAppUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountCodeAppUpdate) mutation instead.

    POST /graphql.json

  • Write

    discountAutomaticBasicCreate

    Creates an [amount off discount](https://help.shopify.com/manual/discounts/discount-types/percentage-fixed-amount) that's automatically applied on a cart and at checkout. > Note: > To create code discounts, use the [`discountCodeBasicCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountCodeBasicCreate) mutation.

    POST /graphql.json

  • Write

    discountAutomaticBasicUpdate

    Updates an existing [amount off discount](https://help.shopify.com/manual/discounts/discount-types/percentage-fixed-amount) that's automatically applied on a cart and at checkout. > Note: > To update code discounts, use the [`discountCodeBasicUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountCodeBasicUpdate) mutation instead.

    POST /graphql.json

  • Write

    discountAutomaticBxgyCreate

    Creates a [buy X get Y discount (BXGY)](https://help.shopify.com/manual/discounts/discount-types/buy-x-get-y) that's automatically applied on a cart and at checkout. > Note: > To create code discounts, use the [`discountCodeBxgyCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountCodeBxgyCreate) mutation.

    POST /graphql.json

  • Write

    discountAutomaticBxgyUpdate

    Updates an existing [buy X get Y discount (BXGY)](https://help.shopify.com/manual/discounts/discount-types/buy-x-get-y) that's automatically applied on a cart and at checkout. > Note: > To update code discounts, use the [`discountCodeBxgyUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountCodeBxgyUpdate) mutation instead.

    POST /graphql.json

  • Write

    discountAutomaticDeactivate

    Deactivates an automatic discount.

    POST /graphql.json

  • Write

    discountAutomaticFreeShippingCreate

    Creates automatic free shipping discounts that apply to qualifying orders without requiring discount codes. These promotions automatically activate when customers meet specified criteria, streamlining the checkout experience. For example, a store might create an automatic free shipping discount for orders over variable pricing to encourage larger purchases, or offer free shipping to specific customer segments during promotional periods. Use `DiscountAutomaticFreeShippingCreate` to: - Set up code-free shipping promotions - Create order value-based shipping incentives - Target specific customer groups with shipping benefits - Establish location-based shipping discounts The mutation validates discount configuration and returns the created automatic discount node along with any configuration errors that need resolution. Learn more about [automatic discounts](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticNode).

    POST /graphql.json

  • Write

    discountAutomaticFreeShippingUpdate

    Updates existing automatic free shipping discounts, allowing merchants to modify promotion criteria, shipping destinations, and eligibility requirements without recreating the entire discount structure. For example, extending a holiday free shipping promotion to include additional countries, adjusting the minimum order value threshold, or expanding customer eligibility to include new segments. Use `DiscountAutomaticFreeShippingUpdate` to: - Modify shipping discount thresholds and criteria - Expand or restrict geographic availability - Update customer targeting and eligibility rules - Adjust promotion timing and activation periods Changes take effect immediately for new orders, while the mutation validates all modifications and reports any configuration conflicts through user errors. Learn more about [managing automatic discounts](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomaticFreeShipping).

    POST /graphql.json

  • Write

    discountBulkTagsAdd

    Adds tags to multiple [discounts](https://help.shopify.com/manual/discounts/discount-types) 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 add tags to a predefined set of price rules.

    POST /graphql.json

  • Write

    discountCodeActivate

    Activates a previously created code discount, making it available for customers to use during checkout. This mutation transitions inactive discount codes into an active state where they can be applied to orders. For example, after creating a "SUMMER20" discount code but leaving it inactive during setup, merchants can activate it when ready to launch their summer promotion campaign. Use `DiscountCodeActivate` to: - Launch scheduled promotional campaigns - Reactivate previously paused discount codes - Enable discount codes after configuration changes - Control the timing of discount availability The mutation returns the updated discount code node with its new active status and handles any validation errors that might prevent activation, such as conflicting discount rules or invalid date ranges.

    POST /graphql.json

  • Write

    discountCodeAppCreate

    Creates a code discount. The discount type must be provided by an app extension that uses [Shopify Functions](https://shopify.dev/docs/apps/build/functions). Functions can implement [order](https://shopify.dev/docs/api/functions/reference/order-discounts), [product](https://shopify.dev/docs/api/functions/reference/product-discounts), or [shipping](https://shopify.dev/docs/api/functions/reference/shipping-discounts) discount functions. Use this mutation with Shopify Functions when you need custom logic beyond [Shopify's native discount types](https://help.shopify.com/manual/discounts/discount-types). For example, use this mutation to create a code discount using an app's "Volume" discount type that applies a percentage off when customers purchase more than the minimum quantity of a product. For an example implementation, refer to [our tutorial](https://shopify.dev/docs/apps/build/discounts/build-discount-function). > Note: > To create automatic discounts with custom logic, use [`discountAutomaticAppCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountAutomaticAppCreate).

    POST /graphql.json

  • Write

    discountCodeAppUpdate

    Updates a code discount, where the discount type is provided by an app extension that uses [Shopify Functions](https://shopify.dev/docs/apps/build/functions). Use this mutation when you need advanced, custom, or dynamic discount capabilities that aren't supported by [Shopify's native discount types](https://help.shopify.com/manual/discounts/discount-types). > Note: > To update automatic discounts, use [`discountAutomaticAppUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountAutomaticAppUpdate).

    POST /graphql.json

  • Write

    discountCodeBasicCreate

    Creates an [amount off discount](https://help.shopify.com/manual/discounts/discount-types/percentage-fixed-amount) that's applied on a cart and at checkout when a customer enters a code. Amount off discounts can be a percentage off or a fixed amount off. > Note: > To create discounts that are automatically applied on a cart and at checkout, use the [`discountAutomaticBasicCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountAutomaticBasicCreate) mutation.

    POST /graphql.json

  • Write

    discountCodeBasicUpdate

    Updates an [amount off discount](https://help.shopify.com/manual/discounts/discount-types/percentage-fixed-amount) that's applied on a cart and at checkout when a customer enters a code. Amount off discounts can be a percentage off or a fixed amount off. > Note: > To update discounts that are automatically applied on a cart and at checkout, use the [`discountAutomaticBasicUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountAutomaticBasicUpdate) mutation.

    POST /graphql.json

  • Write

    discountCodeBulkActivate

    Activates multiple [code discounts](https://help.shopify.com/manual/discounts/discount-types#discount-codes) 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 search criteria, or activate a predefined set of discount codes.

    POST /graphql.json

  • Write

    discountCodeBulkDeactivate

    Deactivates multiple [code-based discounts](https://help.shopify.com/manual/discounts/discount-types#discount-codes) 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 match a search criteria, or deactivate a predefined set of discount codes.

    POST /graphql.json

  • Write

    discountCodeBxgyCreate

    Creates a [buy X get Y discount (BXGY)](https://help.shopify.com/manual/discounts/discount-types/buy-x-get-y) that's applied on a cart and at checkout when a customer enters a code. > Note: > To create discounts that are automatically applied on a cart and at checkout, use the [`discountAutomaticBxgyCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountAutomaticBxgyCreate) mutation.

    POST /graphql.json

  • Write

    discountCodeBxgyUpdate

    Updates a [buy X get Y discount (BXGY)](https://help.shopify.com/manual/discounts/discount-types/buy-x-get-y) that's applied on a cart and at checkout when a customer enters a code. > Note: > To update discounts that are automatically applied on a cart and at checkout, use the [`discountAutomaticBxgyUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountAutomaticBxgyUpdate) mutation.

    POST /graphql.json

  • Write

    discountCodeDeactivate

    Temporarily 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. For example, when a flash sale needs to end immediately or a discount code requires temporary suspension due to inventory issues, merchants can deactivate it to stop new redemptions while keeping the discount structure intact. Use `DiscountCodeDeactivate` to: - Pause active promotional campaigns timely - Temporarily suspend problematic discount codes - Control discount availability during inventory shortages - Maintain discount history while stopping usage Deactivated discounts remain in the system and can be reactivated later, unlike deletion which persistently removes the code. Customers attempting to use deactivated codes will receive appropriate error messages.

    POST /graphql.json

  • Write

    discountCodeFreeShippingCreate

    Creates an [free shipping discount](https://help.shopify.com/manual/discounts/discount-types/free-shipping) that's applied on a cart and at checkout when a customer enters a code. > Note: > To create discounts that are automatically applied on a cart and at checkout, use the [`discountAutomaticFreeShippingCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountAutomaticFreeShippingCreate) mutation.

    POST /graphql.json

  • Write

    discountCodeFreeShippingUpdate

    Updates a [free shipping discount](https://help.shopify.com/manual/discounts/discount-types/free-shipping) that's applied on a cart and at checkout when a customer enters a code. > Note: > To update a free shipping discount that's automatically applied on a cart and at checkout, use the [`discountAutomaticFreeShippingUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/discountAutomaticFreeShippingUpdate) mutation.

    POST /graphql.json

  • Write

    discountRedeemCodeBulkAdd

    Asynchronously add [discount codes](https://help.shopify.com/manual/discounts/discount-types#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 marketing channels.

    POST /graphql.json

  • Write

    disputeEvidenceUpdate

    Updates the evidence package for a Shopify Payments dispute. Merchants submit evidence — such as shipping confirmations, customer communications, and refund policies — to contest a dispute filed by a cardholder. This mutation updates the evidence fields.

    POST /graphql.json

  • Write

    draftOrderBulkAddTags

    Adds tags to multiple draft orders.

    POST /graphql.json

  • Write

    draftOrderCalculate

    Calculates the properties of a [`DraftOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrder) without creating it. Returns pricing information including [`CalculatedDraftOrderLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CalculatedDraftOrderLineItem) totals, shipping charges, applicable discounts, and tax calculations based on the provided [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) and [`MailingAddress`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) information. Use this mutation to preview total taxes and prices before creating a draft order. It's particularly useful when working with B2B [`PurchasingEntity`](https://shopify.dev/docs/api/admin-graphql/latest/unions/PurchasingEntity) or when you need to determine costs without committing to a draft order. Learn more about [calculating draft orders for B2B purchasing entities](https://shopify.dev/docs/apps/build/b2b/draft-orders#step-1-calculate-a-draft-order-for-a-purchasing-entity).

    POST /graphql.json

  • Write

    draftOrderComplete

    Completes a [draft order](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrder) and converts it into a [regular order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order). The order appears in the merchant's orders list, and the customer can be notified about their order. Use the `draftOrderComplete` mutation when a merchant is ready to finalize a draft order and create a real order in their store. The `draftOrderComplete` mutation also supports sales channel attribution for tracking order sources using the [`sourceName`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/draftOrderComplete#arguments-sourceName) argument, [cart validation](https://shopify.dev/docs/apps/build/checkout/cart-checkout-validation) controls for app integrations, and detailed error reporting for failed completions. You can complete a draft order with different [payment scenarios](https://help.shopify.com/manual/fulfillment/managing-orders/payments): - Mark the order as paid immediately. - Set the order as payment pending using [payment terms](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentTerms). - Specify a custom payment amount. - Select a specific payment gateway. > Note: > When completing a draft order, inventory is [committed](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps#inventory-states) for the items in the order. This means the items will no longer be available for other customers to purchase. Make sure to verify inventory availability before completing the draft order.

    POST /graphql.json

  • Write

    draftOrderCreate

    Creates a [draft order](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrder) with attributes such as customer information, line items, shipping and billing addresses, and payment terms. Draft orders are useful for merchants that need to: - Create new orders for sales made by phone, in person, by chat, or elsewhere. When a merchant accepts payment for a draft order, an order is created. - Send invoices to customers with a secure checkout link. - Use custom items to represent additional costs or products not in inventory. - Re-create orders manually from active sales channels. - Sell products at discount or wholesale rates. - Take pre-orders. After creating a draft order, you can: - Send an invoice to the customer using the [`draftOrderInvoiceSend`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/draftOrderInvoiceSend) mutation. - Complete the draft order using the [`draftOrderComplete`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/draftOrderComplete) mutation. - Update the draft order using the [`draftOrderUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/draftOrderUpdate) mutation. - Duplicate a draft order using the [`draftOrderDuplicate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/draftOrderDuplicate) mutation. - Delete the draft order using the [`draftOrderDelete`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/draftOrderDelete) mutation. > Note: > When you create a draft order, you can't [reserve or hold inventory](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps#inventory-states) for the items in the order by default. > However, you can reserve inventory using the [`reserveInventoryUntil`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/draftOrderCreate#arguments-input.fields.reserveInventoryUntil) input.

    POST /graphql.json

  • Write

    draftOrderCreateFromOrder

    Creates a draft order from order.

    POST /graphql.json

  • Write

    draftOrderDuplicate

    Duplicates a draft order.

    POST /graphql.json

  • Write

    draftOrderInvoicePreview

    Previews a draft order invoice email.

    POST /graphql.json

  • Write

    draftOrderInvoiceSend

    Sends an invoice email for a [`DraftOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrder). The invoice includes a secure checkout link for reviewing and paying for the order. Use the [`email`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/draftOrderInvoiceSend#arguments-email) argument to customize the email, such as the subject and message.

    POST /graphql.json

  • Write

    draftOrderUpdate

    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.

    POST /graphql.json

  • Write

    eventBridgeWebhookSubscriptionCreate (deprecated)

    Creates a webhook subscription that notifies your [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) when specific events occur in a shop. Webhooks push event data to your endpoint immediately when changes happen, eliminating the need for polling. This mutation configures webhook delivery to an Amazon EventBridge partner event source. You can filter events using [Shopify API search syntax](https://shopify.dev/docs/api/usage/search-syntax) to receive only relevant webhooks, control which data fields are included in webhook payloads, and specify metafield namespaces to include. > Note: > The Webhooks API version [configured in your app](https://shopify.dev/docs/apps/build/webhooks/subscribe/use-newer-api-version) determines the API version for webhook events. You can't specify it per 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.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe).

    POST /graphql.json

  • Write

    eventBridgeWebhookSubscriptionUpdate (deprecated)

    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.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe).

    POST /graphql.json

  • Write

    fileAcknowledgeUpdateFailed

    Acknowledges file update failure by resetting FAILED status to READY and clearing any media errors.

    POST /graphql.json

  • Write

    fileCreate

    Creates file assets for a store from external URLs or files that were previously uploaded using the [`stagedUploadsCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/stageduploadscreate) mutation. Use the `fileCreate` mutation to add various types of media and documents to your store. These files are added to the [**Files** page](https://shopify.com/admin/settings/files) in the Shopify admin and can be referenced by other resources in your store. The `fileCreate` mutation supports multiple file types: - **Images**: Product photos, variant images, and general store imagery - **Videos**: Shopify-hosted videos for product demonstrations and marketing - **External videos**: YouTube and Vimeo videos for enhanced product experiences - **3D models**: Interactive 3D representations of products - **Generic files**: PDFs, documents, and other file types for store resources The mutation handles duplicate filenames using configurable resolution modes that automatically append UUIDs, replace existing files, or raise errors when conflicts occur. > Note: > Files are processed asynchronously. Check the > [`fileStatus`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/File#fields-fileStatus) > field to monitor processing completion. The maximum number of files that can be created in a single batch is 250. After creating files, you can make subsequent updates using the following mutations: - [`fileUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fileUpdate): Update file properties such as alt text or replace file contents while preserving the same URL. - [`fileDelete`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fileDelete): Remove files from your store when they are no longer needed. To list all files in your store, use the [`files`](https://shopify.dev/docs/api/admin-graphql/latest/queries/files) query. Learn how to manage [product media and file assets](https://shopify.dev/docs/apps/build/online-store/product-media) in your app.

    POST /graphql.json

  • Write

    flowGenerateSignature

    Generates a signature for a Flow action payload.

    POST /graphql.json

  • Write

    flowTriggerReceive

    Triggers any workflows that begin with the trigger specified in the request body. To learn more, refer to [_Create Shopify Flow triggers_](https://shopify.dev/apps/flow/triggers).

    POST /graphql.json

  • Write

    fulfillmentConstraintRuleCreate

    Creates a fulfillment constraint rule and its metafield.

    POST /graphql.json

  • Write

    fulfillmentConstraintRuleUpdate

    Update a fulfillment constraint rule.

    POST /graphql.json

  • Write

    fulfillmentCreate

    Creates a fulfillment for one or more [`FulfillmentOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) objects. The fulfillment orders are associated with the same [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) and are assigned to the same [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location). Use this mutation to mark items as fulfilled when they're ready to ship. You can specify tracking information, customer notification preferences, and which [`FulfillmentOrderLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentorderlineitem) objects to fulfill from each fulfillment order. If you don't specify line items, then the mutation fulfills all items in the fulfillment order. Learn more about [building fulfillment solutions](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/build-fulfillment-solutions#create-a-fulfillment).

    POST /graphql.json

  • Write

    fulfillmentCreateV2 (deprecated)

    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.

    POST /graphql.json

  • Write

    fulfillmentEventCreate

    Creates a [`FulfillmentEvent`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentEvent) to track the shipment status and location of items that have shipped. Events capture status updates like carrier pickup, in transit, out for delivery, or delivered. Each event records the timestamp and current status of the [`Fulfillment`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Fulfillment). You can include optional details such as the location where the event occurred, estimated arrival time, and messages for tracking purposes.

    POST /graphql.json

  • Write

    fulfillmentOrderAcceptFulfillmentRequest

    Accepts a fulfillment request that the fulfillment service has received for a [`FulfillmentOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) which signals that the fulfillment service will process and fulfill the order. The fulfillment service can optionally provide a message to the merchant and an estimated shipped date when accepting the request. Learn more about [accepting fulfillment requests](https://shopify.dev/docs/apps/build/orders-fulfillment/fulfillment-service-apps/build-for-fulfillment-services#accept-a-fulfillment-request).

    POST /graphql.json

  • Write

    fulfillmentOrderClose

    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 `IN_PROGRESS`. 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](https://shopify.dev/apps/build/orders-fulfillment/fulfillment-service-apps/build-for-fulfillment-services#step-7-optional-close-a-fulfillment-order).

    POST /graphql.json

  • Write

    fulfillmentOrderHold

    Applies a fulfillment hold on a fulfillment order. As of the [2025-01 API version](https://shopify.dev/changelog/apply-multiple-holds-to-a-single-fulfillment-order), the mutation can be successfully executed on fulfillment orders that are already on hold. To place multiple holds on a fulfillment order, apps need to supply the [handle](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentHold#field-handle) field. Each app can place up to 10 active holds per fulfillment order. If an app attempts to place more than this, the mutation will return [a user error indicating that the limit has been reached](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderHoldUserErrorCode#value-fulfillmentorderholdlimitreached). The app would need to release one of its existing holds before being able to apply a new one.

    POST /graphql.json

  • Write

    fulfillmentOrderLineItemsPreparedForPickup

    Marks [fulfillment order line items](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrderLineItem) as ready for customer pickup. When executed, this mutation automatically sends a "Ready For Pickup" notification to the customer. Use this mutation for local pickup orders after the items have been prepared and are available for the customer to collect. You can specify one or more [fulfillment order](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) objects by providing the fulfillment order IDs in the [`lineItemsByFulfillmentOrder`](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/PreparedFulfillmentOrderLineItemsInput) field. This allows you to mark fulfillment order line items from different fulfillment orders as ready for pickup.

    POST /graphql.json

  • Write

    fulfillmentOrderMerge

    Merges a set or multiple sets of fulfillment orders together into one based on line item inputs and quantities.

    POST /graphql.json

  • Write

    fulfillmentOrderMove

    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 fulfillment order has had progress manually reported. To move a fulfillment order that has had progress manually reported, the fulfillment order must first be marked as open resolving the ongoing progress state. * The destination location doesn't stock 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](https://shopify.dev/docs/api/admin-graphql/latest/enums/FulfillmentOrderRequestStatus) of `SUBMITTED`, `ACCEPTED`, `CANCELLATION_REQUESTED`, or `CANCELLATION_REJECTED`. 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](https://shopify.dev/docs/api/admin-graphql/latest/objects/fulfillmentorder#field-fulfillmentorder-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 `fulfillmentOrderLineItems` parameter (available as of the `2023-04` API 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.

    POST /graphql.json

  • Write

    fulfillmentOrderOpen

    Marks 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.

    POST /graphql.json

  • Write

    fulfillmentOrderRejectCancellationRequest

    Rejects a cancellation request sent to a fulfillment service for a fulfillment order.

    POST /graphql.json

  • Write

    fulfillmentOrderRejectFulfillmentRequest

    Rejects a fulfillment request sent to a fulfillment service for a fulfillment order.

    POST /graphql.json

  • Write

    fulfillmentOrderReleaseHold

    Releases the fulfillment hold on a fulfillment order.

    POST /graphql.json

  • Write

    fulfillmentOrderReportProgress

    Reports the progress of an open or in-progress fulfillment order.

    POST /graphql.json

  • Write

    fulfillmentOrderReschedule

    Reschedules a scheduled fulfillment order. Updates the value of the `fulfillAt` field on a scheduled fulfillment order. The fulfillment order will be marked as ready for fulfillment at this date and time.

    POST /graphql.json

  • Write

    fulfillmentOrderSplit

    Splits [`FulfillmentOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) objects by moving the specified [`LineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) objects and quantities into a new fulfillment order. If the original fulfillment order can't be split due to its current state, then the mutation creates a replacement fulfillment order instead.

    POST /graphql.json

  • Write

    fulfillmentOrderSubmitCancellationRequest

    Sends a cancellation request to the fulfillment service of a fulfillment order.

    POST /graphql.json

  • Write

    fulfillmentOrderSubmitFulfillmentRequest

    Sends a fulfillment request to the fulfillment service assigned to a [`FulfillmentOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder). The fulfillment service must then accept or reject the request before processing can begin. You can either request fulfillment for all line items or specify individual items with quantities for partial fulfillment. When requesting partial fulfillment, Shopify splits the original fulfillment order into two: one with the submitted items and another with the remaining unsubmitted items. Include an optional message to communicate special instructions to the fulfillment service, such as gift wrapping or handling requirements. Learn more about [managing fulfillment requests as a fulfillment service](https://shopify.dev/docs/apps/build/orders-fulfillment/fulfillment-service-apps/build-for-fulfillment-services#step-4-act-on-fulfillment-requests).

    POST /graphql.json

  • Write

    fulfillmentOrdersReroute

    Route the fulfillment orders to an alternative location, according to the shop's order routing settings. This involves: * Finding an alternate location that can fulfill the fulfillment orders. * Assigning the fulfillment orders to the new location.

    POST /graphql.json

  • Write

    fulfillmentOrdersSetFulfillmentDeadline

    Sets the latest date and time by which the fulfillment orders need to be fulfilled.

    POST /graphql.json

  • Write

    fulfillmentServiceCreate

    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-10` or 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](https://shopify.dev/api/admin-graphql/latest/mutations/locationEdit) mutation after creating the fulfillment service.

    POST /graphql.json

  • Write

    fulfillmentServiceUpdate

    Updates the [`FulfillmentService`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentService) configuration, including its name, callback URL, and operational settings. The mutation modifies how the fulfillment service handles inventory tracking, shipping requirements, and package tracking support. > Note: > To update the physical address or other location details of the fulfillment service, use the [`locationEdit`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/locationEdit) mutation instead. Learn more about [editing fulfillment service locations](https://shopify.dev/docs/apps/build/orders-fulfillment/fulfillment-service-apps/build-for-fulfillment-services#step-2-edit-locations).

    POST /graphql.json

  • Write

    fulfillmentTrackingInfoUpdate

    Updates tracking information for a fulfillment, including the carrier name, tracking numbers, and tracking URLs. You can provide either single or multiple tracking numbers for shipments with multiple packages. The mutation accepts a [`FulfillmentTrackingInput`](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/FulfillmentTrackingInput) that supports both single tracking (using [`number`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdate#arguments-trackingInfoInput.fields.number) and [`url`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdate#arguments-trackingInfoInput.fields.url) fields) and multi-package tracking (using [`numbers`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdate#arguments-trackingInfoInput.fields.numbers) and [`urls`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdate#arguments-trackingInfoInput.fields.urls) fields). When you specify a [supported carrier name](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentTrackingInfo#supported-tracking-companies), Shopify automatically generates tracking URLs for the provided tracking numbers. You can optionally notify customers about tracking updates with the [`notifyCustomer`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fulfillmentTrackingInfoUpdate#arguments-notifyCustomer) argument. When enabled, customers receive shipping update emails with tracking details and receive notifications about future updates to the fulfillment. Learn more about [enabling tracking support](https://shopify.dev/docs/apps/build/orders-fulfillment/fulfillment-service-apps/build-for-fulfillment-services#step-9-optional-enable-tracking-support) for fulfillment services.

    POST /graphql.json

  • Write

    fulfillmentTrackingInfoUpdateV2 (deprecated)

    Updates tracking information for a fulfillment.

    POST /graphql.json

  • Write

    giftCardCreate

    Creates a new [`GiftCard`](https://shopify.dev/docs/api/admin-graphql/latest/objects/GiftCard) with a specified initial value. You can assign the gift card to a [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) or create it without assignment for manual distribution. You can customize the gift card with an optional code, expiration date, and internal note. If you don't provide a code, the system generates a random 16 character alphanumeric code. The mutation also supports scheduling gift card notifications to recipients, with a personalized message, through the [`recipientAttributes`](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/GiftCardCreateInput#fields-recipientAttributes) field on the `GiftCardCreateInput` input object.

    POST /graphql.json

  • Write

    giftCardCredit

    Adds 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 reusable gift card.

    POST /graphql.json

  • Write

    giftCardDeactivate

    Deactivate a gift card. A deactivated gift card cannot be used by a customer. A deactivated gift card cannot be re-enabled.

    POST /graphql.json

  • Write

    giftCardDebit

    Removes 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.

    POST /graphql.json

  • Write

    giftCardSendNotificationToCustomer

    Sends a gift card notification. If the gift card has a designated recipient, a purchase confirmation is sent instead. Both default email templates include the gift card code. By default, gift card notifications use the linked order's contact details, with the assigned customer's details as a fallback. Purchase confirmations use the assigned customer's contact details. The gift card must have an assigned customer with an email address or phone number. Returns an error without sending if the selected contact source has no contact information. When both an email address and a phone number are available, the notification is sent by email.

    POST /graphql.json

  • Write

    giftCardSendNotificationToRecipient

    Sends a notification to the designated recipient of a gift card, delivering the gift card code and redemption instructions. The notification is delivered using the recipient's available contact method. Use this to deliver or re-deliver the gift card to the intended recipient.

    POST /graphql.json

  • Write

    giftCardUpdate

    Updates the properties of an existing gift card, such as its expiration date, note, or template suffix. Use this to modify gift card details — for example, extending an expiration date for a loyal customer or adding an internal note for tracking purposes.

    POST /graphql.json

  • Write

    inventoryActivate

    Activates an inventory item at a [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) by creating an [`InventoryLevel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel) that tracks stock quantities. This enables you to manage inventory for a [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) at the specified location. When you activate an inventory item, you can set its initial quantities. The [`available`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryActivate#arguments-available) argument sets the quantity that's available for sale. [`onHand`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryActivate#arguments-onHand) argument sets the total physical quantity at the location. If you don't specify quantities, then `available` and `onHand` default to zero. > Caution: > As of version `2026-01`, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of version `2026-04`, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests). Learn more about [managing inventory quantities and states](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states).

    POST /graphql.json

  • Write

    inventoryAdjustQuantities

    Adjusts quantities for inventory items by applying incremental changes at specific locations. Each adjustment modifies the quantity by a delta value rather than setting an absolute amount. The mutation tracks adjustments with a reason code and optional reference URI for audit trails. Returns an [`InventoryAdjustmentGroup`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryAdjustmentGroup) that records all changes made in the operation. Learn more about [managing inventory quantities and states](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states#adjust-inventory-quantities). > Caution: > As of version `2026-01`, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of version `2026-04`, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    inventoryBulkToggleActivation

    Activates or deactivates an inventory item at multiple locations. When you activate an [`InventoryItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem) at a [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location), that location can stock and track quantities for that item. When you deactivate an inventory item at a location, the inventory item is no longer stocked at that location. The mutation accepts an inventory item ID and a list of location-specific activation settings. It returns the updated inventory item and any activated [`InventoryLevel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel) objects. Learn more about [managing inventory quantities and states](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states#inventory-object-relationships).

    POST /graphql.json

  • Write

    inventoryItemUpdate

    Updates an [`InventoryItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem)'s properties including whether inventory is tracked, cost, SKU, and whether shipping is required. Inventory items represent the goods available to be shipped to customers.

    POST /graphql.json

  • Write

    inventoryMoveQuantities

    Moves inventory quantities for a single inventory item between different states at a single location. Use this mutation to reallocate inventory across quantity states without moving it between locations. Each change specifies the quantity to move, the source state and location, and the destination state and location. The mutation returns an [`InventoryAdjustmentGroup`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryAdjustmentGroup) that tracks all changes made in a single operation, providing an audit trail with the reason and reference document URI. > Caution: > As of version `2026-01`, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of version `2026-04`, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    inventorySetOnHandQuantities (deprecated)

    Sets an inventory item's on-hand quantities to specific absolute values at designated locations. The mutation takes a reason for tracking purposes and a reference document URI for audit trails. Returns an [`InventoryAdjustmentGroup`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryAdjustmentGroup) that tracks all changes made in this operation, including the delta values calculated from the previous quantities. > Caution: > As of 2026-01, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of 2026-04, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    inventorySetQuantities

    Set quantities of specified name using absolute values. This mutation supports compare-and-swap (CAS) functionality to handle concurrent requests properly. As of 2026-04, each quantity in `quantities` must include a `changeFromQuantity` value. The mutation only updates the quantity if the persisted quantity matches `changeFromQuantity`, and otherwise returns a `CHANGE_FROM_QUANTITY_STALE` error. In order to opt out of the check for a quantity, explicitly pass `null` as its `changeFromQuantity`. Omitting `changeFromQuantity` returns an error. Before 2026-04, if `ignoreCompareQuantity` is not set to true, the mutation will only update the quantity if the persisted quantity matches the `compareQuantity` value. If the `compareQuantity` value does not match the persisted value, the mutation will return an error. In order to opt out of the `compareQuantity` check, the `ignoreCompareQuantity` argument can be set to true. > Note: > Only use this mutation if calling on behalf of a system that acts as the source of truth for inventory quantities, > otherwise please consider using the [inventoryAdjustQuantities](https://shopify.dev/api/admin-graphql/latest/mutations/inventoryAdjustQuantities) mutation. > > > Opting out of the compare-and-swap check can lead to inaccurate inventory quantities if multiple requests are made concurrently. > It is recommended to always pass the expected current quantity as `changeFromQuantity` (or `compareQuantity` before 2026-04) > to ensure the accuracy of the inventory quantities, and to opt out of the check (with a `null` `changeFromQuantity`, or > `ignoreCompareQuantity` before 2026-04) only when necessary. > For more information, refer to the [compare and swap documentation](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states#compare-and-swap). > Caution: > As of 2026-01, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of 2026-04, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    inventorySetScheduledChanges (deprecated)

    Set up scheduled changes of inventory items. > Caution: > As of 2026-01, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of 2026-04, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    inventoryShipmentAddItems

    Adds items to an inventory shipment. > Caution: > As of 2026-01, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of 2026-04, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    inventoryShipmentCreate

    Adds a draft shipment to an inventory transfer. > Caution: > As of 2026-01, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of 2026-04, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    inventoryShipmentCreateInTransit

    Adds an in-transit shipment to an inventory transfer. > Caution: > As of 2026-01, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of 2026-04, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    inventoryShipmentMarkInTransit

    Marks a draft inventory shipment as in transit.

    POST /graphql.json

  • Write

    inventoryShipmentReceive

    Receive an inventory shipment. > Caution: > As of 2026-01, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of 2026-04, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    inventoryShipmentSetBarcode

    Sets the barcode on an inventory shipment.

    POST /graphql.json

  • Write

    inventoryShipmentSetTracking

    Edits the tracking info on an inventory shipment.

    POST /graphql.json

  • Write

    inventoryShipmentUpdateItemQuantities

    Updates items on an inventory shipment.

    POST /graphql.json

  • Write

    inventoryTransferCreate

    Creates a draft inventory transfer to move inventory items between [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) objects in your store. The transfer tracks which items to move, their quantities, and the origin and destination locations. Use [`inventoryTransferMarkAsReadyToShip`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryTransferMarkAsReadyToShip) to mark the transfer as ready to ship. > Caution: > As of version `2026-01`, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of version `2026-04`, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    inventoryTransferCreateAsReadyToShip

    Creates an inventory transfer in ready to ship. > Caution: > As of 2026-01, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of 2026-04, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    inventoryTransferDuplicate

    This 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. > Caution: > As of 2026-01, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of 2026-04, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    inventoryTransferEdit

    Edits an inventory transfer.

    POST /graphql.json

  • Write

    inventoryTransferMarkAsReadyToShip

    Sets an inventory transfer to ready to ship.

    POST /graphql.json

  • Write

    inventoryTransferSetItems

    This mutation sets the quantity for one or more line items on a Transfer. Only the items you include in the `lineItems` field are updated. Items already on the transfer but not referenced in your update will stay unchanged. Each inventory item may appear at most once in `lineItems`; duplicate `inventoryItemId` entries are rejected. For each entry in `lineItems`: - If the inventory item isn't yet on the transfer, a new line item is added with the provided quantity. - If the inventory item is already on the transfer, the provided quantity replaces the line item's [`processableQuantity`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryTransferLineItem#field-InventoryTransferLineItem.fields.processableQuantity). Any quantity outside the processable portion (for example, already shipped or picked for shipment) is preserved, so the resulting total quantity equals the preserved portion plus the provided quantity. Passing a quantity of `0` is only allowed for transfers in `DRAFT` status; on `READY_TO_SHIP` or `IN_PROGRESS` transfers it returns an `INVALID_QUANTITY` error. On `DRAFT` transfers, `quantity: 0` leaves a zero-quantity line item on the transfer; it does not remove the item. To remove a line item from a transfer, use [`inventoryTransferRemoveItems`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryTransferRemoveItems). > Caution: > As of 2026-01, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of 2026-04, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    locationActivate

    Activates a location so that you can stock inventory at the location. Refer to the [`isActive`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location#field-isactive) and [`activatable`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location#field-activatable) fields on the `Location` object. > Caution: > As of 2026-01, this mutation supports an optional idempotency key using the `@idempotent` directive. As of 2026-04, the idempotency key is required and must be provided using the `@idempotent` directive. For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    locationAdd

    Adds a new [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) where you can stock inventory and fulfill orders. Locations represent physical places like warehouses, retail stores, or fulfillment centers. The location requires a name and address with at least a country code. You can specify whether the location fulfills online orders, which determines if its inventory is available for online sales. You can also attach custom [metafields](https://shopify.dev/docs/apps/build/custom-data) to store additional information about the location.

    POST /graphql.json

  • Write

    locationDeactivate

    Deactivates a location and moves inventory, pending orders, and moving transfers " "to a destination location. > Caution: > As of 2026-01, this mutation supports an optional idempotency key using the `@idempotent` directive. As of 2026-04, the idempotency key is required and must be provided using the `@idempotent` directive. For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    locationEdit

    Updates the properties of an existing [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location). You can modify the location's name, address, whether it fulfills online orders, and custom [`metafields`](https://shopify.dev/docs/apps/build/custom-data). Apps that created a [`FulfillmentService`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentService) can edit the associated location to ensure accurate representation of their fulfillment network. > Note: > You can't disable the [`fulfillsOnlineOrders`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/locationEdit#arguments-input.fields.fulfillsOnlineOrders) setting for fulfillment service locations. Learn more about [editing locations for fulfillment services](https://shopify.dev/docs/apps/build/orders-fulfillment/fulfillment-service-apps/build-for-fulfillment-services#step-2-edit-locations).

    POST /graphql.json

  • Write

    locationLocalPickupDisable

    Disables local pickup for a location.

    POST /graphql.json

  • Write

    locationLocalPickupEnable

    Enables 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 location.

    POST /graphql.json

  • Write

    marketCreate

    Creates a [`Market`](https://shopify.dev/docs/api/admin-graphql/latest/objects/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 payment methods. Define conditions to match buyers by region, company location, retail location, or other criteria. Configure [`MarketCurrencySettings`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketCurrencySettings) to control currency behavior. Set [`MarketPriceInclusions`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketPriceInclusions) to determine tax and duty display. Assign [`Catalog`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Catalog) objects and [`MarketWebPresence`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketWebPresence) configurations to control product availability and SEO strategy. Learn more about [Shopify Markets](https://shopify.dev/docs/apps/build/markets).

    POST /graphql.json

  • Write

    marketCurrencySettingsUpdate (deprecated)

    Updates currency settings of a market.

    POST /graphql.json

  • Write

    marketLocalizationsRegister

    Creates or updates market localizations.

    POST /graphql.json

  • Write

    marketRegionsCreate (deprecated)

    Creates regions that belong to an existing market.

    POST /graphql.json

  • Write

    marketUpdate

    Updates the properties of a market.

    POST /graphql.json

  • Write

    marketWebPresenceCreate (deprecated)

    Creates a web presence for a market.

    POST /graphql.json

  • Write

    marketWebPresenceUpdate (deprecated)

    Updates a market web presence.

    POST /graphql.json

  • Write

    marketingActivityCreate

    Create new marketing activity. Marketing activity app extensions are deprecated and will be removed in the near future.

    POST /graphql.json

  • Write

    marketingActivityCreateExternal (deprecated)

    Creates a new external marketing activity.

    POST /graphql.json

  • Write

    marketingActivityUpdate

    Updates a marketing activity with the latest information. Marketing activity app extensions are deprecated and will be removed in the near future.

    POST /graphql.json

  • Write

    marketingActivityUpdateExternal

    Update an external marketing activity.

    POST /graphql.json

  • Write

    marketingActivityUpsertExternal

    Creates a new external marketing activity or updates an existing one. When optional fields are absent or null, associated information will be removed from an existing marketing activity.

    POST /graphql.json

  • Write

    marketingEngagementCreate

    Creates a new marketing engagement for a marketing activity.

    POST /graphql.json

  • Write

    menuCreate

    Creates a navigation [`Menu`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Menu) for the online store. Menus organize links that help customers navigate to [collections](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection), [products](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product), [pages](https://shopify.dev/docs/api/admin-graphql/latest/objects/Page), [blogs](https://shopify.dev/docs/api/admin-graphql/latest/objects/Blog), and custom URLs. Each menu requires a unique handle for identification and can contain multiple [`MenuItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MenuItem) objects with nested sub-items up to three levels deep.

    POST /graphql.json

  • Write

    menuUpdate

    Updates a [`Menu`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Menu) for display on the storefront. Modifies the menu's title and navigation structure, including nested [`MenuItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MenuItem) objects. You can update the handle for non-default menus. The items argument accepts a list of menu items with their nested structure. Each item can include nested items to create multi-level navigation hierarchies. Default menus have restricted updates—you can't change their handles.

    POST /graphql.json

  • Write

    metafieldDefinitionCreate

    Creates a [`MetafieldDefinition`](https://shopify.dev/docs/api/admin-graphql/current/objects/MetafieldDefinition) that establishes structure and validation rules for metafields. The definition specifies the data type, validation constraints, and access permissions for metafields with a given namespace and key combination. When you create a new definition, the system validates any existing unstructured metafields matching the same owner type, namespace, and key against it. The system updates each valid metafield's type to match the definition. Invalid metafields remain unchanged but must conform to the definition when updated. Learn more about [creating metafield definitions](https://shopify.dev/docs/apps/build/custom-data/metafields/definitions).

    POST /graphql.json

  • Write

    metafieldDefinitionPin

    You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions. The order of your pinned metafield definitions determines the order in which your metafields are displayed on the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed.

    POST /graphql.json

  • Write

    metafieldDefinitionUnpin

    You can organize your metafields in your Shopify admin by pinning/unpinning metafield definitions. The order of your pinned metafield definitions determines the order in which your metafields are displayed on the corresponding pages in your Shopify admin. By default, only pinned metafields are automatically displayed.

    POST /graphql.json

  • Write

    metafieldDefinitionUpdate

    Updates a [`MetafieldDefinition`](https://shopify.dev/docs/api/admin-graphql/current/objects/MetafieldDefinition)'s configuration and settings. You can modify the definition's name, description, validation rules, access settings, capabilities, and constraints. The mutation updates access settings that control visibility across different APIs, such as the [GraphQL Admin API](https://shopify.dev/docs/api/admin-graphql), [Storefront API](https://shopify.dev/docs/api/storefront), and [Customer Account API](https://shopify.dev/docs/api/customer). It also enables capabilities like admin filtering or unique value validation, and modifies constraints that determine which resource subtypes the definition applies to. > Note: The type, namespace, key, and owner type identify the definition and so can't be changed. Learn more about [updating metafield definitions](https://shopify.dev/docs/apps/build/custom-data/metafields/definitions).

    POST /graphql.json

  • Write

    metafieldsSet

    Sets metafield values. Metafield values will be set regardless if they were previously created or not. Allows a maximum of 25 metafields to be set at a time, with a maximum total request payload size of 10MB. This operation is atomic, meaning no changes are persisted if an error is encountered. As of `2024-07`, this operation supports compare-and-set functionality to better handle concurrent requests. If `compareDigest` is set for any metafield, the mutation will only set that metafield if the persisted metafield value matches the digest used on `compareDigest`. If the metafield doesn't exist yet, but you want to guarantee that the operation will run in a safe manner, set `compareDigest` to `null`. The `compareDigest` value can be acquired by querying the metafield object and selecting `compareDigest` as a field. If the `compareDigest` value does not match the digest for the persisted value, the mutation will return an error. You can opt out of write guarantees by not sending `compareDigest` in the request.

    POST /graphql.json

  • Write

    metaobjectCreate

    Creates a metaobject entry based on an existing [`MetaobjectDefinition`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectDefinition). The type must match a definition that already exists in the shop. Specify field values using key-value pairs that correspond to the field definitions. The mutation generates a unique handle automatically if you don't provide one. You can also configure capabilities like publishable status to control the metaobject's visibility across channels. Learn more about [managing metaobjects](https://shopify.dev/docs/apps/build/custom-data/metaobjects/manage-metaobjects).

    POST /graphql.json

  • Write

    metaobjectDefinitionCreate

    Creates a metaobject definition that establishes the structure for custom data objects in your store. The definition specifies the fields, data types, and access permissions that all [`Metaobject`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metaobject) entries of this type share. Use the `type` field to create a unique namespace for your metaobjects. Prefix the type with `$app:` to reserve the definition for your app's exclusive use. The definition can include capabilities like publishable status or translation eligibility, to extend how metaobjects integrate with Shopify's features. Learn more about [managing metaobjects](https://shopify.dev/docs/apps/build/custom-data/metaobjects/manage-metaobjects).

    POST /graphql.json

  • Write

    metaobjectDefinitionUpdate

    Updates a [`MetaobjectDefinition`](https://shopify.dev/docs/api/admin-graphql/latest/objects/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. The mutation supports reordering fields when `resetFieldOrder` is `true`, which arranges submitted fields first followed by alphabetized omitted fields. Learn more about [managing metaobjects](https://shopify.dev/docs/apps/build/custom-data/metaobjects/manage-metaobjects).

    POST /graphql.json

  • Write

    metaobjectUpdate

    Updates a [`Metaobject`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metaobject) with new field values, handle, or capabilities. [Metaobjects](https://shopify.dev/docs/apps/build/custom-data#what-are-metaobjects) are custom data structures that extend Shopify's data model. You can modify field values mapped to the metaobject's [`MetaobjectDefinition`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectDefinition), update the handle for a unique identifier, and adjust capabilities like publishing status. When updating the handle, you can optionally create a redirect from the old handle to maintain existing references.

    POST /graphql.json

  • Write

    metaobjectUpsert

    Creates or updates a [`Metaobject`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metaobject) based on its handle. If a metaobject with the specified handle exists, the mutation updates it with the provided field values. If no matching metaobject exists, the mutation creates a new one. The handle serves as a unique identifier within a metaobject type. Field values map to the [`MetaobjectDefinition`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectDefinition)'s field keys and overwrite existing values during updates.

    POST /graphql.json

  • Write

    mobilePlatformApplicationCreate

    Create a mobile platform application.

    POST /graphql.json

  • Write

    mobilePlatformApplicationUpdate

    Update a mobile platform application.

    POST /graphql.json

  • Write

    orderCapture

    Captures payment for an authorized transaction on an order. Use this mutation to claim the money that was previously reserved by an authorization transaction. The `orderCapture` mutation can be used in the following scenarios: - To capture the full amount of an authorized transaction - To capture a partial payment by specifying an amount less than the total order amount - To perform multiple captures on the same order, as long as the order transaction is [multi-capturable](https://shopify.dev/docs/api/admin-graphql/latest/objects/ordertransaction#field-OrderTransaction.fields.multiCapturable) > Note: > Multi-capture functionality is only available to stores on a [Shopify Plus plan](https://help.shopify.com/manual/intro-to-shopify/pricing-plans/plans-features/shopify-plus-plan). For multi-currency orders, the [`currency`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCapture#arguments-input.fields.currency) field is required and should match the presentment currency from the order. After capturing a payment, you can: - View the transaction details including status, amount, and processing information. - Track the captured amount in both shop and presentment currencies. - Monitor the transaction's settlement status. Learn more about [order transactions](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderTransaction).

    POST /graphql.json

  • Write

    orderClose

    Marks an open [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) as closed. A closed order is one where merchants fulfill or cancel all [`LineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) objects and complete all financial transactions. Once closed, the order indicates that no further work is required. The order's [`closedAt`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-closedAt) timestamp is set when this mutation completes successfully.

    POST /graphql.json

  • Write

    orderCreate

    Creates an order with attributes such as customer information, line items, and shipping and billing addresses. Use the `orderCreate` mutation to programmatically generate orders in scenarios where orders aren't created through the standard checkout process, such as when importing orders from an external system or creating orders for wholesale customers. The `orderCreate` mutation doesn't support applying multiple discounts, such as discounts on line items. Automatic discounts won't be applied unless you replicate the logic of those discounts in your custom implementation. You can [apply a discount code](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/OrderCreateDiscountCodeInput), but only one discount code can be set for each order. > Note: > If you're using the `orderCreate` mutation with a > [trial](https://help.shopify.com/manual/intro-to-shopify/pricing-plans/free-trial) or > [development store](https://shopify.dev/docs/api/development-stores), then you can create a > maximum of five new orders per minute. After you create an order, you can make subsequent edits to the order using one of the following mutations: * [`orderUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderUpdate): Used for simple updates to an order, such as changing the order's note, tags, or customer information. * [`orderEditBegin`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditBegin): Used when you need to make significant updates to an order, such as adding or removing line items, changing quantities, or modifying discounts. The `orderEditBegin` mutation initiates an order editing session, allowing you to make multiple changes before finalizing them. Learn more about using the `orderEditBegin` mutation to [edit existing orders](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders). Learn how to build apps that integrate with [order management and fulfillment processes](https://shopify.dev/docs/apps/build/orders-fulfillment).

    POST /graphql.json

  • Write

    orderCreateMandatePayment

    Creates a payment for an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) using a stored [`PaymentMandate`](https://shopify.dev/docs/api/admin-graphql/latest/objects/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 purchases. The mutation processes the payment asynchronously and returns a [`Job`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Job) for tracking the payment status. You can specify the payment amount to collect, and use the [`autoCapture`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCreateMandatePayment#arguments-autoCapture) argument to either immediately capture the payment or only authorize it for later capture. Each payment request requires a unique [`idempotencyKey`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCreateMandatePayment#arguments-idempotencyKey) to prevent duplicate charges. Subsequent calls with the same key return the original payment result rather than creating a new payment. Learn more about [deferred payments and payment mandates](https://shopify.dev/docs/apps/build/purchase-options/deferred#charging-the-remaining-balance) and [idempotent requests](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    orderCreateManualPayment

    Records a manual payment for an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/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. You can specify the payment [amount](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCreateManualPayment#arguments-amount), [method name](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCreateManualPayment#arguments-paymentMethodName), and [when it was processed](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCreateManualPayment#arguments-processedAt).

    POST /graphql.json

  • Write

    orderCustomerSet

    Sets a customer on an order.

    POST /graphql.json

  • Write

    orderEditAddCustomItem

    Adds a custom line item to an existing [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order). Custom line items represent products or services not in your catalog, such as gift wrapping, installation fees, or one-off charges. Creates a [`CalculatedLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CalculatedLineItem) with the specified title, price, and quantity. Changes remain in the edit session until you commit them with the [`orderEditCommit`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditCommit) mutation. Learn more about [adding custom line items](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders#add-a-custom-line-item).

    POST /graphql.json

  • Write

    orderEditAddLineItemDiscount

    Applies a discount to a [`LineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) during an order edit session. The discount can be either a fixed amount or percentage value. To modify pricing on specific line items, use this mutation after starting an order edit with the [`orderEditBegin`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditBegin) mutation. The changes remain staged until you commit them with the [`orderEditCommit`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditCommit) mutation. Learn more about [editing existing orders](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders).

    POST /graphql.json

  • Write

    orderEditAddShippingLine

    Adds a custom shipping line to an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) during an edit session. Specify the shipping title and price to create a new [`ShippingLine`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShippingLine). Returns a [`CalculatedOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CalculatedOrder) showing the order with edits applied but not yet saved. To save your changes, use the [`orderEditCommit`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditCommit) mutation. Learn more about [editing existing orders](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders).

    POST /graphql.json

  • Write

    orderEditAddVariant

    Adds a [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) as a line item to an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) that's being edited. The mutation respects the variant's contextual pricing. You can specify a [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) to check for inventory availability and control whether duplicate variants are allowed. The [`quantity`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditAddVariant#arguments-quantity) must be a positive value. Learn more about [editing existing orders](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders#add-a-new-variant).

    POST /graphql.json

  • Write

    orderEditBegin

    Starts an order editing session that enables you to modify an existing [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order). This mutation creates an [`OrderEditSession`](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderEditSession) and returns a [`CalculatedOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CalculatedOrder) showing how the order looks with your changes applied. Order editing follows a three-step workflow: Begin the edit with [`orderEditBegin`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditBegin), apply changes using mutations like [`orderEditAddVariant`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditAddVariant) or [`orderEditSetQuantity`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditSetQuantity), and then save the changes with the [`orderEditCommit`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditCommit) mutation. The session tracks all staged changes until you commit or abandon them. Learn more about [editing existing orders](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders).

    POST /graphql.json

  • Write

    orderEditCommit

    Applies staged changes from an order editing session to the original order. This finalizes all modifications made during the edit session, including changes to line items, quantities, discounts, and shipping lines. Order editing follows a three-step workflow: start with [`orderEditBegin`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditBegin) to create an editing session, apply changes using various orderEdit mutations, and then save the changes with the [`orderEditCommit`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditCommit) mutation. The mutation can optionally notify the customer of changes and add staff notes for internal tracking. You can only edit unfulfilled line items. If an edit changes the total order value, then the customer might need to pay a balance or receive a refund. Learn more about [editing existing orders](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders).

    POST /graphql.json

  • Write

    orderEditUpdateDiscount

    Updates 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](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).

    POST /graphql.json

  • Write

    orderEditUpdateShippingLine

    Updates 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](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).

    POST /graphql.json

  • Write

    orderInvoiceSend

    Sends an email invoice for an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order). You can customize the email recipient, sender, and subject line using the [`email`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderInvoiceSend#arguments-email) argument. > Note: > Use store or staff account email addresses for the [`from`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderInvoiceSend#arguments-email.fields.from) and [`bcc`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderInvoiceSend#arguments-email.fields.bcc) input fields.

    POST /graphql.json

  • Write

    orderMarkAsPaid

    Marks 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. The `orderMarkAsPaid` mutation is particularly useful in scenarios where: - Orders were created with manual payment methods (cash on delivery, bank deposit, money order) - Payments were received offline and need to be recorded in the system - Previously authorized payments need to be captured manually - Orders require manual payment reconciliation due to external payment processing The mutation validates that the order can be marked as paid before processing. An order can be marked as paid only if it has a positive outstanding balance and its [financial status](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.displayFinancialStatus) isn't already `PAID`. The mutation will either create a new sale transaction for the full outstanding amount or capture an existing authorized transaction, depending on the order's current payment state. After successfully marking an order as paid, the order's financial status is updated to reflect the payment, and payment events are logged for tracking and analytics purposes. Learn more about [managing orders](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps) in apps.

    POST /graphql.json

  • Write

    orderOpen

    Opens a closed order.

    POST /graphql.json

  • Write

    orderRiskAssessmentCreate

    Creates a risk assessment for a specific order using the provided risk level and facts. Shopify sends an `orders/risk_assessment_changed` webhook when the assessment is created.

    POST /graphql.json

  • Write

    orderUpdate

    Updates the attributes of an order, such as the customer's email, the shipping address for the order, tags, and [metafields](https://shopify.dev/docs/apps/build/custom-data) 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 [`orderEditBegin`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderEditBegin) mutation instead. The `orderEditBegin` mutation initiates an order editing session, allowing you to make multiple changes before finalizing them. Learn more about using the `orderEditBegin` mutation to [edit existing orders](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders). If you need to remove a customer from an order, then use the [`orderCustomerRemove`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCustomerRemove) mutation instead. Learn how to build apps that integrate with [order management and fulfillment processes](https://shopify.dev/docs/apps/build/orders-fulfillment).

    POST /graphql.json

  • Write

    pageCreate

    Creates a [`Page`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Page) for the online store. Pages contain custom content like "About Us" or "Contact" information that merchants display outside their product catalog. The page requires a [`title`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Page#field-Page.fields.title) and can include HTML content, publishing settings, and custom [template suffixes](https://shopify.dev/docs/api/admin-graphql/latest/objects/Page#field-Page.fields.templateSuffix). You can control visibility through the [`isPublished`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Page#field-Page.fields.isPublished) flag or schedule publication with a specific date. The mutation returns the complete page object upon successful creation or validation errors if the input is invalid.

    POST /graphql.json

  • Write

    pageUpdate

    Updates an existing page's content and settings. For example, merchants can update their "Shipping Policy" page when rates change, or refresh their "About Us" page with new team information. Use the `pageUpdate` mutation to: - Update page content and titles - Modify publication status - Change page handles for URL structure - Adjust template settings The mutation supports partial updates, allowing specific changes while preserving other page properties.

    POST /graphql.json

  • Write

    paymentCustomizationActivation

    Activates or deactivates payment customizations for the shop. Payment customizations allow apps to hide, reorder, or rename payment methods at checkout based on cart contents, customer attributes, or other conditions. Use this to toggle customizations on or off without deleting them.

    POST /graphql.json

  • Write

    paymentCustomizationCreate

    Creates a new payment customization for the shop. Payment customizations let apps modify the payment methods shown at checkout — hiding, reordering, or renaming options based on cart contents, customer attributes, or other business logic.

    POST /graphql.json

  • Write

    paymentCustomizationUpdate

    Updates an existing payment customization, modifying its configuration for how payment methods are displayed at checkout. Use this to change the customization's title or enabled state. The customization's function can't be changed once set; create a new payment customization to use a different function.

    POST /graphql.json

  • Write

    paymentReminderSend

    Sends an email payment reminder for a payment schedule.

    POST /graphql.json

  • Write

    paymentTermsCreate

    Create 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`.

    POST /graphql.json

  • Write

    paymentTermsUpdate

    Update 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`.

    POST /graphql.json

  • Write

    pointOfSaleDeviceAssignToCashDrawer

    Assigns a point of sale device to a cash drawer, removing any prior assignment.

    POST /graphql.json

  • Write

    pointOfSaleDevicePaymentSessionAdjust

    Adds an adjustment to a point of sale device payment session.

    POST /graphql.json

  • Write

    pointOfSaleDevicePaymentSessionClose

    Closes a point of sale device payment session.

    POST /graphql.json

  • Write

    pointOfSaleDevicePaymentSessionCount

    Records a mid-session cash count for a point of sale device payment session.

    POST /graphql.json

  • Write

    pointOfSaleDevicePaymentSessionOpen

    Opens a point of sale device payment session.

    POST /graphql.json

  • Write

    priceListCreate

    Creates a [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList). Price lists enable contextual pricing by defining fixed prices or percentage-based adjustments. The price list requires a unique name, currency for fixed prices, and parent adjustment settings that determine how the system calculates prices relative to base prices. To apply contextual pricing, link the price list to a [`Catalog`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Catalog). When that catalog's context is matched, customers receive the price list's prices. Learn more about [building catalogs with price lists](https://shopify.dev/docs/apps/build/markets/build-catalog#step-2-associate-a-price-list-with-the-catalog).

    POST /graphql.json

  • Write

    priceListFixedPricesAdd

    Creates or updates fixed prices on a [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList). Use this mutation to set specific prices for [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects that override the price list's default percentage-based adjustments. When you add fixed prices, the mutation replaces any existing fixed prices for those variants on the price list.

    POST /graphql.json

  • Write

    privacyFeaturesDisable

    Disable a shop's privacy features.

    POST /graphql.json

  • Write

    productBundleCreate

    Creates a product bundle that groups multiple [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/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 the component products. The mutation runs asynchronously and returns a [`ProductBundleOperation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductBundleOperation) object to track the creation status. Poll the operation using the [`productOperation`](https://shopify.dev/docs/api/admin-graphql/latest/queries/productOperation) query to determine when the bundle is ready. Learn more about [creating product fixed bundles](https://shopify.dev/docs/apps/build/product-merchandising/bundles/add-product-fixed-bundle#step-1-create-a-bundle).

    POST /graphql.json

  • Write

    productBundleUpdate

    Updates a product bundle or componentized product.

    POST /graphql.json

  • Write

    productChangeStatus (deprecated)

    Changes the status of a product. This allows you to set the availability of the product across all channels.

    POST /graphql.json

  • Write

    productCreate

    Creates a [product](https://shopify.dev/docs/api/admin-graphql/latest/objects/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 one in the Shopify admin. Common examples include creating products for a new collection, launching a new product line, or adding seasonal products. You can define product [options](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOption) and [values](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOptionValue), allowing you to create products with different variations like sizes or colors. You can also associate media files to your products, including images and videos. The `productCreate` mutation only supports creating a product with its initial [product variant](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant). To create multiple product variants for a single product and manage prices, use the [`productVariantsBulkCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkCreate) mutation. > Note: > The `productCreate` mutation has a [throttle](https://shopify.dev/docs/api/usage/rate-limits#resource-based-rate-limits) > that takes effect when a store has 50,000 product variants. After this threshold is reached, no more than > 1,000 new product variants can be created per day. After you create a product, you can make subsequent edits to the product using one of the following mutations: - [`publishablePublish`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/publishablePublish): Used to publish the product and make it available to customers. The `productCreate` mutation creates products in an unpublished state by default, so you must perform a separate operation to publish the product. - [`productUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productUpdate): Used to update a single product, such as changing the product's title, description, vendor, or associated media. - [`productSet`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productSet): Used to perform multiple operations on products, such as creating or modifying product options and variants. Learn more about the [product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model) and [adding product data](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/add-data).

    POST /graphql.json

  • Write

    productCreateMedia (deprecated)

    Adds media files to a [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product), such as images, videos, or 3D models. Media files enhance product listings by providing visual representations that help customers understand the product. The mutation accepts an array of [`CreateMediaInput`](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/CreateMediaInput) objects, each specifying the source URL, content type, and optional alt text. You can add multiple media files in a single request. The mutation adds all valid files and returns errors for any invalid ones.

    POST /graphql.json

  • Write

    productDuplicate

    Duplicates a product. If you need to duplicate a large product, such as one that has many [variants](https://shopify.dev/api/admin-graphql/latest/input-objects/ProductVariantInput) that are active at several [locations](https://shopify.dev/api/admin-graphql/latest/input-objects/InventoryLevelInput), you might encounter timeout errors. To avoid these timeout errors, include the `synchronous: false` argument in this mutation to perform the duplication asynchronously. Metafield values are not duplicated if the unique values capability is enabled.

    POST /graphql.json

  • Write

    productFeedCreate

    Creates a product feed for a specific publication.

    POST /graphql.json

  • Write

    productFullSync

    Runs the full product sync for a given shop.

    POST /graphql.json

  • Write

    productJoinSellingPlanGroups

    Adds multiple selling plan groups to a product.

    POST /graphql.json

  • Write

    productLeaveSellingPlanGroups

    Removes multiple groups from a product.

    POST /graphql.json

  • Write

    productOptionUpdate

    Updates an [option](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOption) on a [product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product), such as size, color, or material. Each option includes a name, position, and a list of values. The combination of a product option and value creates a [product variant](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant). Use the `productOptionUpdate` mutation for the following use cases: - **Update product choices**: Modify an existing option, like "Size" (Small, Medium, Large) or "Color" (Red, Blue, Green), so customers can select their preferred variant. - **Enable personalization features**: Update an option (for example, "Engraving text") to let customers customize their purchase. - **Offer seasonal or limited edition products**: Update a value (for example, "Holiday red") on an existing option to support limited-time or seasonal variants. - **Integrate with apps that manage product configuration**: Allow third-party apps to update options, like "Bundle size", when customers select or customize [product bundles](https://shopify.dev/docs/apps/build/product-merchandising/bundles). - **Link options to metafields**: Associate a product option with a custom [metafield](https://shopify.dev/docs/apps/build/custom-data), like "Fabric code", for richer integrations with other systems or apps. > Note: > The `productOptionUpdate` mutation enforces strict data integrity for product options and variants. All option positions must be sequential, and every option should be used by at least one variant. After you update a product option, you can further manage a product's configuration using related mutations: - [`productOptionsCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsCreate) - [`productOptionsDelete`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsDelete) - [`productOptionsReorder`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsReorder) - [`productVariantsBulkCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkCreate) - [`productVariantsBulkUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkUpdate) - [`productSet`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productSet) Learn more about the [product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model) and [adding product data](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/add-data).

    POST /graphql.json

  • Write

    productOptionsCreate

    Creates one or more [options](https://shopify.dev/docs/api/admin-graphql/current/objects/ProductOption) on a [product](https://shopify.dev/docs/api/admin-graphql/current/objects/Product), such as size, color, or material. Each option includes a name, position, and a list of values. The combination of a product option and value creates a [product variant](https://shopify.dev/docs/api/admin-graphql/current/objects/ProductVariant). Use the `productOptionsCreate` mutation for the following use cases: - **Add product choices**: Add a new option, like "Size" (Small, Medium, Large) or "Color" (Red, Blue, Green), to an existing product so customers can select their preferred variant. - **Enable personalization features**: Add options such as "Engraving text" to let customers customize their purchase. - **Offer seasonal or limited edition products**: Add a new value (for example, "Holiday red") to an existing option to support limited-time or seasonal variants. - **Integrate with apps that manage product configuration**: Allow third-party apps to add options, like "Bundle size", when customers select or customize [product bundles](https://shopify.dev/docs/apps/build/product-merchandising/bundles). - **Link options to metafields**: Associate a product option with a custom [metafield](https://shopify.dev/docs/apps/build/custom-data), like "Fabric code", for richer integrations with other systems or apps. > Note: > The `productOptionsCreate` mutation enforces strict data integrity for product options and variants. All option positions must be sequential, and every option should be used by at least one variant. If you use the [`CREATE` variant strategy](https://shopify.dev/docs/api/admin-graphql/current/mutations/productOptionsCreate#arguments-variantStrategy.enums.CREATE), consider the maximum allowed number of variants for each product is 2048. If the product already has an option with the same name, then the mutation returns an `OPTION_ALREADY_EXISTS` error. A product that has only its default variant is the exception, because its implicit `Title` option is a placeholder that the mutation replaces. To declare the complete set of options and variants that a product should have, and let Shopify create, update, or remove them to match, use the [`productSet`](https://shopify.dev/docs/api/admin-graphql/current/mutations/productSet) mutation instead. After you create product options, you can further manage a product's configuration using related mutations: - [`productOptionUpdate`](https://shopify.dev/docs/api/admin-graphql/current/mutations/productOptionUpdate) - [`productOptionsReorder`](https://shopify.dev/docs/api/admin-graphql/current/mutations/productOptionsReorder) - [`productOptionsDelete`](https://shopify.dev/docs/api/admin-graphql/current/mutations/productOptionsDelete) - [`productVariantsBulkCreate`](https://shopify.dev/docs/api/admin-graphql/current/mutations/productVariantsBulkCreate) - [`productVariantsBulkUpdate`](https://shopify.dev/docs/api/admin-graphql/current/mutations/productVariantsBulkUpdate) - [`productSet`](https://shopify.dev/docs/api/admin-graphql/current/mutations/productSet) Learn more about the [product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model) and [adding product data](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/add-data).

    POST /graphql.json

  • Write

    productOptionsReorder

    Reorders the [options](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOption) and [option values](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOptionValue) on a [product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product), updating the order in which [product variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) are presented to customers. The `productOptionsReorder` mutation accepts a list of product options, each identified by `id` or `name`, and an optional list of values (also by `id` or `name`) specifying the new order. The order of options in the mutation's input determines their new positions (for example, the first option becomes `option1`). The order of values within each option determines their new positions. The mutation recalculates the order of variants based on the new option and value order. Suppose a product has the following variants: 1. `"Red / Small"` 2. `"Green / Medium"` 3. `"Blue / Small"` You reorder options and values: ``` options: [ { name: "Size", values: [{ name: "Small" }, { name: "Medium" }] }, { name: "Color", values: [{ name: "Green" }, { name: "Red" }, { name: "Blue" }] } ] ``` The resulting variant order will be: 1. `"Small / Green"` 2. `"Small / Red"` 3. `"Small / Blue"` 4. `"Medium / Green"` Use the `productOptionsReorder` mutation for the following use cases: - **Change the order of product options**: For example, display "Color" before "Size" in a store. - **Reorder option values within an option**: For example, show "Red" before "Blue" in a color picker. - **Control the order of product variants**: The order of options and their values determines the sequence in which variants are listed and selected. - **Highlight best-selling options**: Present the most popular or relevant options and values first. - **Promote merchandising strategies**: Highlight seasonal colors, limited editions, or featured sizes. > Note: > The `productOptionsReorder` mutation enforces strict data integrity for product options and variants. > All option positions must be sequential, and every option should be used by at least one variant. After you reorder product options, you can further manage a product's configuration using related mutations: - [`productOptionsCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsCreate) - [`productOptionsDelete`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsDelete) - [`productVariantsBulkCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkCreate) - [`productVariantsBulkUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkUpdate) - [`productSet`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productSet) Learn more about the [product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model) and [managing product data](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/add-data).

    POST /graphql.json

  • Write

    productPublish (deprecated)

    Publishes a [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) to specified [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) objects. Products sold exclusively on subscription (`requiresSellingPlan: true`) can only be published to online stores.

    POST /graphql.json

  • Write

    productReorderMedia

    Reorders [media](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Media) attached to a product, changing their sequence in product displays. The operation processes asynchronously to handle [products](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) with large media collections. Specify the [product ID](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productReorderMedia#arguments-id) and an array of [moves](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productReorderMedia#arguments-moves), where each move contains a media ID and its new zero-based position. > Note: > Only include media items that need repositioning. Unchanged items maintain their relative order automatically. The mutation returns a [`Job`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Job) to track the reordering progress. Poll the job status to determine when the operation completes and media positions update across all sales channels. Learn more about [reordering product media](https://shopify.dev/docs/apps/build/online-store/product-media#step-6-reorder-media-objects).

    POST /graphql.json

  • Write

    productUnpublish (deprecated)

    Unpublishes a product.

    POST /graphql.json

  • Write

    productUpdate

    Updates a [product](https://shopify.dev/docs/api/admin-graphql/latest/objects/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 by one in the Shopify admin. Common examples including updating product details like status or tags. The `productUpdate` mutation doesn't support updating [product variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant). To update multiple product variants for a single product and manage prices, use the [`productVariantsBulkUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkUpdate) mutation. > Note: > The `productUpdate` mutation has a [throttle](https://shopify.dev/docs/api/usage/rate-limits#resource-based-rate-limits) > that takes effect when a store has 50,000 product variants. After this threshold is reached, no more than > 1,000 new product variants can be updated per day. After updating a product, you can make additional changes using one of the following mutations: - [`productSet`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productSet): Used to perform multiple operations on products, such as creating or modifying product options and variants. - [`publishablePublish`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/publishablePublish): Used to publish the product and make it available to customers, if the product is currently unpublished. Learn more about the [product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model) and [adding product data](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/add-data).

    POST /graphql.json

  • Write

    productUpdateMedia (deprecated)

    Updates properties of media attached to a [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product). You can modify alt text for accessibility or change preview images for existing media items. Provide the product ID and an array of [`UpdateMediaInput`](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/UpdateMediaInput) objects. Each update specifies the media's ID and the properties to change. Updates apply only to media already attached to the product and don't affect their position in the product gallery.

    POST /graphql.json

  • Write

    productVariantAppendMedia

    Appends existing media from a product to specific variants of that product, creating associations between media files and particular product options. This allows different variants to showcase relevant images or videos. For example, a t-shirt product might have color variants where each color variant displays only the images showing that specific color, helping customers see exactly what they're purchasing. Use `ProductVariantAppendMedia` to: - Associate specific images with product variants for accurate display - Build variant-specific media management in product interfaces - Implement automated media assignment based on variant attributes The operation links existing product media to variants without duplicating files, maintaining efficient media storage while enabling variant-specific displays. Learn more about [product variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant).

    POST /graphql.json

  • Write

    productVariantDetachMedia

    Detaches media from product variants.

    POST /graphql.json

  • Write

    productVariantJoinSellingPlanGroups

    Adds multiple selling plan groups to a product variant.

    POST /graphql.json

  • Write

    productVariantLeaveSellingPlanGroups

    Remove multiple groups from a product variant.

    POST /graphql.json

  • Write

    productVariantRelationshipBulkUpdate

    Creates new bundles, updates component quantities in existing bundles, and removes bundle components for one or multiple [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects. Each bundle variant can contain up to 30 component variants with specified quantities. After an app assigns components to a bundle, only that app can manage those components. > Note: > For most use cases, use [`productBundleCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productBundleCreate) instead, which creates product fixed bundles. `productVariantRelationshipBulkUpdate` is for [variant fixed bundles](https://shopify.dev/docs/apps/build/product-merchandising/bundles/add-variant-fixed-bundle), where each variant has its own component configuration.

    POST /graphql.json

  • Write

    productVariantsBulkCreate

    Creates multiple [product variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) for a single [product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) in one operation. You can run this mutation directly or as part of a [bulk operation](https://shopify.dev/docs/api/usage/bulk-operations/imports) for large-scale catalog updates. Use the `productVariantsBulkCreate` mutation to efficiently add new product variants—such as different sizes, colors, or materials—to an existing product. The mutation is helpful if you need to add product variants in bulk, such as importing from an external system. The mutation supports: - Creating variants with custom option values - Associating media (for example, images, videos, and 3D models) with the product or its variants - Handling complex product configurations > Note: > By default, stores have a limit of 2048 product variants for each product. After creating variants, you can make additional changes using one of the following mutations: - [`productVariantsBulkUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkUpdate): Updates multiple product variants for a single product in one operation. - [`productSet`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productSet): Used to perform multiple operations on products, such as creating or modifying product options and variants. You can also specifically manage product options through related mutations: - [`productOptionsCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsCreate) - [`productOptionUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionUpdate) - [`productOptionsReorder`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsReorder) - [`productOptionsDelete`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsDelete) Learn more about the [product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model) and [adding product data](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/add-data).

    POST /graphql.json

  • Write

    productVariantsBulkReorder

    Reorders multiple variants in a single product. This mutation can be called directly or via the bulkOperation.

    POST /graphql.json

  • Write

    productVariantsBulkUpdate

    Updates multiple [product variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) for a single [product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) in one operation. You can run this mutation directly or as part of a [bulk operation](https://shopify.dev/docs/api/usage/bulk-operations/imports) for large-scale catalog updates. Use the `productVariantsBulkUpdate` mutation to efficiently modify product variants—such as different sizes, colors, or materials—associated with an existing product. The mutation is helpful if you need to update a product's variants in bulk, such as importing from an external system. The mutation supports: - Updating variants with custom option values - Associating media (for example, images, videos, and 3D models) with the product or its variants - Handling complex product configurations > Note: > By default, stores have a limit of 2048 product variants for each product. After creating variants, you can make additional changes using the [`productSet`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productSet) mutation, which is used to perform multiple operations on products, such as creating or modifying product options and variants. You can also specifically manage product options through related mutations: - [`productOptionsCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsCreate) - [`productOptionUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionUpdate) - [`productOptionsReorder`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsReorder) - [`productOptionsDelete`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsDelete) Learn more about the [product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model) and [adding product data](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/add-data).

    POST /graphql.json

  • Write

    pubSubWebhookSubscriptionCreate (deprecated)

    Creates a webhook subscription that notifies your [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) when specific events occur in a shop. Webhooks push event data to your endpoint immediately when changes happen, eliminating the need for polling. This mutation configures webhook delivery to a Google Cloud Pub/Sub topic. You can filter events using [Shopify API search syntax](https://shopify.dev/docs/api/usage/search-syntax) to receive only relevant webhooks, control which data fields are included in webhook payloads, and specify metafield namespaces to include. > Note: > The Webhooks API version [configured in your app](https://shopify.dev/docs/apps/build/webhooks/subscribe/use-newer-api-version) determines the API version for webhook events. You can't specify it per 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.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe).

    POST /graphql.json

  • Write

    pubSubWebhookSubscriptionUpdate (deprecated)

    Updates a Google Cloud Pub/Sub 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.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe).

    POST /graphql.json

  • Write

    publicationCreate

    Creates a [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) that controls which [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) and [`Collection`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection) customers can access through a [`Catalog`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Catalog). ### When to create a publication Publications are **optional** for catalogs. Only create a publication if you need to control which products are visible in a specific catalog context. When a publication isn't associated with a catalog, product availability is determined by the sales channel. **Create a publication if you need to:** - Restrict product visibility to a subset of your inventory for a specific market or company location - Publish different product selections to different contexts **Do NOT create a publication if:** - You want product availability determined by the sales channel - You only need custom pricing (use a price list on the catalog instead) ### Configuration options You can create an empty publication and add products later, or prepopulate it with all existing products. The [`autoPublish`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/publicationCreate#arguments-input.fields.autoPublish) field determines whether the publication automatically adds newly created products.

    POST /graphql.json

  • Write

    publicationUpdate

    Updates a [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). You can add or remove [products](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) from the publication, with a maximum of 50 items per operation. The [`autoPublish`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/publicationUpdate#arguments-input.fields.autoPublish) field determines whether new products automatically display in this publication.

    POST /graphql.json

  • Write

    publishablePublish

    Publishes a resource, such as a [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) or [`Collection`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection), to one or more [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). For products to be visible in a channel, they must have an active [`ProductStatus`](https://shopify.dev/docs/api/admin-graphql/latest/enums/ProductStatus). Products sold exclusively on subscription (`requiresSellingPlan: true`) can only be published to online stores. You can schedule future publication by providing a publish date. Only online store channels support [scheduled publishing](https://shopify.dev/docs/apps/build/sales-channels/scheduled-product-publishing).

    POST /graphql.json

  • Write

    publishablePublishToCurrentChannel (deprecated)

    Publishes a resource to the current [`Channel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) associated with the requesting app. The system determines the current channel by the app's API client ID. Resources include [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) and [`Collection`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection) objects that implement the [`Publishable`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Publishable) interface. For products to be visible in the channel, they must have an active [`ProductStatus`](https://shopify.dev/docs/api/admin-graphql/latest/enums/ProductStatus). Products sold exclusively on subscription ([`requiresSellingPlan`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product#field-Product.fields.requiresSellingPlan): `true`) can only be published to online stores.

    POST /graphql.json

  • Write

    publishableUnpublish

    Unpublishes a resource, such as a [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) or [`Collection`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection), from one or more [publications](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). The resource remains in your store but becomes unavailable to customers. For products to be visible in a channel, they must have an active [`ProductStatus`](https://shopify.dev/docs/api/admin-graphql/latest/enums/ProductStatus).

    POST /graphql.json

  • Write

    publishableUnpublishToCurrentChannel (deprecated)

    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`.

    POST /graphql.json

  • Write

    quantityRulesAdd

    Creates or updates existing quantity rules on a price list. You can use the `quantityRulesAdd` mutation to set order level minimums, maximumums and increments for specific product variants.

    POST /graphql.json

  • Write

    refundCreate

    Creates a refund for an order, allowing you to process returns and issue payments back to customers. Use the `refundCreate` mutation to programmatically process refunds in scenarios where you need to return money to customers, such as when handling returns, processing chargebacks, or correcting order errors. The `refundCreate` mutation supports various refund scenarios: - Refunding line items with optional restocking - Refunding shipping costs - Refunding duties and import taxes - Refunding additional fees - Processing refunds through different payment methods - Issuing store credit refunds (when enabled) You can create both full and partial refunds, and optionally allow over-refunding in specific cases. After creating a refund, you can track its status and details through the order's [`refunds`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order#field-Order.fields.refunds) field. The refund is associated with the order and can be used for reporting and reconciliation purposes. Learn more about [managing returns](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/build-return-management) and [refunding duties](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/view-and-refund-duties). > Note: > The refunding behavior of the `refundCreate` mutation is similar to the [`returnRefund`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/returnRefund) mutation. The key difference is that the `refundCreate` mutation lets you to specify restocking behavior for line items, whereas the `returnRefund` mutation focuses solely on handling the financial refund without any restocking input. > Caution: > As of 2026-01, this mutation supports an optional idempotency key using the `@idempotent` directive. > As of 2026-04, the idempotency key is required and must be provided using the `@idempotent` directive. > For more information, see the [idempotency documentation](https://shopify.dev/docs/api/usage/idempotent-requests).

    POST /graphql.json

  • Write

    returnApproveRequest

    Approves a customer's return request. If this mutation is successful, then the `Return.status` field of the approved return is set to `OPEN`.

    POST /graphql.json

  • Write

    returnClose

    Indicates 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.

    POST /graphql.json

  • Write

    returnCreate

    Creates a return from an existing order that has at least one fulfilled [line item](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) that hasn't yet been refunded. If you create a return on an archived order, then the order is automatically unarchived. Use the `returnCreate` mutation when your workflow involves [approving](https://shopify.dev/docs/api/admin-graphql/latest/mutations/returnApproveRequest) or [declining](https://shopify.dev/docs/api/admin-graphql/latest/mutations/returnDeclineRequest) requested returns outside of the Shopify platform. The `returnCreate` mutation performs the following actions: - Creates a return in the `OPEN` state, and assumes that the return request from the customer has already been approved - Creates a [reverse fulfillment order](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/manage-reverse-fulfillment-orders), and enables you to create a [reverse delivery](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/manage-reverse-deliveries) for the reverse fulfillment order After you've created a return, use the [`return`](https://shopify.dev/docs/api/admin-graphql/latest/queries/return) query to retrieve the return by its ID. Learn more about providing a [return management workflow](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/build-return-management) for merchants.

    POST /graphql.json

  • Write

    returnDeclineRequest

    Declines a return on an order. When a return is declined, each `ReturnLineItem.fulfillmentLineItem` can be associated to a new return. Use the `ReturnCreate` or `ReturnRequest` mutation to initiate a new return.

    POST /graphql.json

  • Write

    returnProcess

    Processes a return by confirming which items customers return and exchange, handling their disposition, and optionally issuing refunds. This mutation confirms the quantities for [`ReturnLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ReturnLineItem) and [`ExchangeLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ExchangeLineItem) objects previously created on the [`Return`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Return). For returned items, you specify how to handle them through dispositions such as restocking or disposal. The mutation creates [`FulfillmentOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) objects for exchange items and records all transactions in the merchant's financial reports. You can optionally issue refunds through financial transfers, apply refund duties, and refund shipping costs. Learn more about [processing returns](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/build-return-management).

    POST /graphql.json

  • Write

    returnRefund (deprecated)

    Creates a refund for items being returned when the return status is `OPEN` or `CLOSED`. This mutation processes the financial aspects of a return by refunding line items, shipping costs, and duties back to the customer.

    POST /graphql.json

  • Write

    returnReopen

    Reopens a closed return.

    POST /graphql.json

  • Write

    returnRequest

    Creates 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. Use this mutation when customers initiate returns that need review. After creating a requested return, use [`returnApproveRequest`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/returnApproveRequest) to approve it or [`returnDeclineRequest`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/returnDeclineRequest) to decline it. For returns that should be immediately open for processing, use the [`returnCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/returnCreate) mutation instead. Learn more about [building return management workflows](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/build-return-management).

    POST /graphql.json

  • Write

    reverseDeliveryCreateWithShipping

    Creates a new reverse delivery with associated external shipping information.

    POST /graphql.json

  • Write

    reverseDeliveryShippingUpdate

    Updates a reverse delivery with associated external shipping information.

    POST /graphql.json

  • Write

    reverseFulfillmentOrderDispose

    Disposes reverse fulfillment order line items.

    POST /graphql.json

  • Write

    savedSearchCreate

    Creates a saved search.

    POST /graphql.json

  • Write

    savedSearchUpdate

    Updates a saved search.

    POST /graphql.json

  • Write

    scriptTagCreate

    <div class="note"><h4>Theme app extensions</h4> <p>If your app integrates with a Shopify theme and you plan to submit it to the Shopify App Store, you must use theme app extensions instead of Script tags. Script tags can only be used with vintage themes. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div> Creates a new script tag.

    POST /graphql.json

  • Write

    scriptTagUpdate

    <div class="note"><h4>Theme app extensions</h4> <p>If your app integrates with a Shopify theme and you plan to submit it to the Shopify App Store, you must use theme app extensions instead of Script tags. Script tags can only be used with vintage themes. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div> Updates a script tag.

    POST /graphql.json

  • Write

    segmentCreate

    Creates a segment.

    POST /graphql.json

  • Write

    segmentUpdate

    Updates a segment.

    POST /graphql.json

  • Write

    sellingPlanGroupAddProductVariants

    Adds multiple product variants to a selling plan group.

    POST /graphql.json

  • Write

    sellingPlanGroupAddProducts

    Adds multiple products to a selling plan group.

    POST /graphql.json

  • Write

    sellingPlanGroupCreate

    Creates 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 or more selling plans with specific billing, delivery, and pricing policies. Use the [`resources`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/sellingPlanGroupCreate#arguments-resources) argument to associate products or product variants with the group during creation. You can also add products later using [`sellingPlanGroupAddProducts`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/sellingPlanGroupAddProducts) or [`sellingPlanGroupAddProductVariants`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/sellingPlanGroupAddProductVariants). Learn more about [building selling plan groups](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans/build-a-selling-plan#step-1-create-a-selling-plan-group) or explore [examples of creating TBYB and other selling plan groups](https://shopify.dev/docs/api/admin-graphql/latest/mutations/sellingPlanGroupCreate?example=create-a-tbyb-selling-plan-group).

    POST /graphql.json

  • Write

    sellingPlanGroupUpdate

    Update a Selling Plan Group.

    POST /graphql.json

  • Write

    serverPixelCreate

    Creates a new unconfigured server pixel. A single server pixel can exist for an app and shop combination. If you call this mutation when a server pixel already exists, then an error will return.

    POST /graphql.json

  • Write

    shippingPackageMakeDefault

    Set a shipping package as the default. The default shipping package is the one used to calculate shipping costs on checkout.

    POST /graphql.json

  • Write

    shippingPackageUpdate

    Updates a shipping package.

    POST /graphql.json

  • Write

    shopLocaleEnable

    Adds a locale for a shop. The newly added locale is in the unpublished state.

    POST /graphql.json

  • Write

    shopLocaleUpdate

    Updates a locale for a shop.

    POST /graphql.json

  • Write

    shopPolicyUpdate

    Updates a shop policy.

    POST /graphql.json

  • Write

    shopResourceFeedbackCreate

    The `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 connect their marketplace account by signing in. Resource feedback notifications are displayed to the merchant on the home screen of their Shopify admin, and in the product details view for any products that are published to your app. This resource should be used only in cases where you're describing steps that a merchant is required to complete. If your app offers optional or promotional set-up steps, or if it makes recommendations, then don't use resource feedback to let merchants know about them. ## Sending feedback on a shop You can send resource feedback on a shop to let the merchant know what steps they need to take to make sure that your app is set up correctly. Feedback can have one of two states: `REQUIRES_ACTION` or `ACCEPTED`. You need to send a `REQUIRES_ACTION` feedback request for each step that the merchant is required to complete. If there are multiple set-up steps that require merchant action, then send feedback with a state of `REQUIRES_ACTION` as merchants complete prior steps. When all required actions are resolved, send an `ACCEPTED` feedback request to clear the active feedback signal. ### Clearing feedback with ACCEPTED Sending `state: ACCEPTED` removes the active feedback entry. After this mutation succeeds, reading `channel.resourceFeedback`, `app.feedback`, or the `feedback` field on this payload may return `null`—this is expected behavior, not a mutation failure. A `null` result means no outstanding feedback exists for the channel. ### Important Sending feedback replaces previously sent feedback for the shop. Send a new `shopResourceFeedbackCreate` mutation to push the latest state of a shop or its resources to Shopify.

    POST /graphql.json

  • Write

    shopifyPaymentsPayoutAlternateCurrencyCreate

    Creates an alternate currency payout for a Shopify Payments account.

    POST /graphql.json

  • Write

    stagedUploadTargetGenerate (deprecated)

    Generates the URL and signed paramaters needed to upload an asset to Shopify.

    POST /graphql.json

  • Write

    stagedUploadTargetsGenerate (deprecated)

    Uploads multiple images.

    POST /graphql.json

  • Write

    stagedUploadsCreate

    Creates staged upload targets for file uploads such as images, videos, and 3D models. Use the `stagedUploadsCreate` mutation instead of direct file creation mutations when: - **Uploading large files**: Files over a few MB benefit from staged uploads for better reliability - **Uploading media files**: Videos, 3D models, and high-resolution images - **Bulk importing**: CSV files, product catalogs, or other bulk data - **Using external file sources**: When files are stored remotely and need to be transferred to Shopify The `stagedUploadsCreate` mutation is the first step in Shopify's secure two-step upload process: **Step 1: Create staged upload targets** (this mutation) - Generate secure, temporary upload URLs for your files. - Receive authentication parameters for the upload. **Step 2: Upload files and create assets** - Upload your files directly to the provided URLs using the authentication parameters. - Use the returned `resourceUrl` as the `originalSource` in subsequent mutations like `fileCreate`. This approach provides better performance for large files, handles network interruptions gracefully, and ensures secure file transfers to Shopify's storage infrastructure. > Note: > File size is required when uploading > [`VIDEO`](https://shopify.dev/docs/api/admin-graphql/latest/enums/StagedUploadTargetGenerateUploadResource#enums-VIDEO) or > [`MODEL_3D`](https://shopify.dev/docs/api/admin-graphql/latest/enums/StagedUploadTargetGenerateUploadResource#enums-MODEL_3D) > resources. After creating staged upload targets, complete the process by: 1. **Uploading files**: Send your files to the returned [`url`](https://shopify.dev/docs/api/admin-graphql/latest/objects/StagedMediaUploadTarget#field-StagedMediaUploadTarget.fields.url) using the provided [`parameters`](https://shopify.dev/docs/api/admin-graphql/latest/objects/StagedMediaUploadTarget#field-StagedMediaUploadTarget.fields.parameters) for authentication 2. **Creating file assets**: Use the [`resourceUrl`](https://shopify.dev/docs/api/admin-graphql/latest/objects/StagedMediaUploadTarget#field-StagedMediaUploadTarget.fields.resourceUrl) as the `originalSource` in mutations such as: - [`fileCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fileCreate): Creates file assets from staged uploads - [`productUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productUpdate): Updates products with new media from staged uploads Learn more about [uploading media to Shopify](https://shopify.dev/apps/online-store/media/products).

    POST /graphql.json

  • Write

    standardMetafieldDefinitionEnable

    Activates the specified standard metafield definition from its template. Refer to the [list of standard metafield definition templates](https://shopify.dev/apps/metafields/definitions/standard-definitions).

    POST /graphql.json

  • Write

    standardMetaobjectDefinitionEnable

    Enables the specified standard metaobject definition from its template.

    POST /graphql.json

  • Write

    storeCreditAccountCredit

    Adds funds to a [`StoreCreditAccount`](https://shopify.dev/docs/api/admin-graphql/latest/objects/StoreCreditAccount) by creating a [`StoreCreditAccountCreditTransaction`](https://shopify.dev/docs/api/admin-graphql/latest/objects/StoreCreditAccountCreditTransaction). The mutation accepts either a store credit account ID, a [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) ID, or a [`CompanyLocation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocation) ID. When you provide a customer or company location ID, it automatically creates an account if one doesn't exist for the specified currency. Store credit accounts are currency-specific. A single owner can have multiple accounts, each holding a different currency. Use the most appropriate currency for the given store credit account owner. Credits can optionally include an expiration date.

    POST /graphql.json

  • Write

    storeCreditAccountDebit

    Creates a debit transaction that decreases the store credit account balance by the given amount.

    POST /graphql.json

  • Write

    storefrontAccessTokenCreate

    Creates a storefront access token that delegates unauthenticated access scopes to clients using the [Storefront API](https://shopify.dev/docs/api/storefront). The token provides public access to storefront resources without requiring customer authentication. Each shop can have up to 100 active [`StorefrontAccessToken`](https://shopify.dev/docs/api/admin-graphql/latest/objects/StorefrontAccessToken) objects. Headless storefronts, mobile apps, and other client applications typically use these tokens to access public storefront data. Learn more about [building with the Storefront API](https://shopify.dev/docs/storefronts/headless/building-with-the-storefront-api/getting-started).

    POST /graphql.json

  • Write

    subscriptionBillingAttemptCreate

    Creates a billing attempt to charge for a [`SubscriptionContract`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract). The mutation processes either the payment for the current billing cycle or for a specific cycle, if selected. The mutation creates an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) when successful. Failed billing attempts include a [`processingError`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionBillingAttemptCreate#returns-subscriptionBillingAttempt.fields.processingError) field with error details. > Tip: > Use the [`idempotencyKey`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionBillingAttemptCreate#arguments-subscriptionBillingAttemptInput.fields.idempotencyKey) to ensure the billing attempt executes only once, preventing duplicate charges if the request is retried. You can target a specific billing cycle using the [`billingCycleSelector`](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/SubscriptionBillingCycleSelector) to bill past or future cycles. The [`originTime`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingAttempt#field-SubscriptionBillingAttempt.fields.originTime) parameter adjusts fulfillment scheduling for attempts completed after the expected billing date. Learn more about [creating billing attempts](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts/build-a-subscription-contract#step-4-create-a-billing-attempt).

    POST /graphql.json

  • Write

    subscriptionBillingCycleBulkCharge

    Asynchronously queries and charges all subscription billing cycles whose [billingAttemptExpectedDate](https://shopify.dev/api/admin-graphql/latest/objects/SubscriptionBillingCycle#field-billingattemptexpecteddate) values fall within a specified date range and meet additional filtering criteria. The results of this action can be retrieved using the [subscriptionBillingCycleBulkResults](https://shopify.dev/api/admin-graphql/latest/queries/subscriptionBillingCycleBulkResults) query.

    POST /graphql.json

  • Write

    subscriptionBillingCycleBulkSearch

    Asynchronously queries all subscription billing cycles whose [billingAttemptExpectedDate](https://shopify.dev/api/admin-graphql/latest/objects/SubscriptionBillingCycle#field-billingattemptexpecteddate) values fall within a specified date range and meet additional filtering criteria. The results of this action can be retrieved using the [subscriptionBillingCycleBulkResults](https://shopify.dev/api/admin-graphql/latest/queries/subscriptionBillingCycleBulkResults) query.

    POST /graphql.json

  • Write

    subscriptionBillingCycleCharge

    Creates a new subscription billing attempt for a specified billing cycle. This is the alternative mutation for [subscriptionBillingAttemptCreate](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionBillingAttemptCreate). For more information, refer to [Create a subscription contract](https://shopify.dev/docs/apps/selling-strategies/subscriptions/contracts/create#step-4-create-a-billing-attempt).

    POST /graphql.json

  • Write

    subscriptionBillingCycleContractDraftCommit

    Commits the updates of a Subscription Billing Cycle Contract draft. Commits are rate limited per subscription contract across all apps on the store. If you exceed the limit, then the mutation returns a top-level `THROTTLED` error and doesn't commit. Wait before you retry.

    POST /graphql.json

  • Write

    subscriptionBillingCycleContractDraftConcatenate

    Concatenates a contract to a Subscription Draft.

    POST /graphql.json

  • Write

    subscriptionBillingCycleContractEdit

    Edit the contents of a subscription contract for the specified billing cycle.

    POST /graphql.json

  • Write

    subscriptionBillingCycleScheduleEdit

    Modify the schedule of a specific billing cycle.

    POST /graphql.json

  • Write

    subscriptionBillingCycleSkip

    Skips a Subscription Billing Cycle.

    POST /graphql.json

  • Write

    subscriptionBillingCycleUnskip

    Unskips a Subscription Billing Cycle.

    POST /graphql.json

  • Write

    subscriptionContractActivate

    Activates a Subscription Contract. Contract status must be either active, paused, or failed.

    POST /graphql.json

  • Write

    subscriptionContractAtomicCreate

    Creates a Subscription Contract.

    POST /graphql.json

  • Write

    subscriptionContractCreate (deprecated)

    Creates a subscription contract draft, which is an intention to create a new subscription. The draft lets you incrementally build and modify subscription details before committing them to create the actual [`SubscriptionContract`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract). The mutation requires [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) information, billing details, and contract configuration including the [`SubscriptionBillingPolicy`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionBillingPolicy) and [`SubscriptionDeliveryPolicy`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionDeliveryPolicy). You can specify the [`CustomerPaymentMethod`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerPaymentMethod), the [`MailingAddress`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) for shipping, and subscription intervals. After you create the draft, you can either modify it with the [`subscriptionDraftUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionDraftUpdate) mutation or finalize and create the active subscription contract with [`subscriptionDraftCommit`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionDraftCommit). This mutation and the draft-based flow are deprecated in favor of the [SubscriptionContractCalculation API](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts/migrate-to-subscription-calculation-api). Learn more about [building subscription contracts](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts/build-a-subscription-contract).

    POST /graphql.json

  • Write

    subscriptionContractExpire

    Expires a Subscription Contract.

    POST /graphql.json

  • Write

    subscriptionContractFail

    Fails a Subscription Contract.

    POST /graphql.json

  • Write

    subscriptionContractPause

    Pauses a Subscription Contract.

    POST /graphql.json

  • Write

    subscriptionContractProductChange

    Allows for the easy change of a Product in a Contract or a Product price change. Changes are rate limited per subscription contract across all apps on the store. If you exceed the limit, then the mutation returns a top-level `THROTTLED` error and doesn't change the contract. Wait before you retry.

    POST /graphql.json

  • Write

    subscriptionContractSetNextBillingDate

    Sets the next billing date of a Subscription Contract. This field is managed by the apps. Alternatively you can utilize our [Billing Cycles APIs](https://shopify.dev/docs/apps/selling-strategies/subscriptions/billing-cycles), which provide auto-computed billing dates and additional functionalities.

    POST /graphql.json

  • Write

    subscriptionContractUpdate (deprecated)

    Creates a draft of an existing [`SubscriptionContract`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContract). The draft captures the current state of the contract and allows incremental modifications through draft mutations such as [`subscriptionDraftLineAdd`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionDraftLineAdd), [`subscriptionDraftDiscountAdd`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionDraftDiscountAdd), and [`subscriptionDraftUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionDraftUpdate). Changes remain in draft state and don't affect the live contract until committed. After you've made all necessary changes to the draft, commit it using [`subscriptionDraftCommit`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/subscriptionDraftCommit) to apply the updates to the original contract. This mutation and the draft-based edit flow are deprecated in favor of the [SubscriptionContractCalculation API](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts/migrate-to-subscription-calculation-api). Learn more about [updating subscription contracts](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/contracts/update-a-subscription-contract#step-2-create-a-draft-of-an-existing-contract).

    POST /graphql.json

  • Write

    subscriptionDraftCommit (deprecated)

    Commits the updates of a Subscription Contract draft. Commits are rate limited per subscription contract across all apps on the store. If you exceed the limit, then the mutation returns a top-level `THROTTLED` error and doesn't commit. Wait before you retry.

    POST /graphql.json

  • Write

    subscriptionDraftDiscountAdd (deprecated)

    Adds a subscription discount to a subscription draft.

    POST /graphql.json

  • Write

    subscriptionDraftDiscountCodeApply (deprecated)

    Applies a code discount on the subscription draft.

    POST /graphql.json

  • Write

    subscriptionDraftDiscountUpdate (deprecated)

    Updates a subscription discount on a subscription draft.

    POST /graphql.json

  • Write

    subscriptionDraftFreeShippingDiscountAdd (deprecated)

    Adds a subscription free shipping discount to a subscription draft.

    POST /graphql.json

  • Write

    subscriptionDraftFreeShippingDiscountUpdate (deprecated)

    Updates a subscription free shipping discount on a subscription draft.

    POST /graphql.json

  • Write

    subscriptionDraftLineAdd (deprecated)

    Adds a subscription line to a subscription draft.

    POST /graphql.json

  • Write

    subscriptionDraftLineUpdate (deprecated)

    Updates a subscription line on a subscription draft.

    POST /graphql.json

  • Write

    subscriptionDraftUpdate (deprecated)

    Updates a Subscription Draft.

    POST /graphql.json

  • Write

    tagsAdd

    Adds tags to a resource. If the resource type doesn't support tagging, the `id` argument returns a resource-not-found error. Tags help merchants organize and filter resources. See the [`tags`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/tagsAdd#arguments-tags) argument for supported input formats. Learn more about [using tags to organize subscription orders](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/fulfillments/sync-orders-subscriptions#order-tagging).

    POST /graphql.json

  • Write

    taxAppConfigure

    Allows tax app configurations for tax partners.

    POST /graphql.json

  • Write

    taxSummaryCreate

    Creates a tax summary for a given order. If both an order ID and a start and end time are provided, the order ID will be used.

    POST /graphql.json

  • Write

    themeCreate

    Creates 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`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/stageduploadscreate) mutation. The theme displays in the [Themes page](https://admin.shopify.com/themes) in the Shopify admin. New themes have an [`UNPUBLISHED`](https://shopify.dev//docs/api/admin-graphql/latest/mutations/themeCreate#arguments-role.enums.UNPUBLISHED) role by default. You can optionally specify a [`DEVELOPMENT`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/themeCreate#arguments-role.enums.DEVELOPMENT) role for temporary themes used during development.

    POST /graphql.json

  • Write

    themeDuplicate

    Duplicates a theme.

    POST /graphql.json

  • Write

    themeFilesUpsert

    Creates 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. > Note: You can process a maximum of 50 files in a single request. Each file requires a filename and body content. The body must specify a [`type`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/themeFilesUpsert#arguments-files.fields.body.type) with the corresponding [`value`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/themeFilesUpsert#arguments-files.fields.body.value). The mutation returns a [`job`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/themeFilesUpsert#returns-job) field for tracking asynchronous operations and an [`upsertedThemeFiles`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/themeFilesUpsert#returns-upsertedThemeFiles) field with details about the processed files.

    POST /graphql.json

  • Write

    themePublish

    Publishes a theme.

    POST /graphql.json

  • Write

    themeUpdate

    Updates a theme.

    POST /graphql.json

  • Write

    transactionVoid

    Trigger the voiding of an uncaptured authorization transaction.

    POST /graphql.json

  • Write

    translationsRegister

    Creates or updates translations for a resource's [translatable content](https://shopify.dev/docs/api/admin-graphql/latest/objects/TranslatableContent). Each translation requires a digest value from the resource's translatable content. Use the [`translatableResource`](https://shopify.dev/docs/api/admin-graphql/latest/queries/translatableResource) query to get a resource's translatable content and digest values before creating translations. You can optionally scope translations to specific markets using the `marketId` field in each translation input. Learn more about [managing translations](https://shopify.dev/docs/apps/build/markets/manage-translated-content).

    POST /graphql.json

  • Write

    urlRedirectCreate

    Creates a [`UrlRedirect`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object.

    POST /graphql.json

  • Write

    urlRedirectImportCreate

    Creates a [`UrlRedirectImport`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirectImport) object. After creating the `UrlRedirectImport` object, the `UrlRedirectImport` request can be performed using the [`urlRedirectImportSubmit`](https://shopify.dev/api/admin-graphql/latest/mutations/urlRedirectImportSubmit) mutation.

    POST /graphql.json

  • Write

    urlRedirectImportSubmit

    Submits a `UrlRedirectImport` request to be processed. The `UrlRedirectImport` request is first created with the [`urlRedirectImportCreate`](https://shopify.dev/api/admin-graphql/latest/mutations/urlRedirectImportCreate) mutation.

    POST /graphql.json

  • Write

    urlRedirectUpdate

    Updates a URL redirect.

    POST /graphql.json

  • Write

    validationCreate

    Creates a cart and checkout validation: a server-side rule enforced before a customer can complete checkout. Each validation is powered by a cart and checkout validation function that you provide using `functionId` or `functionHandle`. Use `validationCreate` to apply custom rules at checkout, such as limiting item quantities, enforcing order minimums or maximums, or blocking checkout for restricted shipping addresses. Validations run on Shopify's servers and are enforced throughout checkout, so they can't be bypassed by the client. Validation errors always block checkout progress. The `blockOnFailure` field controls whether runtime exceptions, such as timeouts, also block checkout.

    POST /graphql.json

  • Write

    validationUpdate

    Updates a cart and checkout validation. Use `validationUpdate` to rename it, toggle whether it's enabled at checkout, change its `blockOnFailure` behavior, or update its metafields. Validation errors always block checkout progress. The `blockOnFailure` field controls whether runtime exceptions, such as timeouts, also block checkout.

    POST /graphql.json

  • Write

    webPixelCreate

    Activate a [web pixel extension](https://shopify.dev/docs/apps/build/marketing-analytics/build-web-pixels) by creating a web pixel record on the store where you installed your app. When you run the `webPixelCreate` mutation, Shopify validates it against the settings definition in `shopify.extension.toml`. If the `settings` input field doesn't match the schema that you defined, then the mutation fails. Learn how to define [web pixel settings](https://shopify.dev/docs/apps/build/marketing-analytics/build-web-pixels#step-2-define-your-web-pixel-settings).

    POST /graphql.json

  • Write

    webPixelUpdate

    Activate a [web pixel extension](https://shopify.dev/docs/apps/build/marketing-analytics/build-web-pixels) by updating a web pixel record on the store where you installed your app. When you run the `webPixelUpdate` mutation, Shopify validates it against the settings definition in `shopify.extension.toml`. If the `settings` input field doesn't match the schema that you defined, then the mutation fails. Learn how to define [web pixel settings](https://shopify.dev/docs/apps/build/marketing-analytics/build-web-pixels#step-2-define-your-web-pixel-settings).

    POST /graphql.json

  • Write

    webPresenceCreate

    Creates a web presence.

    POST /graphql.json

  • Write

    webPresenceUpdate

    Updates a web presence.

    POST /graphql.json

  • Write

    webhookSubscriptionCreate

    Creates a webhook subscription that notifies your [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) when specific events occur in a shop. Webhooks push event data to your endpoint immediately when changes happen, eliminating the need for polling. The subscription configuration supports multiple endpoint types including HTTPS URLs, Google Pub/Sub topics, and AWS EventBridge event sources. You can filter events using [Shopify API search syntax](https://shopify.dev/docs/api/usage/search-syntax) to receive only relevant webhooks, control which data fields are included in webhook payloads, and specify metafield namespaces to include. > Note: > The Webhooks API version [configured in your app](https://shopify.dev/docs/apps/build/webhooks/subscribe/use-newer-api-version) determines the API version for webhook events. You can't specify it per 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.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe).

    POST /graphql.json

  • Write

    webhookSubscriptionUpdate

    Updates a webhook subscription's configuration. Modify the endpoint URL, event filters, included fields, or metafield namespaces without recreating the subscription. The mutation accepts a [`WebhookSubscriptionInput`](https://shopify.dev/docs/api/admin-graphql/latest/input-objects/WebhookSubscriptionInput) that specifies the new configuration. You can switch between endpoint types (HTTP, Pub/Sub, EventBridge) by providing a different URI format. Updates apply atomically without interrupting webhook delivery. Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe).

    POST /graphql.json

  • Destructive

    appRevokeAccessScopes

    Revokes previously granted access scopes from an app installation, allowing merchants to reduce an app's permissions without completely uninstalling it. This provides granular control over what data and functionality apps can access. For example, if a merchant no longer wants an app to access customer information but still wants to use its inventory features, they can revoke the customer-related scopes while keeping inventory permissions active. Use the `appRevokeAccessScopes` mutation to: - Remove specific permissions from installed apps - Maintain app functionality while minimizing data exposure The mutation returns details about which scopes were successfully revoked and any errors that prevented certain permissions from being removed. Learn more about [managing app permissions](https://shopify.dev/docs/apps/build/authentication-authorization/app-installation/manage-access-scopes#revoke-granted-scopes-dynamically).

    POST /graphql.json

  • Destructive

    appSubscriptionCancel

    Cancels an active app subscription, stopping future billing cycles. The cancellation behavior depends on the `replacementBehavior` setting - it can either disable auto-renewal (allowing the subscription to continue until the end of the current billing period) or immediately cancel with prorated refunds. When a merchant decides to discontinue using subscription features, this mutation provides a clean cancellation workflow that respects billing periods and merchant expectations. Use the `AppSubscriptionCancel` mutation to: - Process merchant-initiated subscription cancellations - Terminate subscriptions due to policy violations or account issues - Handle subscription cancellations during app uninstallation workflows The cancellation timing and merchant access depends on the `replacementBehavior` setting and the app's specific implementation of subscription management. For subscription lifecycle management and cancellation best practices, consult the [subscription management guide](https://shopify.dev/docs/apps/launch/billing/subscription-billing).

    POST /graphql.json

  • Destructive

    appUninstall

    Uninstalls an [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) from a shop. Apps use this mutation to uninstall themselves programmatically, removing their [`AppInstallation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppInstallation) from the merchant's store. When an app uninstalls, Shopify automatically performs cleanup tasks, such as deleting [`WebhookSubscription`](https://shopify.dev/docs/api/admin-graphql/latest/objects/WebhookSubscription) objects and [admin links](https://shopify.dev/docs/apps/build/admin/admin-links) associated with the app. Learn more about [app lifecycle management](https://shopify.dev/docs/apps/build/authentication-authorization/app-installation/uninstall-app-api-request). > Caution: > This action is irreversible. You can't restore an uninstalled app's configuration or data. Before you uninstall an app, make sure that you no longer need to make API calls for the store in which the app has been installed.

    POST /graphql.json

  • Destructive

    articleDelete

    Permanently deletes a blog article from a shop's blog. This mutation removes the article and all associated metadata. For example, when outdated product information or seasonal content needs removal, merchants can use this mutation to clean up their blog. Use the `articleDelete` mutation to: - Remove outdated or incorrect blog content - Clean up seasonal or time-sensitive articles - Maintain blog organization The deletion is permanent and returns the deleted article's ID for confirmation.

    POST /graphql.json

  • Destructive

    blogDelete

    Permanently deletes a blog from a shop. This mutation removes the blog container and its organizational structure. For example, when consolidating multiple seasonal blogs into a single year-round content strategy, merchants can use this mutation to remove unused blogs. Use the `blogDelete` mutation to: - Remove unused or outdated blogs - Consolidate content organization - Clean up blog structure The deletion is permanent and returns the deleted blog's ID for confirmation.

    POST /graphql.json

  • Destructive

    bulkOperationCancel

    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.

    POST /graphql.json

  • Destructive

    carrierServiceDelete

    Removes an existing carrier service.

    POST /graphql.json

  • Destructive

    cartTransformDelete

    Removes 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).

    POST /graphql.json

  • Destructive

    cashManagementReasonCodeDelete

    Deletes a cash management reason code.

    POST /graphql.json

  • Destructive

    catalogDelete

    Delete a catalog.

    POST /graphql.json

  • Destructive

    channelDelete

    Deletes a [`Channel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) from the shop. All associated product feeds are removed. Existing orders attributed to the channel are preserved. The channel must have been created via [`channelCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/channelCreate).

    POST /graphql.json

  • Destructive

    collectionDelete

    Deletes 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. For example, when merchants discontinue seasonal promotions or reorganize their catalog structure, they can delete outdated collections like "Back to School 2023" to keep their store organized. Use `CollectionDelete` to: - Remove outdated or unused collections from stores - Clean up collection structures during catalog reorganization - Implement collection management tools with deletion capabilities Products within the deleted collection remain in the store but are no longer grouped under that collection. Learn more about [collection management](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection).

    POST /graphql.json

  • Destructive

    collectionRemoveProducts (deprecated)

    Removes multiple manually included products from a collection in a single operation. This mutation can process large product sets (up to 250 products) and may take significant time to complete for collections with many products. For example, when ending a seasonal promotion, merchants can remove all sale items from a "Summer Clearance" collection at once rather than editing each product individually. Use `CollectionRemoveProducts` to: - Bulk-remove products from collections efficiently - Clean up collection membership during catalog updates - Implement automated collection management workflows The operation processes asynchronously to avoid timeouts and performance issues, especially for large product sets. Learn more about [collection management](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection).

    POST /graphql.json

  • Destructive

    commentDelete

    Permanently 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. Use the `commentDelete` mutation to: - Remove spam or inappropriate comments permanently - Clean up irrelevant discussions - Maintain content standards on blog articles Deletion is permanent and can't be undone.

    POST /graphql.json

  • Destructive

    companiesDelete

    Deletes a list of companies.

    POST /graphql.json

  • Destructive

    companyAddressDelete

    Deletes a company address.

    POST /graphql.json

  • Destructive

    companyContactDelete

    Deletes a company contact.

    POST /graphql.json

  • Destructive

    companyContactRemoveFromCompany

    Removes a company contact from a Company.

    POST /graphql.json

  • Destructive

    companyContactRevokeRole

    Revokes a role on a company contact.

    POST /graphql.json

  • Destructive

    companyContactRevokeRoles

    Revokes roles on a company contact.

    POST /graphql.json

  • Destructive

    companyContactsDelete

    Deletes one or more company contacts.

    POST /graphql.json

  • Destructive

    companyDelete

    Deletes a company.

    POST /graphql.json

  • Destructive

    companyLocationDelete

    Deletes a company location.

    POST /graphql.json

  • Destructive

    companyLocationRemoveStaffMembers

    Deletes one or more existing mappings between a staff member at a shop and a company location.

    POST /graphql.json

  • Destructive

    companyLocationRevokeRoles

    Revokes roles on a company location.

    POST /graphql.json

  • Destructive

    companyLocationRevokeTaxExemptions (deprecated)

    Revokes tax exemptions from the company location.

    POST /graphql.json

  • Destructive

    companyLocationRevokeTaxRegistration (deprecated)

    Revokes tax registration on a company location.

    POST /graphql.json

  • Destructive

    companyLocationsDelete

    Deletes a list of company locations.

    POST /graphql.json

  • Destructive

    companyRevokeMainContact

    Revokes the main contact from the company.

    POST /graphql.json

  • Destructive

    customerAddressDelete

    Deletes a customer's address.

    POST /graphql.json

  • Destructive

    customerDelete

    Deletes a [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) from the store. You can only delete customers who haven't placed any [orders](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order). Apps using protected customer data must meet Shopify's [protected customer data requirements](https://shopify.dev/docs/apps/launch/protected-customer-data#requirements).

    POST /graphql.json

  • Destructive

    customerPaymentMethodRevoke

    Revokes a customer's vaulted payment method, preventing it from being used for future charges such as subscriptions, draft orders, or other payments. Revocation will fail if the payment method has active subscription contracts. Use this when a customer requests removal of their stored payment information or when a payment method is no longer valid.

    POST /graphql.json

  • Destructive

    customerRemoveTaxExemptions

    Remove tax exemptions from a customer.

    POST /graphql.json

  • Destructive

    customerRequestDataErasure

    Enqueues a request to erase customer's data. Read more [here](https://help.shopify.com/manual/privacy-and-security/privacy/processing-customer-data-requests#erase-customer-personal-data). To cancel the data erasure request use the [customerCancelDataErasure mutation](https://shopify.dev/api/admin-graphql/unstable/mutations/customerCancelDataErasure).

    POST /graphql.json

  • Destructive

    delegateAccessTokenDestroy

    Destroys a delegate access token.

    POST /graphql.json

  • Destructive

    deliveryCustomizationDelete

    Creates a delivery customization.

    POST /graphql.json

  • Destructive

    deliveryProfileRemove

    Enqueue the removal of a delivery profile.

    POST /graphql.json

  • Destructive

    discountAutomaticBulkDelete

    Deletes multiple automatic discounts in a single operation, providing efficient bulk management for stores with extensive discount catalogs. This mutation processes deletions asynchronously to handle large volumes without blocking other operations. For example, when cleaning up expired seasonal promotions or removing outdated automatic discounts across product categories, merchants can delete dozens of discounts simultaneously rather than processing each individually. Use `DiscountAutomaticBulkDelete` to: - Remove multiple automatic discounts efficiently - Clean up expired or obsolete promotions - Streamline discount management workflows - Process large-scale discount removals asynchronously The operation returns a job object for tracking deletion progress and any validation errors encountered during processing. Learn more about [discount management](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountAutomatic).

    POST /graphql.json

  • Destructive

    discountAutomaticDelete

    Deletes an existing automatic discount from the store, permanently removing it from all future order calculations. This mutation provides a clean way to remove promotional campaigns that are no longer needed. For example, when a seasonal promotion ends or a flash sale concludes, merchants can use this mutation to ensure the discount no longer applies to new orders while preserving historical order data. Use `DiscountAutomaticDelete` to: - Remove expired promotional campaigns - Clean up test discounts during development - Delete automatic discounts that conflict with new promotions - Maintain a clean discount configuration The mutation returns the ID of the deleted discount for confirmation and any validation errors if the deletion cannot be completed. Once deleted, the automatic discount will no longer appear in discount lists or apply to new customer orders.

    POST /graphql.json

  • Destructive

    discountBulkTagsRemove

    Removes tags from multiple [discounts](https://help.shopify.com/manual/discounts/discount-types) 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 criteria, or delete tags from a predefined set of price rules.

    POST /graphql.json

  • Destructive

    discountCodeBulkDelete

    Deletes multiple [code-based discounts](https://help.shopify.com/manual/discounts/discount-types#discount-codes) 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 search criteria, or delete a predefined set of discount codes.

    POST /graphql.json

  • Destructive

    discountCodeDelete

    Removes a code discount from the store, making it permanently unavailable for customer use. This mutation provides a clean way to eliminate discount codes that are no longer needed or have been replaced. For example, when a seasonal promotion ends or a discount code has been compromised, merchants can delete it entirely rather than just deactivating it, ensuring customers cannot attempt to use expired promotional codes. Use `DiscountCodeDelete` to: - persistently remove outdated promotional codes - Clean up discount code lists after campaigns end - Eliminate compromised or leaked discount codes - Maintain organized discount management Once deleted, the discount code cannot be recovered and any customer attempts to use it will fail. This differs from deactivation, which preserves the code for potential future reactivation.

    POST /graphql.json

  • Destructive

    discountCodeRedeemCodeBulkDelete

    Asynchronously delete [discount codes](https://help.shopify.com/manual/discounts/discount-types#discount-codes) in bulk that customers can use to redeem a discount.

    POST /graphql.json

  • Destructive

    draftOrderBulkDelete

    Deletes multiple draft orders.

    POST /graphql.json

  • Destructive

    draftOrderBulkRemoveTags

    Removes tags from multiple draft orders.

    POST /graphql.json

  • Destructive

    draftOrderDelete

    Deletes a draft order.

    POST /graphql.json

  • Destructive

    eventBridgeServerPixelUpdate

    Updates the server pixel to connect to an EventBridge endpoint. Running this mutation deletes any previous subscriptions for the server pixel.

    POST /graphql.json

  • Destructive

    fileDelete

    Deletes file assets that were previously uploaded to your store. Use the `fileDelete` mutation to permanently remove media and file assets from your store when they are no longer needed. This mutation handles the complete removal of files from both your store's file library and any associated references to products or other resources. The `fileDelete` mutation supports removal of multiple file types: - **Images**: Product photos, variant images, and general store imagery - **Videos**: Shopify-hosted videos for product demonstrations and marketing content - **External Videos**: YouTube and Vimeo videos linked to your products - **3D models**: Interactive 3D representations of products - **Generic files**: PDFs, documents, and other file types stored in your [**Files** page](https://shopify.com/admin/settings/files) When you delete files that are referenced by products, the mutation automatically removes those references and reorders any remaining media to maintain proper positioning. Product file references are database relationships managed through a media reference system, not just links in product descriptions. The Shopify admin provides a UI to manage these relationships, and when files are deleted, the system automatically cleans up all references. Files that are currently being processed by other operations are rejected to prevent conflicts. > Caution: > File deletion is permanent and can't be undone. When you delete a file that's being used in your store, > it will immediately stop appearing wherever it was displayed. For example, if you delete a product image, > that product will show a broken image or placeholder on your storefront and in the admin. The same applies > to any other files linked from themes, blog posts, or pages. Before deleting files, you can use the > [`files` query](https://shopify.dev/api/admin-graphql/latest/queries/files) to list and review > your store's file assets. Learn how to manage [product media and file assets](https://shopify.dev/docs/apps/build/online-store/product-media) in your app.

    POST /graphql.json

  • Destructive

    fileUpdate

    Updates properties, content, and metadata associated with an existing file asset that has already been uploaded to Shopify. Use the `fileUpdate` mutation to modify various aspects of files already stored in your store. Files can be updated individually or in batches. The `fileUpdate` mutation supports updating multiple file properties: - **Alt text**: Update accessibility descriptions for images and other media. - **File content**: Replace image or generic file content while maintaining the same URL. - **Filename**: Modify file names (extension must match the original). - **Product references**: Add or remove associations between files and products. Removing file-product associations deletes the file from the product's media gallery and clears the image from any product variants that were using it. The mutation handles different file types with specific capabilities: - **Images**: Update preview images, original source, filename, and alt text. - **Generic files**: Update original source, filename, and alt text. - **Videos and 3D models**: Update alt text and product references. > Note: > Files must be in `ready` state before they can be updated. The mutation includes file locking to prevent > conflicts during updates. You can't simultaneously update both `originalSource` and `previewImageSource`. After updating files, you can use related mutations for additional file management: - [`fileCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fileCreate): Create new file assets from external URLs or staged uploads. - [`fileDelete`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/fileDelete): Remove files from your store when they are no longer needed. Learn how to manage [product media and file assets](https://shopify.dev/docs/apps/build/online-store/product-media) in your app.

    POST /graphql.json

  • Destructive

    fulfillmentCancel

    Cancels an existing [`Fulfillment`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Fulfillment) and reverses its effects on associated [`FulfillmentOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) objects. When you cancel a fulfillment, the system creates new fulfillment orders for the cancelled items so they can be fulfilled again. The cancellation affects fulfillment orders differently based on their fulfillment status. If a fulfillment order was entirely fulfilled, then it automatically closes. If a fulfillment order is partially fulfilled, then the remaining quantities adjust to include the cancelled items. The system creates new fulfillment orders at the original [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) when items are still stocked there, or at alternative locations based on the store's fulfillment priority settings. Learn more about [canceling fulfillments](https://shopify.dev/docs/apps/build/orders-fulfillment/fulfillment-service-apps/build-for-fulfillment-services#step-7-cancel-a-fulfillment).

    POST /graphql.json

  • Destructive

    fulfillmentConstraintRuleDelete

    Deletes a fulfillment constraint rule and its metafields.

    POST /graphql.json

  • Destructive

    fulfillmentOrderAcceptCancellationRequest

    Accept a cancellation request sent to a fulfillment service for a fulfillment order.

    POST /graphql.json

  • Destructive

    fulfillmentOrderCancel

    Cancels a [`FulfillmentOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentOrder) and creates a replacement fulfillment order to represent the work left to be done. The original fulfillment order will be marked as closed. This mutation works when the fulfillment order has a `SUBMITTED` or `CANCELLATION_REQUESTED` status. For `SUBMITTED` orders, cancellation happens immediately because the fulfillment service hasn't accepted the request. > Note: Orders that have had cancellation requested but the cancellation has yet to be accepted by the fulfillment service might still have work completed despite cancellation.

    POST /graphql.json

  • Destructive

    fulfillmentServiceDelete

    Deletes a fulfillment service.

    POST /graphql.json

  • Destructive

    inventoryDeactivate

    Removes an inventory item's quantities from a location, and turns off inventory at the location.

    POST /graphql.json

  • Destructive

    inventoryShipmentDelete

    Deletes an inventory shipment. Only draft shipments can be deleted.

    POST /graphql.json

  • Destructive

    inventoryShipmentRemoveItems

    Remove items from an inventory shipment.

    POST /graphql.json

  • Destructive

    inventoryTransferCancel

    Cancels an inventory transfer.

    POST /graphql.json

  • Destructive

    inventoryTransferDelete

    Deletes an inventory transfer.

    POST /graphql.json

  • Destructive

    inventoryTransferRemoveItems

    This mutation removes [`InventoryTransferLineItem`s](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryTransferLineItem), or portions of them, from a `DRAFT` or `READY_TO_SHIP` Transfer. For each referenced line item, if its entire quantity is still unallocated to a shipment, the line item is removed; otherwise the line item remains on the transfer with its quantity reduced to the allocated portion. Quantity allocated to a shipment (whether the shipment is in draft, in transit, or already received) is preserved. On `READY_TO_SHIP` transfers, removing items also returns the affected reserved quantity to available inventory at the origin location. To change the quantity of a line item without removing it, use [`inventoryTransferSetItems`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/inventoryTransferSetItems).

    POST /graphql.json

  • Destructive

    locationDelete

    Deletes a location.

    POST /graphql.json

  • Destructive

    marketDelete

    Deletes a market definition.

    POST /graphql.json

  • Destructive

    marketLocalizationsRemove

    Deletes market localizations.

    POST /graphql.json

  • Destructive

    marketRegionDelete (deprecated)

    Deletes a market region.

    POST /graphql.json

  • Destructive

    marketRegionsDelete (deprecated)

    Deletes a list of market regions.

    POST /graphql.json

  • Destructive

    marketWebPresenceDelete (deprecated)

    Deletes a market web presence.

    POST /graphql.json

  • Destructive

    marketingActivitiesDeleteAllExternal

    Deletes all external marketing activities. Deletion is performed by a background job, as it may take a bit of time to complete if a large number of activities are to be deleted. Attempting to create or modify external activities before the job has completed will result in the create/update/upsert mutation returning an error.

    POST /graphql.json

  • Destructive

    marketingActivityDeleteExternal

    Deletes an external marketing activity.

    POST /graphql.json

  • Destructive

    marketingEngagementsDelete (deprecated)

    Marks engagement data for a channel so it no longer appears in reports. Activity-level data cannot be deleted directly; delete the MarketingActivity instead.

    POST /graphql.json

  • Destructive

    menuDelete

    Deletes a menu.

    POST /graphql.json

  • Destructive

    metafieldDefinitionDelete

    Deletes a [`MetafieldDefinition`](https://shopify.dev/docs/api/admin-graphql/current/objects/MetafieldDefinition). You can identify the definition by providing either its owner type, namespace, and key, or its global ID. When you set [`deleteAllAssociatedMetafields`](https://shopify.dev/docs/api/admin-graphql/current/mutations/metafieldDefinitionDelete#arguments-deleteAllAssociatedMetafields) to `true`, the mutation asynchronously deletes all [`Metafield`](https://shopify.dev/docs/api/admin-graphql/current/objects/Metafield) objects that use this definition. This option must be `true` when deleting definitions under the `$app` namespace. Learn more about [deleting metafield definitions](https://shopify.dev/docs/apps/build/custom-data/metafields/definitions).

    POST /graphql.json

  • Destructive

    metafieldsDelete

    Deletes [`Metafield`](https://shopify.dev/docs/api/admin-graphql/current/objects/Metafield) objects in bulk by specifying combinations of owner ID, namespace, and key. Returns the identifiers of successfully deleted metafields. If a specified metafield doesn't exist, then the mutation still succeeds but returns `null` for that identifier in the response.

    POST /graphql.json

  • Destructive

    metaobjectBulkDelete

    Asynchronously delete metaobjects and their associated metafields in bulk.

    POST /graphql.json

  • Destructive

    metaobjectDefinitionDelete

    Deletes the specified metaobject definition. Also deletes all related metafield definitions, metaobjects, and metafields asynchronously.

    POST /graphql.json

  • Destructive

    metaobjectDelete

    Deletes the specified metaobject and its associated metafields.

    POST /graphql.json

  • Destructive

    mobilePlatformApplicationDelete

    Delete a mobile platform application.

    POST /graphql.json

  • Destructive

    orderCancel

    Cancels an order, with options for refunding, restocking inventory, and customer notification. > Caution: > Order cancellation is irreversible. An order that has been cancelled can't be restored to its original state. Use the `orderCancel` mutation to programmatically cancel orders in scenarios such as: - Customer-requested cancellations due to size, color, or other preference changes - Payment processing failures or declined transactions - Fraud detection and prevention - Insufficient inventory availability - Staff errors in order processing - Wholesale or B2B order management workflows The `orderCancel` mutation provides flexible refund options including refunding to original payment methods or issuing store credit. If a payment was only authorized (temporarily held) but not yet charged, that hold will be automatically released when the order is cancelled, even if you choose not to refund other payments. The mutation supports different cancellation reasons: customer requests, payment declines, fraud, inventory issues, staff errors, or other unspecified reasons. Each cancellation can include optional staff notes for internal documentation (notes aren't visible to customers). An order can only be cancelled if it meets the following criteria: - The order hasn't already been cancelled. - The order has no pending payment authorizations. - The order has no active returns in progress. - The order has no outstanding fulfillments that can't be cancelled. Orders might be assigned to locations that become [deactivated](https://help.shopify.com/manual/fulfillment/setup/locations-management#deactivate-and-reactivate-locations) after the order was created. When cancelling such orders, inventory behavior depends on payment status: - **Paid orders**: Cancellation will fail with an error if restocking is enabled, since inventory can't be returned to deactivated locations. - **Unpaid orders**: Cancellation succeeds but inventory is not restocked anywhere, even when the restock option is enabled. The committed inventory effectively becomes unavailable rather than being returned to stock at the deactivated location. After you cancel an order, you can still make limited updates to certain fields (like notes and tags) using the [`orderUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderUpdate). For partial refunds or more complex refund scenarios on active orders, such as refunding only specific line items while keeping the rest of the order fulfilled, consider using the [`refundCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/refundCreate) mutation instead of full order cancellation. Learn how to build apps that integrate with [order management and fulfillment processes](https://shopify.dev/docs/apps/build/orders-fulfillment).

    POST /graphql.json

  • Destructive

    orderCustomerRemove

    Removes customer from an order.

    POST /graphql.json

  • Destructive

    orderDelete

    Permanently deletes an [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) from the store. You can only delete [specific order types](https://help.shopify.com/manual/orders/cancel-delete-order#delete-an-order). Other orders you can cancel using the [`orderCancel`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/orderCancel) mutation instead. > Caution: > This action is irreversible. You can't recover deleted orders.

    POST /graphql.json

  • Destructive

    orderEditRemoveDiscount

    Removes 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](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).

    POST /graphql.json

  • Destructive

    orderEditRemoveLineItemDiscount (deprecated)

    Removes a line item discount that was applied as part of an order edit.

    POST /graphql.json

  • Destructive

    orderEditRemoveShippingLine

    Removes 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](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).

    POST /graphql.json

  • Destructive

    orderEditSetQuantity

    Sets 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. Setting the quantity to zero effectively removes the line item from the order. The item still exists as a data structure with zero quantity. When decreasing quantities, you can optionally restock the removed items to inventory by setting the `restock` parameter to `true`. Learn more about [editing workflows for existing orders](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps/edit-orders).

    POST /graphql.json

  • Destructive

    pageDelete

    Permanently deletes a page from the online store. For example, merchants might delete seasonal landing pages after campaigns end, or remove outdated policy pages when terms change. Use the `pageDelete` mutation to: - Remove outdated or unnecessary pages - Clean up seasonal landing pages - Delete duplicate pages The deletion is permanent and returns the deleted page's ID for confirmation.

    POST /graphql.json

  • Destructive

    paymentCustomizationDelete

    Permanently deletes a payment customization. Once deleted, the customization will no longer affect which payment methods appear at checkout.

    POST /graphql.json

  • Destructive

    paymentTermsDelete

    Delete 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`.

    POST /graphql.json

  • Destructive

    priceListDelete

    Deletes a price list. For example, you can delete a price list so that it no longer applies for products in the associated market.

    POST /graphql.json

  • Destructive

    priceListFixedPricesByProductUpdate

    Sets or removes fixed prices for all variants of a [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) on a [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList). Simplifies pricing management when all variants of a product should have the same price on a price list, rather than setting individual variant prices. When you add a fixed price for a product, all its [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects receive the same price on the price list. When you remove a product's fixed prices, all variant prices revert to the price list's adjustment rules.

    POST /graphql.json

  • Destructive

    priceListFixedPricesDelete

    Deletes 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. After deleting the set of fixed prices from the price list, the price of each product variant reverts to the original price that was determined by the price list adjustment.

    POST /graphql.json

  • Destructive

    priceListFixedPricesUpdate

    Updates fixed prices on a [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList). This mutation lets you add new fixed prices for specific [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects and remove existing prices in a single operation. Use this mutation to modify variant pricing on a price list by providing prices to add and variant IDs to delete. Learn more about [setting fixed prices for product variants](https://shopify.dev/docs/apps/build/markets/build-catalog#step-3-set-fixed-prices-for-specific-product-variants).

    POST /graphql.json

  • Destructive

    priceListUpdate

    Updates a [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList)'s configuration, including its name, currency, [`Catalog`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Catalog) association, and pricing adjustments. Changing the currency removes all fixed prices from the price list. The affected [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects revert to prices calculated from the price list's adjustment settings.

    POST /graphql.json

  • Destructive

    productDelete

    Permanently deletes a product and all its associated data, including variants, media, publications, and inventory items. Use the `productDelete` mutation to programmatically remove products from your store when they need to be permanently deleted from your catalog, such as when removing discontinued items, cleaning up test data, or synchronizing with external inventory management systems. The `productDelete` mutation removes the product from all associated collections, and removes all associated data for the product, including: - All product variants and their inventory items - Product media (images, videos) that are not referenced by other products - [Product options](https://shopify.dev/api/admin-graphql/latest/objects/ProductOption) and [option values](https://shopify.dev/api/admin-graphql/latest/objects/ProductOptionValue) - Product publications across all sales channels - Product tags and metadata associations The `productDelete` mutation also has the following effects on existing orders and transactions: - **Draft orders**: Existing draft orders that reference this product will retain the product information as stored data, but the product reference will be removed. Draft orders can still be completed with the stored product details. - **Completed orders and refunds**: Previously completed orders that included this product aren't affected. The product information in completed orders is preserved for record-keeping, and existing refunds for this product remain valid and processable. > Caution: > Product deletion is irreversible. After a product is deleted, it can't be recovered. Consider archiving > or unpublishing products instead if you might need to restore them later. If you need to delete a large product, such as one that has many [variants](https://shopify.dev/api/admin-graphql/latest/objects/ProductVariant) that are active at several [locations](https://shopify.dev/api/admin-graphql/latest/objects/Location), you might encounter timeout errors. To avoid these timeout errors, you can set the [`synchronous`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productDelete#arguments-synchronous) parameter to `false` to run the deletion asynchronously, which returns a [`ProductDeleteOperation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductDeleteOperation) that you can monitor for completion status. If you need more granular control over product cleanup, consider using these alternative mutations: - [`productUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productUpdate): Update the product status to archived or unpublished instead of deleting. - [`productVariantsBulkDelete`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkDelete): Delete specific variants while keeping the product. - [`productOptionsDelete`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsDelete): Delete the choices available for a product, such as size, color, or material. Learn more about the [product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model).

    POST /graphql.json

  • Destructive

    productDeleteMedia (deprecated)

    Deletes media from a [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product), such as images, videos, and 3D models. When you delete media images, the mutation also removes any corresponding product images. The mutation returns the IDs of both the deleted media and any product images that the deletion removed. > Caution: > This action is irreversible. You can't recover deleted media.

    POST /graphql.json

  • Destructive

    productFeedDelete

    Deletes a product feed for a specific publication.

    POST /graphql.json

  • Destructive

    productOptionsDelete

    Deletes one or more [options](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOption) from a [product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product). Product options define the choices available for a product, such as size, color, or material. > Caution: > Removing an option can affect a product's > [variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) and their > configuration. Deleting an option might also delete associated option values and, depending on the chosen > [strategy](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productoptionsdelete#arguments-strategy), > might affect variants. Use the `productOptionsDelete` mutation for the following use cases: - **Simplify product configuration**: Remove obsolete or unnecessary options (for example, discontinue "Material" if all variants are now the same material). - **Clean up after seasonal or limited-time offerings**: Delete options that are no longer relevant (for example, "Holiday edition"). - **Automate catalog management**: Enable apps or integrations to programmatically remove options as product data changes. > Note: > The `productOptionsDelete` mutation enforces strict data integrity for product options and variants. > All option positions must remain sequential, and every remaining option must be used by at least one variant. After you delete a product option, you can further manage a product's configuration using related mutations: - [`productOptionsCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsCreate) - [`productOptionUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionUpdate) - [`productOptionsReorder`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsReorder) - [`productVariantsBulkCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkCreate) - [`productVariantsBulkUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkUpdate) - [`productSet`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productSet) Learn more about the [product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model) and [adding product data](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/add-data).

    POST /graphql.json

  • Destructive

    productSet

    Performs multiple operations to create or update products in a single request. Use the `productSet` mutation to sync information from an external data source into Shopify, manage large product catalogs, and perform batch updates. The mutation is helpful for bulk product management, including price adjustments, inventory updates, and product lifecycle management. The behavior of `productSet` depends on the type of field it's modifying: - **For list fields**: Creates new entries, updates existing entries, and deletes existing entries that aren't included in the mutation's input. Common examples of list fields include [`collections`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productSet#arguments-input.fields.collections), [`metafields`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productSet#arguments-input.fields.metafields), and [`variants`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productSet#arguments-input.fields.variants). - **For all other field types**: Updates only the included fields. Any omitted fields will remain unchanged. > Note: > By default, stores have a limit of 2048 product variants for each product. You can run `productSet` in one of the following modes: - **Synchronously**: Returns the updated product in the response. - **Asynchronously**: Returns a [`ProductSetOperation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductSetOperation) object. Use the [`productOperation`](https://shopify.dev/api/admin-graphql/latest/queries/productOperation) query to check the status of the operation and retrieve details of the updated product and its product variants. If you need to only manage product variants, then use one of the following mutations: - [`productVariantsBulkCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkCreate) - [`productVariantsBulkUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkUpdate) - [`productVariantsBulkDelete`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productVariantsBulkDelete) If you need to only manage product options, then use one of the following mutations: - [`productOptionsCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsCreate) - [`productOptionUpdate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionUpdate) - [`productOptionsReorder`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsReorder) - [`productOptionsDelete`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/productOptionsDelete) Learn more about [syncing product data from an external source](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/sync-data).

    POST /graphql.json

  • Destructive

    productVariantsBulkDelete

    Deletes multiple variants in a single [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product). Specify the product ID and an array of variant IDs to remove variants in bulk. You can call this mutation directly or through the [`bulkOperationRunMutation`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/bulkOperationRunMutation) mutation. Returns the updated product and any [`UserError`](https://shopify.dev/docs/api/admin-graphql/latest/objects/UserError) objects.

    POST /graphql.json

  • Destructive

    pubSubServerPixelUpdate

    Updates the server pixel to connect to a Google PubSub endpoint. Running this mutation deletes any previous subscriptions for the server pixel.

    POST /graphql.json

  • Destructive

    publicationDelete

    Deletes a publication.

    POST /graphql.json

  • Destructive

    quantityPricingByVariantUpdate

    Updates quantity pricing on a [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) for specific [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects. You can set fixed prices (see [`PriceListPrice`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceListPrice)), quantity rules, and quantity price breaks in a single operation. [`QuantityRule`](https://shopify.dev/docs/api/admin-graphql/latest/objects/QuantityRule) objects define minimum, maximum, and increment constraints for ordering. [`QuantityPriceBreak`](https://shopify.dev/docs/api/admin-graphql/latest/objects/QuantityPriceBreak) objects offer tiered pricing based on purchase volume. The mutation executes delete operations before create operations and doesn't allow partial updates. > Note: If any requested change fails, then the mutation doesn't apply any of the changes.

    POST /graphql.json

  • Destructive

    quantityRulesDelete

    Deletes specific quantity rules from a price list using a product variant ID. You can use the `quantityRulesDelete` mutation to delete a set of quantity rules from a price list.

    POST /graphql.json

  • Destructive

    removeFromReturn

    Removes return and/or exchange lines from a return.

    POST /graphql.json

  • Destructive

    returnCancel

    Cancels 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).

    POST /graphql.json

  • Destructive

    returnLineItemRemoveFromReturn (deprecated)

    Removes return lines from a return.

    POST /graphql.json

  • Destructive

    savedSearchDelete

    Delete a saved search.

    POST /graphql.json

  • Destructive

    scriptTagDelete

    <div class="note"><h4>Theme app extensions</h4> <p>If your app integrates with a Shopify theme and you plan to submit it to the Shopify App Store, you must use theme app extensions instead of Script tags. Script tags can only be used with vintage themes. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div> Deletes a script tag.

    POST /graphql.json

  • Destructive

    segmentDelete

    Deletes a segment.

    POST /graphql.json

  • Destructive

    sellingPlanGroupDelete

    Delete a Selling Plan Group. This does not affect subscription contracts.

    POST /graphql.json

  • Destructive

    sellingPlanGroupRemoveProductVariants

    Removes multiple product variants from a selling plan group.

    POST /graphql.json

  • Destructive

    sellingPlanGroupRemoveProducts

    Removes multiple products from a selling plan group.

    POST /graphql.json

  • Destructive

    serverPixelDelete

    Deletes the Server Pixel associated with the current app & shop.

    POST /graphql.json

  • Destructive

    shippingPackageDelete

    Deletes a shipping package.

    POST /graphql.json

  • Destructive

    shopLocaleDisable

    Deletes a locale for a shop. This also deletes all translations of this locale.

    POST /graphql.json

  • Destructive

    storefrontAccessTokenDelete

    Deletes a storefront access token.

    POST /graphql.json

  • Destructive

    subscriptionBillingCycleEditDelete

    Delete the schedule and contract edits of the selected subscription billing cycle.

    POST /graphql.json

  • Destructive

    subscriptionBillingCycleEditsDelete

    Delete the current and future schedule and contract edits of a list of subscription billing cycles.

    POST /graphql.json

  • Destructive

    subscriptionContractCancel

    Cancels a Subscription Contract.

    POST /graphql.json

  • Destructive

    subscriptionDraftDiscountRemove (deprecated)

    Removes a subscription discount from a subscription draft.

    POST /graphql.json

  • Destructive

    subscriptionDraftLineRemove (deprecated)

    Removes a subscription line from a subscription draft.

    POST /graphql.json

  • Destructive

    tagsRemove

    Removes tags from a resource. If the resource type doesn't support tagging, the `id` argument returns a resource-not-found error. Tags are searchable keywords that help organize and filter these resources.

    POST /graphql.json

  • Destructive

    themeDelete

    Deletes a theme.

    POST /graphql.json

  • Destructive

    themeFilesCopy

    Copy theme files. Copying to existing theme files will overwrite them.

    POST /graphql.json

  • Destructive

    themeFilesDelete

    Deletes a theme's files.

    POST /graphql.json

  • Destructive

    translationsRemove

    Deletes translations.

    POST /graphql.json

  • Destructive

    urlRedirectBulkDeleteAll

    Asynchronously delete [URL redirects](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) in bulk.

    POST /graphql.json

  • Destructive

    urlRedirectBulkDeleteByIds

    Asynchronously delete [URLRedirect](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) objects in bulk by IDs. Learn more about [URLRedirect](https://help.shopify.com/en/manual/online-store/menus-and-links/url-redirect) objects.

    POST /graphql.json

  • Destructive

    urlRedirectBulkDeleteBySavedSearch

    Asynchronously delete redirects in bulk.

    POST /graphql.json

  • Destructive

    urlRedirectBulkDeleteBySearch

    Asynchronously delete redirects in bulk.

    POST /graphql.json

  • Destructive

    urlRedirectDelete

    Deletes a [`UrlRedirect`](https://shopify.dev/api/admin-graphql/latest/objects/UrlRedirect) object.

    POST /graphql.json

  • Destructive

    validationDelete

    Deletes a cart and checkout validation, removing its rule from the shop's checkout. Once deleted, its cart and checkout validation function no longer runs during checkout.

    POST /graphql.json

  • Destructive

    webPixelDelete

    Deletes the web pixel shop settings.

    POST /graphql.json

  • Destructive

    webPresenceDelete

    Deletes a web presence.

    POST /graphql.json

  • Destructive

    webhookSubscriptionDelete

    Deletes a [`WebhookSubscription`](https://shopify.dev/docs/api/admin-graphql/latest/objects/WebhookSubscription) and stops all future webhooks to its endpoint. Returns the deleted subscription's ID for confirmation. Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe).

    POST /graphql.json

Queries

  • Read

    abandonedCheckouts

    Returns a list of abandoned checkouts. A checkout is considered abandoned when a customer adds contact information but doesn't complete their purchase. Includes both abandoned and recovered checkouts. Each checkout provides [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) details, [`AbandonedCheckoutLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AbandonedCheckoutLineItem) objects, pricing information, and a recovery URL for re-engaging customers who didn't complete their purchase.

    POST /graphql.json

  • Read

    abandonedCheckoutsCount

    Returns the count of abandoned checkouts for the given shop. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    abandonment

    Returns a `Abandonment` resource by ID.

    POST /graphql.json

  • Read

    abandonmentByAbandonedCheckoutId

    Returns an Abandonment by the Abandoned Checkout ID.

    POST /graphql.json

  • Read

    app

    Retrieves an [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) by its ID. If no ID is provided, returns details about the currently authenticated app. The query provides access to app details including title, icon, and pricing information. If the app isn't installed on the current shop, then the [`installation`](https://shopify.dev/docs/api/admin-graphql/latest/queries/app#returns-App.fields.installation) field will be `null`.

    POST /graphql.json

  • Read

    appByHandle

    Retrieves an app by its unique handle. The handle is a URL-friendly identifier for the app. Returns the [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) if found, or `null` if no app exists with the specified handle.

    POST /graphql.json

  • Read

    appByKey

    Retrieves an [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App) by its client ID (API key). Returns the app's configuration, installation status, [`AccessScope`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AccessScope) objects, and developer information. Returns `null` if no app exists with the specified client ID.

    POST /graphql.json

  • Read

    appDiscountType

    An app discount type.

    POST /graphql.json

  • Read

    appDiscountTypes

    A list of app discount types installed by apps.

    POST /graphql.json

  • Read

    appDiscountTypesNodes

    A list of app discount types installed by apps.

    POST /graphql.json

  • Read

    appInstallation

    Retrieves an [`AppInstallation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppInstallation) by ID. If no ID is provided, returns the installation for the currently authenticated [`App`](https://shopify.dev/docs/api/admin-graphql/latest/objects/App). The query provides essential data for validating installation state and managing app functionality within a store. Use this query to access installation details including granted [`AccessScope`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AccessScope) objects, active [`AppSubscription`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscription) objects, [`AppCredit`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppCredit) objects, [`AppPurchaseOneTime`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppPurchaseOneTime) objects, and app-specific metadata. Learn more about [app installation](https://shopify.dev/docs/apps/build/authentication-authorization/app-installation).

    POST /graphql.json

  • Read

    appInstallations

    A paginated list of [`AppInstallation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppInstallation) objects across multiple stores where your app is installed. Use this query to monitor installation status, track billing and subscriptions through [`AppSubscription`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscription) objects, and review granted [`AccessScope`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AccessScope) objects. Filter by [`AppInstallationCategory`](https://shopify.dev/docs/api/admin-graphql/latest/enums/AppInstallationCategory) to find specific types of installations (such as POS or channel apps) and by [`AppInstallationPrivacy`](https://shopify.dev/docs/api/admin-graphql/latest/enums/AppInstallationPrivacy) to scope to public or private installations.

    POST /graphql.json

  • Read

    article

    Returns a `Article` resource by ID.

    POST /graphql.json

  • Read

    articleAuthors

    List of article authors for the shop.

    POST /graphql.json

  • Read

    articleTags

    List of all article tags.

    POST /graphql.json

  • Read

    articles

    Returns a paginated list of articles from the shop's blogs. [`Article`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Article) objects are blog posts that contain content like text, images, and tags. Supports [cursor-based pagination](https://shopify.dev/docs/api/usage/pagination-graphql) to control the number of articles returned and their order. Use the [`query`](https://shopify.dev/docs/api/admin-graphql/latest/queries/articles#arguments-query) argument to filter results by specific criteria.

    POST /graphql.json

  • Read

    assignedFulfillmentOrders

    The paginated list of fulfillment orders assigned to the shop locations owned by the app. Assigned fulfillment orders are fulfillment orders that are set to be fulfilled from locations managed by [fulfillment services](https://shopify.dev/api/admin-graphql/latest/objects/FulfillmentService) that are registered by the app. One app (api_client) can host multiple fulfillment services on a shop. Each fulfillment service manages a dedicated location on a shop. Assigned fulfillment orders can have associated [fulfillment requests](https://shopify.dev/api/admin-graphql/latest/enums/FulfillmentOrderRequestStatus), or might currently not be requested to be fulfilled. The app must have the `read_assigned_fulfillment_orders` [access scope](https://shopify.dev/docs/api/usage/access-scopes) to be able to retrieve the fulfillment orders assigned to its locations. All assigned fulfillment orders (except those with the `CLOSED` status) will be returned by default. Perform filtering with the `assignmentStatus` argument to receive only fulfillment orders that have been requested to be fulfilled.

    POST /graphql.json

  • Read

    automaticDiscount (deprecated)

    Returns a `DiscountAutomatic` resource by ID.

    POST /graphql.json

  • Read

    automaticDiscountNode (deprecated)

    Returns a `DiscountAutomaticNode` resource by ID.

    POST /graphql.json

  • Read

    automaticDiscountNodes (deprecated)

    Returns a list of [automatic discounts](https://help.shopify.com/manual/discounts/discount-types#automatic-discounts).

    POST /graphql.json

  • Read

    automaticDiscountSavedSearches

    List of the shop's automatic discount saved searches.

    POST /graphql.json

  • Read

    automaticDiscounts (deprecated)

    Returns a list of automatic discounts that are applied in the cart and at checkout without requiring a discount code.

    POST /graphql.json

  • Read

    availableBackupRegions

    The geographic regions that you can set as the [`Shop`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Shop)'s backup region. The backup region serves as a fallback when the system can't determine a buyer's actual location.

    POST /graphql.json

  • Read

    availableCarrierServices

    Returns a list of activated carrier services and associated shop locations that support them.

    POST /graphql.json

  • Read

    availableLocales

    Returns all locales that Shopify supports. Each [`Locale`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Locale) includes an ISO code and human-readable name. Use this query to discover which locales you can enable on a shop with the [`shopLocaleEnable`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/shopLocaleEnable) mutation.

    POST /graphql.json

  • Read

    backupRegion

    The backup region of the shop.

    POST /graphql.json

  • Read

    blog

    Returns a `Blog` resource by ID.

    POST /graphql.json

  • Read

    blogs

    Returns a paginated list of the shop's [`Blog`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Blog) objects. Blogs serve as containers for [`Article`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Article) objects and provide content management capabilities for the store's editorial content. Supports [cursor-based pagination](https://shopify.dev/docs/api/usage/pagination-graphql) to control the number of blogs returned and their order. Use the [`query`](https://shopify.dev/docs/api/admin-graphql/latest/queries/blogs#arguments-query) argument to filter results by specific criteria.

    POST /graphql.json

  • Read

    blogsCount

    Count of blogs. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    bulkOperation

    Returns a `BulkOperation` resource by ID.

    POST /graphql.json

  • Read

    bulkOperations

    Returns the app's bulk operations meeting the specified filters. Defaults to sorting by created_at, with newest operations first.

    POST /graphql.json

  • Read

    businessEntities

    Returns the list of [business entities](https://shopify.dev/docs/api/admin-graphql/latest/objects/BusinessEntity) associated with the shop. Use this query to retrieve business entities for assigning to markets, managing payment providers per entity, or viewing entity attribution on orders. Each shop can have multiple business entities with one designated as primary. To identify the primary entity in the query results, set the [`primary`](https://shopify.dev/docs/api/admin-graphql/latest/queries/businessEntities#returns-BusinessEntity.fields.primary) field to `true`. Learn more about [managing multiple legal entities](https://shopify.dev/docs/apps/build/markets/multiple-entities).

    POST /graphql.json

  • Read

    businessEntity

    Returns a Business Entity by ID.

    POST /graphql.json

  • Read

    carrierService

    Returns a `DeliveryCarrierService` resource by ID.

    POST /graphql.json

  • Read

    carrierServices

    A paginated list of carrier services configured for the shop. Carrier services provide real-time shipping rates from external providers like FedEx, UPS, or custom shipping solutions. Use the `query` parameter to filter results by attributes such as active status.

    POST /graphql.json

  • Read

    cartTransforms

    Retrieves 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).

    POST /graphql.json

  • Read

    cashDrawer

    Returns a `CashDrawer` resource by ID.

    POST /graphql.json

  • Read

    cashDrawers

    A list of cash drawers in the shop.

    POST /graphql.json

  • Read

    cashManagementLocationSummary

    Summary of cash management data for a location. Data is returned only if the location has a POS Pro subscription.

    POST /graphql.json

  • Read

    cashManagementReasonCodes

    Returns the cash management reason codes for the shop.

    POST /graphql.json

  • Read

    cashManagementShopSummary

    Summary of cash management data across all locations with a POS Pro subscription for a shop, filtered by currency.

    POST /graphql.json

  • Read

    cashTrackingSession

    Returns a `CashTrackingSession` resource by ID.

    POST /graphql.json

  • Read

    cashTrackingSessions

    Returns 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](https://shopify.dev/docs/api/usage/bulk-operations/queries).

    POST /graphql.json

  • Read

    catalog

    Retrieves a [catalog](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/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. Use the `catalog` query to retrieve information associated with the following workflows: - Managing product publications across different contexts - Setting up contextual pricing with price lists - Managing market-specific product availability - Configuring B2B customer catalogs There are several types of catalogs: - [`MarketCatalog`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketCatalog) - [`AppCatalog`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppCatalog) - [`CompanyLocationCatalog`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocationCatalog) Learn more about [catalogs for different markets](https://shopify.dev/docs/apps/build/markets/catalogs-different-markets).

    POST /graphql.json

  • Read

    catalogOperations

    Returns the most recent catalog operations for the shop.

    POST /graphql.json

  • Read

    catalogs

    Returns a paginated list of catalogs for the shop. Catalogs control which products are published and how they're priced in different contexts, such as international markets (Canada vs. United States), B2B company locations (different branches of the same business), or specific sales channels (such as online store vs. POS). Filter catalogs by [`type`](https://shopify.dev/docs/api/admin-graphql/latest/queries/catalogs#arguments-type) and use the [`query`](https://shopify.dev/docs/api/admin-graphql/latest/queries/catalogs#arguments-query) argument to search and filter by additional criteria. Learn more about [Shopify Catalogs](https://shopify.dev/docs/apps/build/markets/catalogs-different-markets).

    POST /graphql.json

  • Read

    catalogsCount

    The count of catalogs belonging to the shop. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    channel

    Returns a [`Channel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) by ID. The channel must belong to the calling application.

    POST /graphql.json

  • Read

    channelByHandle

    Returns a [`Channel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) by its unique string handle. The handle is either set explicitly during [`channelCreate`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/channelCreate) or auto-generated from the specification handle and account ID. The channel must belong to the calling application.

    POST /graphql.json

  • Read

    channels

    The list of [`Channel`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Channel) objects on the shop. When the calling application supports multi-channel, only channels established by the calling application are returned. Each channel represents an authenticated connection to an external selling platform such as a marketplace, social media platform, online store, or point-of-sale system.

    POST /graphql.json

  • Read

    checkoutAndAccountsConfiguration

    A checkout and accounts configuration for a shop.

    POST /graphql.json

  • Read

    checkoutAndAccountsConfigurations

    List of checkout and accounts configurations on a shop.

    POST /graphql.json

  • Read

    checkoutBranding (deprecated)

    Returns the visual customizations for checkout for a given [checkout profile](https://shopify.dev/docs/api/admin-graphql/latest/objects/CheckoutProfile). To update checkout branding settings, use the [`checkoutBrandingUpsert`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/checkoutBrandingUpsert) mutation. Learn more about [customizing checkout's appearance](https://shopify.dev/docs/apps/build/checkout/styling).

    POST /graphql.json

  • Read

    checkoutProfile (deprecated)

    Returns a [`CheckoutProfile`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CheckoutProfile). Checkout profiles define the branding settings and UI extensions for a store's checkout experience. Stores can have one published profile that renders on their live checkout and multiple draft profiles for testing customizations in the checkout editor.

    POST /graphql.json

  • Read

    checkoutProfiles (deprecated)

    List of checkout profiles on a shop.

    POST /graphql.json

  • Read

    codeDiscountNode (deprecated)

    Returns a [code discount](https://help.shopify.com/manual/discounts/discount-types#discount-codes) resource by ID.

    POST /graphql.json

  • Read

    codeDiscountNodeByCode

    Retrieves a [code discount](https://help.shopify.com/manual/discounts/discount-types#discount-codes) by its discount code. The search is case-insensitive, enabling you to find discounts regardless of how customers enter the code. Returns a [`DiscountCodeNode`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DiscountCodeNode) that contains the underlying discount details, which could be a basic [amount off discount](https://help.shopify.com/manual/discounts/discount-types/percentage-fixed-amount), a ["Buy X Get Y" (BXGY) discount](https://help.shopify.com/manual/discounts/discount-types/buy-x-get-y), a [free shipping discount](https://help.shopify.com/manual/discounts/discount-types/free-shipping), or an [app-provided discount](https://help.shopify.com/manual/discounts/discount-types/discounts-with-apps). Learn more about working with [Shopify's discount model](https://shopify.dev/docs/apps/build/discounts).

    POST /graphql.json

  • Read

    codeDiscountNodes (deprecated)

    Returns a list of [code-based discounts](https://help.shopify.com/manual/discounts/discount-types#discount-codes).

    POST /graphql.json

  • Read

    codeDiscountSavedSearches

    List of the shop's code discount saved searches.

    POST /graphql.json

  • Read

    collection

    Retrieves a [collection](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection) by its ID. A collection represents a grouping of [products](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) that merchants can display and sell as a group in their [online store](https://shopify.dev/docs/apps/build/online-store) and other [sales channels](https://shopify.dev/docs/apps/build/sales-channels). Use the `collection` query when you need to: - Manage collection publishing across sales channels - Access collection metadata and SEO information - Work with collection rules and product relationships A collection can be either a custom ([manual](https://help.shopify.com/manual/products/collections/manual-shopify-collection)) collection where products are manually added, or a smart ([automated](https://help.shopify.com/manual/products/collections/automated-collections)) collection where products are automatically included based on defined rules. Each collection has associated metadata including title, description, handle, image, and [metafields](https://shopify.dev/docs/apps/build/custom-data/metafields).

    POST /graphql.json

  • Read

    collectionByHandle (deprecated)

    Retrieves a collection by its unique handle identifier. Handles provide a URL-friendly way to reference collections and are commonly used in storefront URLs and navigation. For example, a collection with the title "Summer Sale" might have the handle `summer-sale`, allowing you to fetch it directly without knowing the internal ID. Use `CollectionByHandle` to: - Fetch collections for storefront display and navigation - Build collection-based URLs and routing systems - Validate collection existence before displaying content Handles are automatically generated from collection titles but can be customized by merchants for SEO and branding purposes. Learn more about [collections](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection).

    POST /graphql.json

  • Read

    collectionByIdentifier

    Return a collection by an identifier.

    POST /graphql.json

  • Read

    collectionRulesConditions

    Lists all rules that can be used to create collections.

    POST /graphql.json

  • Read

    collectionSavedSearches

    Returns a list of the shop's collection saved searches.

    POST /graphql.json

  • Read

    collections

    Retrieves a list of [collections](https://shopify.dev/docs/api/admin-graphql/latest/objects/Collection) in a store. Collections are groups of [products](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) that merchants can organize for display in their [online store](https://shopify.dev/docs/apps/build/online-store) and other [sales channels](https://shopify.dev/docs/apps/build/sales-channels). For example, an athletics store might create different collections for running attire, shoes, and accessories. Use the `collections` query when you need to: - Build a browsing interface for a store's product groupings. - Create collection searching, sorting, and filtering experiences (for example, by title, type, or published status). - Sync collection data with external systems. The `collections` query supports [pagination](https://shopify.dev/docs/api/usage/pagination-graphql) for large catalogs and [saved searches](https://shopify.dev/docs/api/admin-graphql/latest/queries/collections#arguments-savedSearchId) for frequently used collection queries. The `collections` query returns collections with their associated metadata, including: - Basic collection information (title, description, handle, and type) - Collection image and SEO metadata - Product count and product relationships - Collection rules or conditions - Publishing status and publication details - Metafields and custom attributes Learn more about [using metafields with collection conditions](https://shopify.dev/docs/apps/build/custom-data/metafields/use-metafield-capabilities).

    POST /graphql.json

  • Read

    collectionsCount

    Count of collections. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    comment

    Returns a `Comment` resource by ID.

    POST /graphql.json

  • Read

    comments

    List of the shop's comments.

    POST /graphql.json

  • Read

    companies

    A paginated list of companies in the shop. [`Company`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Company) objects are business entities that purchase from the merchant. Use the [`query`](https://shopify.dev/docs/api/admin-graphql/latest/queries/companies#arguments-query) argument to filter companies by attributes like name or externalId. Sort and paginate results to handle large datasets efficiently. Learn more about [Shopify API search syntax](https://shopify.dev/docs/api/usage/search-syntax).

    POST /graphql.json

  • Read

    companiesCount

    The number of companies for a shop. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    company

    Returns a `Company` resource by ID.

    POST /graphql.json

  • Read

    companyContact

    Returns a `CompanyContact` resource by ID.

    POST /graphql.json

  • Read

    companyContactRole

    Returns a `CompanyContactRole` resource by ID.

    POST /graphql.json

  • Read

    companyLocation

    Returns a `CompanyLocation` resource by ID.

    POST /graphql.json

  • Read

    companyLocations

    A paginated list of [`CompanyLocation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocation) objects for B2B customers. Company locations represent individual branches or offices of a [`Company`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Company) where B2B orders can be placed. Each location can have its own billing and shipping addresses, tax settings, [`PaymentTerms`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PaymentTerms), and [`Catalog`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Catalog) assignments with custom pricing. Use the query parameter to search locations by name or other attributes. Learn more about [managing company locations](https://shopify.dev/docs/apps/build/b2b/manage-client-company-locations).

    POST /graphql.json

  • Read

    consentPolicy

    Returns the customer privacy consent policies of a shop.

    POST /graphql.json

  • Read

    consentPolicyRegions

    List of countries and regions for which consent policies can be created or updated.

    POST /graphql.json

  • Read

    currentAppInstallation

    Returns the [`AppInstallation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppInstallation) for the currently authenticated app. Provides access to granted access scopes, active [`AppSubscription`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppSubscription) objects, and billing information for your app. Use this query to check which permissions your app has, monitor subscription status, or retrieve [`AppCredit`](https://shopify.dev/docs/api/admin-graphql/latest/objects/AppCredit) objects. Learn more about [managing access scopes](https://shopify.dev/docs/api/usage/access-scopes#checking-granted-access-scopes), [subscription billing](https://shopify.dev/docs/apps/launch/billing/subscription-billing), and [app credits](https://shopify.dev/docs/apps/launch/billing/award-app-credits).

    POST /graphql.json

  • Read

    currentBulkOperation (deprecated)

    Returns the current app's most recent [`BulkOperation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/BulkOperation). Bulk query and bulk mutation operations can run at the same time per shop. The number of concurrent operations that an app can run depends on the API version. For the applicable concurrency limits, refer to the [bulk operations guide](https://shopify.dev/docs/api/usage/bulk-operations/queries). The operation type parameter determines whether to retrieve the most recent query or mutation bulk operation. Use this query to check the operation's status, track its progress, and retrieve the result URL when it completes.

    POST /graphql.json

  • Read

    currentStaffMember

    The staff member making the API request.

    POST /graphql.json

  • Read

    customer

    Returns a `Customer` resource by ID.

    POST /graphql.json

  • Read

    customerAccountPage

    Returns a `CustomerAccountPage` resource by ID.

    POST /graphql.json

  • Read

    customerAccountPages

    List of the shop's customer account pages.

    POST /graphql.json

  • Read

    customerByIdentifier

    Return a customer by an identifier.

    POST /graphql.json

  • Read

    customerMergeJobStatus

    Returns the status of a customer merge request job.

    POST /graphql.json

  • Read

    customerMergePreview

    Returns a preview of a customer merge request. The `customerOneId` and `customerTwoId` arguments don't guarantee which customer is kept. Shopify selects the resulting customer in this order: 1. If `overrideFields.customerIdOfEmailToKeep` is provided and valid, then the selected customer is kept. 2. If exactly one customer has an email address, then that customer is kept. 3. If both customers have email addresses, then account state and email marketing consent determine the customer that's kept: an `enabled` account wins over other account states; otherwise, an `invited` account can win when consent doesn't already prefer `subscribed` or `pending`; otherwise the consent result is used. If those rules don't prefer either customer, then `customerTwoId` is kept. 4. If neither customer has an email address, then `customerTwoId` is kept.

    POST /graphql.json

  • Read

    customerPaymentMethod

    Returns a vaulted customer payment method by its ID, including the instrument type (credit card, PayPal, etc.), billing address, and current status. Optionally includes revoked payment methods. Use this to look up a specific saved payment method for a customer — for example, to check whether a subscription's payment method is still valid or to display stored payment details.

    POST /graphql.json

  • Read

    customerSavedSearches (deprecated)

    List of the shop's customer saved searches.

    POST /graphql.json

  • Read

    customerSegmentMembers

    A paginated list of customers that belong to an individual [`Segment`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Segment). Segments group customers based on criteria defined through [ShopifyQL queries](https://shopify.dev/docs/api/shopifyql/segment-query-language-reference). Access segment members with their profile information and purchase summary data. The connection includes statistics for analyzing segment attributes (such as average and sum calculations) and a total count of all members. The maximum page size is 1000.

    POST /graphql.json

  • Read

    customerSegmentMembersQuery

    Returns a `CustomerSegmentMembersQuery` resource by ID.

    POST /graphql.json

  • Read

    customerSegmentMembership

    Whether a member, which is a customer, belongs to a segment.

    POST /graphql.json

  • Read

    customers

    Returns a list of [customers](https://shopify.dev/api/admin-graphql/latest/objects/Customer) in your Shopify store, including key information such as name, email, location, and purchase history. Use this query to segment your audience, personalize marketing campaigns, or analyze customer behavior by applying filters based on location, order history, marketing preferences and tags. The `customers` query supports [pagination](https://shopify.dev/api/usage/pagination-graphql) and [sorting](https://shopify.dev/api/admin-graphql/latest/enums/CustomerSortKeys).

    POST /graphql.json

  • Read

    customersCount

    The number of customers. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    deletionEvents (deprecated)

    The paginated list of deletion events.

    POST /graphql.json

  • Read

    deliveryCustomization

    The delivery customization.

    POST /graphql.json

  • Read

    deliveryCustomizations

    The delivery customizations.

    POST /graphql.json

  • Read

    deliveryProfile

    Retrieves a [`DeliveryProfile`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryProfile) by ID. Delivery profiles group shipping settings for specific [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) objects that ship from selected [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) objects to [delivery zones](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryZone with defined rates. Learn more about [delivery profiles](https://shopify.dev/docs/apps/build/purchase-options/deferred/delivery-and-deferment#whats-a-delivery-profile).

    POST /graphql.json

  • Read

    deliveryProfiles

    Returns a paginated list of [`DeliveryProfile`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryProfile) objects for the shop. Delivery profiles group [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) and [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects that share shipping rates and zones. Each profile contains [`DeliveryLocationGroup`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryLocationGroup) objects that organize fulfillment [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) objects and their associated delivery zones. [`DeliveryZone`](https://shopify.dev/docs/api/admin-graphql/latest/objects/DeliveryZone) objects define geographic regions with specific shipping methods and rates. Use the [`merchantOwnedOnly`](https://shopify.dev/docs/api/admin-graphql/latest/queries/deliveryProfiles#arguments-merchantOwnedOnly) filter to exclude profiles that third-party apps manage. Learn more about [delivery profiles](https://shopify.dev/docs/apps/build/purchase-options/deferred/delivery-and-deferment#whats-a-delivery-profile).

    POST /graphql.json

  • Read

    deliveryPromiseParticipants

    Returns delivery promise participants.

    POST /graphql.json

  • Read

    deliveryPromiseProvider

    Lookup a delivery promise provider.

    POST /graphql.json

  • Read

    deliveryPromiseSettings

    Represents the delivery promise settings for a shop.

    POST /graphql.json

  • Read

    discountCodesCount

    The total number of discount codes for the shop. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    discountNode

    Returns a `DiscountNode` resource by ID.

    POST /graphql.json

  • Read

    discountNodes

    Returns a list of discounts.

    POST /graphql.json

  • Read

    discountNodesCount

    The total number of discounts for the shop. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    discountRedeemCodeBulkCreation

    Returns a `DiscountRedeemCodeBulkCreation` resource by ID.

    POST /graphql.json

  • Read

    discountRedeemCodeSavedSearches

    List of the shop's redeemed discount code saved searches.

    POST /graphql.json

  • Read

    discountTags

    List of tags associated to discounts.

    POST /graphql.json

  • Read

    dispute

    Returns a `ShopifyPaymentsDispute` resource by ID.

    POST /graphql.json

  • Read

    disputeEvidence

    Returns a `ShopifyPaymentsDisputeEvidence` resource by ID.

    POST /graphql.json

  • Read

    disputes

    Returns a paginated list of all Shopify Payments disputes for the shop. Disputes occur when a buyer files a complaint with their payments provider, and the merchant must provide evidence to contest it. Each dispute includes the status, amount, reason, and associated order. Use this to monitor and manage open chargebacks and track dispute resolution outcomes.

    POST /graphql.json

  • Read

    domain

    Returns a `Domain` resource by ID.

    POST /graphql.json

  • Read

    draftOrder

    Retrieves a [draft order](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrder) by its ID. A draft order is an order created by a merchant on behalf of their customers. Draft orders contain all necessary order details (products, pricing, customer information) but require payment to be accepted before they can be converted into [completed orders](https://shopify.dev/docs/api/admin-graphql/latest/mutations/draftOrderComplete). Use the `draftOrder` query to retrieve information associated with the following workflows: - Creating orders for phone, in-person, or chat sales - Sending invoices to customers with secure checkout links - Managing custom items and additional costs - Selling products at discount or wholesale rates - Processing pre-orders and saving drafts for later completion A draft order is associated with a [customer](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) and contains multiple [line items](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrderLineItem). Each draft order has a [status](https://shopify.dev/docs/api/admin-graphql/latest/objects/DraftOrder#field-DraftOrder.fields.status), which indicates its progress through the sales workflow.

    POST /graphql.json

  • Read

    draftOrderAvailableDeliveryOptions

    Available delivery options for a [`DraftOrder`](https://shopify.dev/docs/api/admin-graphql/latest/objects/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. Accepts draft order details including [`LineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) objects, [`MailingAddress`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MailingAddress) for shipping, and discounts to determine which delivery methods are available. Pagination parameters control the number of local pickup options returned.

    POST /graphql.json

  • Read

    draftOrderSavedSearches

    List of the shop's draft order saved searches.

    POST /graphql.json

  • Read

    draftOrderTag

    Returns a `DraftOrderTag` resource by ID.

    POST /graphql.json

  • Read

    draftOrders

    List of saved draft orders.

    POST /graphql.json

  • Read

    draftOrdersCount

    Returns the number of draft orders that match the query. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    event

    Retrieves a single event by ID. Events chronicle activities in your store such as resource creation, updates, or staff comments. The query returns an [`Event`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Event) interface of type [`BasicEvent`](https://shopify.dev/docs/api/admin-graphql/latest/objects/BasicEvent) or [`CommentEvent`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CommentEvent).

    POST /graphql.json

  • Read

    events

    A paginated list of events that chronicle activities in the store. [`Event`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Event) is an interface implemented by types such as [`BasicEvent`](https://shopify.dev/docs/api/admin-graphql/latest/objects/BasicEvent) and [`CommentEvent`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CommentEvent) that track actions such as creating [`Article`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Article) objects, fulfilling [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) objects, adding [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) objects, or staff comments on timelines. The query supports filtering and sorting to help you find specific events or audit store activity over time.

    POST /graphql.json

  • Read

    eventsCount

    Count of events. Limited to a maximum of 10000.

    POST /graphql.json

  • Read

    fileSavedSearches

    A list of the shop's file saved searches.

    POST /graphql.json

  • Read

    files

    Retrieves a paginated list of files that have been uploaded to a Shopify store. Files represent digital assets that merchants can upload to their store for various purposes including product images, marketing materials, documents, and brand assets. Use the `files` query to retrieve information associated with the following workflows: - [Managing product media and images](https://shopify.dev/docs/apps/build/online-store/product-media) - [Theme development and asset management](https://shopify.dev/docs/storefronts/themes/store/success/brand-assets) - Brand asset management and [checkout branding](https://shopify.dev/docs/apps/build/checkout/styling/add-favicon) Files can include multiple [content types](https://shopify.dev/docs/api/admin-graphql/latest/enums/FileContentType), such as images, videos, 3D models, and generic files. Each file has properties like dimensions, file size, alt text for accessibility, and upload status. Files can be filtered by [media type](https://shopify.dev/docs/api/admin-graphql/latest/enums/MediaContentType) and can be associated with [products](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product), [themes](https://shopify.dev/docs/api/admin-graphql/latest/objects/OnlineStoreTheme), and other store resources.

    POST /graphql.json

  • Read

    financeAppAccessPolicy

    Returns the access policy for a finance app .

    POST /graphql.json

  • Read

    financeKycInformation

    Returns Know Your Customer (KYC) information for the shop's Shopify Payments account. KYC data includes verified identity and business details collected during onboarding. This is primarily used by embedded finance apps (e.g., Shopify Balance, Bill Pay) that need to verify the merchant's identity without requiring a separate KYC process.

    POST /graphql.json

  • Read

    fulfillment

    Retrieves a [`Fulfillment`](https://shopify.dev/docs/api/admin-graphql/latest/objects/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`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order). It includes tracking information, [`LineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem) objects, and the status of the fulfillment. Use this query to track the progress of shipped items, view tracking details, or check [fulfillment events](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentEvent) for example when a package is out for delivery or delivered.

    POST /graphql.json

  • Read

    fulfillmentConstraintRules

    The fulfillment constraint rules that belong to a shop.

    POST /graphql.json

  • Read

    fulfillmentOrder

    Returns a `FulfillmentOrder` resource by ID.

    POST /graphql.json

  • Read

    fulfillmentOrders

    The paginated list of all fulfillment orders. The returned fulfillment orders are filtered according to the [fulfillment order access scopes](https://shopify.dev/api/admin-graphql/latest/objects/fulfillmentorder#api-access-scopes) granted to the app. Use this query to retrieve fulfillment orders assigned to merchant-managed locations, third-party fulfillment service locations, or all kinds of locations together. For fetching only the fulfillment orders assigned to the app's locations, use the [assignedFulfillmentOrders](https://shopify.dev/api/admin-graphql/2024-07/objects/queryroot#connection-assignedfulfillmentorders) connection.

    POST /graphql.json

  • Read

    fulfillmentService

    Returns a [`FulfillmentService`](https://shopify.dev/docs/api/admin-graphql/latest/objects/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. When you register a fulfillment service, Shopify automatically creates an associated [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) where fulfillment order's can be assigned to be processed. Learn more about [building fulfillment service apps](https://shopify.dev/docs/apps/build/orders-fulfillment/fulfillment-service-apps/build-for-fulfillment-services).

    POST /graphql.json

  • Read

    giftCard

    Retrieves a [`GiftCard`](https://shopify.dev/docs/api/admin-graphql/latest/objects/GiftCard) by its ID. Returns the gift card's balance, transaction history, [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) information, and whether it's enabled. Additional fields include the initial value, expiration date, deactivation timestamp (if applicable), and the associated [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) if the gift card was purchased by a customer through checkout. Gift cards that merchants create manually won't have an associated order.

    POST /graphql.json

  • Read

    giftCardConfiguration

    The configuration for the shop's gift cards.

    POST /graphql.json

  • Read

    giftCards

    Returns a paginated list of [`GiftCard`](https://shopify.dev/docs/api/admin-graphql/latest/objects/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`](https://shopify.dev/docs/api/admin-graphql/latest/queries/giftCards#arguments-query) parameter. You can also apply [`SavedSearch`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SavedSearch) objects to filter results.

    POST /graphql.json

  • Read

    giftCardsCount

    Returns 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. The count includes all gift cards regardless of status (active, disabled, or fully redeemed). Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    inventoryItem

    Retrieves an [inventory item](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem) by its ID. An inventory item represents the inventory for a [product variant](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant), and holds the stock keeping unit (SKU), whether quantities are tracked, shipping requirements, and customs information. Use the [`inventoryLevels`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem#field-InventoryItem.fields.inventoryLevels) field to get the [inventory level](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel) for each location that stocks the item, and the level's [`quantities`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel#field-InventoryLevel.fields.quantities) field to read its inventory quantities by name. Learn more about [inventory object relationships](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states#inventory-object-relationships).

    POST /graphql.json

  • Read

    inventoryItems

    Returns a list of inventory items.

    POST /graphql.json

  • Read

    inventoryLevel

    Retrieves an [inventory level](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel) by its ID. An inventory level exists for an inventory item at each location that stocks it. Each inventory level has a [`quantities`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryLevel#field-InventoryLevel.fields.quantities) field to read the inventory quantity by name. Quantity names represent the [inventory states](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps#inventory-states) that merchants use to track inventory. The [`InventoryItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem) and [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) objects each have an `inventoryLevels` field. Use it to find the ID of an inventory level. Learn more about [inventory object relationships](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps/manage-quantities-states#inventory-object-relationships).

    POST /graphql.json

  • Read

    inventoryProperties

    Returns the shop's inventory configuration, including all inventory quantity names. Quantity names represent different [inventory states](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps#inventory-states) that merchants use to track inventory.

    POST /graphql.json

  • Read

    inventoryShipment

    Retrieves an [`InventoryShipment`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryShipment) by ID. Returns tracking details, [`InventoryShipmentLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryShipmentLineItem) objects with quantities, and the shipment's current [`InventoryShipmentStatus`](https://shopify.dev/docs/api/admin-graphql/latest/enums/InventoryShipmentStatus).

    POST /graphql.json

  • Read

    inventoryShipments

    Returns a paginated list of [`InventoryShipment`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryShipment) objects. Supports filtering by barcode (e.g. `barcode:"12345"`), status (e.g. `status:"draft"` or `status:"in_transit"`), and destination (e.g. `destination_id:12345`).

    POST /graphql.json

  • Read

    inventoryTransfer

    Returns an [`InventoryTransfer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryTransfer) by ID. Inventory transfers track the movement of inventory between locations, including origin and destination details, [`InventoryTransferLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryTransferLineItem) objects, quantities, and [`InventoryTransferStatus`](https://shopify.dev/docs/api/admin-graphql/latest/enums/InventoryTransferStatus) values.

    POST /graphql.json

  • Read

    inventoryTransfers

    Returns a paginated list of [`InventoryTransfer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryTransfer) objects between locations. Transfers track the movement of [`InventoryItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryItem) objects between [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) objects. Supports filtering transfers using query parameters and sorting by various criteria. Use the connection's edges to access transfer details including [`InventoryTransferLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/InventoryTransferLineItem) objects, quantities, and shipment status.

    POST /graphql.json

  • Read

    job

    Returns a Job resource by ID. Used to check the status of internal jobs and any applicable changes.

    POST /graphql.json

  • Read

    location

    Retrieves a [`Location`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Location) by its ID. Locations are physical places where merchants store inventory, such as warehouses, retail stores, or fulfillment centers. Each location tracks inventory levels, fulfillment capabilities, and address information. Active locations can stock products and fulfill orders based on their configuration settings.

    POST /graphql.json

  • Read

    locationByIdentifier

    Return a location by an identifier.

    POST /graphql.json

  • Read

    locations

    A paginated list of inventory locations where merchants can stock [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) items and fulfill [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) items. Returns only active locations by default. Use the [`includeInactive`](https://shopify.dev/docs/api/admin-graphql/latest/queries/locations#arguments-includeInactive) argument to retrieve deactivated locations that can no longer stock inventory or fulfill orders. Use the [`includeLegacy`](https://shopify.dev/docs/api/admin-graphql/latest/queries/locations#arguments-includeLegacy) argument to include locations that [`FulfillmentService`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentService) apps manage. Use the [`query`](https://shopify.dev/docs/api/admin-graphql/latest/queries/locations#arguments-query) argument to filter by location attributes like name, address, and whether local pickup is enabled.

    POST /graphql.json

  • Read

    locationsAvailableForDeliveryProfiles (deprecated)

    Returns a list of all origin locations available for a delivery profile.

    POST /graphql.json

  • Read

    locationsAvailableForDeliveryProfilesConnection

    Returns a list of all origin locations available for a delivery profile.

    POST /graphql.json

  • Read

    locationsCount

    Returns the count of locations for the given shop. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    manualHoldsFulfillmentOrders

    Returns a list of fulfillment orders that are on hold.

    POST /graphql.json

  • Read

    market

    Returns a `Market` resource by ID.

    POST /graphql.json

  • Read

    marketByGeography (deprecated)

    Returns the applicable market for a customer based on where they are in the world.

    POST /graphql.json

  • Read

    marketLocalizableResource

    A resource that can have localized values for different markets.

    POST /graphql.json

  • Read

    marketLocalizableResources

    Resources that can have localized values for different markets.

    POST /graphql.json

  • Read

    marketLocalizableResourcesByIds

    Resources that can have localized values for different markets.

    POST /graphql.json

  • Read

    marketingActivities

    A list of marketing activities associated with the marketing app.

    POST /graphql.json

  • Read

    marketingActivity

    Returns a `MarketingActivity` resource by ID.

    POST /graphql.json

  • Read

    marketingEvent

    Returns a `MarketingEvent` resource by ID.

    POST /graphql.json

  • Read

    marketingEvents

    A list of marketing events associated with the marketing app.

    POST /graphql.json

  • Read

    markets

    Returns a paginated list of [`Market`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Market) objects configured for the shop. Markets match buyers based on defined conditions to deliver customized shopping experiences. Filter markets by [`MarketType`](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketType) and [`MarketStatus`](https://shopify.dev/docs/api/admin-graphql/latest/enums/MarketStatus), search by name, and control sort order. Retrieve market configurations including [`MarketCurrencySettings`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketCurrencySettings), [`MarketWebPresence`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketWebPresence) objects, and [`MarketConditions`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketConditions). Learn more about [Shopify Markets](https://shopify.dev/docs/apps/build/markets).

    POST /graphql.json

  • Read

    marketsResolvedValues

    The resolved values for a buyer signal.

    POST /graphql.json

  • Read

    menu

    Returns a `Menu` resource by ID.

    POST /graphql.json

  • Read

    menus

    Retrieves navigation menus. Menus organize content into hierarchical navigation structures that merchants can display in the online store (for example, in headers, footers, and sidebars) and customer accounts. Each [`Menu`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Menu) contains a handle for identification, a title for display, and a collection of [`MenuItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MenuItem) objects that can be nested up to 3 levels deep. Default menus have protected handles that can't be modified.

    POST /graphql.json

  • Read

    metafieldDefinition

    Retrieves a [`MetafieldDefinition`](https://shopify.dev/docs/api/admin-graphql/current/objects/MetafieldDefinition) by its identifier. You can identify a definition using either its owner type, namespace, and key, or its global ID. Use this query to inspect a definition's configuration, including its data type, validations, access settings, and the count of [metafields](https://shopify.dev/docs/api/admin-graphql/current/objects/Metafield) using it.

    POST /graphql.json

  • Read

    metafieldDefinitionTypes

    The available metafield types that you can use when creating [`MetafieldDefinition`](https://shopify.dev/docs/api/admin-graphql/current/objects/MetafieldDefinition) objects. Each type specifies what kind of data it stores (such as boolean, color, date, or references), its category, and which validations it supports. For a list of supported types and their capabilities, refer to the [metafield types documentation](https://shopify.dev/docs/apps/metafields/types).

    POST /graphql.json

  • Read

    metafieldDefinitions

    Returns a list of metafield definitions.

    POST /graphql.json

  • Read

    metaobject

    Retrieves a single [`Metaobject`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metaobject) by its global ID. [Metaobjects](https://shopify.dev/docs/apps/build/custom-data#what-are-metaobjects) store custom structured data based on defined schemas. The returned metaobject includes its fields with values, display name, handle, and associated metadata like update timestamps and capabilities.

    POST /graphql.json

  • Read

    metaobjectByHandle

    Retrieves a [`Metaobject`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metaobject) by its handle and type. Handles are unique identifiers within a metaobject type.

    POST /graphql.json

  • Read

    metaobjectDefinition

    Retrieves a [`MetaobjectDefinition`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectDefinition) by its global ID. Metaobject definitions provide the structure and fields for metaobjects. The definition includes field configurations, access settings, display preferences, and capabilities that determine how [metaobjects](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metaobject) of this type behave across the Shopify platform.

    POST /graphql.json

  • Read

    metaobjectDefinitionByType

    Retrieves a [`MetaobjectDefinition`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectDefinition) by its type. The type serves as a unique identifier that distinguishes one metaobject definition from another.

    POST /graphql.json

  • Read

    metaobjectDefinitions

    Returns a paginated list of all [`MetaobjectDefinition`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MetaobjectDefinition) objects configured for the store. Metaobject definitions provide the schema for creating custom data structures composed of individual fields. Each definition specifies the field types, access permissions, and capabilities for [`Metaobject`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metaobject) entries of that type. Use this query to discover available metaobject types before creating or querying metaobject entries. Learn more about [managing metaobjects](https://shopify.dev/docs/apps/build/custom-data/metaobjects/manage-metaobjects).

    POST /graphql.json

  • Read

    metaobjects

    Returns a paginated list of [`Metaobject`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metaobject) entries for a specific type. Metaobjects are custom data structures that extend Shopify's data model with merchant or app-specific data types. Filter results using the query parameter with a search syntax for metaobject fields. Use `fields.{key}:{value}` to filter by field values, supporting any field previously marked as filterable. Results are ordered by metaobject ID in ascending order by default. The `sortKey` parameter accepts `id`, `type`, `updated_at`, or `display_name` to control result ordering. Pass `reverse: true` to invert the order. Learn more about [querying metaobjects by field value](https://shopify.dev/docs/apps/build/custom-data/metafields/query-by-metafield-value).

    POST /graphql.json

  • Read

    mobilePlatformApplication

    Return a mobile platform application by its ID.

    POST /graphql.json

  • Read

    mobilePlatformApplications

    List the mobile platform applications.

    POST /graphql.json

  • Read

    node

    Returns a specific node (any object that implements the [Node](https://shopify.dev/api/admin-graphql/latest/interfaces/Node) interface) by ID, in accordance with the [Relay specification](https://relay.dev/docs/guides/graphql-server-specification/#object-identification). This field is commonly used for refetching an object.

    POST /graphql.json

  • Read

    nodes

    Returns the list of nodes (any objects that implement the [Node](https://shopify.dev/api/admin-graphql/latest/interfaces/Node) interface) with the given IDs, in accordance with the [Relay specification](https://relay.dev/docs/guides/graphql-server-specification/#object-identification).

    POST /graphql.json

  • Read

    onlineStore

    The shop's online store channel.

    POST /graphql.json

  • Read

    order

    The `order` query retrieves an [order](https://shopify.dev/docs/api/admin-graphql/latest/objects/order) by its ID. This query provides access to comprehensive order information such as customer details, line items, financial data, and fulfillment status. Use the `order` query to retrieve information associated with the following processes: - [Order management and fulfillment](https://shopify.dev/docs/apps/build/orders-fulfillment/order-management-apps) - [Financial reporting](https://help.shopify.com/manual/finance) - [Customer purchase history](https://help.shopify.com/manual/reports-and-analytics/shopify-reports/report-types/default-reports/customers-reports) and [transaction analysis](https://shopify.dev/docs/apps/launch/billing/view-charges-earnings#transaction-data-through-the-graphql-admin-api) - [Shipping](https://shopify.dev/docs/apps/build/checkout/delivery-shipping) and [inventory management](https://shopify.dev/docs/apps/build/orders-fulfillment/inventory-management-apps) You can only retrieve the last 60 days worth of orders from a store by default. If you want to access older orders, then you need to [request access to all orders](https://shopify.dev/docs/api/usage/access-scopes#orders-permissions). For large order datasets, consider using [bulk operations](https://shopify.dev/docs/api/usage/bulk-operations/queries). Bulk operations handle pagination automatically and allow you to retrieve data asynchronously without being constrained by API rate limits. Learn more about [creating orders](https://shopify.dev/docs/api/admin-graphql/latest/mutations/ordercreate) and [building order management apps](https://shopify.dev/docs/apps/build/orders-fulfillment).

    POST /graphql.json

  • Read

    orderByIdentifier

    Return an order by an identifier.

    POST /graphql.json

  • Read

    orderEditSession

    Returns a `OrderEditSession` resource by ID.

    POST /graphql.json

  • Read

    orderPaymentStatus

    Retrieves 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. Deferred payments are called [payment terms](https://shopify.dev/docs/apps/build/checkout/payments/payment-terms) in the API. The query returns an [`OrderPaymentStatus`](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderPaymentStatus) object that includes the current payment status, any error messages, and associated transactions. Poll this query to track [asynchronous payment processing](https://shopify.dev/docs/apps/build/payments/processing) after initiating a deferred payment.

    POST /graphql.json

  • Read

    orderSavedSearches

    Returns [saved searches](https://shopify.dev/docs/api/admin-graphql/latest/objects/SavedSearch) for orders in the shop. Saved searches store search queries with their filters and search terms.

    POST /graphql.json

  • Read

    orders

    Returns a list of [orders](https://shopify.dev/api/admin-graphql/latest/objects/Order) placed in the store, including data such as order status, customer, and line item details. Use the `orders` query to build reports, analyze sales performance, or automate fulfillment workflows. The `orders` query supports [pagination](https://shopify.dev/docs/api/usage/pagination-graphql), [sorting](https://shopify.dev/docs/api/admin-graphql/latest/queries/orders#arguments-sortKey), and [filtering](https://shopify.dev/docs/api/admin-graphql/latest/queries/orders#arguments-query).

    POST /graphql.json

  • Read

    ordersCount

    Returns the number of [orders](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) in the shop. You can filter orders using [search syntax](https://shopify.dev/docs/api/usage/search-syntax) or a [`SavedSearch`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SavedSearch), and set a maximum count limit to control query performance. Use the [`query`](https://shopify.dev/docs/api/admin-graphql/latest/queries/ordersCount#arguments-query) argument to filter the count by criteria like order status, financial state, or fulfillment status. The response includes both the count value and its precision, indicating whether the count is exact or an estimate. > Note: > The count is limited to 10,000 orders by default. Use the [`limit`](https://shopify.dev/docs/api/admin-graphql/latest/queries/ordersCount#arguments-limit) argument to adjust this value, or pass `null` for no limit. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    page

    Returns a `Page` resource by ID.

    POST /graphql.json

  • Read

    pages

    A paginated list of pages from the online store. [`Page`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Page) objects are content pages that merchants create to provide information to customers, such as "About Us", "Contact", or policy pages. The query supports filtering with a [search query](https://shopify.dev/docs/api/usage/search-syntax) and sorting by various criteria. Advanced filtering is available through saved searches using the [`savedSearchId`](https://shopify.dev/docs/api/admin-graphql/latest/queries/pages#arguments-savedSearchId) argument.

    POST /graphql.json

  • Read

    pagesCount

    Count of pages. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    paymentCustomization

    The payment customization.

    POST /graphql.json

  • Read

    paymentCustomizations

    The payment customizations.

    POST /graphql.json

  • Read

    paymentTermsTemplates

    The list of payment terms templates eligible for all shops and users.

    POST /graphql.json

  • Read

    pendingOrdersCount

    The number of pendings orders. Limited to a maximum of 10000.

    POST /graphql.json

  • Read

    pointOfSaleDevice

    Returns a `PointOfSaleDevice` resource by ID.

    POST /graphql.json

  • Read

    pointOfSaleDevicePaymentSession

    Lookup a point of sale device payment session by ID.

    POST /graphql.json

  • Read

    pointOfSaleDevicePaymentSessions

    A list of point of sale device payment sessions in the shop. Cash management data is returned only for locations with a POS Pro subscription.

    POST /graphql.json

  • Read

    priceList

    Returns a [`PriceList`](https://shopify.dev/docs/api/admin-graphql/latest/objects/PriceList) by ID. You can use price lists to specify either fixed prices or adjusted relative prices that override initial [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) prices. Price lists enable contextual pricing for the [`Catalog`](https://shopify.dev/docs/api/admin-graphql/latest/interfaces/Catalog) they are associated to. Each price list can define fixed prices for specific [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects or percentage-based adjustments relative to other prices.

    POST /graphql.json

  • Read

    priceLists

    All price lists for a shop.

    POST /graphql.json

  • Read

    primaryMarket (deprecated)

    The primary market of the shop.

    POST /graphql.json

  • Read

    privacySettings

    Privacy related settings for a shop.

    POST /graphql.json

  • Read

    product

    Retrieves a [product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) by its ID. A product is an item that a merchant can sell in their store. Use the `product` query when you need to: - Access essential product data (for example, title, description, price, images, SEO metadata, and metafields). - Build product detail pages and manage inventory. - Handle international sales with localized pricing and content. - Manage product variants and product options. Learn more about working with [Shopify's product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/product-model-components).

    POST /graphql.json

  • Read

    productByHandle (deprecated)

    Retrieves a [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) using its handle. A handle is a unique, URL-friendly string that Shopify automatically generates from the product's title. Returns `null` if no product exists with the specified handle.

    POST /graphql.json

  • Read

    productByIdentifier

    Return a product by an identifier.

    POST /graphql.json

  • Read

    productDuplicateJob

    Returns the product duplicate job.

    POST /graphql.json

  • Read

    productFeed

    Returns a ProductFeed resource by ID.

    POST /graphql.json

  • Read

    productFeeds

    The product feeds for the shop.

    POST /graphql.json

  • Read

    productOperation

    Returns a ProductOperation resource by ID. This can be used to query the [ProductSetOperation](https://shopify.dev/api/admin-graphql/current/objects/ProductSetOperation), using the ID that was returned [when the product was created or updated](https://shopify.dev/api/admin/migrate/new-product-model/sync-data#create-a-product-with-variants-and-options-asynchronously) by the [ProductSet](https://shopify.dev/api/admin-graphql/current/mutations/productSet) mutation. The `status` field indicates whether the operation is `CREATED`, `ACTIVE`, or `COMPLETE`. The `product` field provides the details of the created or updated product. For the [ProductSetOperation](https://shopify.dev/api/admin-graphql/current/objects/ProductSetOperation), the `userErrors` field provides mutation errors that occurred during the operation.

    POST /graphql.json

  • Read

    productResourceFeedback

    Retrieves product resource feedback for the currently authenticated app, providing insights into product data quality, completeness, and optimization opportunities. This feedback helps apps guide merchants toward better product listings and improved store performance. For example, an SEO app might receive feedback indicating that certain products lack meta descriptions or have suboptimal titles, enabling the app to provide specific recommendations for improving search visibility and conversion rates. Use `ProductResourceFeedback` to: - Display product optimization recommendations to merchants - Identify data quality issues across product catalogs - Build product improvement workflows and guided experiences - Track progress on product listing completeness and quality - Implement automated product auditing and scoring systems - Generate reports on catalog health and optimization opportunities - Provide contextual suggestions within product editing interfaces The feedback system evaluates products against various criteria including SEO best practices, required fields, media quality, and sales channel requirements. Each feedback item includes specific details about the issue, suggested improvements, and priority levels. Feedback is app-specific and reflects the particular focus of your application - marketing apps receive different insights than inventory management apps. The system continuously updates as merchants make changes, providing real-time guidance for product optimization. This resource is particularly valuable for apps that help merchants improve their product listings, optimize for search engines, or enhance their overall catalog quality. The feedback enables proactive suggestions rather than reactive problem-solving. Learn more about [product optimization](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product).

    POST /graphql.json

  • Read

    productSavedSearches

    Returns a list of the shop's product saved searches.

    POST /graphql.json

  • Read

    productTags

    Returns tags added to [`Product`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) objects in the shop. Provides a paginated list of tag strings. The maximum page size is 5000 tags per request. Tags are returned as simple strings through a [`StringConnection`](https://shopify.dev/docs/api/admin-graphql/latest/objects/StringConnection). The maximum page size is 5000.

    POST /graphql.json

  • Read

    productTypes

    Returns a paginated list of product types assigned to [products](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) in the store. The maximum page size is 1000. The maximum page size is 1000.

    POST /graphql.json

  • Read

    productVariant

    Retrieves a [product variant](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) by its ID. A product variant is a specific version of a [product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) that comes in more than one [option](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOption), such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another. Use the `productVariant` query when you need to: - Access essential product variant data (for example, title, price, image, and metafields). - Build product detail pages and manage inventory. - Handle international sales with localized pricing and content. - Manage product variants that are part of a bundle or selling plan. Learn more about working with [Shopify's product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/product-model-components).

    POST /graphql.json

  • Read

    productVariantByIdentifier

    Return a product variant by an identifier.

    POST /graphql.json

  • Read

    productVariants

    Retrieves a list of [product variants](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) associated with a [product](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product). A product variant is a specific version of a product that comes in more than one [option](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductOption), such as size or color. For example, if a merchant sells t-shirts with options for size and color, then a small, blue t-shirt would be one product variant and a large, blue t-shirt would be another. Use the `productVariants` query when you need to: - Search for product variants by attributes such as SKU, barcode, or inventory quantity. - Filter product variants by attributes, such as whether they're gift cards or have custom metafields. - Fetch product variants for bulk operations, such as updating prices or inventory. - Preload data for product variants, such as inventory items, selected options, or associated products. The `productVariants` query supports [pagination](https://shopify.dev/docs/api/usage/pagination-graphql) to handle large product catalogs and [saved searches](https://shopify.dev/docs/api/admin-graphql/latest/queries/productVariants#arguments-savedSearchId) for frequently used product variant queries. The `productVariants` query returns product variants with their associated metadata, including: - Basic product variant information (for example, title, SKU, barcode, price, and inventory) - Media attachments (for example, images and videos) - Associated products, selling plans, bundles, and metafields Learn more about working with [Shopify's product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/product-model-components).

    POST /graphql.json

  • Read

    productVariantsCount

    Count of product variants. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    productVendors

    The list of vendors added to products. The maximum page size is 1000.

    POST /graphql.json

  • Read

    products

    Retrieves a list of [products](https://shopify.dev/docs/api/admin-graphql/latest/objects/Product) in a store. Products are the items that merchants can sell in their store. Use the `products` query when you need to: - Build a browsing interface for a product catalog. - Create product [searching](https://shopify.dev/docs/api/usage/search-syntax), [sorting](https://shopify.dev/docs/api/admin-graphql/latest/queries/products#arguments-sortKey), and [filtering](https://shopify.dev/docs/api/admin-graphql/latest/queries/products#arguments-query) experiences. - Implement product recommendations. - Sync product data with external systems. The `products` query supports [pagination](https://shopify.dev/docs/api/usage/pagination-graphql) to handle large product catalogs and [saved searches](https://shopify.dev/docs/api/admin-graphql/latest/queries/products#arguments-savedSearchId) for frequently used product queries. The `products` query returns products with their associated metadata, including: - Basic product information (for example, title, description, vendor, and type) - Product options and product variants, with their prices and inventory - Media attachments (for example, images and videos) - SEO metadata - Product categories and tags - Product availability and publishing statuses Learn more about working with [Shopify's product model](https://shopify.dev/docs/apps/build/graphql/migrate/new-product-model/product-model-components).

    POST /graphql.json

  • Read

    productsCount

    Count of products. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    publicApiVersions

    The list of publicly-accessible Admin API versions, including supported versions, the release candidate, and unstable versions.

    POST /graphql.json

  • Read

    publication

    Retrieves a [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication) by [`ID`](https://shopify.dev/docs/api/usage/gids). Returns `null` if the publication doesn't exist.

    POST /graphql.json

  • Read

    publications

    Returns a paginated list of [`Publication`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Publication). Filter publications by [`CatalogType`](https://shopify.dev/docs/api/admin-graphql/latest/enums/CatalogType).

    POST /graphql.json

  • Read

    publicationsCount

    Count of publications. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    publishedProductsCount

    Returns a count of published products by publication ID. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    refund

    Retrieves a [refund](https://shopify.dev/docs/api/admin-graphql/latest/objects/Refund) by its ID. A refund represents a financial record of money returned to a customer from an order. It provides a comprehensive view of all refunded amounts, transactions, and restocking instructions associated with returning products or correcting order issues. Use the `refund` query to retrieve information associated with the following workflows: - Displaying refund details in order management interfaces - Building customer service tools for reviewing refund history - Creating reports on refunded amounts and reasons - Auditing refund transactions and payment gateway records - Tracking inventory impacts from refunded items A refund is associated with an [order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) and includes [refund line items](https://shopify.dev/docs/api/admin-graphql/latest/objects/RefundLineItem) that specify which items were refunded. Each refund processes through [order transactions](https://shopify.dev/docs/api/admin-graphql/latest/objects/OrderTransaction) that handle the actual money transfer back to the customer.

    POST /graphql.json

  • Read

    return

    Retrieves 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. Use the `return` query to retrieve information associated with the following workflows: - [Managing returns](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/build-return-management) - [Processing exchanges](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/manage-exchanges) - [Tracking reverse fulfillment orders](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/manage-reverse-fulfillment-orders) A return is associated with an [order](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) and can include multiple return [line items](https://shopify.dev/docs/api/admin-graphql/latest/objects/LineItem). Each return has a [status](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps#return-statuses), which indicates the state of the return.

    POST /graphql.json

  • Read

    returnCalculate

    Calculates the financial outcome of a [`Return`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Return) without creating it. Use this query to preview return costs before initiating the actual return process. The calculation provides detailed breakdowns of refund amounts, taxes, [`RestockingFee`](https://shopify.dev/docs/api/admin-graphql/latest/objects/RestockingFee) charges, return shipping fees, and order-level discount adjustments based on the [`FulfillmentLineItem`](https://shopify.dev/docs/api/admin-graphql/latest/objects/FulfillmentLineItem) objects that customers select for return. Learn more about building for [return management](https://shopify.dev/docs/apps/build/orders-fulfillment/returns-apps/build-return-management).

    POST /graphql.json

  • Read

    returnReasonDefinitions

    Returns the full library of available return reason definitions. Use this query to retrieve the standardized return reasons available for creating returns. Filter by IDs or handles to get specific definitions. Only non-deleted reasons should be shown to customers when creating new returns. Deleted reasons have been replaced with better alternatives and are no longer recommended. However, they remain valid options and may still appear on existing returns.

    POST /graphql.json

  • Read

    returnableFulfillment

    Returns a `ReturnableFulfillment` resource by ID.

    POST /graphql.json

  • Read

    returnableFulfillments

    List of returnable fulfillments.

    POST /graphql.json

  • Read

    reverseDelivery

    Lookup a reverse delivery by ID.

    POST /graphql.json

  • Read

    reverseFulfillmentOrder

    Lookup a reverse fulfillment order by ID.

    POST /graphql.json

  • Read

    scriptTag

    <div class="note"><h4>Theme app extensions</h4> <p>If your app integrates with a Shopify theme and you plan to submit it to the Shopify App Store, you must use theme app extensions instead of Script tags. Script tags can only be used with vintage themes. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div> Returns a `ScriptTag` resource by ID.

    POST /graphql.json

  • Read

    scriptTags

    <div class="note"><h4>Theme app extensions</h4> <p>If your app integrates with a Shopify theme and you plan to submit it to the Shopify App Store, you must use theme app extensions instead of Script tags. Script tags can only be used with vintage themes. <a href="/apps/online-store#what-integration-method-should-i-use" target="_blank">Learn more</a>.</p></div> A list of script tags.

    POST /graphql.json

  • Read

    segment

    Retrieves a customer [`Segment`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Segment) by ID. Segments are dynamic groups of customers that meet specific criteria defined through [ShopifyQL queries](https://shopify.dev/docs/api/shopifyql/segment-query-language-reference). Use segments for targeted marketing campaigns, analyzing customer behavior, or creating personalized experiences. Each segment includes its name, creation date, and the query that defines which [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) objects belong to it.

    POST /graphql.json

  • Read

    segmentFilterSuggestions

    A list of filter suggestions associated with a segment. A segment is a group of members (commonly customers) that meet specific criteria.

    POST /graphql.json

  • Read

    segmentFilters

    A list of filters.

    POST /graphql.json

  • Read

    segmentMigrations (deprecated)

    A list of a shop's segment migrations.

    POST /graphql.json

  • Read

    segmentValueSuggestions

    The list of suggested values corresponding to a particular filter for a segment. A segment is a group of members, such as customers, that meet specific criteria.

    POST /graphql.json

  • Read

    segments

    Returns a paginated list of [`Segment`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Segment) objects for the shop. Segments are dynamic groups of customers that meet specific criteria defined through [ShopifyQL queries](https://shopify.dev/docs/api/shopifyql/segment-query-language-reference). You can filter segments by search query and sort them by creation date or other criteria. The query supports standard [pagination](https://shopify.dev/docs/api/usage/pagination-graphql) arguments and returns a [`SegmentConnection`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SegmentConnection) containing segment details including names, creation dates, and the query definitions that determine segment membership.

    POST /graphql.json

  • Read

    segmentsCount

    The number of segments for a shop. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    sellingPlanGroup

    Returns a `SellingPlanGroup` resource by ID.

    POST /graphql.json

  • Read

    sellingPlanGroups

    Retrieves a paginated list of [`SellingPlanGroup`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlanGroup) objects that belong to the app making the API call. Selling plan groups are selling methods like subscriptions, preorders, or other purchase options that merchants offer to customers. Each group has one or more [`SellingPlan`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SellingPlan) objects that define specific billing and delivery schedules, pricing adjustments, and policies. Use the [`query`](https://shopify.dev/docs/api/admin-graphql/latest/queries/sellingPlanGroups#arguments-query) argument to search by name or filter results by other criteria. Learn more about [building selling plans](https://shopify.dev/docs/apps/build/purchase-options/subscriptions/selling-plans).

    POST /graphql.json

  • Read

    serverPixel

    The server pixel configured by the app.

    POST /graphql.json

  • Read

    shop

    Returns the Shop resource corresponding to the access token used in the request. The Shop resource contains business and store management settings for the shop.

    POST /graphql.json

  • Read

    shopBillingPreferences

    The 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](https://shopify.dev/docs/apps/launch/billing#supported-currencies), helping them budget their app spend without exposure to exchange rate fluctuations.

    POST /graphql.json

  • Read

    shopLocales

    Returns the locales enabled on a shop. Each locale represents a language for translations and determines how content displays to customers in different markets. Use the optional `published` argument to filter for only the locales that are visible to customers. The response includes the ISO locale code, whether it's the shop's primary locale, and which [`MarketWebPresence`](https://shopify.dev/docs/api/admin-graphql/latest/objects/MarketWebPresence) objects use each locale.

    POST /graphql.json

  • Read

    shopPayPaymentRequestReceipt

    Returns 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. Use this to look up a specific Shop Pay transaction for order reconciliation or customer support.

    POST /graphql.json

  • Read

    shopPayPaymentRequestReceipts

    Returns a paginated list of Shop Pay payment request receipts for the shop. Each receipt documents a completed Shop Pay transaction. Use this to review Shop Pay transaction history, generate reports, or audit Shop Pay payment activity.

    POST /graphql.json

  • Read

    shopifyFunction

    Returns a Shopify Function by its ID. [Functions](https://shopify.dev/apps/build/functions) enable you to customize Shopify's backend logic at defined parts of the commerce loop.

    POST /graphql.json

  • Read

    shopifyFunctions

    Returns Shopify Functions owned by the querying API client installed on the shop. [Functions](https://shopify.dev/docs/apps/build/functions) enable you to customize Shopify's backend logic at specific points in the commerce loop, such as discounts, checkout validation, and fulfillment. You can filter the results by API type to find specific function implementations, or by whether they provide a merchant configuration interface in the Shopify Admin. The response includes details about each function's configuration, including its title, description, API version, and the input query used to provide data to the function logic. Learn more about [building functions](https://shopify.dev/docs/api/functions).

    POST /graphql.json

  • Read

    shopifyPaymentsAccount

    Returns the Shopify Payments account information for the shop. Includes current balances across all currencies, payout schedules, and bank account configurations. The account includes [`ShopifyPaymentsBalanceTransaction`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsBalanceTransaction) records showing charges, refunds, and adjustments that affect your balance. Also includes [`ShopifyPaymentsDispute`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsDispute) records and [`ShopifyPaymentsPayout`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsPayout) history between the account and connected [`ShopifyPaymentsBankAccount`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ShopifyPaymentsBankAccount) configurations.

    POST /graphql.json

  • Read

    shopifyqlQuery

    Executes a [ShopifyQL query](https://shopify.dev/docs/apps/build/shopifyql) to analyze store data and returns results in a tabular format. The response includes column metadata with names, data types, and display names, along with the actual data rows. If the query contains syntax errors, then the response provides parse error messages instead of table data. Read the [ShopifyQL reference documentation](https://shopify.dev/docs/api/shopifyql) for more information on how to write ShopifyQL queries.

    POST /graphql.json

  • Read

    staffMember

    Retrieves a [staff member](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) by ID. If no ID is provided, the query returns the staff member that's making the request. A staff member is a user who can access the Shopify admin to manage store operations. Provides staff member details such as email, name, and shop owner status. When querying the current user (with or without an ID), additional [private data](https://shopify.dev/docs/api/admin-graphql/latest/queries/staffMember#returns-StaffMember.fields.privateData) becomes available.

    POST /graphql.json

  • Read

    staffMembers

    Returns a paginated list of [`StaffMember`](https://shopify.dev/docs/api/admin-graphql/latest/objects/StaffMember) objects for the shop. Staff members are users who can access the Shopify admin to manage store operations. Supports filtering by account type, email, and name, with an option to sort results. The query returns a [`StaffMemberConnection`](https://shopify.dev/docs/api/admin-graphql/latest/connections/StaffMemberConnection) for [cursor-based pagination](https://shopify.dev/docs/api/usage/pagination-graphql).

    POST /graphql.json

  • Read

    standardMetafieldDefinitionTemplates

    Retrieves preset metafield definition templates for common use cases. Each template provides a reserved namespace and key combination for specific purposes like product subtitles, care guides, or ISBN numbers. Use these templates to create standardized metafields across your store. Filter templates by constraint status or exclude those you've already activated. See the [list of standard metafield definitions](https://shopify.dev/docs/apps/build/custom-data/metafields/list-of-standard-definitions) for available templates.

    POST /graphql.json

  • Read

    storeCreditAccount

    Retrieves a [`StoreCreditAccount`](https://shopify.dev/docs/api/admin-graphql/latest/objects/StoreCreditAccount) by ID. Store credit accounts hold monetary balances that account owners can use at checkout. The owner is either a [`Customer`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) or a [`CompanyLocation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CompanyLocation).

    POST /graphql.json

  • Read

    storeCreditConfiguration

    Returns the store credit configuration for a shop, including whether store credit is enabled for customers at checkout. Use this to display the current state of a merchant's store credit program or check eligibility before issuing store credit to customers.

    POST /graphql.json

  • Read

    subscriptionBillingAttempt

    Returns a `SubscriptionBillingAttempt` resource by ID.

    POST /graphql.json

  • Read

    subscriptionBillingAttempts

    Returns subscription billing attempts on a store.

    POST /graphql.json

  • Read

    subscriptionBillingCycle

    Returns a subscription billing cycle found either by cycle index or date.

    POST /graphql.json

  • Read

    subscriptionBillingCycleBulkResults

    Retrieves the results of the asynchronous job for the subscription billing cycle bulk action based on the specified job ID. This query can be used to obtain the billing cycles that match the criteria defined in the subscriptionBillingCycleBulkSearch and subscriptionBillingCycleBulkCharge mutations.

    POST /graphql.json

  • Read

    subscriptionBillingCycles

    Returns subscription billing cycles for a contract ID.

    POST /graphql.json

  • Read

    subscriptionContract

    Retrieves a [`SubscriptionContract`](https://shopify.dev/docs/api/customer/latest/objects/SubscriptionContract) by ID. The contract tracks the subscription's lifecycle through various [statuses](https://shopify.dev/docs/api/admin-graphql/latest/queries/subscriptionContract#returns-SubscriptionContract.fields.status), and links to related billing attempts, generated [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order) objects, and the customer's [`CustomerPaymentMethod`](https://shopify.dev/docs/api/admin-graphql/latest/objects/CustomerPaymentMethod).

    POST /graphql.json

  • Read

    subscriptionContracts

    Returns a [`SubscriptionContractConnection`](https://shopify.dev/docs/api/admin-graphql/latest/objects/SubscriptionContractConnection) containing [subscription contracts](https://shopify.dev/docs/api/customer/latest/objects/SubscriptionContract). Subscription contracts are agreements between [customers](https://shopify.dev/docs/api/admin-graphql/latest/objects/Customer) and merchants for recurring purchases with defined billing and delivery schedules. Filter results with the [`query`](https://shopify.dev/docs/api/admin-graphql/latest/queries/subscriptionContracts#arguments-query) argument. You can paginate results using standard [cursor-based pagination](https://shopify.dev/docs/api/usage/pagination-graphql).

    POST /graphql.json

  • Read

    subscriptionDraft (deprecated)

    Returns a Subscription Draft resource by ID.

    POST /graphql.json

  • Read

    taxonomy

    Access to Shopify's [standardized product taxonomy](https://shopify.github.io/product-taxonomy/releases/unstable/?categoryId=sg-4-17-2-17) for categorizing products. The [`Taxonomy`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Taxonomy) organizes products into a hierarchical tree structure with categories, attributes, and values. Query categories using search terms, or navigate the hierarchy by requesting children, siblings, or descendants of specific categories. Each [`TaxonomyCategory`](https://shopify.dev/docs/api/admin-graphql/latest/objects/TaxonomyCategory) includes its position in the tree, parent-child relationships, and associated attributes for that product category.

    POST /graphql.json

  • Read

    tenderTransactions

    Transactions representing a movement of money between customers and the shop. Each transaction records the amount, payment method, processing details, and the associated [`Order`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Order). Positive amounts indicate customer payments to the merchant. Negative amounts represent refunds from the merchant to the customer. Use the [`query`](https://shopify.dev/docs/api/admin-graphql/latest/queries/tenderTransactions#arguments-query) parameter to filter transactions by attributes such as transaction ID, processing date, and point-of-sale device ID.

    POST /graphql.json

  • Read

    theme

    Returns an [`OnlineStoreTheme`](https://shopify.dev/docs/api/admin-graphql/latest/objects/OnlineStoreTheme) by its ID. Use this query to retrieve theme metadata and access the theme's [`files`](https://shopify.dev/docs/api/admin-graphql/latest/queries/theme#returns-OnlineStoreTheme.fields.files), which include templates, assets, [translations](https://shopify.dev/docs/api/admin-graphql/latest/objects/OnlineStoreTheme#field-published_translations), and configuration files.

    POST /graphql.json

  • Read

    themes

    Returns a paginated list of [`OnlineStoreTheme`](https://shopify.dev/docs/api/admin-graphql/latest/objects/OnlineStoreTheme) objects for the online store. Themes control the appearance and layout of the storefront. You can filter themes by [`role`](https://shopify.dev/docs/api/admin-graphql/latest/queries/themes#arguments-roles) to find specific theme types, such as `MAIN` for the published theme and `UNPUBLISHED` for draft themes.

    POST /graphql.json

  • Read

    translatableResource

    Retrieves a resource that has translatable fields. Returns the resource's [`Translation`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Translation) objects for different locales and markets, along with the original [`TranslatableContent`](https://shopify.dev/docs/api/admin-graphql/latest/objects/TranslatableContent) and digest values needed to register new translations. Provides access to existing translations, translatable content with digest hashes for translation registration, and nested translatable resources like [`ProductVariant`](https://shopify.dev/docs/api/admin-graphql/latest/objects/ProductVariant) objects or [`Metafield`](https://shopify.dev/docs/api/admin-graphql/latest/objects/Metafield) objects. Learn more about [managing translated content](https://shopify.dev/docs/apps/build/markets/manage-translated-content).

    POST /graphql.json

  • Read

    translatableResources

    Returns a paginated list of [`TranslatableResource`](https://shopify.dev/docs/api/admin-graphql/latest/objects/TranslatableResource) objects for a specific resource type. Each resource provides translatable content and digest values needed for the [`translationsRegister`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/translationsRegister) mutation. Learn more about [managing translated content](https://shopify.dev/docs/apps/build/markets/manage-translated-content). Learn more about [managing translated content](https://shopify.dev/docs/apps/build/markets/manage-translated-content).

    POST /graphql.json

  • Read

    translatableResourcesByIds

    Returns a paginated list of [`TranslatableResource`](https://shopify.dev/docs/api/admin-graphql/latest/objects/TranslatableResource) objects for the specified resource IDs. Each resource provides translatable content and digest values needed for the [`translationsRegister`](https://shopify.dev/docs/api/admin-graphql/latest/mutations/translationsRegister) mutation. Learn more about [managing translated content](https://shopify.dev/docs/apps/build/markets/manage-translated-content).

    POST /graphql.json

  • Read

    urlRedirect

    Returns a `UrlRedirect` resource by ID.

    POST /graphql.json

  • Read

    urlRedirectImport

    Returns a `UrlRedirectImport` resource by ID.

    POST /graphql.json

  • Read

    urlRedirectSavedSearches

    A list of the shop's URL redirect saved searches.

    POST /graphql.json

  • Read

    urlRedirects

    A list of redirects for a shop.

    POST /graphql.json

  • Read

    urlRedirectsCount

    Count of redirects. Limited to a maximum of 10000 by default.

    POST /graphql.json

  • Read

    validation

    Validation available on the shop.

    POST /graphql.json

  • Read

    validations

    Validations available on the shop.

    POST /graphql.json

  • Read

    webPixel

    Returns a [web pixel](https://shopify.dev/docs/apps/build/marketing-analytics/build-web-pixels) by ID.

    POST /graphql.json

  • Read

    webPresences

    The web presences for the shop.

    POST /graphql.json

  • Read

    webhookSubscription

    Returns a webhook subscription by ID. Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe).

    POST /graphql.json

  • Read

    webhookSubscriptions

    Retrieves a paginated list of webhook subscriptions created using the API for the current app and shop. > Note: Returns only shop-scoped subscriptions, not app-scoped subscriptions configured in TOML files. Subscription details include event topics, endpoint URIs, filtering rules, field inclusion settings, and metafield namespace permissions. Results support cursor-based pagination that you can filter by topic, format, or custom search criteria. Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe).

    POST /graphql.json

  • Read

    webhookSubscriptionsCount

    The count of webhook subscriptions. Building an app? If you only use app-specific webhooks, you won't need this. App-specific webhook subscriptions specified in your `shopify.app.toml` may be easier. They are automatically kept up to date by Shopify & require less maintenance. Please read [About managing webhook subscriptions](https://shopify.dev/docs/apps/build/webhooks/subscribe). Limited to a maximum of 10000 by default.

    POST /graphql.json

Get started

  1. Open Space settings → Connections and search for Shopify.
  2. Connect your account and add the connection to the Space.
  3. Ask for what you need in any thread in that Space.

See How connections work for access and permissions, or browse all integrations.

Reference date: October 28, 2026. Shopify API docs.