Connect Shopify to your AI agent

E-commerce 315 actions available

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

We set up the connection using your own Shopify account, with keys you control, and keep it running. Your agent picks it up and starts doing the work.

Book a setup call → See pricing

Actions

What your agent can do in Shopify

Each one is a real action the agent can take on its own, the same things a person clicking around Shopify could do. Read-only by default; write actions are confirmed against your policy.

Activate one time charge Activate a one-time application charge in Shopify. Use when you need to finalize billing for an accepted charge. DEPRECATED: This endpoint is deprecated as of API version 2021-01. One-time charges are now immediately ac…
Add product to custom collection (Deprecated) DEPRECATED: Use SHOPIFY_ADDS_A_PRODUCT_TO_A_CUSTOM_COLLECTION instead. Adds a product to an existing *custom collection*, optionally specifying its `position` if the collection is manually sorted.
Add product to custom collection Add a product to a custom collection by creating a collect resource. Use when you need to link a product to a custom collection. Note: Can only add products to custom collections, not smart collections.
Adjust inventory levels Adjust the inventory level of an inventory item at a single location. Use when you need to increase or decrease stock quantities at a specific location.
Apply fulfillment hold Applies a fulfillment hold to an open fulfillment order, halting all fulfillment work. Use when you need to pause fulfillment due to payment issues, fraud concerns, address problems, or inventory shortages. The fulfillm…
Approve a comment Approves a pending comment and publishes it to a blog article, making it publicly visible to readers. This action changes the comment's status from 'pending' or 'unapproved' to 'published' and sets the published_at time…
Bulk create products via GraphQL Creates many products (20-50+) in one asynchronous Shopify bulk mutation job. Uses stagedUploadsCreate for JSONL upload, then bulkOperationRunMutation with productCreate, polling until completion and returning per-row s…
Bulk delete customer addresses (Deprecated) Bulk delete multiple customer addresses in a single operation. This action permanently removes several addresses from a customer's address book at once, which is more efficient than deleting addresses one by one. Use th…
Delete metafields in bulk Deletes multiple metafields in bulk using their owner ID, namespace, and key. If a metafield doesn't exist, the mutation still succeeds but returns null for that identifier in the response.
Bulk delete metaobjects Asynchronously delete metaobjects and their associated metafields in bulk. Use this action to delete multiple metaobjects by their IDs or delete all metaobjects of a specific type. The operation is asynchronous and retu…
Run Shopify bulk query operation Run a Shopify GraphQL bulk query operation and return the result file URL and operation metadata. Use when you need to retrieve large datasets (thousands of records) from Shopify without manual pagination, such as bulk…
Calculate a refund Calculate accurate refund amounts, taxes, and transactions for a Shopify order before creating an actual refund. Use this action to: - Preview refund calculations for line items with accurate tax breakdowns - Determine…
Cancel App Subscription Cancel an app subscription in Shopify using the appSubscriptionCancel GraphQL mutation. Use when you need to cancel an existing app subscription, optionally with prorated credits.
Cancel Shopify bulk operation Cancel a running Shopify bulk operation. Use when you need to stop a long-running bulk query or mutation operation that is no longer needed. Note that there may be a short delay between when cancelation starts and when…
Cancel a fulfillment Cancels an existing fulfillment by its ID, reverting all line items to an unfulfilled state. Use this when a fulfillment was created in error or needs to be redone. The cancellation is permanent and cannot be undone - t…
Cancel a Fulfillment Order Cancels a fulfillment order in Shopify and marks it as closed. This creates a replacement fulfillment order with the same line items, allowing reassignment to a different location. Use this for merchant-managed fulfillm…
Cancel an order Cancels a Shopify order and optionally restocks items and sends email notifications. Use when canceling an order that has not yet been paid or fulfilled. Orders cannot be cancelled if payment status is already paid or i…
Close an order Closes an open Shopify order. Use when all line items have been fulfilled or canceled and all financial transactions are complete.
Complete a draft order Complete a draft order in Shopify and transition it to an actual order. Use when you need to finalize a draft order, reserve inventory, and create a corresponding order. When completing with payment_pending=true, the pa…
Connect inventory item to location Connects an inventory item to a location, establishing where the item can be stocked and fulfilled. This creates an inventory level with an initial available quantity of 0. Use this when you need to enable a product var…
Count articles in blog Retrieves a count of all articles from a blog. Use when you need to know how many articles exist in a specific blog, optionally filtered by creation, publication, or update dates and publication status.
Get blogs count Retrieves the total count of all blogs in a Shopify store. Use this action when you need to know how many blogs exist in the store without fetching the full list of blog details. This is useful for pagination calculatio…
Retrieve count of custom collections (Deprecated) Retrieves a count of custom collections with optional filters. Use when you need to know how many custom collections exist in the store, optionally filtered by product, publication status, or date ranges.
Get draft orders count Retrieves a count of draft orders from a Shopify store. Use when you need to know how many draft orders exist without fetching full draft order details. Supports filtering by status and date range to count specific subs…
Count all the events (Deprecated) Count all events in a Shopify store with comprehensive filtering. Use when you need to determine how many events match specified criteria including date range, resource type, or action verb.
Count fulfillments for order Retrieves a count of fulfillments associated with a specific order. Use when you need to determine how many fulfillments exist for an order, optionally filtered by creation or update dates.
Retrieves a count of locations (Deprecated) Retrieves a count of locations. Use when you need to determine how many physical or virtual locations are configured in the Shopify store.
Count shop metafields Retrieves the shop-level count of metafields. Use resource-specific metafield actions for product, customer, order, collection, page, or article metafields.
Count orders (Deprecated) DEPRECATED: Use SHOPIFY_RETRIEVES_AN_ORDER_COUNT instead. Retrieves the count of orders in a Shopify store. Use when you need to know how many orders exist, optionally filtered by status, dates, financial status, fulfil…
Retrieve page count Retrieve the total count of pages in a Shopify store. Use when you need to determine how many pages exist, optionally filtered by creation date, update date, publication date, publication status, or title.
Count price rules Retrieves a count of all price rules. Use when you need to determine how many price rules (discount campaigns) are configured in the store.
Count product images Retrieves the total count of images for a specific Shopify product. Use when you need to know how many images are associated with a product.
Retrieves a count of products Retrieve a count of products in the Shopify store. Use when you need to get the total number of products, optionally filtered by collection, vendor, product type, status, or date ranges.
Count product variants Retrieves the total count of variants for a Shopify product. Use when you need to know how many variants exist for a specific product.
Count script tags Retrieves a count of all script tags in the shop. Script tags are remote JavaScript files that are loaded into the pages of a shop's storefront or checkout. Use this action to determine the total number of script tags,…
Receive a count of all webhooks (Deprecated) Retrieves a count of existing webhook subscriptions. Use when you need to know how many webhooks are configured, optionally filtered by address or topic.
Create a metafield Create a metafield for any Shopify resource. Use when you need to attach custom metadata to products, customers, orders, collections, or other supported resources.
Create A New Product Image (Deprecated) Create a new product image for a Shopify product. Use when you need to add an image to a product by providing either an image URL or base64-encoded image data. Products can have up to 250 images in PNG, GIF, or JPG form…
Create app subscription Create a recurring or usage-based app subscription for charging Shopify merchants. Use when setting up billing for app features and services. Returns a confirmation URL where the merchant must approve charges before the…
Create Article Create an article for a blog in Shopify. Use when you need to add blog content to a specific blog. The title field is mandatory - requests without titles return a 422 error.
Create Comment for Article Create a comment for an article in Shopify. Use when you need to add reader comments to blog articles. Requires 'content' access scope and protected customer data access.
Create a new blog Create a new blog in Shopify. Use when you need to add a blog to the store for publishing articles and content. The title field is mandatory.
Create Country Create a country with tax configuration for the Shopify store. Use when you need to add a new country to the store's shipping or tax settings. **Important Notes:** - The REST Country API is deprecated as of API version…
Create a custom collection Create a new custom (manually curated) collection in Shopify. Does not support smart collections. Use when you need to manually curate and group products for easier store browsing. Custom collections require a title and…
Create Customer Create a new customer in Shopify. Use to add a customer record to the store with contact details, addresses, and marketing preferences. Requires at least one of: email, phone, or both first_name and last_name. Errors (e…
Generate Customer Account Activation URL Generate a one-time account activation URL for a customer whose account is in 'disabled' state (not yet activated). Use this when you've imported customers and need activation URLs to send in welcome emails. The URL all…
Create customer address Create a new address for a customer. Use when you need to add an address to an existing customer's address list.
Create delegate access token Create a delegate access token with a subset of the parent token's permissions. Use when you need to securely delegate limited access to subsystems or services. Each delegate token inherits only the specified scopes, en…
Create Discount Code Creates a discount code for an existing price rule. Price rules define the discount logic (e.g., 10% off, buy X get Y), and discount codes are the actual codes (e.g., 'SUMMER10') customers enter at checkout. Important:…
Create Discount Codes Batch Create a discount code creation job for batch processing. Use when you need to asynchronously create up to 100 discount codes for a price rule in a single request.
Create a new draft order Create a draft order in Shopify. Use when you need to create orders in draft state using product variant line items or custom line items. Draft orders are useful for creating orders on behalf of customers, generating in…
Create EventBridge webhook subscription Create an AWS EventBridge webhook subscription in Shopify. Use when you need to configure real-time event notifications to AWS EventBridge for events like order creation, product updates, or customer changes. EventBridg…
Create Fulfillment Creates a fulfillment for one or many fulfillment orders for a specific order. This completes the shipping process by marking items as fulfilled. IMPORTANT: You must first retrieve fulfillment orders using a "Get fulfil…
Create Fulfillment Event Creates a tracking event for a fulfillment to update shipment status. These events appear on the customer's order status page to track delivery progress (e.g., "in_transit", "out_for_delivery", "delivered"). Use this to…
Create Gift Card Create a gift card for a Shopify store. Use when you need to issue a new gift card with a specified value. Requires write_gift_cards access scope. Gift card codes can only be retrieved at creation time.
Create Marketing Event Engagements Create engagement data for a marketing event in Shopify. Use when tracking customer interactions like views, clicks, and ad spend on marketing events before customers reach the website.
Create Marketing Event Create a marketing event in Shopify to track promotional actions. Use when you need to track marketing campaigns targeting customers across various channels.
Create blog metafield Creates a new metafield for a Shopify blog. Metafields store additional custom information (metadata) on blog resources such as sponsor names, SEO keywords, publication dates, or custom attributes not included in standa…
Create one time application charge Create a new one-time application charge in Shopify. Use when you need to bill merchants for one-time features, upgrades, or services. After creation, the merchant must approve the charge via the confirmation_url before…
Create an order Create a fully committed (real) order in Shopify without payment processing. Use when programmatically generating orders with line items, customer information, and addresses. Creates a live order immediately — not a dra…
Create order risk Creates a risk assessment record for a Shopify order, documenting fraud detection findings or security concerns. Use this to record risk evaluations from external fraud detection systems or internal risk analysis tools.…
Create transaction for order Creates a transaction for an order to process payment operations. Use when you need to authorize, capture, refund, void, or complete a sale for an order. For multi-currency orders, the currency field is required when cr…
Create a new page Create a static web page in Shopify. Use when you need to add long-term static content like About Us, Contact, or Privacy Policy pages. The title and body_html fields are required.
Create Price Rule Creates a price rule that defines discount logic for Shopify orders. Price rules specify how discounts work (percentage/fixed amount off, which products, which customers, etc.) and can be associated with discount codes…
Create a product (Deprecated) DEPRECATED: Use SHOPIFY_CREATES_A_NEW_PRODUCT instead. Creates a new product in a Shopify store; a product title is generally required. Note: The Product REST API is deprecated as of API version 2025-10. While it contin…
Create Product Image (Deprecated) DEPRECATED: Use SHOPIFY_CREATE_A_NEW_PRODUCT_IMAGE instead. Creates a new product image for a Shopify product. Use this tool to add images to products either by providing a publicly accessible image URL (src) or by uplo…
Create product metafield Creates a new metafield for a specific Shopify product. Each namespace+key combination must be unique per product; use the update action if the metafield already exists.
Create a new product variant Create a new product variant for an existing product. Use when adding a new variant with specific option values (like size, color). Each product can have up to 3 options and 100 variants maximum.
Create Pub/Sub webhook subscription Create a Google Cloud Pub/Sub webhook subscription in Shopify. Use when you need to configure real-time event notifications to Google Cloud Pub/Sub for events like order creation, product updates, or customer changes. P…
Create Redirect Create a URL redirect in Shopify. Use when you need to redirect an old path to a new location. When a full URL is provided as the path, it will be saved as an absolute path without the domain.
Create order refund Creates a refund for a Shopify order. **IMPORTANT: You must call the calculate refund endpoint (SHOPIFY_CREATE_ORDERS_REFUNDS_CALCULATE) first** to generate accurate transaction data with kind='suggested_refund', then c…
Create Resource Feedback Creates shop-level resource feedback to notify Shopify merchants about app setup requirements or successful configuration. Feedback appears on the merchant's admin home screen. Each new submission automatically replaces…
Create a new product (Deprecated) Create a new product in Shopify. Use when you need to add a new product to the store with details like title, description, variants, options, and images.
Create Script Tag Create a new script tag in Shopify to load remote JavaScript into your online store. Script tags allow you to add custom functionality to your storefront by loading external JavaScript files. Requires 'write_script_tags…
Create Smart Collection Create a new smart collection with automated product rules. Use when you need to create dynamic collections that automatically include products matching specific criteria (e.g., by vendor, price range, tags). Requires w…
Create or Update Theme Asset Creates or updates a theme asset file (templates, stylesheets, scripts, or images) within a Shopify theme. This action uploads or modifies files in the theme's file structure. For text-based files (HTML, Liquid, CSS, JS…
Create Storefront Access Token Creates a new storefront access token for unauthenticated Storefront API access. The token delegates unauthenticated access scopes to clients that need to access the Storefront API without authentication. Requirements:…
Create Theme Creates a new theme in Shopify from a ZIP file containing theme assets. Requires a publicly accessible URL to the ZIP file. The theme will default to 'unpublished' status unless the role is explicitly set to 'main' (whi…
Create Webhook (Deprecated) Creates a new webhook subscription in Shopify to receive real-time notifications when specific events occur in the store. Webhooks allow your application to be notified automatically when events like order creation, pro…
Create webhook subscription Create a webhook subscription that notifies your app when specific events occur in a Shopify store. Use when you need real-time event notifications for orders, products, customers, or other resources. Supports HTTPS URL…
Delete Article Delete an article from a blog in Shopify. Use when you need to permanently remove blog content. This action is irreversible.
Delete a blog Permanently deletes a blog from a Shopify store using its `blog_id`; this action is irreversible and requires the 'content' access scope.
Remove product from collection Removes a product from a custom collection by deleting the collect. Use when you need to unlink a specific product from a custom collection using the collect ID.
Remove a comment Remove a comment from a Shopify blog. Use when you need to hide a comment from blog readers while preserving the data. The comment status will be changed to 'removed'. Note: This action requires 'write_content' scope an…
Delete country Deletes a country from the shop's tax configuration. Removes a country that was previously added to the shop's tax settings. The country must have been added via the API or Shopify admin for this operation to succeed. R…
Delete custom collection (Deprecated) DEPRECATED: Use SHOPIFY_DELETES_A_CUSTOM_COLLECTION instead. Permanently deletes a custom collection from a Shopify store using its `collection_id`; this action is irreversible and requires a valid, existing `collection…
Delete a customer Deletes a customer from the Shopify store. Use when you need to permanently remove a customer who has no existing orders. Cannot delete customers with existing orders.
Delete customer address Removes an address from a customer's address list. Cannot delete the customer's default address - to delete a default address, first assign a different address as the default.
Delete a draft order Delete a draft order from Shopify. Use when you need to remove an existing draft order permanently.
Delete fulfillment event Deletes a fulfillment event (tracking status update) from an order's fulfillment. Use this action when you need to remove an incorrect or outdated tracking event from a fulfillment. Fulfillment events represent tracking…
Remove fulfillment service Remove an existing fulfillment service from a Shopify store. Use when you need to permanently delete a third-party fulfillment service.
Delete inventory levels Deletes an inventory level of an inventory item at a location. Deleting an inventory level removes that item from the specified location. Every inventory item must have at least one inventory level.
Delete a marketing event Delete a marketing event from Shopify. Use when you need to remove an existing marketing event from the system.
Delete a metafield by its ID Deletes a metafield by its ID from any Shopify resource. Use this action to permanently remove metafields from: - Shop-level metafields (use resource='shop' or 'metafields') - Product metafields (resource='products') -…
Delete metaobject Deletes a metaobject and its associated metafields using GraphQL mutation. Use when you need to permanently remove a metaobject from the Shopify store. The deletion is permanent and cannot be undone.
Delete metaobject definition Delete a metaobject definition and all its associated data. Use when you need to completely remove a metaobject definition schema. This mutation also asynchronously deletes all related metafield definitions, metaobjects…
Delete an order Permanently delete an order from Shopify. Use when you need to remove test orders, orders paid with manual payment methods, or draft orders marked as paid. Orders must be archived or canceled before deletion. Orders tha…
Delete order risk Deletes an order risk from an order. Only the application that created the risk can delete it - you cannot delete risks created by other applications. **IMPORTANT DEPRECATION NOTICE**: The Order Risk REST API has been d…
Delete a page Delete a page from a Shopify store permanently. Use when you need to remove an existing page; this operation is irreversible and requires content access scope.
Delete price rule Deletes an existing price rule from the Shopify store permanently. Use this action to remove price rules that are no longer needed. Note that deleting a price rule will also delete any discount codes associated with it.…
Delete a product Permanently deletes a product from a Shopify store by its product ID. This action is irreversible - deleted products cannot be recovered. Deleting a product also removes all associated variants, images, inventory, and r…
Delete product image Deletes a specific image from a product in Shopify, requiring the `product_id` of an existing product and the `image_id` of an image currently associated with that product.
Delete product metafield Deletes a specific metafield from a Shopify product using the product ID and metafield ID.
Remove product variant Deletes a specific product variant from a Shopify store using its unique product ID and variant ID; this action is irreversible. Use when you need to permanently remove a variant from a product.
Delete redirect Permanently deletes a URL redirect from a Shopify store. Use this tool to remove redirect rules that are no longer needed. A redirect automatically forwards visitors from an old URL path to a new target location. When y…
Delete a custom collection Permanently delete a custom collection from a Shopify store. Use when you need to remove a custom collection that is no longer needed. This operation is irreversible and requires the 'write_products' access scope.
Delete a discount code Delete a discount code from a price rule. Use when you need to remove a specific discount code associated with a price rule.
Delete a saved search Delete a saved search in Shopify. Use when you need to remove a saved search by its ID. The ID must be provided in GID format (gid://shopify/SavedSearch/[ID]).
Delete Script Tag Delete a script tag from your Shopify store. Permanently removes a script tag using its unique identifier. Script tags are JavaScript files that load on your storefront. Use this action to clean up deprecated scripts or…
Delete smart collection Permanently removes a smart collection from a Shopify store using its `smart_collection_id`; this action is irreversible and requires a valid, existing smart collection ID.
Delete Storefront Access Token Delete an existing storefront access token from a Shopify store. Use when you need to permanently revoke access for a storefront access token. This operation is irreversible.
Delete theme Deletes a theme from the Shopify store by its ID. Use this tool when you need to permanently remove an unwanted theme. The deleted theme's details are returned in the response for confirmation. **Important limitations:*…
Delete theme asset Delete an asset from a Shopify theme. Use when you need to remove a specific asset file (such as CSS, JavaScript, images, or template files) from a theme by providing the theme ID and asset key. Note that required theme…
Delete webhook subscription (Deprecated) Delete a webhook subscription from Shopify. Use when you need to remove an existing webhook. Only the app that registered the webhook can delete it; attempting to delete another app's webhook will return a 404 error.
Delete webhook subscription Delete a webhook subscription and stop all future webhooks to its endpoint. Use when you need to remove a webhook subscription that is no longer needed. Returns the deleted subscription's ID for confirmation. Note: If y…
Delete web presence Delete a web presence from Shopify. Use when you need to remove a web presence by its ID.
Disable a Gift Card Disable a gift card in Shopify. Use when you need to permanently deactivate a gift card. WARNING: This operation is irreversible and the gift card cannot be re-enabled once disabled.
Enable standard metaobject definition Enable a standard metaobject definition from its template. Use when you need to activate a predefined Shopify metaobject template for use in your store.
Get abandonment Retrieves an abandonment record from Shopify using its unique ID. Use when you need to query customer abandonment data including type, customer info, email state, and timing details.
Get abandonment by abandoned checkout ID Query abandonment information by abandoned checkout ID using Shopify's GraphQL Admin API. Use when you need to retrieve customer journey data, abandonment type, and email state for a specific abandoned checkout. Returns…
Get a list of access scopes Retrieves a list of access scopes associated with the access token. Use when you need to view the permissions that merchants have granted during app installation.
Get App Query information about a Shopify app using the GraphQL API. Use when you need to retrieve details about the currently authenticated app or a specific app by its ID.
Get app by handle Query app information by handle using the Shopify Admin GraphQL API. Use when you need to retrieve details about a specific Shopify app using its handle.
Get app installation details Query a specific app installation on a Shopify store. Use when you need to retrieve details about an app installation including access scopes, launch URL, and uninstall URL.
Get Application Charge By ID Retrieve a single application charge by its unique identifier. Use when you need detailed information about a specific one-time charge.
Get Application Charges Retrieves a list of one-time application charges for the current app installation. Application charges are one-time fees charged to merchants for app usage. This endpoint returns all charges with their status (pending,…
Get application credits Retrieve all application credits for a shop. Use when you need to view credits issued to merchants that can be used towards future app purchases.
Get Article Retrieves a single article from a Shopify blog by its ID. Use this action when you need to: - Get detailed information about a specific blog article - Retrieve article content, metadata, or publication status - Access a…
Get Batch Discount Codes Retrieves discount codes from a batch creation job, showing which succeeded and which failed. **Workflow:** After batch job completes (status='completed'), use this to get the actual codes. 1. Create price rule (get pri…
Get Single Blog Retrieve a single blog by its unique identifier. Use when you need to access detailed information about a specific blog in the Shopify store.
Get blog article tags Retrieve a list of all article tags from a specific blog. Use when you need to get all unique tags that have been applied to articles in a particular blog, optionally sorted by popularity.
Get bulk operation status Query the status and details of a Shopify bulk operation by its ID. Use when you need to check the progress, status, or results of a previously initiated bulk operation. Returns metadata including status, completion tim…
Get carrier services Retrieves all active carrier services configured in a Shopify store. Carrier services allow apps to provide real-time shipping rates at checkout. This endpoint returns only carrier services where active=true. Requiremen…
Get catalogs count Query the count of catalogs in the Shopify store. Use when you need to know how many catalogs exist, optionally filtered by type or search query.
Get checkout profile Retrieves a checkout profile from Shopify using its unique ID. Use when you need to query checkout profile details including name, publication status, and timestamps.
Get checkouts count Retrieves a count of abandoned checkouts from the past 90 days. Use when you need to know how many checkouts are abandoned, optionally filtered by date ranges or status.
Get collect by ID Retrieves a specific collect by its ID. Use when you need to get details about a specific product-collection relationship.
Get collection by ID Retrieves a specific Shopify collection by its `collection_id`, optionally filtering returned data to specified `fields`.
Get collection by identifier Query a collection by identifier (ID or handle) using the Shopify GraphQL Admin API. Use when you need to fetch collection details by either its global ID or unique handle.
Get collects Retrieves a list of collects from a Shopify store, where a collect links a product to a custom collection. Returns only collect mapping records (collect_id, collection_id, product_id, position, etc.), not full product d…
Get collects count Retrieves a count of collects (product-collection relationships). Use when you need to know the total number of collects, optionally filtered by collection_id or product_id.
Get count of comments Retrieves a count of comments. Use when you need to know how many comments exist, optionally filtered by article, blog, status, or date ranges.
Get consent policy Query consent policies for privacy compliance requirements. Use when you need to retrieve customer consent requirements for specific regions or countries (GDPR, CCPA, etc.).
Get Countries Retrieve a list of countries configured in the Shopify store with tax rates and provinces. Use when you need to get countries and their tax configuration for the store.
Get countries count Retrieves the count of countries configured in a Shopify store. Use when you need to determine how many countries are available in the store's tax and shipping settings. **DEPRECATION WARNING**: This endpoint is depreca…
Get provinces count for country Retrieves a count of provinces for a country. Use when you need to determine how many provinces or states are configured for a specific country in Shopify.
Get Province for Country Get Province for Country
Get country Retrieve a specific country by its ID from Shopify. Use when you need to get tax information, country details, and province-level tax rates for a particular country.
Get provinces for country Retrieve a list of provinces for a specified country. Use when you need to get province information, tax rates, and shipping zones for a specific country.
Get Currencies Retrieve a list of currencies enabled on a Shopify store. This action fetches all currencies that the merchant has enabled for multi-currency transactions through Shopify Payments. Each currency includes its ISO 4217 co…
Get custom collection by ID Retrieve a single custom collection by its unique ID from Shopify. Use when you need to fetch detailed information about a specific custom collection.
Get custom collections Retrieves a list of custom collections from a Shopify store. Supports filtering by IDs, handle, title, product ID, publication status, and date ranges (published/updated). Use the fields parameter to retrieve only speci…
Get custom collections count Retrieves the total count of custom collections in a Shopify store with optional filters. Use this action to get the number of custom collections, optionally filtered by: - Product ID (collections containing a specific…
Retrieve a single customer Retrieve a single customer by their unique identifier. Use when you need to fetch detailed information about a specific customer.
Get Customer Address Retrieve details of a single customer address from Shopify. Use when you need to get complete information about a specific address for a customer, including address lines, city, province, country, postal code, and phone…
Get Customer Addresses Retrieves all addresses associated with a specific customer. Returns complete address details including street address, city, province/state, country, postal code, and contact information. Each address includes a unique…
Get customer orders Retrieves all orders for a specific, existing customer in Shopify using their unique customer ID.
Get customers count Retrieves a count of all customers. Use when you need to know the total number of customers, optionally filtered by creation or update dates.
Search Customers Search for customers matching a supplied query. Use when you need to find customers based on specific criteria like email, name, location, order count, or spending.
Get Discount Code Retrieves a single discount code for a price rule. Use when you need to get details about a specific discount code including its usage count and timestamps.
Retrieve Discount Code Creation Job Retrieves the status and progress of an asynchronous batch discount code creation job for a specific price rule. Use this to monitor a job that creates up to 100 discount codes at once. Check the 'status' field ('queued…
Get discount codes count Retrieves a count of discount codes for a shop. Use when you need to know how many discount codes exist, optionally filtered by usage statistics.
Get Discount Code Location Look up a discount code by its code name and retrieve its resource location and IDs. Use this when you have a discount code (e.g., "SUMMER2024") and need to find its price_rule_id and discount_code_id for use with other…
Receive a single draft order Retrieve detailed information for a specific draft order from a Shopify store. Use when you need to access a draft order's status, customer details, line items, pricing, or shipping information.
Get event by ID Retrieve a specific Shopify event by its ID. Events track actions performed on store resources like products, orders, collections, and articles. Use this to get detailed information about a specific event, including wha…
Get events list (Deprecated) Retrieves a list of audit trail events from a Shopify store. Events represent actions performed on store resources (products, orders, collections, pages, articles, etc.). Each event captures what happened (verb: create/…
Get fulfillments by fulfillment order Retrieves all fulfillments (shipments) associated with a specific fulfillment order. A fulfillment order represents a group of line items that are to be fulfilled from a specific location. This action returns tracking i…
Get Fulfillment Event Retrieves a specific fulfillment event by its ID, providing detailed shipment tracking information. Use this when you need to check the status and location of a specific tracking event for a fulfilled order. The event c…
Get fulfillment events Retrieves tracking events for a specific fulfillment, showing shipment status updates (e.g., in_transit, out_for_delivery, delivered) with timestamps and location information. Use this when you need to check the trackin…
Get fulfillment orders for order (Deprecated) Retrieve all fulfillment orders for a specific order. Use when you need to check fulfillment status, assigned locations, or line items for an order.
Retrieves fulfillments by fulfillment order (Deprecated) Retrieves all fulfillments associated with a specific fulfillment order. Returns detailed shipment tracking information, delivery status, line items, and fulfillment metadata. Use this action when you need to check the…
Get fulfillment order locations for move Retrieve locations that a fulfillment order can potentially move to. Use when you need to identify which locations are available for transferring a specific fulfillment order. The resulting list is sorted alphabetically…
Get fulfillment order locations for move (Deprecated) Retrieve a list of locations that a fulfillment order can potentially move to. Use when you need to identify available destination locations for relocating a fulfillment order.
Get fulfillment orders for order Retrieves a list of fulfillment orders for a specific order. Use when you need to get fulfillment order details including line items, delivery method, assigned location, and fulfillment status for a given order.
Get Fulfillment Services Retrieve a list of fulfillment services available on the Shopify store. Use when you need to get information about third-party warehouses that prepare and ship orders on behalf of the store owner.
Get Gift Card By ID Retrieves detailed information about a specific gift card by its ID. Returns the gift card's balance, status, creation date, and other metadata. Note: The full gift card code is never returned by this endpoint - only th…
Retrieves a list of gift cards Retrieve a list of gift cards from Shopify. Use when you need to fetch gift cards with optional filtering by status and pagination support.
Retrieves a count of gift cards Retrieves the total count of gift cards in the store. Use when you need to know how many gift cards exist, optionally filtered by enabled or disabled status.
Get Inventory Item Retrieves a single inventory item by ID. Use when you need to get detailed information about an inventory item including SKU, cost, tracking status, and shipping requirements.
Get Inventory Items Retrieves a list of inventory items by specified IDs. Use when you need to get inventory item details like SKU, cost, shipping requirements, and tracking status. Note: As of version 2019-10, pagination is implemented us…
Get Inventory Levels Retrieves a list of inventory levels for specified items and locations. Use when you need to check inventory quantities at specific locations. At least one of inventory_item_ids or location_ids must be provided as a fil…
Get Inventory Levels For Location Retrieves a list of inventory levels for a specific location. Use when you need to check inventory quantities at a particular location. This endpoint implements cursor-based pagination via Link headers in the response.
Get location Retrieve a single location by its ID. Use when you need to get details about a specific physical or virtual place where inventory is stocked and orders are fulfilled.
Get locations count Query the count of locations in a Shopify store using the GraphQL API. Use when you need to get the total number of locations, optionally filtered by search criteria.
Retrieve a single marketing event Retrieves detailed information about a specific marketing event by its ID. Use this action to: - Get full details of a marketing campaign including UTM parameters, budget, and timeline - Check the status and configurati…
Get marketing events count Retrieves a count of all marketing events in the store. Use when you need to know the total number of marketing events.
Get blog metafields Retrieve a list of metafields from a blog resource. Use when you need to fetch metafields attached to a specific Shopify blog.
Get metafield by ID Retrieve a single metafield from a resource by its ID. Use when you need to fetch metafield details without knowing the parent resource.
Get metafields Retrieve a list of metafields. Use when you need to fetch metafields across resources or for specific resources by providing owner_id and owner_resource filters.
Get shop metafields count (Deprecated) Retrieves the count of shop-level metafields only. This action returns how many metafields are directly attached to the shop itself, not metafields on other resources like products, customers, or orders. Use this when y…
Get order Retrieve a specific order using its unique identifier. Returns detailed order information including line items, customer data, addresses, financial status, fulfillment status, and more.
Retrieve order fulfillments Retrieve fulfillments associated with a Shopify order. Use when you need to get delivery tracking information, shipment status, or fulfillment details for a specific order.
Get order list (Deprecated) Retrieves a list of orders from Shopify with optional filters and pagination.
Get specific refund for order Retrieves a specific refund by refund ID for an order. Use this action when you need to: - Get detailed information about a particular refund - Review specific refund transactions and payment details - Check refunded li…
Get refunds for order Retrieves a list of all refunds for a specific order. Use this action when you need to: - Review refund history and details for an order - Check refunded amounts, line items, and shipping costs - Verify payment transact…
Get Order Risks (Deprecated) Retrieves all fraud risk assessments for a specific order. Returns a list of risk assessments indicating potential fraud. Each risk includes a recommendation (cancel/investigate/accept) and a fraud likelihood score. Onl…
Get order risks Retrieves all fraud risk assessments for a specific order. Returns a list of risk assessments with recommendations (cancel/investigate/accept) and fraud likelihood scores. Use this when reviewing fraud detection finding…
Get order by id (Deprecated) Retrieves a specific Shopify order by its unique ID, which must correspond to an existing order.
Get orders with filters Retrieves Shopify orders filtered by dates and other filters. Uses server-side filtering. Results are paginated; follow `page_info` cursors until exhausted to retrieve all matching orders — a single request returns at m…
Get order transactions count Retrieve a count of an order's transactions in Shopify. Use when you need to know how many transactions (authorization, sale, capture, void, refund) are associated with a specific order without fetching the full transac…
Get page by ID Retrieve a single Shopify page by its unique ID. Use when you need to fetch detailed information about a specific page.
Get Policies Retrieve a list of the shop's policies. Use when you need to view configured shop policies such as refund policy, privacy policy, or terms of service.
Get Price Rule Retrieves a single price rule by ID from Shopify. Returns discount configuration including type (percentage/fixed), value, target items, customer eligibility, and prerequisites. Note: The PriceRule REST API is deprecate…
Check Batch Listing Support for Price Rule Checks if batch listing is supported for a price rule and provides guidance on alternatives. **IMPORTANT: Shopify's API does not provide an endpoint to list all batches for a price rule.** This action returns structured…
Get Discount Codes for Price Rule Retrieve a list of discount codes for a price rule. Use when you need to get all discount codes associated with a specific price rule. Note: As of version 2019-10, pagination is implemented via Link headers in the respo…
Get product Retrieves details for an existing Shopify product using its unique product ID.
Get product image Retrieve a single product image by ID for a specific product. Use when you need to get details about a specific image associated with a product.
Get Product Images (Deprecated) Retrieves all images for a Shopify product, specified by its `product_id` which must correspond to an existing product.
Get product metafield Retrieves a specific metafield for a Shopify product using the product ID and metafield ID.
Get product metafields Retrieves all metafields for a specific Shopify product. Metafields are returned under `data.response_data.metafields`. Can be filtered by namespace and/or key; empty results are valid when no metafields match. Always f…
Get products (Deprecated) Retrieves a list of products from a Shopify store. Results are paginated; for large catalogs, use SHOPIFY_GET_PRODUCTS_PAGINATED to iterate all pages, as this tool may return only a partial set. Product handles and SKUs…
Get products in collection (Deprecated) Retrieves products that belong to a specific Shopify collection. Returns detailed product information including variants, images, and options. Products are sorted according to the collection's configured sort order. Use…
Get products (paginated) List products with Shopify cursor-based pagination. Iterate until `next_page_info` is null; stopping early silently truncates the product list. Products are at `data.response_data.products`; the next cursor is at `data.…
Receive a single product variant Retrieves detailed information about a single product variant by its ID from Shopify. A product variant represents a specific version of a product (e.g., different sizes, colors, or materials). This action returns compr…
Get recurring application charges Retrieve a list of recurring application charges for the app. Use when you need to view subscription charges, check billing status, or audit recurring payments.
Retrieve a single redirect (Deprecated) Retrieve details of a specific URL redirect by its ID. Returns the redirect's path (source) and target (destination) configuration. Use this when you have a specific redirect ID and need its details; for finding redirec…
Get redirect by ID Retrieve a single redirect by its ID. Use when you need to get details about a specific URL redirect configuration in a Shopify store.
Get redirects Retrieve a list of URL redirects from a Shopify store. Use when you need to fetch URL redirect configurations, optionally filtered by path or target. Supports pagination via Link headers.
Get redirects count Retrieves a count of URL redirects in the store. Use when you need to know how many URL redirects are configured, optionally filtered by path or target.
Retrieve a specific refund (Deprecated) Retrieves detailed information about a specific refund for an order. Use this action when you need complete refund details including refunded line items, transactions, order adjustments, duties, and shipping costs. Both…
Get Script Tag Retrieves a single script tag by its ID. Use when you need to get details of a specific script tag configuration.
Get segments count Query the number of segments for a shop. Use when you need to know how many customer segments exist.
Get Shipping Zones Retrieve all configured shipping zones with countries, provinces, tax rates, and shipping rates. Use when you need to view or analyze shipping configuration.
Get shop billing address Retrieves the billing address for the shop via GraphQL query. Returns the shop's billing information including address details, city, province, country, and phone number.
Get Shop Configuration DEPRECATED: Use SHOPIFY_GET_SHOP_DETAILS instead. Retrieve the complete configuration and settings for the authenticated Shopify shop account. Use when you need to access shop information such as business details, addre…
Get Shop Details (Deprecated) Retrieves comprehensive administrative information about the authenticated Shopify store. The returned `iana_timezone` field is critical for date-based filtering in other tools (e.g., `created_at_min`/`created_at_max` i…
Retrieve metafield by ID (Deprecated) Retrieve a metafield by its ID directly. Use when you know the metafield ID and need to fetch its details without specifying the resource type or owner.
Retrieve metafields from resource endpoint (Deprecated) DEPRECATED: Use SHOPIFY_GET_METAFIELDS instead (apps/shopify/actions/get_metafields.py). Retrieve a list of metafields attached to resources. Use when you need to fetch metafields that can be filtered by namespace, key,…
Retrieve a single smart collection (Deprecated) Retrieve a single smart collection by its ID from Shopify. Use when you need to get detailed information about a specific smart collection including its rules, products ordering, and metadata. Requires read_products acc…
Get smart collection by ID Retrieve a single smart collection by its ID. Use when you need to get details about a specific smart collection including its rules, settings, and associated image.
Get smart collections Retrieve a list of smart collections from a Shopify store. Use when you need to fetch smart collections with optional filtering by IDs, handle, title, product ID, publication status, or date ranges. Supports pagination…
Get smart collections count Retrieve a count of smart collections in a Shopify store. Use when you need to know the total number of smart collections, optionally filtered by publication status, title, product association, or date ranges.
Get storefront access tokens Retrieves a list of storefront access tokens that have been issued for the shop. Use when you need to view all active storefront access tokens and their permissions.
Get tender transactions Retrieve a list of tender transactions from Shopify. Tender transactions represent actual money movement between customers and the merchant (positive = payment to merchant, negative = refund from merchant). Use this act…
Retrieve a single theme Retrieves a single Shopify theme by its unique ID. Use this action when you need to: - Get details about a specific theme (name, role, timestamps, store ID) - Check if a theme is the currently published theme (role='mai…
Get themes Retrieves a list of themes from a Shopify store. Use when you need to access theme information including name, role, and metadata.
Get Theme Asset Retrieve a single asset for a theme by its key. Use when you need to fetch the content or metadata of a specific theme file such as templates, stylesheets, or scripts.
Retrieve a specific transaction Retrieve a specific transaction for an order. Use when you need to get detailed information about a payment transaction. Transactions in multi-currency orders are in presentment currency by default; use in_shop_currency…
Get Webhook Retrieves a single webhook subscription by its ID. Use when you need to get details of a specific webhook configuration.
Get webhook subscriptions count Query the number of webhook subscriptions for a shop. Use when you need to know how many webhook subscriptions exist, optionally filtered by query criteria.
Shopify GraphQL Admin execute Execute any Shopify Admin GraphQL query or mutation with variables. Use this when a workflow needs a GraphQL Admin operation that does not have a dedicated Mercury action yet. It unlocks the GraphQL-only resources calle…
Shopify graphql collections and publication ready collection reads Shopify GraphQL collections and publication-ready collection reads. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
Shopify GraphQL customers and customer search Shopify GraphQL customers and customer search. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
Shopify GraphQL discounts and discount search Shopify GraphQL discounts and discount search. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
Shopify GraphQL draft orders Shopify GraphQL draft orders. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
Shopify GraphQL inventory items and levels Shopify GraphQL inventory items and levels. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
Shopify GraphQL metafields and metaobjects Canonical GraphQL read surface for metafields, metafield definitions, and metaobjects.
Shopify GraphQL orders and order search Shopify GraphQL orders and order search. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
Shopify GraphQL products, variants, media, and publishing GraphQL-first product toolkit: products, variants, options, media, and publications. This is the canonical agent-facing replacement for legacy REST product, product variant, and product image actions. It exposes Shopify…
Execute Shopify GraphQL query Executes a GraphQL query against the Shopify Admin API for flexible data retrieval and mutations including metafields. Response data is nested under result['data']['data'], not result['data']. Always inspect both respon…
Shopify GraphQL shop and app metadata GraphQL-first shop, app installation, and configuration read action.
Shopify GraphQL webhook subscriptions Shopify GraphQL webhook subscriptions. The response always includes raw GraphQL data, extracted userErrors, pageInfo, and cost extensions.
Shopify GraphQL write operations Canonical GraphQL write surface for Shopify orders, customers, inventory, discounts, collections, webhooks, fulfillments, metafields, and bulk operations.
List abandoned checkouts Retrieves a list of abandoned checkouts with customer contact information. An abandoned checkout occurs when a customer adds contact information but doesn't complete the purchase. Use this to recover abandoned carts, se…
Retrieves all application credits (Deprecated) Retrieve all application credits issued to a shop by your app. Use when you need to view credits that can be applied towards future app purchases.
List article authors Retrieve a list of all article authors from the store. Use when you need to get all unique author names who have created articles across all blogs.
List article tags Retrieve a list of all article tags from the store. Use when you need to get all unique tags that have been applied to articles, optionally sorted by popularity.
List available locales Query available locales for the Shopify store using the Admin GraphQL API. Use when you need to retrieve the list of supported language/region combinations.
Retrieve list of articles from blog Retrieves a list of all articles from a blog. Use when you need to access articles from a specific blog, with optional filtering by author, dates, or publication status. Pagination is implemented via response header lin…
Retrieve a list of all blogs Retrieve a list of all blogs from a Shopify store. Use when you need to get blog information, list available blogs, or paginate through blogs using since_id.
List bulk operations Retrieve a paginated list of bulk operations from Shopify. Use when you need to view the history of bulk operations, check their statuses, or retrieve result URLs for completed operations. Supports filtering by status,…
List channels Retrieves a list of sales channels available in the Shopify store using GraphQL. Use when you need to fetch channel information including Online Store, Point of Sale, and other active sales channels. Supports cursor-bas…
List checkout profiles Query checkout profiles from Shopify. Use when you need to retrieve checkout profile configurations including branding settings and UI extensions. Supports pagination and filtering by publication status.
Retrieve products in collection Retrieve a list of products belonging to a collection. Use when you need to fetch products from a specific Shopify collection. Implements cursor-based pagination via Link headers (as of version 2019-10).
Retrieve list of collects (Deprecated) Retrieve a list of collects (product-collection associations). Use when you need to find which products belong to which custom collections.
Retrieve a list of comments Retrieve a list of comments from Shopify. Use when you need to get comments with optional filtering by dates, status, or pagination.
Receive a list of all countries (Deprecated) Retrieve a list of all countries where the merchant sells products with tax rates. Use when you need to access country-level tax configuration and regional settings. Note: This endpoint is deprecated as of API version 2…
Retrieves a list of currencies enabled on a shop (Deprecated) Retrieves a list of currencies enabled on a Shopify store. This action fetches all currencies that the merchant has enabled for multi-currency transactions through Shopify Payments. Each currency includes its ISO 4217 c…
Retrieve custom collections (Deprecated) Retrieve a list of custom collections from Shopify. Use when you need to query collections with filtering options like handle, title, publication status, or date ranges.
Get customer orders (Deprecated) Retrieves all orders for a specific customer from Shopify. Returns order details including line items, fulfillment status, payment information, shipping address, and more. Use this when you need to view a customer's ord…
Retrieves a list of customers Retrieve a list of customers from a Shopify store. Use when you need to fetch customer data with optional filtering by IDs, creation dates, update dates, or account status. Supports pagination using cursor-based navigat…
Retrieve list of draft orders Retrieve a list of draft orders from Shopify. Use when you need to fetch draft orders with optional filtering by status, IDs, or update dates. Supports pagination via since_id and limit parameters. Note: As of version 2…
Retrieves a List of Inventory Levels (Deprecated) Retrieves a list of inventory levels for specified items and locations. Use when you need to check inventory quantities at specific locations. At least one of inventory_item_ids or location_ids must be provided as a fil…
List locations Retrieve a list of locations for a Shopify store. Use when you need to get physical or virtual places where inventory is stocked and orders are fulfilled.
Retrieve all marketing events Retrieves a paginated list of marketing events from a Shopify store. Marketing events represent marketing activities such as ads, posts, newsletters, retargeting campaigns, abandoned cart emails, loyalty programs, and a…
List orders (Deprecated) Retrieves a list of orders from Shopify with optional filtering by status, dates, and other criteria. Use when you need to fetch multiple orders with pagination and filtering support.
Retrieve refunds for order (Deprecated) Retrieve a list of refunds for a Shopify order. Use when you need to check refund history for a specific order.
Retrieves a list of orders (Deprecated) Retrieves a list of orders from Shopify. Use when you need to fetch multiple orders with optional filtering by status, financial status, fulfillment status, or date ranges.
Retrieve list of pages Retrieve a list of all pages from a Shopify store. Use when you need to fetch page content or metadata. As of version 2019-10, this endpoint implements pagination via response header links.
List Payment Terms Templates Query payment terms templates from Shopify using the GraphQL API. Use when you need to retrieve available payment terms templates, optionally filtered by payment terms type.
Receive A List Of All Product Images Retrieve all images for a Shopify product. Use when you need to get the complete list of images associated with a specific product.
Get product variants Retrieve all variants for a specified product. Use when you need to list product variants with optional filtering by fields or pagination. Note: As of API version 2019-10, pagination is implemented via Link headers in t…
Get resource feedback Retrieves the current resource feedback for the shop. Resource feedback is how your app communicates its setup/configuration status to merchants via the Shopify admin. Use this to check what feedback your app has previo…
Retrieve all script tags Retrieves a list of all script tags. Use when you need to fetch all script tags or filter by URL, date range, or other criteria. Supports pagination via response headers (link-based pagination as of API version 2019-10).
List Theme Assets (Deprecated) Retrieves metadata for theme assets (files that make up a theme: templates, images, stylesheets, snippets). Returns metadata only—not file content. To get actual file content, you must retrieve assets individually using…
Retrieve order transactions Retrieves all transactions for a specific order. Use when you need to view payment exchanges for an order. Transactions include authorization, sale, capture, void, and refund types.
Mark Comment as Not Spam Marks a comment as not spam in Shopify, restoring it to published or unapproved state. Use this to remove the spam designation from a comment that was incorrectly flagged. The comment status will change from 'spam' to e…
Mark Comment as Spam Mark a comment as spam in Shopify. Use when you need to flag a comment as spam and remove it from visibility. When marked as spam, the comment status changes to 'spam', published_at is set to null, and it becomes invisi…
Modify an existing product variant Update an existing product variant in Shopify. Use when you need to modify variant properties like price, SKU, weight, or inventory settings.
Modify existing webhook (Deprecated) Modify an existing webhook subscription's address or other properties. Use when you need to update webhook delivery URIs, data formats, or field filters. Note: the webhook topic cannot be changed after creation.
Move Fulfillment Order to New Location Move a fulfillment order from one merchant managed location to another. Use when you need to relocate unfulfilled items to a different location. The operation will fail if the fulfillment order is closed or if the desti…
Pin metafield definition Pin a metafield definition in Shopify admin. Use when you need to organize metafields by pinning them to control their display order and visibility. Pinned metafields are automatically displayed in the admin interface.
Query app by API key Query app information by API key using Shopify's GraphQL Admin API. Use when you need to retrieve metadata about a Shopify app using its client ID. Returns null if no app is found with the provided API key.
Query business entities Retrieve all business entities associated with the shop. Use when you need to view business entities for assigning to markets, managing payment providers per entity, or checking order attribution.
Query business entity Query business entity information from Shopify. Use when you need to retrieve business entity details such as company name, address, and payment account information. If no ID is provided, returns the primary business en…
Query catalogs Queries catalogs from Shopify using the GraphQL Admin API. Catalogs control which products are published and how they're priced in different contexts such as international markets, B2B company locations, or specific sal…
Query channel by ID Query a single Shopify channel by ID. Use when you need to retrieve detailed information about a specific sales channel including its associated app, name, handle, and publishing capabilities.
Query consent policy regions Query the list of countries and regions for which consent policies can be created in Shopify. Use when you need to retrieve all available consent policy regions for compliance purposes.
Query current app installation Query the currently authenticated app installation on a Shopify store. Use when you need to retrieve details about the current app's installation including access scopes, active subscriptions, launch URL, and uninstall…
Query current Shopify bulk operation Query the current Shopify bulk operation status. Use when you need to check if a bulk operation is running or to retrieve the status and results of the most recent bulk query or mutation operation.
Query customer account pages Queries customer account pages from Shopify using the GraphQL Admin API. Use when you need to retrieve customizable pages for customer accounts.
Query deletion events Query deletion events from Shopify. Use when you need to retrieve records of deleted resources such as products or collections. Deletion events are the only trace of a resource after it has been permanently removed.
Query disputes Query Shopify Payments disputes using the GraphQL Admin API. Use when you need to retrieve information about payment disputes, including their status and initiation date. Supports pagination and filtering by status or I…
Query domain Query a specific domain by its ID from Shopify. Use when you need to retrieve domain details including host, URL, SSL status, and localization settings.
Query events Query events from Shopify using the GraphQL Admin API. Events track actions performed on store resources like products, orders, collections, customers, and more. Use this to retrieve activity history, audit changes, mon…
Query events count Query the count of events in Shopify using the GraphQL Admin API. Use when you need to get the total number of events with optional filtering by date, subject type, or other criteria. Returns both the count and precisio…
Query job Query a single job by its ID using Shopify's GraphQL API. Use when you need to check the status of an asynchronous job. Jobs track long-running operations like bulk operations, mutations, or imports.
Query metafield definition by ID Query metafield definition details by ID using Shopify's GraphQL Admin API. Use when you need to retrieve metadata about a metafield definition including its type, namespace, key, and usage count. Returns null if no met…
Query metafield definitions Query metafield definitions from Shopify using the GraphQL Admin API. Use this to retrieve the schema and configuration of metafields for a specific resource type (PRODUCT, COLLECTION, CUSTOMER, etc.). Returns detailed…
Query metafield definition types Queries all available metafield definition types from Shopify using the GraphQL Admin API. Returns comprehensive information about each type including its category, supported validations, and migration capabilities. Use…
Query node by ID Query any Shopify resource by its global ID using the node query. Use when you have a GID and need to retrieve the basic resource information.
Query nodes by IDs Query nodes by their IDs from the Shopify GraphQL Admin API. Use when you need to retrieve multiple Shopify objects by their global IDs (GIDs). Returns node objects with at least an id field, or null for non-existent no…
Query online store Query online store settings from Shopify using the GraphQL Admin API. Returns configuration information including password protection status. Use this to check if the online store is password protected or to retrieve ot…
Query product duplicate job Query a product duplicate job by its ID using Shopify's GraphQL API. Use when you need to check the status of a product duplication operation.
Query public API versions Query available public API versions from Shopify using the GraphQL Admin API. Returns a list of all API versions with their support status. Use this to check which API versions are currently supported before making vers…
Query publication by ID Query a single publication by ID using Shopify's GraphQL Admin API. Use when you need to retrieve detailed information about a specific publication including its name, auto-publish settings, future publishing support, a…
Query server pixel configuration Query the server pixel configuration in Shopify. Use when you need to retrieve the current server pixel settings including its ID, status, and webhook endpoint address.
Query Shop (GraphQL) Retrieve shop information using the Shopify GraphQL Admin API. Use when you need shop-level configuration such as name, email, domain, currency settings, enabled features, and policies.
Query shop billing preferences Query the shop's billing preferences from Shopify using the GraphQL Admin API. Use when you need to retrieve the currency used for billing apps and services.
Query Shopify Functions Query Shopify Functions owned by the API client installed on the shop. Use when you need to retrieve functions that customize Shopify's backend logic such as discounts, checkout validation, and fulfillment.
Query Shop Pay payment request receipts Query Shop Pay payment request receipts from Shopify using the GraphQL Admin API. Use when you need to retrieve and list Shop Pay payment request receipts. Note: This query requires API version 2026-01 or later.
Query standard metafield templates Query standard metafield definition templates from Shopify using the GraphQL Admin API. Returns preset metafield configurations with reserved namespace-key combinations for common use cases like product subtitles, care…
Query taxonomy Query Shopify's product taxonomy using the GraphQL Admin API. Use when you need to explore product categories, discover the taxonomy hierarchy, or find appropriate categories for products. Returns taxonomy categories th…
Query webhook subscription by ID Retrieve webhook subscription details by ID using the Shopify GraphQL Admin API. Use when you need to inspect webhook configuration, endpoint details, or subscription metadata.
Query webhook subscriptions Query webhook subscriptions from Shopify using the GraphQL Admin API. Returns a paginated list of webhook subscriptions with their topics, endpoints (HTTP or PubSub), and formats. Use this to view all configured webhook…
Get product images count (Deprecated) Retrieves the total count of images for a Shopify product. Use when you need to know how many images are associated with a specific product.
Receive a single fulfillment Retrieve detailed information about a specific fulfillment for an order. Use when you need to check the status, tracking details, or line items of a fulfillment.
Receive a single webhook (Deprecated) Retrieves detailed information about a specific webhook subscription by its ID. Use this tool when you need to: - View configuration details of an existing webhook (address, topic, format) - Check webhook metadata (API…
Release fulfillment hold Releases the fulfillment hold on a fulfillment order, allowing fulfillment work to proceed. Use when you need to resume fulfillment on an order that was previously placed on hold. The fulfillment order status will chang…
Release fulfillment order hold (Deprecated) Release all fulfillment holds on a fulfillment order. Use when you need to resume fulfillment work after holds have been resolved.
Reopen a closed order Reopens a previously closed Shopify order. Use when an order needs to be modified after being closed.
Restore Comment Restores a previously removed comment, changing its status back to 'published'. Use when you need to reactivate a comment that was removed. Note: This action requires protected customer data access approval because comm…
Retrieve a specific metafield (Deprecated) Retrieve a metafield by specifying the ID. Use when you need to fetch a specific metafield from any Shopify resource (products, customers, orders, etc.).
Get resource metafields Retrieve metafields attached to any Shopify resource by using the resource's endpoint. Use when you need to fetch metafields for a specific resource instance (products, customers, orders, collections, etc.).
Retrieve abandoned checkouts (Deprecated) Retrieves a list of abandoned checkouts from Shopify. Use this when you need to access abandoned checkout data for recovery campaigns, remarketing, or analytics. An abandoned checkout occurs when a customer adds contact…
Retrieves a list of all article tags (Deprecated) Retrieves all article tags used across all blogs in the Shopify shop. Use this to: - Discover available tags for filtering or categorizing blog content - Identify popular tags to understand trending topics - Build tag c…
Get Price Rules List Retrieve a list of price rules from a Shopify store. Use when you need to view all discount pricing rules with optional filtering by date ranges and usage. Note: As of version 2019-10, pagination is implemented via Link…
Retrieve a list of products (Deprecated) Retrieve a list of products from Shopify. Use when you need to fetch products with filtering options like status, vendor, product type, or date ranges. Supports pagination with limit and since_id parameters.
Retrieves a list of webhooks (Deprecated) Retrieve a list of webhook subscriptions for a Shopify shop. Use when you need to view all configured webhook subscriptions or filter webhooks by specific criteria such as topic, address, or creation date.
Retrieves an order count (Deprecated) Retrieves the count of orders matching specified filters. Use when you need to know how many orders exist with specific criteria (status, dates, financial status, etc.).
Retrieve a single location by its ID (Deprecated) Retrieves detailed information about a specific Shopify location by its ID. A location represents a physical or virtual place where a shop's products are stocked, and from which orders can be fulfilled. This includes re…
Get order risk by ID Retrieves a single order risk assessment by its unique ID. Use this action when you need details about a specific risk assessment (e.g., to check its recommendation, score, or message). If you need all risk assessments…
Retrieve Single Price Rule (Deprecated) Retrieves a single price rule by its unique identifier. Use when you need to get detailed information about a specific discount rule including its value, target type, customer selection, prerequisites, and entitlements.
Retrieve a single product (Deprecated) Retrieves a single product by its unique product ID. Use when you need to get detailed information about a specific product including its variants, images, and options.
Retrieve Specific Fulfillment Event (Deprecated) Retrieves a specific fulfillment event by its ID. **DEPRECATED**: This endpoint is deprecated as of Shopify REST Admin API 2024-10. Consider using the list fulfillment events endpoint instead to retrieve all events and…
List article tags from blog (Deprecated) Retrieve a list of all article tags from a specific blog. Use when you need to get all unique tags that have been applied to articles within a particular blog, optionally sorted by popularity.
Retrieve Discount Codes for Batch Job (Deprecated) Retrieve a list of discount codes for a discount code creation job. Use when you need to check the status of a batch discount code creation job and see which codes were successfully created and which encountered errors.
Retrieve storefront access tokens (Deprecated) Retrieves a list of storefront access tokens that have been issued for the shop. Use when you need to view all active storefront access tokens and their associated permissions. The app must have at least one unauthentic…
Retrieve specific fulfillment order Retrieve a specific fulfillment order by its ID. Use when you need detailed information about a particular fulfillment order including line items, destination, and status.
Retrieve Shop Configuration (Deprecated) Retrieve the shop's configuration and general business settings. Use when you need to access shop information such as name, domain, timezone, currency, contact details, or plan information.
Revoke app access scopes Revoke previously granted access scopes from an app installation. Use when you need to reduce an app's permissions without completely uninstalling it, providing granular control over what data and functionality the app…
Run bulk mutation operation Create and run a bulk operation to import data asynchronously by executing a GraphQL mutation multiple times. Use when you need to perform bulk mutations like creating/updating many products, variants, or other resource…
Run Shopify bulk operation query Create and start a Shopify GraphQL bulk operation for asynchronous data fetching. Use when you need to retrieve large datasets from Shopify without pagination. The operation runs in the background and results are availa…
Search Gift Cards Search for gift cards that match a supplied query. Use when searching for gift cards by various indexed fields including created_at, updated_at, disabled_at, balance, initial_value, amount_spent, email, and last_charact…
Send Account Invite to Customer (Deprecated) Sends an account activation invite email to an existing customer, allowing them to set up their online store account. Use this action to: - Send account activation emails to newly created customers who haven't activated…
Send Customer Account Invite Sends an account invitation email to a customer, allowing them to create or activate their Shopify account. The invitation includes a link for the customer to set up their account credentials. This action is useful when…
Send an invoice Send an invoice email for a draft order to a customer. Use when you need to email an invoice to a customer for a specific draft order.
Set Default Customer Address Set a specific address as the default address for a customer. Use when you need to mark an address as default for tax and shipping calculations. The default address cannot be deleted.
Set Fulfillment Orders Deadline Set the latest fulfillment deadline for multiple fulfillment orders. Use when you need to update deadline for one or more fulfillment orders.
Set inventory level Set inventory level for an item at a location. Use when you need to establish or update inventory quantity for a specific item at a designated location. If the location isn't already connected, the connection occurs aut…
Set metafields Create or update multiple metafields in a single operation using the metafieldsSet GraphQL mutation. Use when you need to set custom metadata on Shopify resources like shops, products, customers, or orders. Supports up…
Trigger Shopify Flow Trigger Shopify Flow workflows that begin with the specified trigger handle. Use when you need to manually activate Flow automation workflows from your app. The payload must be under 50 KB and match the trigger's expect…
Update app subscription line item capped amount Update the capped amount on usage-based billing for an app subscription line item. Use when adjusting usage limits based on merchant needs or changing pricing models. The mutation returns a confirmation URL where the me…
Update Article Update an existing article in a Shopify blog. Use when you need to modify article properties such as title, content, tags, or publication status.
Modify an existing blog Updates an existing blog's configuration in your Shopify store. Use this to change the blog title, URL handle, comment moderation settings, custom templates, or attach metadata. Common use cases: rebranding blogs, enabl…
Update Comment Update an existing comment on a blog article in Shopify. Use when you need to modify comment properties such as body text, author, or publication date. Note: This endpoint requires 'protected customer data' access becau…
Update Country (Deprecated) DEPRECATED: Updates an existing country's tax configuration in Shopify. This endpoint is deprecated as of API version 2024-07 and may return 403 Forbidden errors. The tax field has been read-only since API version 2020-…
Update Province Tax Information Update Province Tax Information
Update Country Update an existing country's tax configuration in Shopify. Use when you need to modify tax settings for a country. Note: This action is DEPRECATED as of 2024-07, and custom tax values cannot be created or updated as of…
Update custom collection Update an existing custom collection in Shopify. Use when you need to modify properties of a custom collection such as title, description, publication status, or sorting order.
Update Customer Update an existing customer in Shopify. Use when you need to modify customer details such as name, email, phone, tags, addresses, or marketing consent preferences.
Update Customer Address Updates an existing address for a Shopify customer. This action allows you to modify address details such as street address, city, province, country, postal code, and contact information. At least one address field must…
Bulk delete customer addresses Performs bulk operations on multiple customer addresses. Currently supports the 'destroy' operation to delete multiple addresses at once. Use this when you need to remove several addresses for a customer in a single API…
Modify an existing draft order Update an existing draft order in Shopify. Use when you need to modify draft order details like customer information, line items, addresses, discounts, notes, or status before completion.
Update EventBridge webhook subscription Update an Amazon EventBridge webhook subscription in Shopify. Use when you need to modify the ARN or data format of an existing EventBridge webhook. Note: This mutation is deprecated; consider using webhookSubscriptionU…
Update Fulfillment Tracking Updates tracking information (carrier company, tracking number, or custom URL) for an existing fulfillment. Use this action when: - You need to add or update tracking details for a shipment after the fulfillment was cre…
Update an Existing Gift Card Updates an existing gift card in Shopify. Use when you need to modify a gift card's expiration date, merchant note, template suffix, or assign it to a customer. Only four properties can be updated after creation: expire…
Update inventory item Updates properties of an inventory item in Shopify. An inventory item represents the physical good behind a product variant, containing metadata like SKU, cost, origin, and shipping requirements. Use this action to modi…
Update Marketing Event Updates an existing marketing event in Shopify. UPDATABLE FIELDS: remote_id, budget, currency, budget_type, started_at, ended_at, scheduled_to_end_at. READ-ONLY FIELDS (cannot be changed after creation): event_type, mar…
Update blog metafield (Deprecated) Update an existing metafield for a blog. Use when you need to modify metafield properties like value, type, or description for a blog resource.
Update metafield by ID Update an existing Shopify metafield by its ID. Use when you need to modify metafield properties like value, type, or description.
Update metafield definition Update a Shopify metafield definition's configuration including name, description, validation rules, access settings, and capabilities. Use when you need to modify an existing metafield definition to change display text…
Update a metafield (Deprecated) Update an existing metafield for any Shopify resource type. Use when you need to modify metafield properties like value, type, or description for products, customers, orders, collections, or other resources.
Update a metafield (Deprecated) Update an existing metafield for any Shopify resource. Use when modifying metafield properties like value, type, or description for products, customers, orders, collections, shops, or other resources. Note: The namespac…
Update Order Updates mutable fields on an existing Shopify order.
Update order risk Updates an order risk assessment for fraud detection in Shopify. Use when modifying existing risk evaluations. **IMPORTANT - API DEPRECATION:** This REST API endpoint is deprecated as of version 2025-10. If using API ve…
Update Page Updates an existing page in a Shopify store. Use this to modify page properties such as title, HTML content (body_html), author, URL handle, publication status, or template. Requires a valid page_id and at least one fie…
Update Price Rule Update an existing price rule (discount) in Shopify. Use when you need to modify price rule properties like title, value, dates, or prerequisites. Only fields provided in the request will be updated; omitted fields rema…
Update Product Image Modify an existing product image. Use when you need to update image properties such as position, alt text, or variant associations.
Update product metafield Updates an existing metafield for a specific Shopify product.
Update Product DEPRECATED: Use SHOPIFY_UPDATES_A_PRODUCT instead. Update an existing Shopify product including its variants and images. Use when you need to modify product details, variants, options, images, or SEO metadata.
Bulk update product variants via GraphQL Updates many product variants (20-50+) in one asynchronous Shopify bulk mutation job. Uses stagedUploadsCreate for JSONL upload, then bulkOperationRunMutation with productVariantsBulkUpdate, polling until completion and…
Update Province for Country (Deprecated) Updates an existing province for a country in Shopify. IMPORTANT: This endpoint is deprecated as of API version 2024-07. Additionally, custom tax values for provinces cannot be updated as of version 2020-10. While the e…
Update Pub/Sub webhook subscription Updates a Google Cloud Pub/Sub webhook subscription configuration. Use when modifying the GCP project, topic, or message format for an existing Pub/Sub webhook.
Update redirect Update an existing Shopify redirect. Use when you need to modify the path or target of a redirect. At least one of path or target must be provided.
Update redirect (Deprecated) Update an existing Shopify redirect. Use when you need to modify the path or target of a redirect.
Updates An Article (Deprecated) DEPRECATED: Use SHOPIFY_UPDATE_ARTICLE instead. Update an existing article in a Shopify blog. Use when you need to modify article properties such as title, body content, tags, author, or publication status.
Updates An Existing Discount Code Updates the code value of an existing discount code associated with a price rule. This action allows you to change the discount code string that customers use at checkout. The code is case-insensitive and can be up to 2…
Update a product (Deprecated) Updates a product and its variants and images. Use when modifying existing product details, pricing, variants, images, or SEO information.
Update Script Tag Modify an existing script tag in Shopify. Use when you need to update script properties like the source URL, display scope, or caching behavior.
Update a metafield (Deprecated) Update an existing shop-level metafield's value and type. Use when you need to modify metafield data attached to the shop itself (not product, customer, or other resource metafields).
Update Smart Collection Update an existing smart collection. Use when you need to modify a smart collection's properties, rules, or settings.
Update smart collection (Deprecated) Update an existing smart collection. Use when you need to modify smart collection properties like title, rules, or settings.
Update smart collection product order Updates the display order of products in a smart collection with manual sorting enabled. Use this action to customize the sequence products appear in a collection. This only works when the collection's sort_order field…
Modify existing theme Update an existing theme's properties such as name or role. Use when you need to modify a theme. Note that a theme cannot be modified while uploading, updating, or if it's the last published theme.
Update webhook subscription Update a webhook subscription's configuration in Shopify. Use when you need to modify the endpoint URL, event filters, included fields, or metafield namespaces without recreating the subscription. You can switch between…
Validate Access DEPRECATED: Use SHOPIFY_GET_SHOP_DETAILS instead. Diagnoses authorization issues by retrieving granted OAuth scopes and validating token authenticity. Use when troubleshooting 401/403 errors to determine if the issue is…

Setup

How we connect it

1
Connect your account

You create a key in Shopify, a key you create and control, and paste it in once. It lives in a secrets store on your server, not with us.
2
Set the guardrails

Read-only by default. You choose which write actions the agent may take, and anything outside that policy gets confirmed with you first.
3
We keep it running

Health checks on every connection, updates handled for you, and we watch the first week of activity to make sure the work lands.

FAQ

Shopify questions, answered.

How does the agent connect to Shopify?

With a key you create and control. You paste it in once, it is stored in a secrets store on your server, permissions are scoped to the minimum the agent needs, and you can revoke it at any time.

What can the agent actually do in Shopify?

The actions Shopify's API allows, the same things a person clicking around the app could do. Connections start read-only by default; write actions are confirmed against the policy you set before the agent takes them.

Is Shopify included in my plan?

Connections are priced per tool on top of the base plan. Some are included, some are premium. See pricing for how connection charges work.

How long until Shopify is ready?

Standard tools are ready inside 7 business days of the setup call. We test the connection end to end, walk you through how the agent uses it, and watch the first week of activity.

Ready to put Shopify to work?

Tell us what your team runs on. We set up the connection, secure it, and your agent takes it from there.

Book a setup call → Browse all integrations

All product names, logos, and brands are property of their respective owners; used for identification only. ZeroToClaw is not affiliated with or endorsed by Shopify.

Connect Shopify to your AI agent

What your agent can do in Shopify

How we connect it

Connect your account

Set the guardrails

We keep it running

More E-commerce tools your agent can use

Shopify questions, answered.

Ready to put Shopify to work?